Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 2.8 KB

README.md

File metadata and controls

87 lines (58 loc) · 2.8 KB
Raw

tmt web

Web application for checking tmt tests, plans and stories.

Run instructions

To run the service locally for development purposes, use the following command:

podman-compose up --build

Add -d for the service to run in the background.

In order to quickly experiment without using Celery use this:

USE_CELERY=false CLONE_DIR_PATH=/tmp/test uvicorn api:app --reload --host 0.0.0.0 --port 8000

Tests

To run the tests, use the pytest command (assuming the service is running).

Alternatively, if you have hatch installed, hatch run test:run command will rebuild, start the service and run the tests.

Environment variables

  • REDIS_URL - optional, passed to Celery on initialization as a broker and backend argument, default value is: redis://localhost:6379
  • CLONE_DIR_PATH - optional, specifies the path where the repositories will be cloned, default value is: ./.repos/
  • USE_CELERY - optional, specifies if the app should use Celery, set to false for running without Celery
  • API_HOSTNAME - required, specifies the hostname of the API, used for creating the callback URL to the service

API

The API version is defined by prefix in url, e.g. /v0.1/status.

If we want to display metadata for both tests and plans, we can combine the test-* and plan-* options together, they are not mutually exclusive.

test-url and test-name, or plan-url and plan-name are required.

/

Returns ID of the created Celery task with additional metadata in JSON and callback url for /status endpoint, returns the same in HTML format if format is set to html.

  • test-url - URL of the repo test is located in - accepts a string

  • test-ref - Ref of the repository the test is located in - accepts a string, defaults to default branch of the repo

  • test-path - Points to directory where fmf tree is stored

  • test-name - Name of the test - accepts a string

  • plan-url - URL of the repo plan is located in - accepts a string

  • plan-ref - Ref of the repository the plan is located in - accepts a string, defaults to default branch of the repo

  • plan-path - Points to directory where fmf tree is stored

  • plan-name - Name of the plan - accepts a string

  • format - Format of the output - accepts a string, default is json, other options are xml, html (serves as a basic human-readable output format)

  • id - Unique ID of the tmt object

/status

Returns a status of the tmt object being processed by the backend.

  • task_id - ID of the task - accepts a string

/status/html

Returns a status of the tmt object being processed by the backend in a simple HTML formatting.

  • task_id - ID of the task - accepts a string

/health

Returns a health status of the service.