Py.test - Splitting conftest file

If you have to maintain a massive project, you probably have many fixtures in conftest file. And there is a problem; this file grows and grows. So, at some point, you decide to split this huge file into smaller files. But, py.test has to know the fixtures are keeping in these files.

So, what you can do? I see three patterns here for this:
  • import these guys inside conftest.py file
  • create more conftest.py files
  • use pytest_plugins

Import fixtures inside conftest file


You can for example do this: 
1
2
3
4
5
6
7
8
9
from tests.my_fixtures.fixs1 import (
    fix11, fix12, fix13, fix14, fix15, ...
)
from tests.my_fixtures.fixs2 import (
    fix21, fix22, fix23,
)
from tests.my_fixtures.fixs3 import (
    fix31, fix32, fix33
)

But, there are some problems with this approach. You import them in an explicit way, so if you create a new fixture, you have to remember to add this guy in the import clause. So, this strategy is not the best solution. If you have many files with fixtures, it might hurt you. Every developer will have to remember that he/she has to append this fixture here.

Hence, you can import all of them:
1
2
3
from tests.my_fixtures.fixs1 import *
from tests.my_fixtures.fixs2 import *
from tests.my_fixtures.fixs3 import *

But, I don't think it is a good practice. For example, you can encounter some problems with pyflakes.

Create more conftest files


You could also create more conftest files. A straightforward solution is to separate tests for example into unit/integrations/ui and keep conftest files there.

For example: 
1
2
3
tests/ui/conftest.py
tests/unit/conftest.py
tests/integration/conftest.py

Ok, but what if these files are still large? You want to split them again... We've discovered recently that we can use pytest_plugins for this.

Use pytest_plugins


How py.test discovers plugins (here's more info)?
  1. by loading all built-in plugins
  2. by loading all plugins registered through setuptools entry point
  3. by pre-scanning the command line for the -p name option
  4. by loading all conftest.py files
  5. by recursively loading all plugins specified by the pytest_plugins variable in conftest.py files
Look at the fifth item; you can load your fixtures by the pytest_plugins variable. You just have to add the pytest_plugins variable to your conftest.py file.

Let's say you had many fixtures in UI tests (in a conftest.py file). You split them into smaller modules, and now you want to have access to all of them during tests.

Here's example: 
1
2
3
4
5
6
7
8
pytest_plugins = [
    ...
    'tests.ui.fixtures.user_fixtures',
    'tests.ui.fixtures.admin_fixtures',
    'tests.ui.fixtures.template_fixtures',
    'tests.ui.fixtures.free_account_fixtures',
    ...
]

If you create a new module with new fixtures, you have to add this guy here, but I think it is not a problem.

Comments

Post a Comment

Popular posts from this blog

GitLab - extends keyword

Image
In the previous post I had written about the include keyword. Now, let's dive in the extends  keyword. What can you do with this? Here is the definition from GitLab documentation: extends defines entry names that a job that uses extends inherits from. It’s an alternative to using YAML anchors and is a little more flexible and readable. So, when is it useful? It is useful when you want to be DRY and keep your setup cleanly. Let's assume that you want to build a docker image and give developers possibility to deploy the image on dev , staging and prod environments. We are going to do that without the extends keyword, and after that we will think how we can do it better. Example without the extends  keyword: As you can see, there is a lot of code which repeats itself: stage, image, when  and script . We can remove a lot of code! So, let's do that. We are going to create a hidden job .deploy  (you will not see this job in a pipeline) and the rest of the jobs ...
Read more

Managing Secrets in GitLab / Git

Image
Let's say that you have to log in via ssh into an instance, and you work with GitLab, so you want to keep the private key in GitLab somewhere. Is it secure? Let's see! Custom environment variables You can use custom environment variables. Here you can read more about them (Developers cannot change them, only Maintainers and Owners can). There are two types of variables: Variable (the runner creates an environment variable that uses the key for the name and the value for the value) File (the runner creates an environment variable that uses the key for the name. For the value, the runner writes the variable value to a temporary file and uses this path) It seems that we can use File type for our purpose. We can set up it via API or UI . So, let's do that! Go to project's Settings > CI/CD . There will be Variables section (btw, you can specify variables also per group and even for all projects (in admin panel)). Click Add Variable button and add a variable: Key: ...
Read more

GitLab - trigger keyword

Image
 We are going to talk about the trigger keyword today. With this feature you can define a downstream pipeline trigger. So, you can trigger a pipeline in any project (you must have access to this project of course). There are two types of downstream pipelines: multi-project pipelines child pipelines  Let's omit child pipelines and have a look at multi-project pipelines. It is very easy to use. You just need to provide a path to the project and that's it. Remember that you only can trigger a pipeline, not a job ! You can also provide more information like environment variables. As always, I am going to provide some examples, so you will understand it better. The first example: you want to trigger a pipeline in another project after the deployment of your service/s. How to do that? Here we want to trigger this pipeline (project my/run-tests ). Let's say that we want to run some tests after each deployment: We need to add the job which will trigger this pipeline in my/run-...
Read more