Dans pytest, qu'est-ce que l'utilisation de conftest.py fichiers?

Est-ce la bonne utilisation de conftest.py?

Oui, il est. Les sanitaires sont un potentiel et l'utilisation commune de conftest.py. L'
les accessoires qui vous permettront de définir sera partagé entre tous les tests dans votre suite de tests. Toutefois, la définition de luminaires à la racine conftest.py peut être inutile et il serait de ralentir le test si ces appareils ne sont pas utilisés par tous les tests.

- T-il d'autres utilisations?

Oui, c'est fait.

• Luminaires: Définir des accessoires pour les données statiques utilisés par les tests. Ces données peuvent être accessibles par tous les tests dans la suite, sauf indication contraire. Cela peut être des données ainsi que les aides de modules qui seront transmises à tous les essais.

• De plugins externes de chargement: conftest.py est utilisé pour importer des plugins externes ou des modules. En définissant la variable globale suivante, pytest va charger le module et de le rendre disponible pour son test. Les Plugins sont généralement des fichiers définis dans votre projet ou à d'autres modules qui pourraient être nécessaires dans vos tests. Vous pouvez également charger un ensemble prédéfini de plugins comme expliqué ici.

  pytest_plugins = "someapp.someplugin"

• Crochets: Vous pouvez spécifier des crochets comme le programme d'installation et les méthodes de démontage et beaucoup plus pour améliorer vos tests. Pour un ensemble de crochets disponibles, lire ici. Exemple:

  def pytest_runtest_setup(item):
       """ called before ``pytest_runtest_call(item). """
       #do some stuff`

• Test du chemin de la racine: C'est un peu une fonctionnalité cachée. Par définition conftest.py dans la racine de votre chemin, vous aurez pytest de la reconnaissance de vos modules de l'application, sans préciser PYTHONPATH. Dans le fond, py.test modifie votre sys.path en incluant tous les submodules qui sont trouvés sur le chemin de la racine.

Puis-je avoir plus d'un conftest.py fichier?

Oui, vous pouvez et il est fortement recommandé si votre test de structure est un peu complexe. conftest.py les fichiers d'un répertoire portée. Par conséquent, la création ciblée des luminaires et des aides est de bonne pratique.

Quand je veux le faire? Des exemples seront appréciées.

Plusieurs cas peuvent s'adapter:

La création d'un ensemble d'outils ou de crochets pour un groupe particulier de tests.

root/mod/conftest.py

def pytest_runtest_setup(item):
    print("I am mod")
    #do some stuff


test root/mod2/test.py will NOT produce "I am mod"

Chargement d'un ensemble de luminaires pour certains tests, mais pas pour les autres.

root/mod/conftest.py

@pytest.fixture()
def fixture():
    return "some stuff"

root/mod2/conftest.py

@pytest.fixture()
def fixture():
    return "some other stuff"

root/mod2/test.py

def test(fixture):
    print(fixture)

Imprimé "quelques autres trucs".

Primordial crochets hérité de la racine conftest.py.

root/mod/conftest.py

def pytest_runtest_setup(item):
    print("I am mod")
    #do some stuff

root/conftest.py

def pytest_runtest_setup(item):
    print("I am root")
    #do some stuff

Par un test à l'intérieur de root/mod, seulement "je suis le mod" est imprimé.

Vous pouvez en lire plus à propos de conftest.py ici.

EDIT:

Que faire si j'ai besoin de plain-vieille fonctions d'assistance pour être appelé à partir d'un certain nombre
des tests dans les différents modules seront - elles disponibles pour moi si j'ai mis
dans un conftest.py? Ou devrais-je simplement les mettre dans un helpers.py
module à l'importation et à l'utiliser dans mes modules de test?

Vous pouvez utiliser conftest.py pour définir vos aides. Cependant, vous devez suivre la pratique courante. Les accompagnateurs peuvent être utilisés comme des appareils à moins de pytest. Par exemple, dans mes tests, j'ai une maquette redis helper qui, je l'injecter dans mes tests de cette façon.

root/helper/redis/redis.py

@pytest.fixture
def mock_redis():
    return MockRedis()

root/tests/stuff/conftest.py

pytest_plugin="helper.redis.redis"

root/tests/stuff/test.py

def test(mock_redis):
    print(mock_redis.get('stuff'))

Ce sera un module de test que vous pouvez importer librement dans vos tests. NOTE que vous pourriez potentiellement nom redis.py comme conftest.py si votre module redis contient plus de tests. Cependant, cette pratique est déconseillée en raison de l'ambiguïté.

Si vous souhaitez utiliser conftest.py, vous pouvez simplement mettre de l'aide à la racine de votre conftest.py et de l'injecter en cas de besoin.

root/tests/conftest.py

@pytest.fixture
def mock_redis():
    return MockRedis()

root/tests/stuff/test.py

def test(mock_redis):
    print(mock_redis.get(stuff))

Une autre chose que vous pouvez faire est d'écrire un " plugin. Dans ce cas, votre aide peut être écrit n'importe où, mais il a besoin de définir un point d'entrée pour être installé dans votre possibles et d'autres frameworks de test. Voir cette.

Si vous ne voulez pas utiliser luminaires, vous pouvez bien entendu définir une simple aide et de l'utilisation juste de la plaine de vieux importation partout où elle est nécessaire.

root/tests/helper/redis.py

class MockRedis():
    # stuff

root/tests/stuff/test.py

from helper.redis import MockRedis

def test():
    print(MockRedis().get(stuff))

Cependant, ici, vous pourriez avoir des problèmes avec le chemin d'accès depuis le module n'est pas dans un dossier enfant du test. Vous devriez être en mesure de surmonter cette (pas testé) par l'ajout d'une __init__.py pour votre aide

root/tests/helper/__init__.py

from .redis import MockRedis

Ou simplement en ajoutant le module d'aide pour votre PYTHONPATH.

- Je utiliser le conftest.py fichier pour définir les appareils que j'ai injecter dans mes tests, est-ce la bonne utilisation de conftest.py?

Oui, un appareil est habituellement utilisé pour obtenir les données prêt pour les tests multiples.

- T-il d'autres utilisations?

Oui, un appareil est une fonction qui est exécutée par pytest avant, et parfois
après, l'effectif des fonctions de test. Le code dans le luminaire pouvez faire ce que vous
le souhaitez. Par exemple, un appareil peut être utilisé pour obtenir un ensemble de données pour les tests de travailler sur, ou un appareil peut également être utilisé pour obtenir un système dans un état connu avant l'exécution d'un test.

Puis-je avoir plus d'un conftest.py fichier? Quand aurais-je envie de faire?

Tout d'abord, il est possible de mettre les appareils en test individuel fichiers. Cependant, à part les agencements entre plusieurs fichiers de test, vous devez utiliser un conftest.py fichier quelque part idéalement situé pour tous les tests. Les luminaires peuvent être partagées par toute épreuve. Ils peuvent être mis dans les différents fichiers de test si vous voulez de l'appareil pour être utilisé uniquement par des tests dans ce fichier.

Deuxième, oui, vous pouvez avoir d'autres conftest.py fichiers dans des sous-répertoires de haut répertoire tests. Si vous le faites, luminaires définis dans ces bas-niveau conftest.py fichiers seront disponibles pour des essais dans ce répertoire et sous-répertoires.

Enfin, de mettre des accessoires dans la conftest.py fichier à la racine de test permettront de les rendre disponibles dans tous les fichiers de test.