Eclipse_installationguide.adoc 13.1 KB
Newer Older
Kristof Szabados's avatar
Kristof Szabados committed
1
2
---
Author: Jenő Balaskó
3
4
Version: 7.2.2
Date: 2021-03-29
Kristof Szabados's avatar
Kristof Szabados committed
5
6

---
Kristof Szabados's avatar
Kristof Szabados committed
7
8
= Installation Guide for the TITAN Designer and TITAN Executor for the Eclipse IDE
:author: Jenő Balaskó
9
10
:revnumber: 7.2.2
:revdate: 2021-03-29
Kristof Szabados's avatar
Kristof Szabados committed
11
:title-logo-image: images/titan_logo.png
12
:sectnums:
13
:doctype: book
14
:leveloffset: +1
Kristof Szabados's avatar
Kristof Szabados committed
15
:toc:
16
:toclevels: 2
Kristof Szabados's avatar
Kristof Szabados committed
17
18
19
20
21
22
23
24
25
26
27

ifdef::env-github,backend-html5[]
image::images/titan_logo.png[alt]
endif::[]

*Abstract*

This document describes the detailed information of installing the TITAN Designer and Executor for the Eclipse IDE.

*Copyright*

Adam Knapp's avatar
Adam Knapp committed
28
Copyright (c) 2000-2021 Ericsson Telecom AB. +
Kristof Szabados's avatar
Kristof Szabados committed
29
30
31
32
33
34
35
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 that accompanies this distribution, and is available at +
https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html.

*Disclaimer*

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

36

37
= Introduction
Kristof Szabados's avatar
Kristof Szabados committed
38

39
== Overview
Kristof Szabados's avatar
Kristof Szabados committed
40
41
42

This document describes the installation and configuration of the TITAN Designer, the TITAN Executor, the TITAN Log Viewer and the Titanium plug-ins for the Eclipse IDE (from now shortly TITAN plug-ins).

43
== Target Groups
Kristof Szabados's avatar
Kristof Szabados committed
44
45
46

This document is intended for system administrators and users who intend to install and configure the TITAN Designer, Executor, Log Viewer and Titanium plug-ins for the Eclipse IDE.

47
== Typographical Conventions
Kristof Szabados's avatar
Kristof Szabados committed
48
49
50
51
52
53
54
55
56
57
58

This document uses the following typographical conventions:

* *Bold* is used to represent graphical user interface (GUI) components such as buttons, menus, menu items, dialog box options, fields and keywords, as well as menu commands. Bold is also used with ’+’ to represent key combinations. For example, *Ctrl+Click*

* The "**/**" character is used to denote a menu and sub-menu sequence. For example, *File / Open*.

* `Monospaced` font is used represent system elements such as command and parameter names, program names, path names, URLs, directory names and code examples.

* *`Bold monospaced font`* is used for commands that must be entered at the Command Line Interface (CLI), For example, *`mctr_gui`*

59
= Requirements
Kristof Szabados's avatar
Kristof Szabados committed
60

61
== Requirements for the TITAN Designer, Executor and Log Viewer plug-ins for the Eclipse IDE
Kristof Szabados's avatar
Kristof Szabados committed
62

Adam Knapp's avatar
Adam Knapp committed
63
* Eclipse IDE 4.7.0 (Oxygen) and all its dependencies, for example, GTK2, must be installed. Any later version is supported. Recommended: the latest Eclipse IDE for Java Developers or Eclipse IDE for C/C++ Developers depending on the user preferences
Kristof Szabados's avatar
Kristof Szabados committed
64
65
66

* ANTLR Runtime 4.3

67
* TITAN TTCN-3 Toolset installed. (Only needed if Eclipse is used for project compilation and test execution. Editing does not require it.)
Kristof Szabados's avatar
Kristof Szabados committed
68
69
70
71
72

* J2SE(TM) Runtime Environment 6.0 or later installed and set in Eclipse as the Java Runtime Environment

* Only Oracle Java Hotspot virtual machine is supported

73
== Requirements for the Titanium Plugin
Kristof Szabados's avatar
Kristof Szabados committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

* TITAN Designer

* JUNG 2.1 (Java Universal Network/Graph Framework)
+
see https://github.com/jrtom/jung

* Google Guava 21.0, see
+
https://github.com/google/guava

* Apache POI 3.9.0

* ANTLR Runtime 4.3.0

89
== Cygwin on Windows
Kristof Szabados's avatar
Kristof Szabados committed
90
91
92
93
94
95
96
97
98

* Using the Eclipse IDE on Windows is fully supported.

Installing Cygwin is optional and only needed if Eclipse is used for project compilation and test execution. TTCN-3 module editing is supported without Cygwin.

For detailed information on installing Cygwin and configuring the environment variables for TITAN to work, refer to <<_1, Installation Guide for TITAN TTCN-3 Test Executor>>.

Only one detail of that document is emphasized here:

99
100
101
102
103
IMPORTANT: When installation is finished, add the +
``$CYGWIN_INSTALL_DIRECTORY\bin`` and +
``$CYGWIN_INSTALL_DIRECTORY\usr\bin`` directories to the ``PATH`` +
environment variable of Windows, so Eclipse will access the shell commands. +
For example, if the cygwin root is ``C:\cygwin64`` then ``Path`` should contain ``C:\cygwin64\bin;C:\cygwin64\usr\bin``.
Kristof Szabados's avatar
Kristof Szabados committed
104

105
= Installing prerequisites
Kristof Szabados's avatar
Kristof Szabados committed
106
107

[[installing-the-titan-ttcn-3-toolset]]
108
== Installing the TITAN TTCN-3 Toolset
Kristof Szabados's avatar
Kristof Szabados committed
109
110
111

For detailed information on installing the TITAN TTCN-3 Toolset, and configuring the environment variables for TITAN to work, refer to <<_1, Installation Guide for TITAN TTCN-3 Test Executor>>.

112
== Installing Eclipse
Kristof Szabados's avatar
Kristof Szabados committed
113

Kristof Szabados's avatar
Kristof Szabados committed
114
Download the latest 32- or 64-bit Eclipse package, according to your platform and OS version form https://www.eclipse.org/downloads/. All Eclipse solution packages are suitable, but if you want to develop also adapters and/or external C/{cpp} functions, the "Eclipse IDE for C/{cpp} Developers" can be a good choice.
Kristof Szabados's avatar
Kristof Szabados committed
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

NOTE: The CDT package can also be added to any Eclipse installation later.

If you want to use/edit XML, XSD and/or JSON files, the Eclipse ecosystem provides tools for this.

For *XML/XSD* editing and validation you can use the Web Tool Platform (WTP) project's XML Editor; it is contained in Eclipse IDE for Java EE Developers by default, and in other Eclipse packages it can be added from the project's update site (for other Eclipse releases just replace "oxygen" with the name of your Eclipse release: http://download.eclipse.org/webtools/repository/oxygen.

To validate your XSD or XML file(s), select the file(s), right-click on the selection and choose *Validate* from the pop-up menu. You can also validate your document by right clicking in the editor window and selecting "validate" from the pop-up menu.

To work with *JSON*, you can find a JSON editor at the Eclipse Marketplace (Help/Marketplace menu): type in the search field "JSON" and follow the instructions.

Decompress the downloaded file in a desired location, then run Eclipse with the executable, `eclipse.exe` or `./eclipse`, for Windows or UNIX, respectively.

NOTE: Users behind a firewall:
When using Eclipse from behind a firewall, the HTTP proxy must be set, and internal Ericsson locations, for example the update site, must be added to proxy exceptions. An example of the proxy settings in Eclipse:

image::images/proxysettings.png[proxy_settings]

133
== Installing Eclipse plug-in prerequisites for Titan Plug-ins and Titanium
Kristof Szabados's avatar
Kristof Szabados committed
134
135
136
137
138
139
140

The prerequisites for Titan plugins are POI and ANTLR Runtime.

The prerequisites for Titanium Plugin are JUNG and Google Guava.

These can be installed together with the Titan plug-ins as external dependencies, see the next chapter.

141
= Installation of the TITAN plug-ins
Kristof Szabados's avatar
Kristof Szabados committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

The TITAN plug-ins for Eclipse can be installed from the provided update sites.

* For Ericsson users only: http://ttcn.ericsson.se/download/update_site. The usage of this version is conditioned by the presence of a license file and supported by the Titan support team.
+
* For users outside Ericsson: https://projects.eclipse.org/projects/tools.titan/downloads. This version is licensed under the Eclipse Public License.
+
Choose the appropriate zip or tgz file, download it and pass the link of the downloaded zip to your Eclipse (like when installing a plugin from an archived update site) or unzip it and pass the link of the folder as update site.
+
NOTE: The all_in_one (or the Eclipse plug-ins plus dependencies) package contains ANTLR Runtime, JUNG and guava, the other packages do not contain any prerequisites.
+
From version 6.1.0 only all_in_one packages are delivered.
+
WARNING: If you have an earlier version than 4.2.0.CRL_113_200_4_R2A_20140902-1911 of TITAN plug-ins then any new installation should be preceded by uninstalling of the TITAN plug-ins or to start with a just installed Eclipse from scratch.

Perform the following steps:

. In Eclipse, open the *Help* scroll-down menu, and select the option "*Install New Software…*".

. Give the provided update site URL in the field or press the button "*Add*". Fill the Name and location. If a downloaded, zipped update site file is used press the button "*Archive…*" and select the zip file.
+
image::images/4_F1.png[]
+
The result is something like this:
+
image::images/4_F2.png[]

. Press *OK*. An install dialog appears.
+
image::images/4_F3.png[]

. It is advised to uncheck the "Contact all update sites…" box. Select the TITAN plug-ins and the external dependency plugins to be installed.
+
image::images/4_F4.png[]

. Click *Next*. An Install Details dialog box appears with the items to be installed.

. Click *Next* again.

. Accept the license agreements then push *OK*.

. At this point "Security Warning" window appears indicating that the authenticity or validity of the plug-ins cannot be established. It is safe to press the *OK* button here.
+
image::images/4_F5.png[]

NOTE: When you update your TITAN plug-ins, it is suggested to update all the installed TITAN plug-ins because of dependencies. Otherwise eclipse will analyze the dependencies and after a while it will force you to update all of the already installed features.

189
= Post-Installation Steps
Kristof Szabados's avatar
Kristof Szabados committed
190
191
192
193
194
195
196
197
198

After installing the TITAN plug-ins in Eclipse, the locations of the installed TITAN TTCN-3 Toolset and the license file must be set.

Open the *Window* scroll-down menu, and open *Preferences.* In the pop-up window, open *TITAN Preferences* from the tree, and set the location of the TITAN installation path and License file (if label "License file" and text box exist in your version).

NOTE: TITAN install path is not mandatory. If you don’t want to build from Eclipse you can leave it empty.

image::images/5_F1.png[]

199
== Turning-Off Automatic Building
Kristof Szabados's avatar
Kristof Szabados committed
200
201
202

By default, a new installation of Eclipse will be set to automatically compile its projects. In the current build system this can take a lot of time, so it is advised to turn this feature off, and only enabling if the actual projects make it possible. Open the *Project* scroll-down menu, and uncheck the *Build automatically* option.

203
== Configuring Java
Kristof Szabados's avatar
Kristof Szabados committed
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238

You might need to modify your `eclipse.ini` file (usually located in the same directory as your `eclipse` executable.)

It is suggested to have at least 1GB and recommended 2 GB free memory per 1 million TTCN-3/ASN.1 source code lines (but it strongly depends on the code complexity). In Java it is controlled via the Xmx option.

For example, if Java 1.6 or 1.7 is applied and a project of 2 million TTCN-3 code lines is edited, the suggested settings in `eclipse.ini` are these:

[source]
----
-vmargs

-XX:MaxPermSize=2048M

-Dosgi.requiredJavaVersion=1.7

-Xms1024M

-Xmx4g
----

If Java 1.8 is used then `MaxPermSize` is ignored, its support is removed. Use these settings instead:

[source]
----
-vmargs

-Dosgi.requiredJavaVersion=1.8

-XX:+UseG1GC

-Xms1024M

-Xmx4g
----

239
NOTE: If you cannot edit the `eclipse.ini` file, you can start eclipse with flags. For example `eclipse -vmargs -Xmx4g` modifies the maximum memory allocation for the virtual machine.
Kristof Szabados's avatar
Kristof Szabados committed
240

241
= Compatibility Issues
Kristof Szabados's avatar
Kristof Szabados committed
242
243
244
245
246
247
248

The plug-ins require the Java Runtime Environment to be version 5.0 or later, but significant speed increase can be gained by installing version 6.0, 7.0 or 8.0.

Note that an actual version of the TITAN Designer plug-in is meant to be compatible with the same version of TITAN, but can be used with older TITAN releases, if:

* The additional features are not used (the makefile generator of TITAN is used to generate the makefile, so if a feature is used that is known by TITAN Designer, but is not known by the makefile generator, the makefile generation will fail)

249
* A special script is inserted into the actually used install directory's bin directory. The role of this script is to convert the call to the makefile generator to valid call of the compiler. (The makefile generator and the compiler are separated from TITAN 1.7.0). It is important to note, that such a file must contain a path to the compiler to be called, so such a script is not expected to work without modifications. Please note that the compiler must be called with *-M* as the first parameter, and the other parameters must be redirected to the compiler.
Kristof Szabados's avatar
Kristof Szabados committed
250

251
= Download the source code
Kristof Szabados's avatar
Kristof Szabados committed
252
253
254
255
256
257
258

The source code of Titan Eclipse plugin is available.

Download the first time:

[source,subs="+quotes"]
----
Adam Knapp's avatar
Adam Knapp committed
259
*git clone https://gitlab.eclipse.org/eclipse/titan/titan.EclipsePlug-ins.git*
Kristof Szabados's avatar
Kristof Szabados committed
260
261
262
263
264
265
----

Updating the already existing local repository:

[source,subs="+quotes"]
----
Adam Knapp's avatar
Adam Knapp committed
266
*git pull https://gitlab.eclipse.org/eclipse/titan/titan.EclipsePlug-ins.git*
Kristof Szabados's avatar
Kristof Szabados committed
267
268
----

269
= References
Kristof Szabados's avatar
Kristof Szabados committed
270
271

[[_1]]
Adam Knapp's avatar
Adam Knapp committed
272
* [1] link:https://gitlab.eclipse.org/eclipse/titan/titan.core/blob/master/usrguide/installationguide/installationguide.adoc[Installation guide for TITAN TTCN-3 Test Executor]
Kristof Szabados's avatar
Kristof Szabados committed
273
274

[[_2]]
Adam Knapp's avatar
Adam Knapp committed
275
* [2] link:https://gitlab.eclipse.org/eclipse/titan/titan.core/blob/master/usrguide/userguide/UserGuide.adoc[User Guide for TITAN TTCN-3 Test Executor]
Kristof Szabados's avatar
Kristof Szabados committed
276
277

[[_3]]
Adam Knapp's avatar
Adam Knapp committed
278
* [3] link:https://gitlab.eclipse.org/eclipse/titan/titan.EclipsePlug-ins/blob/master/org.eclipse.titan.designer/docs/Eclipse_Designer_userguide/DesignerUserGuide.adoc[User Guide for the TITAN Designer for the Eclipse IDE]
Kristof Szabados's avatar
Kristof Szabados committed
279
280

[[_4]]
Adam Knapp's avatar
Adam Knapp committed
281
* [4] link:https://gitlab.eclipse.org/eclipse/titan/titan.EclipsePlug-ins/blob/master/org.eclipse.titan.executor/docs/Eclipse_Executor_userguide/ExecutorUserGuide.adoc[User Guide for the TITAN Executor for the Eclipse IDE]
Kristof Szabados's avatar
Kristof Szabados committed
282
283

[[_5]]
Adam Knapp's avatar
Adam Knapp committed
284
* [5] link:https://gitlab.eclipse.org/eclipse/titan/titan.core/blob/master/usrguide/referenceguide/ReferenceGuide.adoc[Programmer´s Technical Reference for TITAN TTCN-3 Test Executor]