Difference between revisions of "Scout/Concepts/Test"

Revision as of 04:35, 23 January 2013

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.

TODO

• Find a name for the project: com.github.widgets-demo or something like that. (mzi: name should contain scout as substring, the use of github in the substring is not clear to me. more specifically: it is to be expected that the number of demo applications will become larger than just the widgets-demo, so we want to have a consistent naming scheme that relates these demo aplications to Scout. As we did register the domain eclipsescout.org we could for example use org.eclipsescout.demo.widgets)
• 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')

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 exprim the requirements to run the test:

• Plain JUnit
• JUnit with Equinox Context
• JUnit with Equinox Context and an operating system providing a graphical layer.

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, ...).

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.

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