docs/content/ftest/terminology.md
Aravinth Manivannan 31975e0496
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
feat: bootstrap ftest docs
2023-10-02 00:27:41 +05:30

1.5 KiB

+++ title = "Terminology" insert_anchor_links = "right" weight = 2 +++

Specimen

A specimen is an ActityPub or a ForgeFed instance that has to be tested on ftest.

Job Manifest

or ftest.toml

Contains information on the test environment, initialization code and the test suites that has to be run on the specimen

Control Repository

A Repository that houses job manifests, and Infrastructure-as-Code (docker-compose, currently) to spin up a test environment containing the specimen.

Directory structure

Each specimen has it's own directory in the control repository:

23:50 atm@lab ftest-control ±|gotosocial ✗|→ tree

└── targets
    ├── forgejo
    │   ├── conf
    │   │   └── app.ini
    │   ├── docker-compose.yml
    │   └── ftest.toml
    └── gotosocial
        ├── data
        │   └── config
        │       └── config.yaml
        ├── docker-compose.yaml
        └── Dockerfile

specimen docker-compose.yml

The control repository MUST contain a docker-compose.yml to spin up the specimen. It may include configuration files in the same directory, which to docker-compose file can rely on using bind mounts within the container.