Folio-Integration-Tests

Copyright (C) 2020-2022 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

This project is the set of integration tests based on karate framework

Results of the automated daily run are published on Jenkins FOLIO_Reference_Builds folio-api-tests-karate.

Running integration tests

To run all existing API tests on localhost

mvn test

To run all existing API tests on snapshot environment

mvn test -DargLine="-Dkarate.env=snapshot"

To run all existing API tests on snapshot-2 environment

mvn test -DargLine="-Dkarate.env=snapshot-2"

To run only specific submodule use -pl common,testrail-integration,<submodule_name> on snapshot

mvn test -DargLine="-Dkarate.env=snapshot" -pl common,testrail-integration,mod-notify

or use runtests.sh described below.

This first builds the common and testrail-integration submodules and sets maven variables so that mod-notify can use them.

To run only specific runner (Java) class test use -DfailIfNoTests=false and -Dtest=<TestName>.

Running tests for a specific module in a specific environment

sh ./runtests.sh ${PROJECT} ${ENVIRONMENT}
For example,
sh ./runtests.sh mod-oai-pmh snapshot

• Supported values for project are module names from root pom.xml
• Supported values for environment depend on karate-config.js in the corresponding module. For example:

Environment
snapshot
snapshot-2
Any supported value in karate.config

Running Performance Tests

To run all existing performance tests on localhost

mvn gatling:test

To run all existing performance tests on an environment

mvn gatling:test -Dkarate.env=dev

To run only specific submodule use -pl <dependency_modules>,<submodule_name> on dev. For example dependency_modules = common,testrail-integration, submodule_name = acquisitions

mvn gatling:test -Dkarate.env=dev -pl common,testrail-integration,acquisitions

To run specific Class use -Dgatling.simulationClass=<className> (org.folio - package name where class is located)

 mvn gatling:test -Dkarate.env=dev -pl common,testrail-integration,acquisitions -Dgatling.simulationClass=org.folio.InvoiceSimulation

Running tests in rancher

• Create a secret called integration-tests
• Set up secret values: environment and propject.
• Then in rancher pipeline in runscript step specify

sh ./runtests.sh ${PROJECT} ${ENVIRONMENT}

Running D2IR mock server

• Mock server documentation
• [Mock server URL](Configure in karate-config.js file as centralServerUrl)
• Mock server dashboard
• Mock server deployment steps
• Mock server expectation initializer config file is located at mod-inn-reach/src/main/resources/volaris/mod-inn-reach/mocks/general/expectation_initializer.json

Running specific feature from IDEA

  1. Create runner class (Example : org.folio.OrdersApiTest)
  2. Set environment variable in configuration : karate.env=snapshot

Also possible to run integration tests trough IDE by:

• Any test runner like FinanceApiTest
• Directly from root feature file resources/domain/mod-orders/orders.feature
• A specific scenario if it contains all available variable as in above example

Folder structure

├── FolioModuleName1
├── FolioModuleNameN
├── common
│    └── src
│      └── main
│        ├── java
│        └── resources
│             └── common
│                ├── destroy-data.feature
│                ├── dev.feature
│                ├── login.feature
│                ├── module.feature
│                ├── setup-users.feature
│                └── tenant.feature
└── poc
    └── src
      └── main
      │   ├── java
      │   └── resources
      │       ├── common
      │       │   ├── global-finances.feature
      │       │   ├── global-inventory.feature
      │       │   ├── global-organizations.feature
      │       ├── domain
      │       │   ├── mod-finance
      │       │   │   ├── cases
      │       │   │   │   └── transactions.feature
      │       │   │   └── finance.feature
      │       │   └── mod-orders
      │       │       ├── cases
      │       │       │   └── composite-orders.feature
      │       │       └── orders.feature
      │       ├── examples
      │       │   ├── crud.feature
      │       │   └── simple-data-driven.feature
      │       ├── karate-config.js
      │       ├── logback-test.xml
      │       └── samples
      │           └── mod-orders
      │               └── order-line.json
      └── test
          └── java
              └── org
                 └── folio
                      ├── FinanceApiTest.java
                      ├── OrdersApiTest.java
                      └── TestUtils.java

• FolioModuleName1,N - placeholders for future modules
• common - module for reusable features
• PoC/src/main/java - folder for reusable java code or utils methods
• PoC/src/main/resources/common - folder for reusable feature files
• PoC/src/main/resources/domain - folder with domain specific integration tests
• PoC/src/main/resources/examples - folder with karate examples
• PoC/src/main/resources/karate-config.js - karate configuration file applicable for all feature files
• PoC/src/main/resources/samples - folder with domain specific reusable files like request data
• PoC/test/java/org/folio - folder with Test runners

To add Integration tests for a Folio module, create a directory with the module name at the root of this repo and put the tests under it (feel free to use the same directory structure for the module as specified for PoC) and update root pom.xml with new submodule.

To reuse features from the common module you should update pom.xml with dependency below. All features will be located in classpath.

<dependencies>
    <dependency>
        <groupId>org.folio</groupId>
        <artifactId>common</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>

Resources

• Karate repository
• Karate documentation
• Karate examples

Project Setup to test via Vagrant overall roadmap

• Add permissions to user.

  The list of permissions should include: okapi.proxy.modules.", okapi.proxy.pull.", okapi.proxy.tenants.", okapi.proxi.", okapi.env, okapi.env.", okapi.modules, okapi.deployment.", okapi.all, okapi.deploy, okapi.tenants, okapi.tenantmodules, users.item.".

"- includes inner permissions;

• Get userId

  Get permissionId using the userId

  Assign permissionId to userId

  The logic should be used within karate-config.js

• Change proper configuration file line about karate.env to line equals to: var env = karate.env ? karate.env : 'local';

Team assignment

team-assignment.json file is used to define mapping between specific integration tests modules and responsible team. Jenkins will use this file to match team and modules during slack notifications forming and jira tickets creation. Format:

[
  {
    // Team name. Should match 'Development Team' Jira field.
    "team": "Bama",
    // List of integration tests modules the team is responsible for
    "modules": [
      "mod-calendar"
    ],
    // Slack channel which will be used to send failed tests notifications
    "slackChannel": "#bama"
  }
]