Pynguin
Pynguin, the PYthoN General UnIt test geNerator, is a tool that allows developers to generate unit tests automatically.
Testing software is a tedious task. Thus, automated generation techniques have been proposed and mature tools exist—for statically typed languages, such as Java. There is, however, no fully-automated tool available that produces unit tests for general-purpose programs in a dynamically typed language. Pynguin is, to the best of our knowledge, the first tool that fills this gap and allows the automated generation of unit tests for Python programs.
Pynguin is developed at the Chair of Software Engineering II of the University of Passau.
Attention
Pynguin executes the module under test! As a consequence, depending on what code is in that module, running Pynguin can cause serious harm to your computer, for example, wipe your entire hard disk! We recommend running Pynguin in an isolated environment, for example, a Docker container, to minimise the risk of damaging your system.
Prerequisites
Before you begin, ensure you have met the following requirements:
- You have installed Python 3.8 (we have not yet tested with Python 3.9, there might be some problems due to changed internals regarding the byte-code instrumentation).
- You have a recent Linux/macOS/Windows machine.
Please consider reading the online documentation to start your Pynguin adventure.
Installing Pynguin
Pynguin can be easily installed using the pip tool by typing:
pip install pynguin
Make sure that your version of pip is the one of the Python 3.8 interpreted or a virtual environment that uses Python 3.8 as its interpreter as any older version is not supported by Pynguin!
Using Pynguin
Pynguin is a command-line application. Once you installed it to a virtual environment, you can invoke the tool by typing pynguin inside this virtual environment. Pynguin will then print a list of its command-line parameters.
A minimal full command line to invoke Pynguin could be the following, where we assume that a project foo is located in /tmp/foo, we want to store Pynguin's in /tmp/testgen, and we want to generate tests using a whole-suite approach for the module foo.bar (wrapped for better readability):
pynguin \
--algorithm WHOLE_SUITE \
--project_path /tmp/foo \
--output_path /tmp/testgen \
--module_name foo.bar
Contributing to Pynguin
For the development of Pynguin you will need the poetry dependency management and packaging tool. To start developing, follow these steps:
-
Clone the repository
-
Change to the
pynguinfolder:cd pynguin -
Create a virtual environment and install dependencies using
poetry:poetry install -
Make your changes
-
Run
poetry shellto switch to the virtual environment in your current shell -
Run
make checkto verify that your changes pass all checksPlease see the
poetrydocumentation for more information on this tool.
Development using PyCharm.
If you want to use the PyCharm IDE you have to set up a few things:
- Import pynguin into PyCharm.
- Find the location of the virtual environment by running
poetry env infoin the project directory. - Go to
Settings/Project: pynguin/Project interpreter - Add and use a new interpreter that points to the path of the virtual environment
- Set the default test runner to
pytest
License
This project is licensed under the terms of the GNU Lesser General Public License.
![If there is any `.so` (e.g., `_C.so`) file in a package, Pynguin stops generating tests and reports `FileNotFoundError: [Errno 2] No such file or directory: '.../_C.py'`](https://avatars.githubusercontent.com/u/55737536?v=4)
2 Nov 21, 2021
1 Jan 03, 2022
191 Dec 21, 2022
2 Nov 23, 2021
66 Dec 21, 2022
12 Dec 26, 2022
5 Dec 31, 2021
1 Aug 05, 2021
675 Dec 23, 2022
3.5k Dec 29, 2022
252 Dec 21, 2022
3 Dec 15, 2022
1k Dec 31, 2022
4 Jan 21, 2022
2 Jan 28, 2022
19 Sep 10, 2022
122 Nov 22, 2022
73 Nov 06, 2022
25.5k Jan 01, 2023
111 Dec 27, 2022