Skip to content

pytest_configure_hook

This module contains the PytestConfiguration class which is used to handle the configuration of a pytest session.

It includes methods to initialize the configuration, get the worker ID, get the number of nodes, and execute the configuration hook.

PytestConfiguration

A class that handles the configuration of a pytest session.

Attributes:

Name Type Description
logger Logger

The logging object.
config Config

The pytest config object.
worker_id str

The worker ID.
session_store SessionStore

The session store object.

Methods:

Name Description
__init__

Initializes the PytestConfiguration class.
__init_configure

Initializes the configuration.
worker

Returns the worker ID.
nodes

Returns the number of nodes.
configure_hook

Executes the configuration hook.
Source code in libs\cafex_core\src\cafex_core\utils\hooks_\pytest_configure_hook.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class PytestConfiguration:
    """A class that handles the configuration of a pytest session.

    Attributes:
        logger (Logger): The logging object.
        config (Config): The pytest config object.
        worker_id (str): The worker ID.
        session_store (SessionStore): The session store object.

    Methods:
        __init__: Initializes the PytestConfiguration class.
        __init_configure: Initializes the configuration.
        worker: Returns the worker ID.
        nodes: Returns the number of nodes.
        configure_hook: Executes the configuration hook.
    """

    def __init__(self, config_):
        """Initialize the PytestConfiguration class.

        Args:
            config_: The pytest config object.
        """
        self.logger = None
        self.config = config_
        self.worker_id = self.worker
        self.workers_count = self.worker_nodes_count
        self.session_store = None
        self.__init_configure()

    def __init_configure(self):
        """Initialize the configuration by setting up the necessary components.

        Initialize the configuration by setting up the necessary
        components.
        """
        self.session_store = SessionStore()
        self.session_store.worker_id = self.worker_id
        self.session_store.workers_count = self.workers_count
        self.logger_class = CoreLogger(name=None)
        self.logger = self.logger_class.get_logger()
        self.logger_class.initialize(True, self.session_store.logs_dir, self.worker_id)

    @property
    def worker(self):
        """Returns the worker ID.

        Returns:
            str: The worker ID.
        """
        worker_id = os.environ.get("PYTEST_XDIST_WORKER", "master")
        return worker_id

    @property
    def worker_nodes_count(self):
        """Returns the worker nodes.

        Returns:
            int: The worker ID.
        """
        nodes_ = self.config.getoption("numprocesses")
        num_nodes_ = 0 if nodes_ is None else nodes_
        os.environ["numprocesses"] = str(num_nodes_)
        return num_nodes_

    def configure_hook(self):
        """Executes the configuration hook.

        It logs the configuration event, sets the session store
        attributes, and initializes a defaultdict for the globalDict
        attribute.
        """
        self.logger.info("PytestConfigure")
        self.session_store.driver = None
        self.session_store.mobile_driver = None
        self.session_store.counter = 1
        self.session_store.datadriven = 1
        self.session_store.rowcount = 1
        self.session_store.is_parallel = None
        self.session_store.globals = {}
        self.session_store.ui_scenario = False
        self.session_store.mobile_ui_scenario = False
        env_path = os.path.join(self.session_store.conf_dir, ".env")
        load_dotenv(env_path)

worker property

Returns the worker ID.

Returns:

Name Type Description
str

The worker ID.

worker_nodes_count property

Returns the worker nodes.

Returns:

Name Type Description
int

The worker ID.

__init__(config_)

Initialize the PytestConfiguration class.

Parameters:

Name Type Description Default
config_

The pytest config object.

 required
Source code in libs\cafex_core\src\cafex_core\utils\hooks_\pytest_configure_hook.py 
33
34
35
36
37
38
39
40
41
42
43
44
def __init__(self, config_):
    """Initialize the PytestConfiguration class.

    Args:
        config_: The pytest config object.
    """
    self.logger = None
    self.config = config_
    self.worker_id = self.worker
    self.workers_count = self.worker_nodes_count
    self.session_store = None
    self.__init_configure()

__init_configure()

Initialize the configuration by setting up the necessary components.

Initialize the configuration by setting up the necessary components.

Source code in libs\cafex_core\src\cafex_core\utils\hooks_\pytest_configure_hook.py 
46
47
48
49
50
51
52
53
54
55
56
57
def __init_configure(self):
    """Initialize the configuration by setting up the necessary components.

    Initialize the configuration by setting up the necessary
    components.
    """
    self.session_store = SessionStore()
    self.session_store.worker_id = self.worker_id
    self.session_store.workers_count = self.workers_count
    self.logger_class = CoreLogger(name=None)
    self.logger = self.logger_class.get_logger()
    self.logger_class.initialize(True, self.session_store.logs_dir, self.worker_id)

configure_hook()

Executes the configuration hook.

It logs the configuration event, sets the session store attributes, and initializes a defaultdict for the globalDict attribute.

Source code in libs\cafex_core\src\cafex_core\utils\hooks_\pytest_configure_hook.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def configure_hook(self):
    """Executes the configuration hook.

    It logs the configuration event, sets the session store
    attributes, and initializes a defaultdict for the globalDict
    attribute.
    """
    self.logger.info("PytestConfigure")
    self.session_store.driver = None
    self.session_store.mobile_driver = None
    self.session_store.counter = 1
    self.session_store.datadriven = 1
    self.session_store.rowcount = 1
    self.session_store.is_parallel = None
    self.session_store.globals = {}
    self.session_store.ui_scenario = False
    self.session_store.mobile_ui_scenario = False
    env_path = os.path.join(self.session_store.conf_dir, ".env")
    load_dotenv(env_path)