Tiger User Manual

            <!-- optional plugin to dynamically create JUnit driver classes on the fly.
            You may omit this plugin if you have written your driver classes manually.
            -->
            <plugin>
                <groupId>de.gematik.test</groupId>
                <artifactId>tiger-bdd-driver-generator-maven-plugin</artifactId>
                <version>${version.tiger}</version>
                <executions>
                    <execution>
                        <configuration>
                            <skip>false</skip>
                            <!-- optional, defaults to the templated located at
                            /src/main/resources/driverClassTemplate.jtmpl
                            in the tiger-driver-generator-maven-plugin module.
                            Use separate template file if you have spring boot apps to test
                            or need to do some more fancy set up stuff.
                            <templateFile>${project.basedir}/..../XXXX.jtmpl</templateFile>
                            -->
                            <!-- optional -->
                            <basedir>${project.basedir}/src/test/resources/features</basedir>
                            <!-- mandatory -->
                            <includes>
                                <include>**/*.feature</include>
                            </includes>
                            <!-- mandatory -->
                            <glues>
                                <glue>de.gematik.test.tiger.hooks</glue>
                                <glue>de.gematik.test.tiger.glue</glue>
                                <!-- add your packages here -->
                            </glues>
                            <!-- optional -->
                            <driverPackage>
                                de.gematik.test.tiger.examples.bdd.drivers
                            </driverPackage>
                            <!-- optional -->
                            <!--suppress UnresolvedMavenProperty -->
                            <driverClassName>Parallel${ctr}IT</driverClassName>
                        </configuration>
                        <phase>generate-test-sources</phase>
                        <id>default-testSources</id>
                        <goals>
                            <goal>generate-drivers</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

            <!-- Runs the tests by calling the JUnit driver classes -->
            <!-- To filter features / scenarios use the system property
                 -Dcucumber.filter.tags -->
            <plugin>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>3.0.0-M5</version>
                <configuration>
                    <includes>
                        <!-- adapt to the class names of your driver classes -->
                        <include>**/Parallel*IT.java</include>
                    </includes>
                    <!-- on purpose, to ensure the serenity plugin is called afterwards.
                    It's check goal wil bail out in case of test failures,
                    AFTER the serenity report has been generated -->
                    <testFailureIgnore>true</testFailureIgnore>
                </configuration>
            </plugin>

            <!-- Creates the SerenityBDD test report and
                 fails the build if there were test failures -->
            <plugin>
                <groupId>net.serenity-bdd.maven.plugins</groupId>
                <artifactId>serenity-maven-plugin</artifactId>
                <version>${version.serenity.maven.plugin}</version>
                <dependencies>
                    <dependency>
                        <groupId>net.serenity-bdd</groupId>
                        <artifactId>serenity-core</artifactId>
                        <version>${version.serenity.core}</version>
                    </dependency>
                    <!-- Optional if you want to also have a single HTML page mailable report
                    -->
                    <dependency>
                        <groupId>net.serenity-bdd</groupId>
                        <artifactId>serenity-single-page-report</artifactId>
                        <version>${version.serenity.core}</version>
                    </dependency>
                </dependencies>
                <!-- Optional if you want to also have a single HTML page mailable report -->
                <configuration>
                    <reports>single-page-html</reports>
                </configuration>
                <executions>
                    <execution>
                        <id>serenity-reports</id>
                        <phase>post-integration-test</phase>
                        <goals>
                            <goal>aggregate</goal>
                            <goal>reports</goal>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

serverKey_xxx:
  # OPTIONAL host name of this node when accessing it via the test suite
  # (rerouted via the local test suite Tiger Proxy).
  # Defaults to the server key (serverKey_xxx)
  hostname: string
  # MANDATORY one of [tigerProxy|docker|compose|externalJar|externalUrl]
  type: string
  # OPTIONAL name of a template to apply.
  # Default value is empty
  template: string
  # OPTIONAL comma separated list of keys of server nodes that must be started
  # before this node is set up.
  # Default value is empty
  dependsUpon: csv string
  # OPTIONAL duration in seconds to wait for a successful start up of the server node
  # Default value is 20
  startupTimeoutSec: int
  # MANDATORY type specific property in that for some types it's a list,
  # for some others it's a single URL
  source:
    - source entry 1
    - source entry 2
  # type specific property for Tiger Proxy and docker container nodes
  version: string
  # OPTIONAL list of pki certs and keys to initialize
  # the local Tiger Proxy of the test suite with
  # Default value is empty array
  # For more details see "PKI configuration" section below
  pkiKeys: []
  # OPTIONAL type specific list of environmental variable assignments to be used
  # when starting the server node.
  # Each entry has to have the format ENVVARNAME=VALUE
  # Has NO EFFECT on external Url nodes.
  # Default value is empty array
  environment:
    - ENVVAR1=VALUE1
    - ENVVAR2=VALUE2
    - http://tsl --> https://download-ref.tsl.ti-dienste.de
  # OPTIONAL list of routes to be added to the local Tiger Proxy of the test suite.
  # Default value is empty array
  urlMappings:
    - https://www.orf.at --> https://eitzen.at
  # OPTIONAL list of system properties that will be provided to following nodes.
  # Each entry has to have the format system.property.name=VALUE
  # Default value is empty array
  exports:
    - systemProp1=Value1
    - systemProp2=Value2

  # type specific sub structure for external jar, external url and Tiger Proxy nodes
  externalJarOptions:
    # used by external jar and Tiger Proxy nodes
    workingDir: string
    # used by all node types
    healthcheck: string
    # only used by external jar nodes
    options: []
    # used by external jar and Tiger Proxy nodes
    arguments: []

  # type specific sub structure for Tiger Proxy nodes
  tigerProxyCfg:
    serverPort: int
    proxiedServer: string
    proxiedServerProtocol: [HTTP|HTTPS]
    # Here a normal Tiger Proxy configuration can be used.
    # This is explained in more depth down below
    proxyCfg:
      proxyRoutes:
          # defines a forward-proxy-route from this server
        - from: http://foobar
          # to this server
          to: https://cryptic.backend/server/with/path

  # type specific sub structure for docker container and compose nodes
  dockerOptions:
    # only used by docker compose nodes
    serviceHealthchecks: []
    # all properties below only used by docker container nodes
    proxied: boolean
    oneShot: boolean
    entryPoint: string

  pkiKeys:
      # MANDATORY unique key/certificate id
    - id: disc_sig
      # MANDATORY one of [Certificate|Key]
      type: Certificate
      # MANDATORY base64 encoded multiline string representing the certificate / key.
      pem: "MIICsTCCAligAwIBAgIHA61I5ACUjTAKBggqhkjOPQQDAjCBhDELMAkGA1UEBhMC
  REUxHzAdBgNVBAoMFmdlbWF0aWsgR21iSCBOT1QtVkFMSUQxMjAwBgNVBAsMKUtv
  .....
  xiKK4dW1R7MD334OpOPTFjeEhIVV"
    - id: disc_enc
      type: Key
      pem: "ISUADOGBESBXEZOBXWEDHBXOU..."

dockerContainer_001:
  hostname: myDockerContainer
  type: docker
  dependsUpon: csv string
  startupTimeoutSec: int

  # MANDATORY URL from where to download the docker image.
  source:
    - dockerhubrepo.somewhere.org/repo/project/docker.image
  # OPTIONAL version of the docker image to download.
  version: 0.1.2

  dockerOptions:
    # OPTIONAL Flag whether the container shall be modified by
    # o adding the Tiger Proxy certificate to the container operating system.
    # o adding docker.host.internal to the container's /etc/hosts file.
    # Default value is true.
    proxied: true
    # OPTIONAL Flag whether the container is a one shot container or not.
    # One shot meaning it will execute a command and then stop.
    # Default value is false.
    oneShot: false
    # OPTIONAL The entry point command line to be used to start up this container
    # overwriting any configured entry point in the docker image.
    # Default value is empty meaning to use the configured entry point command line.
    entryPoint: chmod a+x /startup.sh && /startup.sh

  # The following properties are explained in the General properties section above
  pkiKeys: []
  environment: []
  urlMappings: []
  exports: []

  type: compose
  dependsUpon: csv string
  startupTimeoutSec: int

  # MANDATORY list of yaml files to use to start up the services.
  # The entries can either be file paths or if starts with
  # classpath:....  a reference to a yaml file contained in the class path
  # (it could also be located inside a jar that is in the class path)
  source:
    - classpath:/de/gematik/test/tiger/testenvmgr/epa/titus-epa2.yml
    - classpath:/de/gematik/test/tiger/testenvmgr/epa/titus-epa2-local.yml
  dockerOptions:
    # MANDATORY list of URLs to check for a successful start up
    # of the docker compose's services
    serviceHealthchecks:
      - http://service1:8001/
      - https://service2:9001/

demis_001:
  type: compose
  source:
    - classpath:/de/gematik/test/tiger/testenvmgr/demis/demis_localhost.yml
  startupTimeoutSec: 180
  dockerOptions:
    serviceHealthchecks:
      - http://notification-gateway:9042
      - http://notification-portal:9041/welcome

java ${options} -jar externalJar.jar ${arguments}

externalJar_001:
  hostname: mySpecialJar
  type: externalJar
  dependsUpon: csv string
  startupTimeoutSec: int

  # MANDATORY SINGLE ENTRY URL from where to download the Jar archive.
  # If the entry starts with "local:" followed by a file path the jar archive
  # is expected to be available at that location and no download is performed.
  # Only one entry is expected for this node type. Additional entries are silently ignored.
  source:
    - http://myjars.download.org/myproject/myjar.jar

  externalJarOptions:
    # OPTIONAL folder from where to start the external jar.
    # The downloaded jar file will be stored and executed from here
    # The default value is empty, which means that the operating-system-specific
    # temporary folder will be used.
    workingDir: /home/user/test/myspecificjar
    # MANDATORY URL to check for the successful startup of this node.
    # A successful start is indicated by ANY answer on this URL.
    # Any status is accepted as long as there is an answer.
    # If set to "NONE" no check is performed and
    # the test environment manager will wait for the startup timeout.
    healthcheck: http://127.0.0.1:8080
    # OPTIONAL Options to pass in to the java executable call.
    options: []
    # OPTIONAL provide additional arguments to the jar archive call.
    # Default value is empty.
    arguments:
      - --testarg1
      - -singledasharg2
      - --paramarg3=testvalue1

  # The following properties are explained in the General properties section above
  pkiKeys: []
  environment: []
  urlMappings: []
  exports: []

externalUrl_001:
  hostname: myExternalServer
  type: externalUrl
  dependsUpon: csv string
  startupTimeoutSec: int

  # MANDATORY URL of the external server
  source:
    - https://www.medizin.de

  externalJarOptions:
    # OPTIONAL URL to check for successful startup of this node.
    # A successful start is indicated by ANY answer on this URL.
    # Any status is accepted as long as there is an answer.
    # If the value is not set, then no health check is carried out
    # in the startup phase, instead the startupTimeout is waited for.
    # After this timeout it is assumed that the server is up.
    healthcheck: https://www.medizin.de/healthyState.jsp

  # The following properties are explained in the General properties section above
  pkiKeys: []
  # IGNORE for this type as it has no effect
  environment: []
  urlMappings: []
  exports: []

tigerProxy_001:
  hostname: myTigerProxy
  type: tigerProxy
  dependsUpon: csv string
  startupTimeoutSec: int

  tigerProxyCfg:
    # OPTIONAL port of the web user interface and the proxy management
    # (e.g. rbel-message forwarding)
    # Default value is empty, which means a random port will be used.
    serverPort: 8080
    # OPTIONAL server key of the node this proxy shall be used as reverse proxy for.
    # If set the routes in the proxyCfg section will be configured appropriately.
    # Default value is empty.
    proxiedServer: externalJar_001
    # OPTIONAL port of the proxy, where the proxy expects to receive proxy requests
    # Default value is empty, which means a random port will be used.
    proxyPort: 3128
    # OPTIONAL protocol the proxy is expecting requests in. One of [http|https]
    # Default value is http
    proxyProtocol: http
    # configures the proxy itself. For more details
    # please check the chapter about the local test suite Tiger Proxy below
    proxyCfg:
      ...
      proxyRoutes:
        - from: http://foobar
          # defines a forward-proxy-route from this server...
          to: https://cryptic.backend/server/with/path
          # to this server
      ...

  # The following properties are explained in the General properties section above
  pkiKeys: []
  environment: []
  urlMappings: []
  exports: []

tigerProxy:
    proxyRoutes:
      - from: http://my.domain/
        to: http://orf.at/

tigerProxy:
    proxyRoutes:
      - from: http://my.domain/deep/
        to: http://orf.at/blub/

tigerProxy:
    proxyRoutes:
      - from: http://my.domain/deep/
        to: http://orf.at/blub/
        basicAuth:
          username: "test1"
          password: "pwd2"

tigerProxy:
    tls:
        domainName: deep.url.of.server.de

Unirest.config().sslContext(tigerProxy.buildSslContext());

 OkHttpClient client = new OkHttpClient.Builder()

    .proxy(new Proxy(
        Proxy.Type.HTTP,
        new InetSocketAddress(
            "localhost",
            tigerProxy.getPort())))

    .sslSocketFactory(
        tigerProxy.getConfiguredTigerProxySslContext().getSocketFactory(),
        tigerProxy.buildTrustManagerForTigerProxy())

    .build();

tigerProxy:
    tls:
        serverRootCa: "certificate.pem;privateKey.pem;PKCS8"
# for more information on specifying PKI identities in tiger see "Configuring PKI identities"

tigerProxy:
    tls:
      serverIdentity: "certificateAndKeyAndChain.p12;Password"

{
    "uuid": "UUID string",
    "request": "base64 encoded http request",
    "response": "base64 encoded http response",
    "sender": {
      "hostname": "hostname/ip address of sender",
      "port": portAsInt
    },
    "reveiver": {
      "hostname": "hostname/ip address of receiver",
      "port": portAsInt
    }
}

rbelPathDebugging: true

RbelElementTreePrinter.builder()
    .rootElement(this) //the target element
    .printKeys(printKeys) // should the keys for every leaf be printed?
    .maximumLevels(100) // only descend this far into the three
    .printContent(true) // should the content of each element be printed?
    .build()
    .execute();

tigerProxy:
    activateRbelParsing: true
    activateAsn1Parsing: false
    activateVauAnalysis: false

// copied from module /tiger-test-lib
// /src/test/java/de/gematik/test/tiger/glue/RBelValidatorGlue.java

/**
 * Specify the amount of seconds Tiger should wait when filtering for
 * requests / responses
 * before reporting them as not found.
 */
@Gegebensei("TGR setze Anfrage Timeout auf {int} Sekunden")
@Given("TGR set request wait timeout to {int} seconds")

/**
 * clear all validatable rbel messages. This does not clear the recorded messages later on
 * reported via the rbel log HTML page or the messages shown on web ui of Tiger Proxies.
 */
@Wenn("TGR lösche aufgezeichnete Nachrichten")
@When("TGR clear recorded messages")

/**
 * filter all subsequent findRequest steps for hostname. To reset set host name to
 * empty string "".
 *
 * @param hostname host name (regex supported) to filter for
 */
@Wenn("TGR filtere Anfragen nach Server {string}")
@When("TGR filter requests based on host {string}")

/**
 * filter all subsequent findRequest steps for method.
 *
 * @param method method to filter for
 */
@Wenn("TGR filtere Anfragen nach HTTP Methode {string}")
@When("TGR filter requests based on method {string}")

/**
 * reset filter for method for subsequent findRequest steps.
 */
@Wenn("TGR lösche den gesetzten HTTP Methodenfilter")
@When("TGR reset request method filter")

/**
 * find the first request where the path equals or matches as regex and memorize it
 * in the {@link #rbelValidator} instance
 *
 * @param path path to match
 */
@Wenn("TGR finde die erste Anfrage mit Pfad {string}")
@When("TGR find request to path {string}")

/**
 * find the first request where path and node value equal or match as regex and memorize it
 * in the {@link #rbelValidator} instance.
 *
 * @param path     path to match
 * @param rbelPath rbel path to node/attribute
 * @param value    value to match at given node/attribute
 */
@Wenn("TGR finde die erste Anfrage mit Pfad {string} und Knoten {string} der mit {string} übereinstimmt")
@When("TGR find request to path {string} with {string} matching {string}")

/**
 * find the NEXT request where the path equals or matches as regex and memorize it
 * in the {@link #rbelValidator} instance.
 *
 * @param path path to match
 */
@Wenn("TGR finde die nächste Anfrage mit dem Pfad {string}")
@When("TGR find next request to path {string}")

/**
 * find the NEXT request where path and node value equal or match as regex and memorize it
 * in the {@link #rbelValidator} instance.
 *
 * @param path     path to match
 * @param rbelPath rbel path to node/attribute
 * @param value    value to match at given node/attribute
 */
@Wenn("TGR finde die nächste Anfrage mit Pfad {string} und Knoten {string} der mit {string} übereinstimmt")
@When("TGR find next request to path {string} with {string} matching {string}")

/**
 * assert that there is any message with given rbel path node/attribute matching given value.
 * The result (request or response) will not be stored in the {@link #rbelValidator}
 * instance.
 *
 * @param rbelPath rbel path to node/attribute
 * @param value    value to match at given node/attribute
 * @deprecated
 */
@Wenn("TGR finde eine Nachricht mit Knoten {string} der mit {string} übereinstimmt")
@When("TGR any message with attribute {string} matches {string}")

// ==========================================================================================
//
//    S T O R E   R E S P O N S E   N O D E   I N   C O N T E X T
//
// ==========================================================================================

/**
 * store given rbel path node/attribute text value of curren tresponse.
 *
 * @param rbelPath path to node/attribute
 * @param varName  name of variable to store the node text value in
 */
@Dann("TGR speichere Wert des Knotens {string} der aktuellen Antwort in der Variable {string}")
@Then("TGR store current response node text value at {string} in variable {string}")

// ==========================================================================================
//
//    R E S P O N S E   V A L I D A T I O N
//
// ==========================================================================================

/**
 * assert that response body of filtered request matches.
 *
 * @param docString value / regex that should equal or match
 */
@Dann("TGR prüfe aktuelle Antwort stimmt im Body überein mit:")
@Then("TGR current response body matches")

/**
 * assert that response of filtered request matches at given rbel path node/attribute.
 *
 * @param rbelPath path to node/attribute
 * @param value    value / regex that should equal or match as string content with MultiLine
 *                 and DotAll regex option
 */
@Dann("TGR prüfe aktuelle Antwort stimmt im Knoten {string} überein mit {string}")
@Then("TGR current response with attribute {string} matches {string}")

/**
 * assert that response of filtered request matches at given rbel path node/attribute.
 *
 * @param rbelPath  path to node/attribute
 * @param docString value / regex that should equal or match as string content with MultiLine
 *                  and DotAll regex option supplied as DocString
 */
@Dann("TGR prüfe aktuelle Antwort im Knoten {string} stimmt überein mit:")
@Then("TGR current response at {string} matches")

/**
 * assert that response of filtered request matches at given rbel path node/attribute.
 *
 * @param rbelPath path to node/attribute
 * @param value    value / regex that should equal or match as string content with MultiLine
 *                 and DotAll regex option
 * @deprecated
 */
@Then("TGR current response at {string} matches {string}")

/**
 * assert that response of filtered request matches at given rbel path node/attribute
 * assuming its JSON or XML
 *
 * @param rbelPath     path to node/attribute
 * @param mode         one of JSON|XML
 * @param oracleDocStr value / regex that should equal or match as JSON or XML content
 * @see JsonChecker#assertJsonObjectShouldMatchOrContainInAnyOrder(String, String, boolean)
 */
@Dann("TGR prüfe aktuelle Antwort im Knoten stimmt als {word} überein mit:")
@Then("TGR current response at {string} matches as {word}")

/**
 * assert that response of filtered request matches at given rbel path node/attribute
 * assuming its XML with given list of diff options.
 *
 * @param rbelPath       path to node/attribute
 * @param diffOptionsCSV a csv separated list of diff option identifiers to be applied
 *                       to comparison of the two XML sources
 *                       <ul>
 *                           <li>nocomment ... {@link DiffBuilder#ignoreComments()}</li>
 *                           <li>
 *                             txtignoreempty ...
 *                             {@link  DiffBuilder#ignoreElementContentWhitespace()}
 *                           </li>
 *                           <li>txttrim ... {@link DiffBuilder#ignoreWhitespace()}</li>
 *                           <li>
 *                             txtnormalize ... {@link DiffBuilder#normalizeWhitespace()}
 *                           </li>
 *                       </ul>
 * @param xmlDocStr      value / regex that should equal or match as JSON content
 * @see <a href="https://github.com/xmlunit/user-guide/wiki/DifferenceEvaluator">
 *        More on DifferenceEvaluator
 *      </a>
 */
@Dann("TGR prüfe aktuelle Antwort im Knoten {string} stimmt als XML mit folgenden diff Optionen {string} überein mit:")
@Then("TGR current response at {string} matches as XML and diff options {string}")

// copied from module /tiger-test-lib
// /src/test/java/de/gematik/test/tiger/glue/TigerGlue.java

    @Gegebensei("TGR zeige {word} Banner {string}")
    @Given("TGR show {word} banner {string}")

    @Gegebensei("TGR zeige {word} Text {string}")
    @Given("TGR show {word} text {string}")

    @Gegebensei("TGR zeige Banner {string}")
    @Given("TGR show banner {string}")

    @When("TGR wait for user abort")
    @Wenn("TGR warte auf Abbruch")

tigerProxy:
    proxyRoutes:
        - from: /
          to: http://127.0.0.1:8080

export TIGERPROXY_PROXYROUTES_0_TO = "http://real.server"

tigerProxy:
    proxyRoutes:
        - from: /
          to: http://127.0.0.1:${backend.server.port}

export BACKEND_SERVER_PORT = "8080"

    TGR current response with attribute "$.body.ReplyStructure.Header.Sender.url" matches "http://127.0.0.1:${backend.server.port}"