Skip to content

Generate boilerplate unittests from given package. Ensures each class or function has a corespondent test.

Notifications You must be signed in to change notification settings

licenseware/lestest

Repository files navigation

Lestest

Generate boilerplate unittests from given package. Ensures each class or function has a corespondent test.

Install

pip3 install git+https://git@github.com/licenseware/lestest.git

Generate boilerplate tests

From the command line to generate unittest with pytest and tox type:

$ lestest --package app

Where app is the package for which we need the unittests created.

The above command will search in the current folder python packages from which it will generate boilerplate tests in the tests folder.

The boilerplate test generated will contain the import for the class or function found in the package and the test function which will trigger the test.

Trimmed down version of the boilerplate test file:

# test_function_name.py
import pytest
from package.module import function_name


def test_function_name():

    function_name()

Package lestest will try to generate some mock parameters based on the function/class parameters and provide a default assertion based on the response type. Objects marked as private (_func) will be excluded from test generation.

Try to use types as much as posible, this way you will have less work to do in the test.

If you create new functions just run lestest generate and those will have a new coresponded test case.

Run tests

Tests can be triggered with make run-tests. After the test completes you will get also the test coverage.

Developing

  • clone the repository;
  • install virtualenv: pip3 install virtualenv;
  • create virtualenv: virtualenv ./;
  • activate virtualenv: source ./bin/activate;
  • install dependencies: pip3 install -r requirements.txt;
  • run tests: python3 -m unittest tests/test_*;
  • or run tests with coverage: coverage run --source=lestest -m unittest tests/test_*;
  • generate html files to see coverage details: coverage html;
  • see coverage details in the terminal: coverage report -m;
  • create coverage badge from coverage created: coverage-badge -o coverage.svg;
  • shortcut for running tests: make run-tests;
  • install lestest wheel: make install;
  • uninstall lestest: make uninstall;
  • build lestest wheel: make build;

About

Generate boilerplate unittests from given package. Ensures each class or function has a corespondent test.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published