Scout/Concepts/Test

The Scout documentation has been moved to https://eclipsescout.github.io/.

This Page describes the architecture we want to obtain for the Scout Test Infrastructure (Testing support: how to test a scout application, but also unit test for Scout RT and SDK). See Scout Roadmap for more information.

Please do not change the title of the sections

Demo

BSI has a small Demo Application (Client-side only) that displays all the fields. For the moment this application is closed source.

This application is useful to display all possibilities offered by the fields (common configuration for each field). There is no need to have this in the eclipse repository (no need for IP-Clear). Therefor the idea is to refactor the application publish it on github.

Nice to have: For each demonstrated field, we want to have a link to the GitHub java source code page.

Branch organization on GitHub should be the same as in the Eclipse Repository.

Side note
We mention this demo Application on this page, because for the moment it is used to do a manual test of the Scout Runtime. When we have ended the migration, we should mention this application as an example application (like bahbah chat application). All theses demonstration application will be hosted at GitHub. For the moment here: org.eclipse.scout.example

TODO

• Define the project name: org.eclipsescout.demo.widgets. (mzi: As we did register the domain eclipsescout.org, such a pattern allows having other demo applications than just the widgets-demo. We want to have a consistent naming scheme that relates these demo applications to Scout)
• Create the repository in GitHub
• Create a POC
  • one page for one field
  • with link to the source code at Git-Hub
  • built with Maven Tycho
• create the rest of the pages (for the other pages) == migration of the current test application to the new widgets-demo application.
• mention the project in the scout book (mzi: i would like to use the Scout widgets demo in the book as basis for describing all the widgets in chapter 'Form Fields' of part 'The Frontend')
• bug 399601: Remove the scout.example.git repository
• bug 399602: Mark scout.example SVN Repository as read only

RT

The RT Code contains some classes used before JUnit (ITest, AbstractClientTest, AbstractServerTest, ...). This approach should no longer be used.

TODO

• bug 397085: Mark legacy testing support as deprecated

RT.Testing

Theses plugins contains classes for testing support: this is a collection of classes (JUnit test runner, Utility, Abstract Test classes…) that can be used to write JUnit tests for Scout Applications.

Naming convention: please do not name the classes with a Test suffix. Prefer TestingSupport or something like that.

List of plugins:

• org.eclipse.scout.rt.testing.client
• org.eclipse.scout.rt.testing.shared
• org.eclipse.scout.rt.testing.server
• org.eclipse.scout.rt.testing.ui.rap
• org.eclipse.scout.rt.testing.swing
• org.eclipse.scout.rt.testing.swt

This plugins are exposed in a testing feature.

This plugins are also used in the RT.Test fragments (Theses tests are also using JUnit to write tests).

TODO

• bug 376459: Add a testing feature and publish it on the Scout update site

RT.Test

This set of fragments / plugins contains the tests to test the runtime classes:

Naming convention:

• org.eclipse.scout.rt.client
  • => org.eclipse.scout.rt.client.test
• org.eclipse.scout.rt.shared
  • => org.eclipse.scout.rt.shared.test
• org.eclipse.scout.rt.server
  • => org.eclipse.scout.rt.server.test
• ...

The test classes should be in the same package than the class under test:

• tests for org.eclipse.scout.rt.client.ui.basic.table.AbstractTable
  • => are located in org.eclipse.scout.rt.client.ui.basic.table.AbstractTableTest (located in the org.eclipse.scout.rt.client.test fragment).

There should be a mechanism (Annotation, special runner, test suite...) to express the requirements to run the test. Currently, there are 3 different types of JUnit tests known, all of them require a different setup:

• Plain JUnit: These are the classical JUnit tests for methods which do not have to be run within the Scout / Equinox context and therefore do not require any Scout services.
• JUnit with Equinox Context: These JUnit tests are responsible for checking the functions and operations of the Scout client model and of the Scout server. These tests need to be run within a Scout / Equinox context.
• JUnit with Equinox Context and an operating system providing a graphical layer: These JUnit tests interact with the GUI of the Scout application. E.g. Scout forms with different kind of widgets are opened and the tests automatically operate on the forms and widgets directly. Therefore, those tests must run within the Scout / Equinox context and they require that the OS provides a Display for the graphical interaction.

Plain JUnit is the preferred way (state of the art, faster during execution, easier to set up…). This is something we need to consider (see Long term vision).

The tests need to be executed from Maven (e.g. Surefire) to be integrated in the CBI. There is probably a way to tell maven which tests can be executed and which tests cannot. For example: If maven is executed on a command-line terminal, the JUnit tests that require an Operating System with a graphical layer need to be ignored.

For the moment, it is not sure whereas the foundation provides computers with graphical layer. The best solution is to have such computers in the eclipse foundation infrastructure. If there is no possibility to have a such computer, there is a need to evaluate the other possibilities (Cloud platform for developers, computer at BSI, ...).

Work in progress
Because we are moving closed source code to Eclipse, we develop first on a specific branch master_testing hosted at GitHub. We will merge these changes in the official Eclipse Scout repository with the appropriate IP Process (We probably need a CQ).

TODO

• Create the necessary plugins/fragments
• Create a POC: some tests + maven/tycho build that execute the tests (depending on the hardware).
• Migrate the closed-source tests to this new platform.

All modifications are tracked here in bug 402298.

Long term vision

The long term vision for Eclipse Scout Code should be to have code that can be tested with plain JUnit. To achieve the goal, the static Utility classes (SERVICES, TEXTS, ...) should not be used. Instead of getting the instance (dependency Lookup), the code should use the correct interface directly and let someone else provide it (could also be with dependency injection).

Here a small example:

This code requires a an Eclipse Equinox Context:

class Foo {
 
    public void doBar() throws ProcessingException {
       SERVICES.getService(IFooService).doBar();
    }
}

This code can be tested with plain JUnit:

class Foo {
 
   private IFooService service;
 
   Foo(IFooService service) {
     this.service = service;
    }
 
    public void doBar() throws ProcessingException {
       service.doBar();
    }
}

Coding/Naming convention

• Fragment name should be: <plugin name>+".test" without ".fragment". (example org.eclipse.scout.rt.client.test for org.eclipse.scout.rt.client)

• JavaDoc:

On top of each class, at least:

/**
 * JUnit tests for {@link <class name>}
 *
 * @since 3.9.0
 */

• Fixture:

ConfigurationUtilityTest

When tests need additional java Object, they are added in a fixture sub-package.

See example: org.eclipse.scout.commons.ConfigurationUtilityTest uses:

• org.eclipse.scout.commons.fixture.A
• org.eclipse.scout.commons.fixture.AbstractC

See also What Is a JUnit Test Fixture?

SDK.Test

Same approach as the RT.Test but for the SDK.

TODO

• Create the necessary plugins/fragments
• Create a POC: some tests + maven/tycho build that execute the tests (depending on the hardware).

SDK Test support

Setting-up all the plugins to test a scout application is not easy. For the moment this operation is achieve by hand. This know-how should be integrated in the Scout SDK, so that it becomes simple to start writing tests for a scout application.

TODO

• bug 394136: Create test infrastructure when creating a Scout project