From 501a3c8a74c66a6efbf792ac6530acfa213c4983 Mon Sep 17 00:00:00 2001 From: Michal Bocek Date: Thu, 21 Feb 2019 14:11:34 +0000 Subject: [PATCH] Mention end to end tests in docs --- docs/tests.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/tests.md b/docs/tests.md index 604f090347..fe24054e9a 100644 --- a/docs/tests.md +++ b/docs/tests.md @@ -1,17 +1,22 @@ # Tests for actors -You can implement two types of tests for an actor in the leapp-repository - component and unit tests. +The Leapp actors are currently covered by three types of tests - unit, component and e2e. -## Component tests - - These tests provide fabricated input messages for the actor, check the outputs stated in the actor's description. - - These tests should not be written based on the actor's code but rather based on the behavior stated in the actor's description. Ideally they could be written by somebody who doesn't know the code. - - Example of a component test: https://github.com/oamg/leapp-repository/blob/master/repos/system_upgrade/el7toel8/actors/redhatsignedrpmcheck/tests/test_redhatsignedrpmcheck.py - -## Unit tests +## Unit and component tests +- Both unit and component tests are to be placed in the actor's _tests_ folder. +- Tutorial on how to write unit and component tests: https://leapp.readthedocs.io/en/latest/unit-testing.html + +### Unit tests - These tests deal with individual actor's functions/methods. - - You can't unit test any method/function within the actor.py. You can write unit tests only for the functions/methods within actor's libraries. - - Thus, to be able to write unit tests for an actor, ideally the only thing in the actor.py's _process()_ method is calling the entry-point function of the actor's library python module. - - Tutorial on how to write unit tests: https://leapp.readthedocs.io/en/latest/unit-testing.html + - Currently it's not possible to unit test any method/function within the *actor.py*. You can write unit tests only for functions/methods within the actor's libraries. + - Thus, to be able to write unit tests for an actor, ideally the only thing in the _actor.py_'s _process()_ method is calling the entry-point function of the actor's library python module. + - Example of unit tests: https://github.com/oamg/leapp-repository/blob/master/repos/system_upgrade/el7toel8/actors/checkbootavailspace/tests/unit_test.py + +### Component tests + - These tests provide fabricated input messages for the actor, check the outputs stated in the actor's description. + - These tests should not be written based on the actor's code but rather based on the behavior stated in the actor's description. They could be written by somebody who didn't write the code. + - Example of component tests: https://github.com/oamg/leapp-repository/blob/master/repos/system_upgrade/el7toel8/actors/checknfs/tests/test_checknfs.py +## End to end (e2e) tests -Both types of tests are to be placed in the actor's _tests_ folder. + - The QA team for the OAMG projects maintains an internal testing framework facilitating e2e tests.