Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: for the plan.

Jump to: navigation, search

OSEE/OTE/Users Guide/Getting Started


The OSEE Test Environment (OTE) provides a framework for the testing of complex software systems. The test environment manages models, messages, remote communication, and logging.

Environments provide the core configuration of the tests, there is generally a 1 to 1 mapping between environments and labs. Generally, tests are written which set input and check output against the unit under test. These tests are sent to the Test Environment which then will coordinate with the unit under test to run the submitted test, or set the requested input.

These outputs can be imported into the OSEE Disposition tool for multi-run disposition of the test failures. And the OSEE Continuous Integration tool can accept changes, launch builds, run test scripts and report to common location for analysis.

The OSEE Coverage tool can take instrumented test output and determine Level A, B and C coverage throughout multiple runs.


  • OS: OTE can run anywhere Java can run but for this excercise we will focus on Windows
  • RAM: recommend at least 8 GB of RAM
  • HDD: At least 4 gigs of free disk space
  • Java: JDK for java version 11 or newer.

Steps to running the OTE Simple Automated Test

Clone org.eclipse.ote

  1. Create a folder for containing your Git repository/ies.
  2. Navigate to Gerrit link here:,general
  3. Use one of the clone commands to clone the OTE source repository.
  4. Once cloned, navigate into that repository folder on your machine and checkout the branch feature/Java11

Install OTE Client and Server

Unzip each zip into unique destination folders.

Set up the client

The OTE client is where you will connect to the OTE server, develop and run the automated tests, as well as develop OTE itself.

  1. Launch the OTE client by running ote.exe from the folder that the client was unzipped.
  2. When asked, select a workspace to contain the automated tests. The default workspace is fine.
    1. OteWorkspaceSelection.png
  3. In the new workspace that comes up, ensure you are in the OSEE Test Perspective:
    1. In the upper right of the workspace, click on the "Open Perspective" button and select "OSEE Test"
    2. PerspectiveSelection.png

Import the Simple Automated Tests:

  1. From the top menu select File->import...
  2. Select General->"Existing Projects into Workspace"
  3. Hit the Browse button and find the root folder where you cloned org.eclipse.ote
  4. Once selected, there should be many projects automatically selected under "Projects"
    1. ImportProjects.png
  5. To run tests, you only need to import a single project from this list so hit the "Deselect all" button.
  6. Scroll through the list put a checkbox on the "org.eclipse.ote.simple.test.script"
  7. Hit the Finish button and wait for the workspace to populate and compile completely

Start the OTE Test Server

The test server is where tests are actually going to be executed and allows for remote testing on machines anywhere in the world. For this excercise you will be launching a test server locally.

  1. Navigate to the directory you unzipped the ote server
  2. Execute the runWinSimpleServer.bat
  3. A new console will launch and start printing out log information. When ready to connect you will see something like the following:
  4. OteServerConsole.png
  5. The SERVER CONNECTION URI is key. Highlight and copy the text "tcp://"

Connect to the test server

The Test Manager is where you will be managing which server you connect to as well as which tests to run. There are also some controls for HOW a script batch is to be run such as result file location, logging level, etc.

  1. Back in the client, open the OTE Navigator:
    1. If you are in the OSEE Test perspective as set up above, this should appear in the left side of the workspce next to the Package Explorer
    2. If you do not see the navigator, select the magnifying glass in the upper right corner and search for "OTE Navigator"
    1. OteNavigator.png
  2. In the navigator, double-click on the "Open OTE Test Manager" selection
  3. In the dialog, select a previous configuration if it exists or select "Create New configuration file"
  4. In the Test Manager, notice there are some subviews in the lower left of the frame. By default it will launch in the "Hosts" tab.
  5. In the "Hosts" tab you will find a list of available servers that the Client knows about. At the moment it should be empty.
  6. In the host table, right-click somewhere in the table and select
    1. HostRightClick.png
  7. In the dialog, paste the TCP connection string your copied from the OTE test server before.
    1. HostDialog.png
  8. If successful, there should be a connection icon attached to the entry in the Host Table

Run the Simple Test

Now you will use the OTE Test Manager to load and run the Simple Test

  1. In the OTE Test Manager, switch to the "Scripts" tab
  2. Now open the Package Explorer view on the left frame and find the file
    1. You can find it by expanding the org.eclipse.ote.simple.test.script pacakge and searching around or you can do a Java type search with CTRL+SHIFT+T and type in "SimpleTestScript"
    2. Once you find the SimpleTestScript java file, drag that file from the package explorer into the scripts table in the OTE Test Manager
    3. Optionally you can right-click on the file and select OTE->Add to Test Manager
    1. RightClickOte.png
  3. Once added, the test should be automatically selected to run in the Scripts table
  4. To run the selected test, click on the Green play button at the top of the Test Manager
    1. TestManagerPlayButton.png
  5. The Test Manager will show periodic updates of the running test as it goes through its automation
    1. Note that this test will never pass completely as there are intentional failures as well as some test that require setup to pass
    2. There will be some examples of manual prompts as the test runs that you must click through to advance the test

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see:

Refer to the OSEE Team generated information included in the eclipse help subsystem.

White Paper - The Java Language Enviornment

Trail - Learning The Java Language

How to Write Doc Comments

Back to the top