OpenArbor Maintenance Upgrade to 2020-12-R

From DDCIDeos
Jump to navigationJump to search

Introduction

For development of OpenArbor, developers need an Eclipse environment that contains all the third-party plugins, as well as the preferences and launch configurations to build and launch the OA plugins properly. To that end, we've come up with a "DevKit". Once created, it can be given to an OA developer. To make a new DevKit, start here: Make the DevKit

For the deployment of OpenArbor to be included in a DDS, we use the third-party tool "maven" to build the 32bit and 64bit Eclipse RCPs (branded with OpenArbor) and the OA plugins. The workspace/Makefile handles this. To prepare the build resources required for the deployment of OA, see the information here: Building OA for Customer Delivery

Make the DevKit

Downloading Required Products

Download the new version of Eclipse and all the new products/plugins to put together a development environment that will allow for a successful build of the OpenArbor plugins. For OpenArbor development, the following products/plugins are required:

  1. Eclipse
  2. Java JDK and JRE
  3. SWTBot
  4. CDT && Eclipse TM Project
  5. Eclipse E4
  6. Apache Commons Net
  7. Subclipse
  8. Maven


At the time of the writing of this wiki page, we are migrating from Eclipse 2019-12-R to Eclipse 2020-12-R DDCI_PCR:4126. All of the information recorded here is from that work. But, it should provide good information for future migrations to later versions of Eclipse when they are available. The downloaded items listed below are stored here: \\nx3000\openarbor\Downloads\Eclipse\2020-12-R

Important Note
Eclipse 2020-12-R ships with a new plugin for XML called Wild Web Developer. (https://projects.eclipse.org/proposals/eclipse-wild-web-developer) In our RCP, we use the Eclipse Web Tools Platform for our XML support, and these two do not work together. (https://github.com/eclipse/wildwebdeveloper/issues/557). So, to solve this problem we've removed the new Wild Web Developer plugin from our RCP, and will continue to use the Web Tools platform. To remove it, the plugin 'org.eclipse.wildwebdeveloper.xml_0.10.0.202011132012.jar' is removed from the installed Eclipse plugin directory prior to making the Dev Kit, and removed from the maven repo.


Product Download Info
Product Product Website Eclipse Update Site Product Version Downloaded Filename Comments
Eclipse for RCP and RAP Developers www.eclipse.org https://download.eclipse.org/eclipse/updates/4.18/ 2019-R-12 eclipse-rcp-2020-12-R-win32-x86_64.zip
eclipse-rcp-2020-12-R-linux-gtk-x86_64.tar.gz
eclipse-rcp-2020-12-R-macosx-cocoa-x86_64.dmg		 Windows,Linux and Cocoa versions are stored at \\nx3000\openarbor\Downloads\Eclipse\2020-12-R\Eclipse for RCP and RAP Developers
Java 11 JDK https://www.oracle.com/java/technologies/javase-jdk11-downloads.html n/a 11 jdk-11.0.9_windows-x64_bin.zip
jdk-11.0.9_linux-x64_bin.tar.gz		 The OA Makefile requires these to be in a zip file. Convert to zip
The files are store here: \\nx3000\openarbor\Downloads\Eclipse\2019-12-R\Java\JDK
Java 11 JRE https://www.oracle.com/java/technologies/javase/jdk-11-relnote.html n/a
Maven http://maven.apache.org/ n/a 3.6.3 apache-maven-3.6.3-bin.zip
apache-maven-3.6.3-bin.tar.gz		 Copy this file to the BuildResources directory. It is the maven tool installation (mvn) used by our Makefile to build the RCPs and plugins.
The files are store here: \\nx3000\openarbor\Downloads\Eclipse\2019-12-R\Maven
CDT 10.1 for Eclipse 2020-R-12 http://www.eclipse.org/cdt/ http://download.eclipse.org/tools/cdt/releases/10.1 9.10.0 eclipse-cpp-2020-12-R-win32-x86_64.zip
eclipse-cpp-2020-12-R-linux-gtk-x86_64.tar.gz
eclipse-cpp-2020-12-R-macosx-cocoa-x86_64.dmg		 The files are store here: \\nx3000\openarbor\Downloads\Eclipse\2020-12-R\CDT
SWTBot http://eclipse.org/swtbot/ https://download.eclipse.org/technology/swtbot/releases/3.0.0/
https://download.eclipse.org/technology/swtbot/releases/latest/		 3.0.0 repository.zip I downloaded the zip, but used the update site to install
Apache Commons Net http://commons.apache.org/proper/commons-net/ http://commons.apache.org/proper/commons-net/download_net.cgi 3.6 commons-net-3.6-bin.zip Copy "commons-net-3.6.jar" and "commons-net-3.6-sources.jar" from the zip file to the Eclipse 2019-R-12 plugin dir
Subclipse http://marketplace.eclipse.org/content/subclipse Subclipse Latest 4.3.x Release - https://dl.bintray.com/subclipse/releases/subclipse/4.3.x/ 4.2 This site has drag/drop button onto the workspace. We do not deliver this to customers. Only used by us for CM
E4 https://www.vogella.com/tutorials/EclipseRCP/article.html https://download.eclipse.org/releases/2020-12/
tycho https://projects.eclipse.org/projects/technology.tycho 1.3.0 Used to update the top-level pom.xml file, and build-utils/generate_build_numbers.py

Installation Choices

CDT Installation Choices

SWTBot Installation Choices

Subclipse Installation Choices

E4 Installation Choices

Creating Java JDK and JRE Zip/Tar Files

With the changes implemented for DDCI_PCR:3525, the dev kit is based on 64bit Eclipse, and the 64bit java compiler is used to build the plugins. Eclipse 2019-R-12+ no longer supports 32bit.

2020-12-R requires Java 11+ which no longer provides a JRE.

  1. JDK = Installed in C:\Eclipse\2020-12-R\windows\eclipse\jre (confusing, I know but the jdk is installed here for plugin development) Also used by mvn when building OpenArbor from the Makefile.

The OpenArbor Makefile requires that the JDK be in a zip file format. To convert what is downloaded from Oracle to the required zip (or tar) file for OpenArbor's Makefile, do the following:

Windows

Java JDK

64bit Java JDK:

  1. Run the Java JDK installer executable that was downloaded (jdk-11.0.9-windows-x64_bin.zip)
  2. Using 7zip, zip up the contents of the resulting installation at : C:\Program Files\Java\jdk11.0.9
  3. Name the resulting zip file: jdk-11.0.9-windows-x64_bin.zip

Clean up any temporary files/folders. It is not required that the Java JDK be installed on your system.

Linux

Java JDK

  1. https://www.geeksforgeeks.org/tar-command-linux-examples/

64bit Java JDK:

  1. Copy the Java JDK tar file that was downloaded (jdk-11.0.9_linux-x64_bin.tar.gz) to a location on the ubuntu vm (/home/lisa/JavaJDK)
  2. Using tar, extract the contents to /home/lisa/JavaJDK
  3. tar xvfz jdk-11.0.9_linux-x64_bin.tar.gz
  4. Using tar, compress the contents of the resulting installation at : /home/lisa/JavaJDK/jdk11.0.9
  5. Name the resulting zip file: jdk-11.0.9_linux-x64_bin.tar.gz
  6. cd /home/lisa/Java/jdk11.0.9
  7. tar cvzf jdk-11.0.9_linux-x64_bin.tar.gz *


Clean up any temporary files/folders. It is not required that the Java JDK be installed on your system.

Release Java for Distribution

With the changes implemented for DDCI_PCR:4107, the OpenArbor distribution is not longer providing the Java JDK or Flexnet files. The JDKs for release to customers is done by including them in the openarbor-product/jre package on our ftp server.

In deosftp:pub/openarbor-products/jre, create a versioned directory for the jdks (e.g. 11.0.9)

  1. ssh -l deosftp deos.ddci.com -p 47734
  2. cd /ftp/pub/openarbor-products/jre
  3. mkdir 11.0.9
  4. rm stable
  5. ln -s 11.0.9 stable
  6. exit

Copy the newly created jre zip/tar files to the jre package:

  1. rsync jdk-11.0.9_linux-x64.tar.gz deosftp:pub/openarbor-products/jre/11.0.9/
  2. rsync jdk-11.0.9-windows-x64_bin.zip deosftp:pub/openarbor-products/jre/11.0.9/

Flexnet Supporting Executables

Windows

See this wikiFlexnet_64_Bit_License_Vendor_Daemon_Development to build FLEXnet items for a DDS release.
Zip up the following files to flexnet-windows-<n>.0.zip:

  1. checkout_10_1_3_Feature.exe
  2. checkout_10_8_Feature.exe
  3. checkout_11_15_1_Feature.exe
  4. lmborrow.exe

Linux

See this wikiFlexnet_64_Bit_License_Vendor_Daemon_Development_(Ubuntu) to build FLEXnet items for a DDS release.
Tar up the following files to flexnet-linux-<n>.0.zip:

  1. checkout_11_15_1_Feature
  2. lmborrow (symbolic link to lmutil)
  3. lmutil

Release new Flexnet Supporting Executables for Distribution

With the changes implemented for DDCI_PCR:4107, the OpenArbor distribution is not longer providing the Java JRE or Flexnet files. The Flexnet content for release to customers is done by including them in the openarbor-product/flexnet package on our ftp server.

  1. Open a terminal and do the following
  2. ssh -l deosftp deos.ddci.com -p 47734
  3. ./disableBuild.sh lcj
  4. cd pub/openarbor-products/flexnet

In deosftp:pub/openarbor-products/flexnet, create a versioned directory for the flexnet zip files (e.g. 1.0)

  1. mkdir 1.0
  2. rm stable
  3. ln -s 1.0 stable
  1. Open a second terminal and to the following:

Copy the newly created flexnet zip files to the flexnet package:

  1. cd to the location of the zip file to be uploaded to the server
  2. rsync flexnet-windows-1.0.zip deosftp:pub/openarbor-products/flexnet/1.0/
  3. rsync flexnet-linux-1.0.zip deosftp:pub/openarbor-products/flexnet/1.0/
  4. ftp password is here: https://deos.ddci.com/scm/Deos/maintainer-tools/admin/passwords
  1. cd /ftp
  2. cd deos2cygwin
  3. ./deos2cygwin.py
  4. cd ..
  5. rm ~/deos2cygwin_build_failed

Install Eclipse and Add 3rd Party Plugins

To build the OpenArbor plugins, the Eclipse development environment must have all the required products/plugins it uses. The Eclipse for RCP and RAP Developers comes with most needed plugins, but not all.

  1. Create a directory for the new Eclipse
    1. Windows: C:\Eclipse\2019-R-12\
    2. Linux:Using mkdir (from an ubuntu vm terminal) sudo mkdir /Eclipse/2019-R-12
  2. Extract the files from the Eclipse RCP zip/tar
    1. Windows:Using 7zip, extract the files from the eclipse-rcp-2019-12-R-win32-x86_64.zip file to the C:\Eclipse\2019-R-12\ directory.
    2. Linux:Using tar (from an ubuntu vm terminal), extract the files from the eclipse-rcp-2019-12-R-linux-gtk-x86_64.tar.gz file to the /Eclipse/2019-R-12 directory.
      1. cd /Eclipse/2019-R-12
      2. tar xvfz eclipse-rcp-2019-12-R-linux-gtk-x86_64.tar.gz
  3. Create a desktop shortcut, called "OA Dev" to
    1. Windows: C:\Eclipse\2019-R-12\eclipse\eclipse.exe
      1. Target: C:\cygwin64\bin\run.exe /bin/python /desk/desk-environment.py C:\Eclipse\2019-R-12\windows\eclipse\eclipse.exe
      2. Start in: C:\Eclipse\2019-R-12\windows\eclipse
    2. Linux:/Eclipse/2019-R-12/eclipse
      1. TBD
  4. Create a JRE folder in 2019-R-12
    1. cd 2019-R12
    2. mkdir jre
  5. Extract the contents of JDK tar/zip to JRE dir
    1. Windows: Using 7zip extract the contents of jdk-1.8.0.241-win32.win32.x86_64.zip to the jre directory created above
    2. Linux: Using tar (from and ubuntu vm) extract the contents of jdk-1.8.0.241-linux.gtk.x86.tar.gz to the jre directory created above
      1. tar xvfz jdk-1.8.0.241-linux.gtk.x86.tar.gz
  6. Create a new milestone (i.e. 9.0.0) in the Bugzilla database. When upgrading eclipse, the major version for OA is increased. Use this milestone when creating the PCR for the feature branch in the next step.
  7. Create a feature branch of the OpenArbor workspace (ie. eclipse_r12)
  8. Open Eclipse 2020-12-R on C:\ddci_eclipse\workspace-windows-eclipse_r12 (or from ubuntu: /home/lisa/ddci_eclipse/workspace-linux-eclipse_r12)
  9. Check the Window | Preferences | Java | Installed JREs correctly points to the Eclipse jre directory created above.
  10. Use the "Help | Install New Software" Install dialog to install CDT, SWTBot, Subclipse and the Eclipse TM plugins. Use the Table to cut/paste update sites to the dialog for each product. Use the installation choices to properly install the third-party plugins.
  11. Restart Eclipse as required.
    1. Linux: When installing subclipse on Linux dev env, I ran into the problem "Failed to load JavaHL Library" documented here: https://myotragusbalearicus.wordpress.com/2011/11/25/subclipsesubversion-error-on-ubuntu-failed-to-load-javahl-library/
      1. To resolve the issue, I did the following:
      2. sudo apt-get install libsvn-java
      3. added to eclipse.in: -Djava.library.path=/usr/lib/x86_64-linux-gnu/jni (just after -vmargs)
      4. added to DDS Dev Launch Configuration | Arguments | vmargs -Djava.library.path=/usr/lib/x86_64-linux-gnu/jni
  12. Import the existing OpenArbor projects into the workspace
  13. Edit the .classpath file for the com.ddci.openarbor.application project to point to the new e4.ui.workbench jar provided by eclipse. Open the Plug-Registry view and find the org.eclipse.e4.ui.workbench, expand it to get the Location. In the com.ddci.openarbor.application project, right click on JRE System Library | Build Path | Configure Build Path to update the location.
  14. Open the Plug-ins view, select All, right-click "Add to Java Workspace Scope"

Development Environment Setup

  1. Linux only: create /home/<username>/oaTestHarness/workspace dir
    1. cd home
    2. mkdir oaTestHarness
    3. cd oaTestHarness
    4. mkdir workspace
  2. Define workpace preferences:
    1. Set Plugin Development -> API Baselines -> Missing API Baseline to Warning
    2. Java->Compiler->Errors/Warnings
      1. Potential Programming Problems->Serializable class without serialVersionUID: Ignore
      2. Unnecessary Code
        1. Value of parameter is not used: Warning
      3. Null analysis
        1. Redundant null check: Warning
      4. Annotations->Missing '@Override' annotation: Warning
    3. Java->Code Style->Formatter->Import...
      1. Use this file: https://deos.ddci.com/svn/DDCI/products/openarbor/OpenArbor-formatting.xml
    4. Check out (Preferences|Java|Editor|Save Actions) and enable it.
  3. Set the workspace to refresh automatically, and configure format source/organize imports to run on save
    1. Settings > General > Workspace > Refresh On Access (aka Lightweight Refresh).
  4. Check out Preferences|Java|Editor|Save Actions and enable it.
  5. Fix auto-props for both environments.
    1. In your desk maintainer environment, ./etc/subversion/, edit the config file and change the line that says enable-auto-props = no to enable-auto-props = yes.
    2. In Eclipse, go to Preferences|Team|SVN and change the configuration location at the bottom to point to the ./etc/subversion/ location of your maintainer environment.
  6. If Eclipse repeatedly asks for your password, and won't save it, try changing the SVN Interface: to SVNKit
    1. Windows | Preferences | Version Control (Team) | SVN
  7. Maven->Errors/Warnings
    1. Set "Plugin execution not covered by lifecycle configuration" to Warning (or Ignore)
  8. Configure any other preferences you want, then export them (see #Making preferences apply to all workspaces below).
  9. You might want to add -clean to eclipse.ini as well, since Eclipse tends to corrupt itself.
  10. Add a JDK. It goes in the jre folder in the eclipse directory. This improves portability. Unzip the JDK zip file into the JRE folder.
  11. If you're making this for everyone:
    1. Delete the workspace history. This is in two places.
      1. In configuration/config.ini, delete the line for osgi.instance.area.default. This is the last used workspace that Eclipse suggests when it prompts for a workspace.
      2. In configuration/.settings/org.eclipse.ui.ide.prefs, delete the line for RECENT_WORKSPACES. This is the full workspace history.

Create Launch Configurations

Windows

  1. Create seven variables
    1. Window | Preferences | Run/Debug | String Substitution
    2. Add "ddsName", the name of the dds you are using
    3. Add "oaTestHarnessWorkspace", the location of all test harness data, e.g. "C:\oaTestHarness\workspace"
    4. Add "ddsBranchName", the name of the svn branch being tested
    5. Add "ddsName", the name of the dds you are using
    6. Add "ddsConfigName", the name of the dds configuration you are using
    7. Add "deosInstallDir", e.g. "${oaTestHarnessWorkspace}\DDS-list\${ddsName}"
    8. Add "testSystemInvocation", the arguments the test system needs to run, e.g. "--installationRoot ${deosInstallDir} --branchRoot ${oaTestHarnessWorkspace}/branches/${ddsBranchName} --enableDebugLog --buildLog C:\TEMP\BuildLog.txt --mldCommandQueueLogger C:\TEMP\MldCommandQueueLog.txt"
      1. You may want to change the branchRoot, for example when you are working on a release branch, or to use your development checkout instead
    9. Add "testWorkspacePrefix", where the workspaces will be located, e.g. "${oaTestHarnessWorkspace}\ddses\${ddsName}"
    10. Add "deskRootLocation", the location of the desk maintainer env, e.g. "C:\cygwin64" (used by test harness dev launch)
    11. In Windows, you should have a global environment variable pointing to your all products license file, named "DDCIFLEX_LICENSE_FILE", e.g. "C:\oaTestHarness\workspace\ddses\<ddsName>\License.lic"


  1. Run->Debug Configurations...->Eclipse Application
    1. Name it DDS <product> Dev Launch
    2. Main Tab
      1. Workspace Data: Location
        1. Use variables defined above to define workspace location - ${testWorkspacePrefix}\${ddsConfigName}\workspace
      2. Program to Run->Run a product: com.ddci.openarbor.application.product
    3. Plugins Tab
      1. Select the appropriate plugins for the product being tested!
      2. Make sure that the activated plugins match the DDC-I features you have installed
      3. Don't forget that the CDT plugins need to be activated as well
    4. Environment Tab
      1. Create two environment variables
        1. Name: DDCIINSTALLLOC
        2. Value: ${deosInstallDir}
        3. Name: DDCIFLEX_LICENSE_FILE
        4. Value: ${testWorkspacePrefix}\license.lic
  1. Run->Debug Configurations...->Eclipse Application
    1. Name it DDS <product> Launch Test Harness
    2. Main Tab
      1. Workspace Data: Location
        1. Use variables defined above to define workspace location - ${workspace_loc}/../runtime-New_configuration
      2. Program to Run->Run a product: com.ddci.dds.manager.product
    3. Arguments Tab
      1. At the end of the arguments, add --deskRoot ${deskRootLocation} -clearPersistedState
  1. Run->Debug Configurations...->SWTBot Launch
    1. Name it DDS <product> Test Launch
    2. Test Tab
      1. Change Test Runner: to JUnit4 <-- Important to do this first!
      2. Run a Single Test
      3. Project: com.ddci.openarbortests
      4. Test Class: com.ddci.openarbortests.Launcher
    3. Main Tab
      1. Workspace Data: Location
        1. Use variables defined above to define workspace location - ${testWorkspacePrefix}\${ddsConfigName}\workspace
      2. Uncheck the "Clear" button!
      3. Program to Run->Run a product: com.ddci.openarbor.application.product
    4. Arguments Tab
      1. Add ${testSystemInvocation} at the end of the arguments
    5. Plugins Tab
      1. Select the appropriate plugins for the product being tested!
      2. Make sure that the activated plugins match the DDC-I features you have installed
      3. Don't forget that the CDT plugins need to be activated as well
      4. There is an additional gotcha here involving the run/debug context menu. If you get "Failed to find menuitem &1 Debug Deos Executable in path &Debug As->&1 Debug Deos Executable" while testing you can solve it by: (1) enable all the plugins, then (2) deselect all the jpt, jst, and wst plugins, then (3) click add required.
    6. Environment Tab
      1. Create two environment variables
        1. Name: DDCIINSTALLLOC
        2. Value: ${deosInstallDir}
        3. Name: DDCIFLEX_LICENSE_FILE
        4. Value: ${testWorkspacePrefix}\license.lic
  2. Export these launch configurations via File->Export... and put them in eclipse/launches if you are making a devkit.
  3. Remove org.eclipse.pde.core/workspace_target_handle=local\:1581019407152.target This causes the Target Platform to "disappear"
  4. C:\Eclipse\2019-R-12\eclipse\configuration\.settings\org.eclipse.ui.ide.prefs (has list of recent workspaces)
  5. replace prefs.ini from previous dev kit
  6. To make the devkit, close Eclipse and zip up Eclipse installation.
  7. Put new devkit here: \\nx3000\openarbor\downloads\oadevkit_windows_2020-12-R.zip

Linux

  1. Create seven variables
    1. Window | Preferences | Run/Debug | String Substitution
    2. Add "username", the name of the user defined in the linux vm.
    3. Add "ddsName", the name of the dds you are using
    4. Add "oaTestHarnessWorkspace", the location of all test harness data, e.g. "/home/${username}/oaTestHarness/workspace"
    5. Add "ddsBranchName", the name of the svn branch being tested
    6. Add "ddsName", the name of the dds you are using
    7. Add "ddsConfigName", the name of the dds configuration you are using
    8. Add "deosInstallDir", e.g. "/"
    9. Add "testSystemInvocation", the arguments the test system needs to run, e.g. "--installationRoot ${deosInstallDir} --branchRoot ${oaTestHarnessWorkspace}/branches/${ddsBranchName}"
      1. You may want to change the branchRoot, for example when you are working on a release branch, or to use your development checkout instead
    10. Add "testWorkspacePrefix", where the workspaces will be located, e.g. "${oaTestHarnessWorkspace}/ddses/${ddsName}"
    11. Add "deskRootLocation", the location of the desk maintainer env, e.g. "C:\cygwin64" (used by test harness dev launch)
    12. [TBD] Will linux users have a global environment variable pointing to your all products license file, named "DDCIFLEX_LICENSE_FILE", e.g. "/home/lisa/oaTestHarness/workspace/ddses/<ddsName>/License.lic"???


  1. Run->Debug Configurations...->Eclipse Application
    1. Name it DDS <product> Dev Launch
    2. Main Tab
      1. Workspace Data: Location
        1. Use variables defined above to define workspace location - ${testWorkspacePrefix}/${ddsConfigName}/workspace
      2. Program to Run->Run a product: com.ddci.openarbor.application.product
    3. Plugins Tab
      1. Select the appropriate plugins for the product being tested!
      2. Make sure that the activated plugins match the DDC-I features you have installed
      3. Don't forget that the CDT plugins need to be activated as well
    4. Environment Tab
      1. Create two environment variables
        1. Name: DDCIINSTALLLOC
        2. Value: ${deosInstallDir}
        3. Name: DDCIFLEX_LICENSE_FILE
        4. Value: ${testWorkspacePrefix}/license.lic
  1. Run->Debug Configurations...->Eclipse Application
    1. Name it DDS <product> Launch Test Harness
    2. Main Tab
      1. Workspace Data: Location
        1. Use variables defined above to define workspace location - ${workspace_loc}/../runtime-New_configuration
      2. Program to Run->Run a product: com.ddci.dds.manager.product
    3. Arguments Tab
      1. At the end of the arguments, add --deskRoot ${deskRootLocation} -clearPersistedState
  1. Run->Debug Configurations...->SWTBot Launch
    1. Name it DDS <product> Test Launch
    2. Test Tab
      1. Change Test Runner: to JUnit4 <-- Important to do this first!
      2. Run a Single Test
      3. Project: com.ddci.openarbortests
      4. Test Class: com.ddci.openarbortests.Launcher
    3. Main Tab
      1. Workspace Data: Location
        1. Use variables defined above to define workspace location - ${testWorkspacePrefix}/${ddsConfigName}/workspace
      2. Uncheck the "Clear" button!
      3. Program to Run->Run a product: com.ddci.openarbor.application.product
    4. Arguments Tab
      1. Add ${testSystemInvocation} at the end of the arguments
    5. Plugins Tab
      1. Select the appropriate plugins for the product being tested!
      2. Make sure that the activated plugins match the DDC-I features you have installed
      3. Don't forget that the CDT plugins need to be activated as well
      4. There is an additional gotcha here involving the run/debug context menu. If you get "Failed to find menuitem &1 Debug Deos Executable in path &Debug As->&1 Debug Deos Executable" while testing you can solve it by: (1) enable all the plugins, then (2) deselect all the jpt, jst, and wst plugins, then (3) click add required.
    6. Environment Tab
      1. Create two environment variables
        1. Name: DDCIINSTALLLOC
        2. Value: ${deosInstallDir}
        3. Name: DDCIFLEX_LICENSE_FILE
        4. Value: ${testWorkspacePrefix}/license.lic
  2. Export these launch configurations via File->Export... and put them in eclipse/launches if you are making a devkit.
  3. Remove org.eclipse.pde.core/workspace_target_handle=local\:1581019407152.target This causes the Target Platform to "disappear"
  4. /Eclipse/2020-12-R/eclipse/configuration/.settings/org.eclipse.ui.ide.prefs (has list of recent workspaces)
  5. replace prefs.ini from previous dev kit
  6. To make the devkit, close Eclipse and tar up Eclipse installation.
    1. cd /Eclipse
    2. sudo tar cvzf oadevkit_linux_2020-12_R.tar.gz 2020-12-R/
  7. Put new devkit here: \\nx3000\openarbor\downloads\oadevkit_linux_2020-12_R.tar.gz
    1. copy the dev kit to the shared drive: (vm -> laptop)
    2. sudo cp oadevkit_linux_2020-12_R.tar.gz /media/sf_C_DRIVE

Making preferences apply to all workspaces

  1. Configure all your preferences the way you want them.
  2. Export all preferences to an epf file.
  3. Hack the resulting epf to remove the /instance/ prefix from all the property names.
  4. Remove org.eclipse.pde.core/workspace_target_handle=local\:1581019407152.target <- This causes the default Target Platform to disappear.
  5. But wait, Eclipse won't export everything. You may have to go digging in $workspace/.metadata/.plugins/org.eclipse.core.runtime/.settings/ <filename>.prefs for the bits in the .prefs files that you need. It's the same syntax, so just bodge them into export from above.
  6. Rename the epf to oaDevPreferences.epf and put it into your eclipse directory.
  7. Edit your eclipse.ini so that the -pluginCustomization parameter points to your new .epf file.

At this point there will likely be build errors that you will need to figure out how to resolve. Once all the build errors are resolved and you can successfully launch a new OpenArbor from a self-hosted new Eclipse, you are ready to move on to build the plugins "headless"ly using the Makefile to produce a release.

Deploying the DevKit

  1. Unzip the devkit file
    1. 64bit Windows: oadevkit_windows_2020-12-R.zip into C:\Eclipse
    2. 64bit Linux: oadevkit_linux_2020-12_R.tar.gz into /Eclipse
      1. or use the linux installer: apt-get install openarbormaintainertools
  2. Import the launch configurations
  3. Import the OA plugin workspace
  4. On Windows, create a new desktop shortcut for OADev
  5. On Windows, update the desktop shortcut, to setup env for gdb. Shortcut tab | Target: C:\cygwin64\bin\run.exe /bin/python /desk/desk-environment.py C:\Eclipse\2020-12-R\eclipse\eclipse.exe
  6. On Linux, open a terminal
    1. sudo bash -c "echo '$USER ALL = (ALL) NOPASSWD: ALL' >> /etc/sudoers" (allow the OA make install commands to update /OpenArbor/plugins or features dir without asking for a linux password
    2. cd /Eclipse/2020-12-R/eclipse
    3. /bin/python /desk/desk-environment.py ./eclipse
    4. sudo apt-get install rename maven xsltproc docbook-xsl xdotool subversion libsvn-java

Building OA for Customer Delivery

The workspace/Makefile has targets for building and deploying OA. For details about the available build commands, look here: OpenArbor_Build
The tycho/maven build uses the information in the workspace/com/ddci.openarbor.product/com.ddci.openarbor.product.product file and the pom.xml file
there to determine what Eclipse plugins to include in the RCPs.

The workspace/build directory contains the resulting deployable OA. The downloads directory contains what is copied from BuildResources and then maven is installed.

We use tycho (which uses maven) to build the OpenArbor branded Eclipse RCPs (32bit and 64bit), and the OpenArbor plugins.

Make Command Description
make clean Removes the workspace/build directory.
make kindaclean Leaves the workspace/build/downloads directory, but removes everything else from workspace/build
make MAVEN_OFFLINE="" When the pom file(s) are updated to point to a new update site, running make with maven in online mode (MAVEN_OFFLINE="") will cause any new third-party plugins to be downloaded from the third-party tool's update site and be placed in the maven-repo/p2/osgi/bundle dir.
make mavenresolve This will instruct maven to resolve the dependencies of any plugins in the product.
  1. Make a new BuildResources directory in the branch: New Build Resources Directory
  2. update the Makefile, pom.xml, and generate_build_numbers.py, about.properties (see DDCI_PCR:3430 for details about changes needed)
  3. make mavenresolve
  4. make MAVEN_OFFLINE=""

This will force the download of components (see note below):

Note: You will likely need to execute the Makefile using the -MAVEN_OFFLINE="" at least once to force the download of any new plugins etc. By default, the Makefile is set to only download from the local maven repository in the BuildResources directory.

Tycho documentation:
https://eclipse.org/tycho
http://www.vogella.com/tutorials/EclipseTycho/article.html

Eclipse Update sites:
https://wiki.eclipse.org/Eclipse_Project_Update_Sites

Build Resources

To successfully build OpenArbor, the following files must exist in the https://deos.ddci.com/svn/DDCI/products/openarbor/BuildResources/<Eclipse Name (i.e. Eclipse_2019_12R)>. directory used by the Makefile. A brief description of each file is in the table below, and more details about these files follow later in this document.

Filename Description
apache-maven-n.n.n-bin.zip Maven is the eclipse build mechanism
jdk-11.0.9_windows-x64_bin.zip
jdk-11.0.9_linux-x64.tar.gz		 Java zip files, used for compiling plugins and the JDKs are shipped with the RCPs
maven_tmp.zip
maven-repo-swtbot3.0.0.zip		 Maven repository (a.k.a. maven repo)

The BuildResources directory has a lot more file in it than what is described above you say? You are right. All of the "other" files are remnants that are required by previous versions of OpenArbor. So, they are left here for good reason. If we ever need to go back to build a previous version of OpenArbor, all the required build resources files are here waiting.

New Build Resources Directory

  1. svn co https://deos.ddci.com/svn/DDCI/products/openarbor/BuildResources/
  2. mkdir Eclipse_2020_12_R
  3. put files listed in the above table into the directory
  4. svn add Eclipse_2020_12_R(and it's contents)
  5. check in the new directory using the upgrade PCR

Deploy New Build Resources Directory

Once the new BuildResources directory is ready for daily use for OA builds, update the BuildResources "externals" directory to point to the new BuildResources directory for the new Eclipse version.

  1. cd to https://deos.ddci.com/svn/DDCI/products/openarbor/openarbor/branches/mainline/
  2. to see the existing externals definition: svn propget svn:externals BuildResources
  3. create t.t file containing: /svn/DDCI/products/openarbor/BuildResources/Eclipse_2020_12_R@head Eclipse_2020_12_R
  4. svn propset --file=t.t svn:externals BuildResources/
  5. svn up
  6. commit changes to propset using upgrade PCR

Note: If it's required to do OA builds against more than one Eclipse version, you can have a reference to more than one BuildResources directory by just specifying one per line
create t.t file containing:
/svn/DDCI/products/openarbor/BuildResources/Eclipse_2019_12R@head Eclipse_2019_12R
/svn/DDCI/products/openarbor/BuildResources/Eclipse_2020_12_R@head Eclipse_2020_12_R

Notes

Updating ALL the pom.xml files (and other files) for both the oaplugins and oatestharness should be done BEFORE making the maven-repo and maven tmp zip files.
Viewing the product file in an Eclipse development environment may display "errors" for the architecture specific files. DO NOT delete these files, they are needed for building the architecture specific RCP.

Building OA for Linux

From the ubuntu vm:

  1. make unreleased

This will copy the Linux RCP package to host laptop /home/lisa/cdrive/ddci_eclipse/linux_built_RCP. Running make unreleased on windows will package both the linux and windows RCP up to the ftp server. This is a work-around for the installer's requirement that both linux and window's RCP's be in the openarborEclipse_64 package.

Using Linux VM

This section is just some notes I've kept doing various things on a vm.

Running a docker image

  1. ./run-docker -it --tty --rm dds-docker-celestial-deos-jupiter-20210809

Installing on Ubuntu Virtual Machine (vm)

Run a postinstall script

  1. sudo /etc/postinstall/openarbor-install-plugins.sh

Run a preremove script

  1. sudo /etc/preremove/openarbor-uninstall-plugins.sh

Setup for licensing

  1. edit /home/lisa/.bashrc to add the following line
  2. DDCIFLEX_LICENSE_FILE=/home/lisa/all_prods.lic; export DDCIFLEX_LICENSE_FILE

Launch OpenArbor

  1. open a new terminal
  2. /desk/desk-environment.py bash -i
  3. /bin/python /desk/desk-environment.py /OpenArbor/OpenArbor

To list all packages:

  1. dpkg-query -l

To list a specific package:

  1. dpkg-query -l <package name>
  2. apt-cache search rtems
  3. apt search rtems


To install OA on the vm:

  1. sudo apt-get install openarboreclipse-64
  2. sudo apt-get install openarborcommon

To force OA to reinstall on the vm:

  1. sudo apt-get install --reinstall openarboreclipse-64
  2. sudo apt-get install --reinstall openarborcommon

Build Test Harness

Go to the test harness development location

  1. make directory C:\ddci_eclipse_test_harness_dev
  2. cd to the above directory and use svn to checkout a fresh copy of: https://deos.ddci.com/svn/DDCI/products/openarbor/utils/dds-manager/dds-manager-e4/
    1. svn co --username=<username> --password=<password> --no-auth-cache https://deos.ddci.com/svn/DDCI/products/openarbor/utils/dds-manager/dds-manager-e4/ dds-manager

Update the svn externals directory.

  1. The dds-manager directory has an svn:external property set. To see the existing externals definition: svn propget svn:externals dds-manager-e4
    1. create t.t file containing:/svn/DDCI/products/openarbor/BuildResources/Eclipse_2019_12R@head BuildResources/Eclipse_2019_12R
    2. svn propset --file=t.t svn:externals dds-manager-e4/
    3. cd dds-manager-e4
    4. svn up
    5. commit changes to propset using upgrade PCR

Update the test harness workspace files

  1. open the dds-manager-e4 directory as the "workspace"
  2. import existing projects into workspace (com.ddci.dds.manager is a project)
  3. import launch configurations from the C:\Eclipse\2020-12-R\launches dir
  4. review/fix any build errors and/or warnings.
  5. update BOTH pom.xml files for new tycho version, if applicable
  6. update AboutHandler.java to indicate the new Eclipse version
  7. edit the .product file (Add Required Plug-ins, Remove invalid ones)
  8. Update the Makefile to reference new BuildResources\Eclipse_12_R dir, new apache-maven zip, maven-repo, etc
  9. commit changes using upgrade PCR
  10. make MAVEN_OFFLINE=""
  11. ./oatestharness
Retrieved from "https://ddci.zapto.org/ddciWiki/index.php?title=OpenArbor_Maintenance_Upgrade_to_2020-12-R&oldid=49622"