Documents the approach to functional/integration testing for the application REST services layer.  

NOTE: integration testing is only minimally implemented, this mostly presents the methodology and approach that would be used to fully flesh out the JPA service layer integration tests.


There are six services, each with a JPA implementation

  • Security Service
  • Metadata Service
  • Content Service
  • Mapping Service
  • Report Service
  • Workflow Service

Complete coverage would address each mode of use of each method call of each service.  It would also consider where different types of mapping projects would expect to have different outcomes (e.g. an "extended map" vs. a "complex map").

Coverage Definition

The attached spreadsheet formally defines REST service layer coverage from an integration testing perspective. 


  • A dev database exists that is loaded with exactly the development content from the mapping-service-data git project.
  • Any changes made are reverted to initial conditions so all tests can assume identical initial conditions
  • A server built using the latest code is deployed to the URL specified in the base.url property of the config file used to run the integration tests.

Coverage is defined in a multi-dimensional matrix that takes into account the services, the methods of the services, and the modes of use of the services (including normal use, degenerate use, and edge cases). NOTE: in many cases there are many "normal" modes of use which may extend the number of columns in the spreadsheet.  For example, methods that take optional parameters (e.g. Pfs). Coverage also considers combinations of calls that have related effects to each other and a placeholder for "ad hoc" tests that can be filled in as gaps in coverage are identified.

The following sample coverage spreadsheet begins to outline the methodology for defining coverage though it is not fully fleshed out.


Integration tests are organized under the integration-testing project.  Looking through the Java packages, you should find a "org.ihtsdo.otf.mapping.test.rest" package that defines a number of test classes that represent the coverage spreadsheet.

Each column of each tab of the coverage spreadsheet is represented by a single testing class, where each row within that column corresponds to a particular method of that testing class.  The coverage spreadsheet defines both the class names used to implement tests as well as the method names (so they can be easily cross referenced).

The test names themselves are "test cases" that are organized into "test suites" according to the structure of the spreadsheet.

For example, the attached coverage spreadsheet has a tab called "Security".  Within that spreadsheet is the "Normal Use" column for which there are three rows filled out, implementing testNormalS001, testNormalS002, and testNormalS003.  In the integration-tests there is a a testing class "SecurityServiceNormalUse.java" that has three testing methods corresponding to those listed above.  In this way, the organization of the tests within the code correlates to the spreadsheet.

For each test suite and test case, there should also exist a documentation page in this wiki.  A test suite is a collection of test cases and a test case is a "script" detailing the actions involved and the expected outcomes with any other needed information.

Integration Test Suites

Test suites are organized by spreadsheet tab.


  • No labels