TSTool / Development Environment / Eclipse
Introduction
The Eclipse Integrated Development Environment (IDE) has traditionally been used for TSTool software development and is recommended. Alternate IDEs may be supported at some point; however, investigating impacts of using other IDEs on TSTool development will require resources. Eclipse does have some issues and limitations, but other IDEs have different issues.
TSTool development has typically occurred on Windows computers, although the software is often deployed to other operating systems.
As discussed in the Java section, OpenJDK Java 9 is currently used for development as of TSTool version 14.9.0. Oracle Java 8 was currently used for development and 64-bit Java and Eclipse are used as of TSTool version 14.0.0.
32-bit Java was previously used due to component requirements. TSTool has been developed with various versions of Eclipse, including Mars, Neon, 2019-03 and later versions. The version of Eclipse is generally not critical as long as the appropriate Java version is configured for compatibility.
The Eclipse .project file is currently saved in the Git repository for each TSTool component repository
in order to facilitate development environment setup. This may change in the future.
Using a compatible version of Eclipse between developers ensures that the format of such files is consistent.
The Eclipse workspace (.metadata) folder is not saved in Git repository and is instead
is recommended to be saved in eclipse-workspace folder under the TSTool product folder
in a standard development folder structure.
Windows
This documentation was created for an older version of Eclipse and needs to be updated. The process for current installations is similar.
Download Eclipse 2019-03 (or newer)
The download links for Eclipse may change as new versions are released. Download the Eclipse IDE for Java Developers (there is currently no reason to use the Eclipse IDE for Java EE Developers, which is used for web development). Make sure to select the Windows 64-bit version. The zip file installer is convenient because it is very clear where the software is installed.
Install Eclipse
The Eclipse installer file will be named eclipse-java-2019-03-R-win32-x86_64.zip or similar.
Note that later versions of Eclipse provide an option to use an installation program
so these instructions need to be updated when later versions of Eclipse are used.
To avoid confusion with other versions of Eclipse that may be installed on the computer (as needed for other product development),
install by copying/unzipping into a folder named C:\Program Files\Eclipse\eclipse-java-2019-03
(older 32-bit Neon version used C:\Program Files (x86)\eclipse-java-neon-3-win32).
The resulting folder structure is as shown in the following figure.
Eclipse Software Folders (see full-size image)
Check Eclipse Run Script
The cdss-app-tstool-main repository build-util folder contains scripts to run the correct version of Eclipse,
assuming a standard installation folder. For example, build-util/run-eclipse-win64.cmd can be run from a Windows command shell.
This ensures that the proper versions of Eclipse and Java are used.
If necessary, this script can be modified or other versions added over time (for example for new versions of Java and Eclipse).
Linux
TSTool is typically developed on Windows, with Linux used for testing to ensure that features work on Linux. The Linux environment is not the primary development or production environment, although support for Linux is being increased over time.
The TSTool Linux development environment is consistent with the operating system and 64-bit is used by default. The following documentation was prepared for Debian Stretch.
Download Eclipse
The Eclipse Linux version is downloaded from the
main Eclipse Download Page.
Unlike Windows, newer versions of Eclipse can be used,
at least Neon but later has also been used (for example 2019-09 release).
Save the download file, for example ~/Downloads/eclipse-inst-linux64.tar.gz.
Install Eclipse
The Eclipse installer from the previous step should be unzipped, for example:
$ cd ~/Downloads
$ tar -xzvf ~/media/vbshare/eclipse-inst-linux64.tar.gz
The top level folder is eclipse-installer. The installer is run using:
$ cd eclipse-installer
$ ./eclipse-inst
The following images illustrate the installation process.
First pick Eclipse IDE for Java Developers. The following defaults are shown, based on Java 8 being installed and using the standard installation folder.
Install Eclipse (see full-size image)
Press Install to install Eclipse. Accept the license. License certificates should also be accepted as shown below.
Install Eclipse - Accept Certificates (see full-size image)
After the software is installed, Eclipse can be launched from the installer. However, a run script is typically configured as discussed in the following section.
Check Eclipse Run Script
The cdss-app-tstool-main repository build-util folder contains scripts to run the correct version of Eclipse,
assuming a standard installation folder.
For example, build-util/run-eclipse.bash can be run from a Linux terminal.
This ensures that the proper versions of Eclipse and Java are used.
If necessary, this script can be modified or other versions added over time (for example for new versions of Java and Eclipse).