Repository structure | InditexTech Karate Tools

This library is a general purpose library that can be used by any Karate project.

The Karate Tools Open Source Repository is organized as follows:

code - Karate Tools Open Source codebase with the corresponding unit and integration tests
- 👩‍💻 karatetools-oss-code
e2e/karate - Karate Tools Open Source karate tests
- 🧪 karatetools-oss-karate-test
docs - Karate Tools Open Source documentation based on asciidoc and antora
- 📄 karatetools-oss-docs

├── code (1)
│   ├── archetype (2)
│   │   └── src
│   │       └── test
│   │           ├── java
│   │           └── resources
│   ...
│   └── starter (2)
├── docs (3)
│   ├── build (4)
│   ├── node_modules (4)
│   ├── src
│   │   └── modules (5)
│   │       ├── HOME
│   │       │   ├── images
│   │       │   └── pages
│   │       ...
│   │       └── release
│   └── supplemental-ui (6)
└── e2e
    └── karate (7)
        └── src
            └── test
                ├── java
                └── resources

1	codebase root directory
2	codebase maven modules
3	documentation root directory
4	documentation build and node directories
5	documentation antora asciidoc modules
6	documentation antora UI assets (page templates, CSS, JavaScript, images, etc.)
7	karate-test maven module root directory

The main code modules are:

👩‍💻 karatetools-oss-archetype: archetype to generate a karate project from scratch with the necessary configurations and utilities for the execution of tests.
👩‍💻 karatetools-oss-clients: clients to interact with relational databases via JDBC (MariaDB and PostgreSQL), MongoDB, Kafka and JMS (Active MQ and Rabbit MQ)
👩‍💻 karatetools-oss-generators: generators of tests from Open API
👩‍💻 karatetools-oss-runner: karate runner and all related utilities (authentication, JWT tokens, karate base configuration, karate utils, karate mocks, karate cache, karate results and reports, …)
👩‍💻 karatetools-oss-starter: starter module to include the generators, clients and runner in a Karate project.

It includes test open api modules:

👩‍💻 karatetools-oss-openapi-test: Open API test specifications for the karate tools tests with two sub-modules:
- 👩‍💻 karatetools-oss-xxx-api-rest-stable: api to test the test generation tools
- 👩‍💻 karatetools-oss-xxx-external-api-rest-stable: api to test the mock generation tools

It includes a spring boot module:

👩‍💻 karatetools-oss-boot: spring boot application with a simple rest api implementing the Open API test specification and docker containers to be used as target for the karate tools tests (runner, rest, auth, jdbc, mongodb, kafka, jms, …)

The karate test module is defined in the e2e/karate folder:

🧪 karatetools-oss-karate-test: karate module to test the karate tools.
- This module has been generated using the ⚙️ Karate Tools - Archetype
- Includes auto-generated tests and mocks for sample api (karatetools-oss-openapi-test)
- uses the karatetools-oss-starter to test the karate clients and the sample application (karatetools-oss-boot) and containers.

The documentation is defined in the docs folder:

📄 karatetools-oss-docs: documentation of the karate tools based on asciidoc and antora.