Teach on Udemy

Turn what you know into an opportunity and reach millions around the world.

Learn More

Your cart is empty.

Keep shopping

PyTest Cookbook - Using hooks to create custom plugins

Name: PyTest Cookbook - Using hooks to create custom plugins
Rating: 5.0 (2 reviews)

Sort, rearrange, randomize and filter tests using hooks and create distributable plugins.

Created byCraig West

Last updated 6/2024

English

What you'll learn

Explore and understand PyTest hooks.
Create local plugins that order, group, select, add custom markers and more.
Create distributable plugins from local plugins.
Randomise order of tests. Select/deselect tests based on your criteria. Group tests based on custom criteria.
Create custom output report files or log directly to a database. Enable dynamic loading of data from database or files for parametrized queries.
Add color to your console test output. Learn now to view popular plugin code to get ideas and understanding.
Create distributable .whl files to share your plugin in many ways.

Course content

16 sections • 74 lectures • 4h 30m total length

Introduction8:22
About me and authenticity2:59
Who I am. A developer/tester who also studies courses and needs to learn new technologies. I teach very much as developer to develop, sharing what has helped me as well as acknowledging all that it 'does not get any easier - just different!
Structure of course6:23
The course is designed to be modular so that each section is self contained. You can start any where you like and references to early are made where possible.
The repo contains all the completed and highly-commented code as well as useful resources. acting as a sort pf 'ebook' as well as code reference.
Requirements0:06
Complete GitHub Repo0:02
Location of GitHub Repo0:15

Explanation of terminology used: MARKERS1:26
Explanation of terminology used: NODEID1:30
Explanation of terminology used: KEYWORDS2:18
Loggin in PyTest and the pytest.ini file2:59
We look at how logging is done in PyTest, the location and name of log file as well as the format of the log messages.
Passing in command line arguments - addoption1:20
We can pas in our own command line arguments using the pytest_addoption hook. We introduce this hook here and we will use this in Project 02.
Refresher on markers and the -strict-markers option.6:24
We will refresh ourselves with markers and how the --strict-markers option works.

Project 02 - contents0:46
We look at the contents of this project.
When might we add custom markers?1:34
Markers and the --strict-marker option4:37
We look at what happens if we turn on/off --strict-markers in pytest.ini along with having markers registered or not.
Create and add dynamically markers - introduction to project4:05
We can create and add markers dynamically based on code. This means we can carry out test suite organisation and management programmatically to save time, effort and errors.
Adding dynamic markers based on 'simple' and 'complex' in test name4:05
Testing our dynamic markers work3:11
We will now run the tests using the -m 'simple_marker' etc to check we get the corresponding selected tests only.
How can we name our tests and mark them to help with our hook functionality?2:34
We will look at how naming our tests can help us in creating more functionality with our hooks as well as how markers can help.
Use case from work2:52
We look at a real world case where someone wants a report of all tests we will be running - effectively our report of --collect-only rather than viewing this in the console.

Project 3 - Demo of all projects in this section6:04
We have a demo look at the three types of sorting - by test name, by makers and randomly.
Sort asc, desc or none - passing in CLI option with addoption3:14
We create the option to pass in two CLI flags --desc and --asc. If passed in, we sort al our tests by testname, either asc or desc or not at all depending on which flag, if any, has been passed in.
Using the pytest_collection_modifyitems again2:54
Once again we use the pytest_collection_modifyitems hook to mange the order of the tests.
Demo tests into 'first', 'last' and neither and run them first, ..., and last2:44
We can group our tests based on two custom markers - first and last. Tests will then be run in the order - first, others, last.
Splitting and reordering tests3:10
Splitting tests based on whether they have the 'first', 'last' or no markers and ordering them first-others-last.
Why we need to add markers dynamically2:51
We look at why we need to add markers dynamically to avoid any future warnings or errors based on pytest.ini setting.
How we get our custom CSV output for tests.4:30
What is xfail0:15
Why we get two reports and how to change this7:26
Sorting our tests with a simple random.shuffle(tests) algorithm3:45
We can use the pytest_collection_modifyitems to gather all our tests into a list. We can then shuffle this list using random.shuffle(tests). We can apply more complex randomising algorithms by using the techniques we have seen previously of grouping our tests and then randomising within these groups and then randomising the groups themselves.
Quick look at pytest-random-order to see a more complex randomise algorithm0:59
We take a quick look at another randomising alogorithm used in pytest-random-order

An example of using @pytest.mark.parametrize1:47
We look at a standard example of parametrized tests where we can test multiple data examples.
Using lists and tuples as input data4:31
Using CLI input to make our parametrized tests more configurable3:20
Using the pytest_addoption hook, we can pass in CLI arguments to customise our test run.
Passing in a CLI argument of a filename to generate tests from file data3:43
Using the pytest_addoption hook, we can pass in CLI arguments to reference a file with data.
Summary of section3:00
We summarise what we have learnt in this section.

Requirements

Intermediate Python and PyTest helpful. This is NOT a beginners course.

Description

In this course, we explore PyTest hooks so that we can modify our tests as well as create our own report files.

This is an intermediate and above course.

There is no code along but we work on completed templates, breaking and fixing to understand how they work.

We will learn to use hooks to:

Create a CSV output of teststhat will be run (like --collect-only). Project 01)
Add custom markers to tests dynamically to enable management of a large number of tests. (Project 02)
Order tests by name, markers and custom criteria. (Project 03)
Randomise order of tests. (Project 03)
Sort tests to run those with markers 'first' first, those with markers 'last, and the rest in the middle with a custom ordering, (Project 03)
Filter tests based on custom criteria dynamically. (Project 04)
Enable dynamic loading of data from code, database or files for parametrized queries. (Project 05)
Create distributable .whl (wheel) files to share your plugin in many ways using one of our custom sorting hooks that sorts test by test name alphabetically in asc or desc with the use of --asc and --desc CLI flags that we built in Project 03.
Learn now to view popular plugin code to get ideas and understanding. We can learn a lot as well as customise already made plugins.
Save properties recorded in tests for use in our final report. (Project 06 and 07)
Create stunning test result console output with emojis, panels and colours! (Project 08)
Learn now to view popular plugin code to get ideas and understanding. We can learn a lot as well as customise already made plugins.

Create distributable plugins:

Create distributable .whl (wheel) files to share your plugin in many ways using one of our custom sorting hooks that sorts test by test name alphabetically in asc or desc with the use of --desc CLI flag that we built in Project 02.

This course assumes intermediate knowledge of Python and PyTest and the use of pip installations. It is not a beginner's course.

There are many hooks or entry points when we run PyTest and by using these we can modify how PyTest runs.

We will learn how to package our hooks into distributable plugins that can be uploaded to PyPi or distributed as .whl files.

Please note!

I do not do a code along.

There are advantages to this and I myself do like following videos with this style.

However, for speed and efficiency, I provide all the source code so we can focus on understanding why the code works rather than just getting it to work.

Methodology:

We will break and fix the code so that we can see what is happening and it also means you will have ready made plugins to modify to your own requirements.

We will go though the 'whys?' of the code and learn how use the docs to get more information.

Each project has written notes to help understand and use them and you will have ready made plugins to go! All you need to do is modify them and use them

I have really enjoyed researching and developing this course and is the course I have wanted.

Complete final source code that is highly commented along with markdown notes to provide an 'ebook'.

Let's start building plugins and leverage the power of PyTest!

Who this course is for:

Python devs/testers who want to go deeper into PyTest.

PyTest Cookbook - Using hooks to create custom plugins

What you'll learn

Explore related topics

Course content

Introduction6 lectures • 18min

Environment setup2 lectures • 4min

Some fundamental concepts to help in creating custom hooks6 lectures • 16min

Understanding Hooks3 lectures • 11min

Project 01 - Output to CSV a list of tests that will run without running tests4 lectures • 13min

Project 2 - Adding custom markers dynamically8 lectures • 24min

Project 3- Sorting and randomising tests11 lectures • 38min

Project 4 - Filtering tests based on custom criteria3 lectures • 8min

Project 5 - How to load data from other sources to be used in parametrization5 lectures • 16min

Project 6 - Use the configure hook to set up initial values1 lecture • 5min

Requirements

Description

Who this course is for: