Table of Contents
This is a test suite for conformance tests of the ISiK Stufe 3 specification modules:
See ReleaseNotes.md for all information regarding the (newest) releases.
To run the test suite you need the following components:
- This test suite, which you can get either by cloning this repository or downloading the latest release.
- An ISiK resource server (System under Test, SUT) that is compliant with one of the ISiK Stufe 3 specification modules.
Operating system requirements: cf. Tiger Framework OS requirements
Configure the endpoint of the SUT using the configuration element servers.fhirserver.source in the tiger.yaml configuration file. Example:
servers:
#...
fhirserver:
type: externalUrl
source:
- http://localhost:9032See examples for different configuration options in the tiger.yaml or check the official Tiger documentation
Each test case requires specific test resources to be present in the SUT. Create the following test resources in the SUT and put their corresponding IDs into the testdata/MODULENAME.yaml configuration file.
Example:
The @Patient-Read test case requires a patient resource to be created in the SUT by the user before the test case can be run. As the SUT would usually assign a new unique ID to each created resource, e.g. 244b0d72-fe47-4294-be48-7763895287c5, this newly assigned ID should be put into the testdata/basis.yaml configuration file. The precondition of the test case declares which configuration variable should be used - patient-read-id in this example:
...
patient-read-id: Patient-Read-Example
...Edit the file .env to select the test cases you want to run (see .env for examples). The default value is all tests from the ISIK basis module.
Afterward call Maven to execute the tests:
mvn clean verifyIf using the tiger testsuite behind a proxy provide the proxy configuration at the following places:
- Maven configuration (official documentation.
tiger.yaml(forwardToProxyconfiguration block)
The testsuite is also distributed as a docker image. Make sure, the docker environment has a connection to the SUT (configure docker proxy settings if needed).
To use the image, download and adjust the following files according to your test environment:
tiger.yaml(configuration of the test environment and test framework)dc-testsuite.yml(configuration of the docker container).env(configuration of the test suite)testdata/*.yaml(configuration of test data per module)
Then start a docker container using docker-compose:
docker compose -f dc-testsuite.yml upRight after starting a test suite a browser window will open, which provides an overview of the testing progress. If using Tiger in Docker, please navigate to http://localhost:9010 manually. See Tiger Workflow UI for further information about the user interface. To run the test suite without the GUI, e.g. within a CI/CD pipeline, set the configuration element lib.activateWorkflowUi to false in the tiger.yaml configuration file.
After the test suite finishes the archived test results can be found in debug-report.zip file (take notice of the debug-report suffix) or target/site/serenity/index.html in case of a Maven run.
Warning Each test run deletes the reports of the previous run. Backup the created reports if you need them in the future.
The artifact target/test-report.zip is required to apply for the ISiK conformance certificate (take notice of the test-report suffix). Please get an account to the TITUS platform and upload the report into the corresponding submission form.
Warning Each test run deletes the reports of the previous run. Backup the created reports if you need them in the future.
If you want to contribute, please check our CONTRIBUTING.md.
Copyright 2025 gematik GmbH
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
See the LICENSE for the specific language governing permissions and limitations under the License.
- Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.
- Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions::
- The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
- The software is provided "as is" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.
- The software is the result of research and development activities, therefore not necessarily quality assured and without the character of a liable product. For this reason, gematik does not provide any support or other user assistance (unless otherwise stated in individual cases and without justification of a legal obligation). Furthermore, there is no claim to further development and adaptation of the results to a more current state of the art.
- Gematik may remove published results temporarily or permanently from the place of publication at any time without prior notice or justification.
- Please note: Parts of this code may have been generated using AI-supported technology.’ Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.
Please open a GitHub issue or a ticket within Anfrageportal ISiK for any questions or feedback.