Pytest

Enable Pytest for your project

1. Open the Settings/Preferences | Tools | Python Integrated Tools settings dialog as described in Choose your testing framework.

2. In the Default test runner field select pytest.

3. Click OK to save the settings.

Create a test

1. Create a Python project.

2. From the main menu, click File | New, choose Python file, type Car.py, and click OK.

3. Copy and paste the Car sample into the Car.py file.

4. In the editor, place the caret at the brake method declaration.

5. Do one of the following:

   • From the main menu, choose Navigate | Test.

   • From the context menu, choose Go To | Test.

     

   • Press Ctrl+Shift+T.

   PyCharm shows the list of available tests.

   

6. Click Create new test.

   The Create Test dialog opens.

   

   In the Create Test dialog, specify the following settings:

   • Target directory, where the new test class will be generated.

   • The name of the test file (in our example, test_car_pytest.py), and the name of the test class if needed.

   • Select the checkboxes next to the methods you want to include in the test class.
     Note that if you place the caret within a method, only this method name is included in the list. Also, mind the naming convention: the test method has the test prefix. The Run Test icon will appear in the editor gutter for all methods with such a prefix.

7. Click OK when ready. PyCharm generates the test file in the specified location.

8. PyCharm automatically generates a test file with the test method template. Replace the template code with the code that sets the initial speed value of Car to 50 and checks if speed gets properly set to 45 after the brake() function execution.

   from Car import Car def test_car_brake(): car = Car(50) car.brake() assert car.speed == 45

Run a test

1. Click to run the test:

   

2. Note that PyCharm automatically creates a pytest Run/Debug configuration:

   

   Select Run pytest for test_car_pytest to execute the test.

3. Inspect test results:

   

4. Alter the assert statement to the following: assert my_car.speed == 4599.

5. Rerun the test to evaluate the assert failing report:

   

   Note that pytest provides an explicit report on the failure.

Use fixtures

1. Modify your Car pytest test as follows:

   import pytest from Car import Car @pytest.fixture def my_car(): return Car(50) def test_car_accelerate(my_car): my_car.accelerate() assert my_car.speed == 55 def test_car_brake(my_car): my_car.brake() assert my_car.speed == 45

   my_car() is a fixture function that creates a Car instance with the speed value equal to 50. It is used in test_car_accelerate and test_car_brake to verify correct execution of the corresponding functions in the Car class.

   Note that the my_car fixture is added to the code completion list along with other standard pytest fixtures, such as tempdir.

   

2. Click either of the icons, or run the entire test module.

Apply parametrization

1. Let us create a set of speed values to test car.accelerate and car.brake functions: speed_data = {45, 50, 55, 100}

2. Modify the test code to the following:

   import pytest from Car import Car speed_data = {45, 50, 55, 100} @pytest.mark.parametrize("speed_brake", speed_data) def test_car_brake(speed_brake): car = Car(50) car.brake() assert car.speed == speed_brake @pytest.mark.parametrize("speed_accelerate", speed_data) def test_car_accelerate(speed_accelerate): car = Car(50) car.accelerate() assert car.speed == speed_accelerate

   Note that PyCharm detects the newly created parameters and adds them to the completion list.

   

3. Run the test for the car.brake() function. You should expect the following test report:

   

You can also run the test for car.accelerate() function to ensure that it fails for all speed values but 55. Refer to pytest documentation for more information about parametrized tests.

Implement test scenarios

This procedure is applicable only for PyCharm Professional.

1. Let us modify the Car sample to validate the car's speed. Add the following function to the Car.py file:

   def speed_validate(self): return self.speed <= 160

2. Next, enable pytest-bdd in your project. In the Settings/Preferences dialog Ctrl+Alt+S, navigate to Languages & Frameworks | BDD, and from the Preferred BDD framework list select pytest-bdd.

3. Create a .feature file to record BDD scenarios using the Gherkin language. Right-click the project root and select New | Gherkin feature file. In the opened dialog, specify car.feature as the filename and click OK.

4. Add the following scenarios to the car.feature file:

   Feature: Speed Scenario: Valid speed Given Speed is less than 160 When Accelerated Then Speed is valid Scenario: Invalid speed Given Speed is more than 160 When Accelerated Then Speed is invalid

   Both scenarios validate the speed of the car. The speed is supposed to be valid when it does not exceed the value of 160. Note the scenario steps are highlighted because they are not defined by this moment.

   

5. PyCharm enables quick generation of step definitions for the entire feature file. Set cursor on any of the highlighted steps, click Ctrl+Shift+A, and select Create all step definitions. In the opened dialog, specify the name of the test file (it should start with test), select Python (pytest-bdd) from the File type list, and, if needed, modify the default file location.

   

   Inspect the test_car_pytest_bdd_fixture.py file. It contains all required import statements and definitions for each scenario steps.

6. Let us modify the test file to use a pytest fixture for a Car object and to add more test logic:

   from pytest_bdd import scenario, given, when, then import pytest from Car import Car @pytest.fixture def my_car(): return Car() @scenario('car.feature', 'Valid speed') def test_speed_valid(): pass @scenario('car.feature', 'Invalid speed') def test_speed_invalid(): pass @given("Speed is less than 160") def set_valid_speed(my_car): my_car.speed = 50 @given("Speed is more than 160") def set_invalid_speed(my_car): my_car.speed = 100 @when("Accelerated") def car_accelerate(my_car): my_car.accelerate() @then("Speed is valid") def success(my_car): assert my_car.speed_validate() @then("Speed is invalid") def fail(my_car): assert not my_car.speed_validate()

7. Run the test by creating the corresponding Run/Debug configuration. You can also run either of the scenarios using the Run icon in the gutter.

8. Inspect the test run results.

   

   In our example, we have the test_speed_valid test passed and the test_speed_invalid test failed.