kse-02/README.md

# Project 02 - Python test generator

### About the Project

This project has the goal of writing a search based automated test generator for Python.
It is part of the Knowledge Search & Extraction - 2023 course from the Università della Svizzera italiana.

In this repository, you can find the following files:

- `benchmark/` folder: which contains the benchmark of functions under test to be instrumented

Note: Feel free to modify this file according to the project's necessities.

## Environment setup

To install the required dependencies make sure `python3` points to a Python 3.10 or 3.11 installation and then run:

```shell
python3 -m venv env
source env/bin/activate
pip install -r requirements.txt
```

## Instrumentation (Part 1)

To generate the instrumented code for all the files in the benchmark run the command:

```shell
python3 ./instrument.py
```

The generated files are created in the directory `instrumented`. Each file name matches the file name of the
corresponding source file in `benchmark`.

## Test case generation (Part 2 and Part 3)

To generate test cases for all files in the benchmark run the command:

```shell
python3 ./genetic.py
```

The test suite is created in the directory `tests`. One test class is generated for each function defined in the 
`benchmark` package. Run the command with the `-h` options for more details on partial generation.

The test suite can be then executed over the benchmark code with the command:

```shell
python3 -m unittest discover tests
```