Skip to main content

Kontr tests development kit

Project description

Kontr Test Development Kit

Kontr Test Development Kit was designed to write custom test scenarios for multiple programming languages. Configuration is done by python script with predefined structure.

Getting stated

KTDK is a library, to use it, you have to install it, or add it to your's Pipenv or requirements.txt file.

Prerequisites

  • Python 3.6 or later
  • (Optional) pipenv

Install the released version

You can install ktdk using the pip:

$ pip install ktdk

Or you can add it as a development dependency using the pipenv

$ pipenv install ktdk

Install the development version

You can either use the Pipenv command.

pipenv install git+https://gitlab.fi.muni.cz/grp-kontr2/ktdk.git

or the pip command:

pip install git+https://gitlab.fi.muni.cz/grp-kontr2/ktdk.git

Available Env variables

  • KTDK_WORKSPACE - Workspace dir
  • KTDK_TEST_FILES - Test files dir
  • KTDK_SUBMISSION - Student's submission dir
  • KTDK_RESULTS - Results directory submission dir
  • KTDK_ENTRY_POINT - Entry point - main script (default: instructions.py)
  • KTDK_TEST_TIMEOUT - Test timeout
  • KTDK_WEBHOOK_URL - Webhook url
  • KTDK_WEBHOOK_TOKEN - Webhook token
  • KTDK_TEST_TIMEOUT - Test timeout
  • KTDK_SUITE_TIMEOUT - Suite timeout
  • KTDK_SUITE_ID - Suite ID

Run the cli tool

Ktdk also provides a simple cli tool, to run your tests

# Show the help
$ ktdk --help

# List all the static tests
$ ktdk tests list

# Run your tests using the ktdk
$ ktdk execute --help

# Example:
$ ktdk execute --submission="<SUBMISSION_DIR>" --test-files="<TEST_FILES_DIR>" --devel

Examples

TBD - python examples of the KTDK tests

Development

Take a look at the contribution guide

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ktdk-0.4.2.tar.gz (1.9 MB view hashes)

Uploaded source

Built Distribution

ktdk-0.4.2-py3-none-any.whl (101.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page