Project

General

Profile

Step 3 - First steps with Z2 on Git » History » Version 59

Henning Blohm, 16.09.2018 18:09

1 58 Henning Blohm
h1. First steps with Z2
2 1 Udo Offermann
3 32 Udo Offermann
[[Step_2_-_Install_and_run_in_5_minutes|« Step 2 - Install and run in 5 minutes]]
4 1 Udo Offermann
5 4 Udo Offermann
h2. Prerequisites
6
7 58 Henning Blohm
You need a z2-base installation as described on the [[How_to_install_z2_v21|previous]] page.
8 56 Udo Offermann
Furthermore you need the "Eclipse-IDE":http://www.eclipse.org (one of Galileo, Helios, Indigo, Juno or Kepler is fine) and the "Egit plug-in:":http://www.eclipse.org/egit. 
9 4 Udo Offermann
10 27 Henning Blohm
h2. First steps with the z2-Environment
11 1 Udo Offermann
12 30 Udo Offermann
Next, we will look at the steps to development for Z2 with Git using Eclipse. Please stop the server before you continue.
13 3 Udo Offermann
14 58 Henning Blohm
In order to have modules from local repositories discovered by Z2, it is required for the repositories and workspace to be siblings to each other. Go back to the "z2-base" directory (@cd ../..@, if you are inside the "bin" directory) and create a folder called "workspace" - this will be used as the workspace root for Eclipse:
15 3 Udo Offermann
16
<pre>
17 58 Henning Blohm
:bin$ cd ../..
18 6 Udo Offermann
:z2-base$ mkdir workspace
19
:z2-base$ ls -l
20
total 0
21
0 drwxr-xr-x   2 mr_x  staff   68  7 Sep 16:34 workspace
22
0 drwxr-xr-x  12 mr_x  staff  408  7 Sep 15:11 z2-base.core
23
:z2-base$
24 1 Udo Offermann
</pre>
25
26 20 Udo Offermann
Now start Eclipse and choose @z2-base/workspace@ as your workspace folder.
27 1 Udo Offermann
28 59 Henning Blohm
For convenience, we recommend to create an "External Tool Configurations" to start the Z2 Graphical User Interface (GUI) from within your development environment. Add the start script @gui.sh@ (or @gui.bat@ on Windows) from the z2-base.core/bin folder as the "Main Location".
29 1 Udo Offermann
30 59 Henning Blohm
When running you should see a new window labeled "Z2 Home (z2-base)":
31 21 Udo Offermann
32 7 Udo Offermann
!z2_gui.png!
33 12 Udo Offermann
34 23 Henning Blohm
The z2-Environment provides an Eclipse plug-in called "Eclipsoid" that has a lot of neat utilities and one really important feature: Dependency resolution from a running z2-Environment.
35 9 Udo Offermann
36 24 Henning Blohm
Here's the catch: When developing with Eclipse, projects in your workspace may require Java types from other projects to compile. Eclipse will try to verify that, every time you save a source code modification. When working on a non-trivial system, you may have a lot of dependencies that you will typically not want to see clutter your workspace. That is where the plugin comes into the game. This way you can checkout and focus on a project subsets while the Eclipsoid plug-in provides the transitive closure of all required prjects and libraries. 
37
38 23 Henning Blohm
Other features provided by the Eclipsoid plug-in that are explained in more details on the [[Eclipsoid]] wiki pages.
39 3 Udo Offermann
40 33 Henning Blohm
{{include(how to install eclipsoid)}}
41 21 Udo Offermann
42 13 Udo Offermann
h2. Changing source code and check the result
43 1 Udo Offermann
44 48 Henning Blohm
To change source code, we need a project in Eclipse. Let's change the simple calculator Web application that is contained in the base repository. 
45 13 Udo Offermann
46 48 Henning Blohm
To do so, we need to 
47 1 Udo Offermann
48 48 Henning Blohm
# make the Git repository available in Eclipse's Git tool EGit, 
49
# import the project into Eclipse and 
50
# change the project and check the result.
51 1 Udo Offermann
52 48 Henning Blohm
The first two steps can be done the regular Eclipse way or using the Eclipsoid plugin - both leading to the same result. Let's try latter:
53
54
In the new "z2-environment" menu choose the entry labled "z2-Repositories view".
55
56 1 Udo Offermann
This will open a view like this:
57 14 Udo Offermann
58 1 Udo Offermann
!z2-Repositories-view.png!
59
60 47 Henning Blohm
This view lists all repositories currently known by the running system. 
61 1 Udo Offermann
62 48 Henning Blohm
(Note: The Eclipsoid plug-in connects by default to the Eclipsoid Web application on http://localhost:8080/eclipsoid/ that provides all kinds of runtime information to the plugin. The connection data can be customized on the "z2-environment" preference page).
63 47 Henning Blohm
64 34 Udo Offermann
The repositories in the view is called *com.zfabrik.boot.config/baseRepository* containing the Z2 foundation services. It also contains a sample web application that we are going to open and change.
65 1 Udo Offermann
66 49 Henning Blohm
Right-click on the base repository and choose "Clone Git repository" from the context menu. This will create a clone from http://git.z2-environment.net/z2-base.base next to the z2-base.core repository inside your z2-base directory. 
67 1 Udo Offermann
68 49 Henning Blohm
To import the project want to work on into your workspace, either import the "com.zfabrik.samples.calculator" from the z2-base.base repository in the Git perspective or return the the z2-Repositories View and expand the "com.zfabrik.boot.config/baseRepository" node and further its "z2-projects" child node. You will see all projects that are stored inside this repository. 
69
70
Right-click the "com.zfabrik.samples.calculator" project and choose "Import Project" from the context menu. This does the same as the import project action of the Git repositories perspective 
71
72 26 Henning Blohm
Once the project is imported go to the Java Package Explorer view and drill down to +/com.zfabrik.samples.calculator/java/src.impl/com/zfabrik/samples/calculator/impl/Calculator.java+, open the the class via double click. The result should look like this:
73 34 Udo Offermann
74 1 Udo Offermann
!Calculator_class.png!
75
76 49 Henning Blohm
In the source is annotated with colored squiggles and red x-markers indicating that Eclipse's compiler is not able to resolve certain identifiers. If you want you can check the classpath of the project and indeed there are only three entries: One for the JRE, one for the sources, and one called "Eclipsoid: z2-Environment Build Container". This container will resolve the incomplete class-path when it is asked to do so. Click the toolbar icon !z2_resolve_icon.png! or hit <Alt+R> to trigger a refresh of that build container. All red x-markers should be gone by now. 
77 1 Udo Offermann
78 36 Udo Offermann
Before we change the code let's have a look at the current state. Launch http://localhost:8080/calc and play around with the calculator. You might miss some operations like logarithm or square root which we are going to add now. Go back to Eclipse and the Calculator class. Uncomment one line inside the enum OP definition:
79
80
<pre><code class="java">
81
private enum OP {
82
	CE, C, open, close, 
83
	sqrt, pow, ln, epowx,
84
	sgn, dot, eq, pi, 
85
	add, sub, mult, div, 
86
	sqr, inv, illegal
87
};
88
</code></pre>
89
90
Scroll down to method @doOp()@ and uncomment the section from @case sqrt:@ to @case epowx:@ (line 154 to 170):
91
92
<pre><code class="Java">
93
...
94
	break;
95
96
case sqrt:
97
	new Sqrt().addTo(this.stack);
98
	break;
99
				
100
case pow:
101
	new Pow().addTo(this.stack);
102
	break;
103
104
case ln:
105
	new Ln().addTo(this.stack);
106
	break;
107
				
108
case epowx:
109
	new EPowX().addTo(this.stack);
110
	break;
111
				
112
default:
113
...
114
</code></pre>
115
116
The implementation classes of these operations do are already exists. 
117
We must also add the operations to the visual layout which is implemented as a JSP file. Navigate to +/com.zfabrik.samples.calculator/web/WebContent/calc.jsp+ and open the file. Scroll down to line 102 and uncomment the block annotated with "uncomment me":
118
119
<pre><code class="html">
120
...
121
<button type="submit" name="op=CE" title="C">CE</button>
122
	
123
<button type="submit" name="op=sqrt" title="r">&radic;</button>
124
<button type="submit" name="op=pow" title="^">x<sup>y</sup></button>
125
<button type="submit" name="op=ln" title="l">ln</button>
126
<button type="submit" name="op=epowx" title="e">e<sup>x</sup></button>
127
				
128
<button type="submit" name="op=pi" title="p">&pi;</button>
129
...
130
</code></pre>
131
132 50 Henning Blohm
Now what happens next is really important to understanding the principles behind Z2. In order to test our modification we will not deploy any kind of archive. Instead we will make sure it considers the project in our workspace a preferred version of the calculator project. 
133 1 Udo Offermann
134 50 Henning Blohm
From the Z2 point of view the Eclipse workspace is yet another component repository. We call the implementation the _Dev-Repository_, because it is obviously suitable for local development.
135
136
To make the inclusion of a specific project into the Dev-Repository effective, we will _arm_ it. This is so you can choose whether a local workspace version of a module should be considered or rather not. Practically, arming means nothing else but putting a file called LOCAL into the project folder.
137
138
When we ask the Z2 server to check for new changes (we say "to _synchronize_ the server"), it will find two versions of our calculator project: one inside the *z2-base.base* repository and one inside the Dev-repository (i.e. your workspace). Because of the preference rule above, the version in your workspace will be considered with preference.
139
140
To "arm" the calculator project right-click the project "com.zfabrik.samples.calculator" in the Java Package Explorer and choose "Arm z2-Projects" (which, a indicated, does in fact nothing but putting an empty LOCAL file).
141
142
You will see a green "z" decoration at the upper left edge of the Java icon in the package explorer: !green_z_decoration.png!.
143
144
After we specified that the workspace version of the calculator project should win over the one in the Git repository we can trigger the z2 synchronization: Choose "Sync with z2-environment" from the "z2-environment" menu, click the new z-icon !z2_sync.png! or hit <Alt+Y>. 
145
146
The connection with the Z2 server is established via he Eclipsoid plug-in over http. In situations where the Web server cannot be started, the Eclipsoid web application will not be available. In this case the z2-gui is the only way to trigger a synchronization (except of a shutdown and restart). You will also see that the log-messages in the z2-gui log pane has changed and that the server has invalidated and restarted one resource:
147 1 Udo Offermann
148 17 Udo Offermann
<pre>
149 39 Udo Offermann
09/28 13:14:47 [36]...entRepositoryImpl [800]: Pulled deltas within 874msec from GitCR com.zfabrik.boot.config/baseRepository (origin=http://git.z2-environment.net/z2-base.base, branch=v2.1, OPTIONAL, root=/Users/udoo/dev/temp/z2-base/z2-base.core/run/bin/../../work/repos/95f655a0/git)
150
09/28 13:14:47 [36]...hronizationRunner [800]: Found 2 invalidation candidate resources
151
09/28 13:14:47 [36]...hronizationRunner [800]: Invalidated 0 resources
152
09/28 13:14:47 [33]...ent/webWorker@0.2 [800]: 09/28 13:14:47 [19]...stemStateResource [800]: Left system state: environment/webWorkerUp
153
09/28 13:14:47 [33]...ent/webWorker@0.2 [800]: 09/28 13:14:47 [19]...pp.WebAppResource [800]: Stopping Web App (/calc): com.zfabrik.samples.calculator/web
154
09/28 13:14:47 [33]...ent/webWorker@0.2 [800]: 09/28 13:14:47 [19]...worker.WorkerSoul [800]: Invalidated 2 resources
155
09/28 13:14:47 [33]...ent/webWorker@0.2 [800]: 09/28 13:14:47 [19]...pp.WebAppResource [800]: Starting WebApp: com.zfabrik.samples.calculator/web
156
09/28 13:14:48 [33]...ent/webWorker@0.2 [800]: 09/28 13:14:48 [19]...pp.WebAppResource [800]: Done starting Web App (/calc): com.zfabrik.samples.calculator/web
157
09/28 13:14:48 [33]...ent/webWorker@0.2 [800]: 09/28 13:14:48 [19]...stemStateResource [800]: System state attained: environment/webWorkerUp
158
09/28 13:14:48 [36]...mponentRepository [800]: Overriding module com.zfabrik.samples.calculator: com.zfabrik.dev.repo/devRepo
159 17 Udo Offermann
</pre>
160
161 39 Udo Offermann
Now it's time to check the result: http://localhost:8080/calc - voilà! 
162 26 Henning Blohm
163 40 Udo Offermann
You should repeat these steps a few times: Change the source code (e.g. adding more new calculator operations like sine, cosine, tangent...), hit <Alt+Y> and check the result, so you will get a feeling of how fast development round trips can be!
164 51 Henning Blohm
165
166
h2. What's next?
167
168
If you prefer using subversion, there is absolutely no restriction. On the contrary, the whole approach may even look more natural with Subversion compared to Git as a lot of unnecessary downloading can be omitted. Please have a look at
169
170 55 Henning Blohm
* [[Step 3 - First steps with Z2 on SVN]]
171 51 Henning Blohm
* [[Repositories]]
172
173
Please visit the [[Samples]]. In most cases, trying them is straight-forward and instructive.
174
175 53 Henning Blohm
Want to understand it better? There are some more detailed articles in this wiki. However, for a structured reference and introduction, you are strongly encouraged to start reading the documentation in parallel to any other investigation either via the samples or the howtos:
176 1 Udo Offermann
177 57 Henning Blohm
* Start reading the "v2.5 documentation":http://www.z2-environment.eu/v25doc
178 53 Henning Blohm
* Check out some of the blogs at [[wiki#blogs|Blogs]]
179 52 Henning Blohm
180
181 54 Henning Blohm
Thanks!
182
183 52 Henning Blohm
---------------------------