Skip to main content

Test Generation Framework

Project description

Test Generation Framework

The Test Generation Framework is a command-line interface (CLI) tool designed to generate and execute automated tests for pull requests (PRs) using AI models. It provides two main commands: generate for generating tests based on the PR number, and execute for running tests with prioritization.

Features

  • Generate Test Cases: Automatically generate test cases using an AI model based on the pull request.
  • Dynamic Tests prioritization: Dynamically generate tests prioritization based on previous execution data.
  • Execute Tests: Run generated tests with prioritization, making it easier to focus on the most important tests first.

Installation

To install the framework, use the following command:

pip install test-gen-framework

Usage

Command-Line Interface

Once installed, you can use the test-gen command with the following syntax:

test-gen <command> <arguments>

Available Commands

1. init

Generates the config file and github actions workflow setup.

Usage:

test-gen-init

2. generate

Generates test cases based on the provided pull request (PR) number.

Usage:

test-gen generate <pr_number>

Arguments:

  • pr_number: The PR number for which to generate test cases.

Example:

test-gen generate 123

This will generate test cases for PR number 123.

3. execute

Executes the generated tests with prioritization.

Usage:

test-gen execute <test_dir> <pr_number>

Arguments:

  • test_dir: The directory where the generated test cases are located.
  • pr_number: The PR number associated with the generated tests.

Example:

test-gen execute tests/pr_123 123

This will execute the tests located in the tests/pr_123 directory, corresponding to PR number 123.

How It Works

  1. init Command: The init command will generate and add neccesery config files to the project and it will also create the github actions worflow setup in your project.
  2. Generate Command: The generate command uses an AI model to generate automated tests for a given pull request. It leverages the PR number to gather relevant code and context.
  3. Execute Command: The execute command runs the generated tests on a specified directory, prioritizing tests based on their importance and relevance.

Contributing

If you'd like to contribute to the project, feel free to fork the repository and submit a pull request. Contributions are always welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.

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

test_gen_framework-1.0.8.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

test_gen_framework-1.0.8-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file test_gen_framework-1.0.8.tar.gz.

File metadata

  • Download URL: test_gen_framework-1.0.8.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for test_gen_framework-1.0.8.tar.gz
Algorithm Hash digest
SHA256 76aba588c748e704d5bc6267d2f25fe95621b1d99c62139ba8e73e991cb91062
MD5 242a270b13e229d18d38463ce4a1e2fc
BLAKE2b-256 d61649899d69078a66d48358d679d15c8cb6d9e4990bae601481e14f065b01d2

See more details on using hashes here.

File details

Details for the file test_gen_framework-1.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for test_gen_framework-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 496dea05e6d96f30e2550d5de283e3eca92a0f7768c83705763d95e318689538
MD5 e0559167daa97c39ab275666aaa88e34
BLAKE2b-256 c8bbdd2db63f2bca8d27dd8b6da3362e19e1840384d2ee21b80342c3703e8301

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page