Skip to content

service

dev_tool.services.unittest.service

log = logging.getLogger(__name__) module-attribute

UnitTestService

Bases: BaseService

A service class for running unit tests.

This class provides methods for running tests for both Django and Python projects.

The constructor for the UnitTestService class.

Parameters:

  • config (dict[str, Any]) –

    The configuration dictionary for unit test settings.

Source code in dev_tool/services/unittest/service.py 
31
32
33
34
35
36
37
38
39
40
def __init__(self, config: dict[str, Any]) -> None:
    """
    The constructor for the UnitTestService class.

    :param config: The configuration dictionary for unit test settings.
    """

    super().__init__()

    self.set_config(config or {})

set_config

A method that sets the configuration for the unit test service.

Parameters:

  • config (dict[str, Any]) –

    The configuration dictionary containing test settings.

Source code in dev_tool/services/unittest/service.py 
42
43
44
45
46
47
48
49
50
51
52
53
def set_config(self, config: dict[str, Any]) -> None:
    """
    A method that sets the configuration for the unit test service.

    :param config: The configuration dictionary containing test settings.
    """

    self.config = config
    self.apps = self.config.get('apps', ['.'])
    self.settings = self.config.get('settings', 'system.testing.settings')
    self.failfast = self.config.get('failfast', False)
    self.keepdb = self.config.get('keepdb', True)

run_django_unittest

A method that runs unit tests for Django projects.

This method requires Django settings to be properly configured.

Source code in dev_tool/services/unittest/service.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
@is_settings
def run_django_unittest(self) -> None:
    """
    A method that runs unit tests for Django projects.

    This method requires Django settings to be properly configured.
    """

    if not self.apps:
        message = 'No apps to test.'
        self.notification.warning_text(message)

        log.debug(message)
        return

    self._validate_directories(self.apps, DjangoTestError)

    message = 'Running Django unit tests...'
    self.notification.normal_text(message)

    apps = list(self.apps) if self.apps else '.'

    command = [
        'manage.py',
        'test',
        *apps,
        f'--settings={self.settings}',
        '-v', '2'
    ]

    if self.failfast:
        command.append('--failfast')

    if self.keepdb:
        command.append('--keepdb')

    try:
        subprocess.run(self.with_venv(command), check=False)
    except Exception:
        message = 'Failed to run Django unit tests'
        log.exception(message)

        raise DjangoTestError(message) from None

run_python_unittest

A method that runs unit tests for Python projects.

Source code in dev_tool/services/unittest/service.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def run_python_unittest(self) -> None:
    """A method that runs unit tests for Python projects."""

    if not self.apps:
        message = 'No test directory specified.'
        self.notification.warning_text(message)

        log.debug(message)
        return

    self._validate_directories(self.apps, PythonTestError)

    message = 'Running Python unit tests...'
    self.notification.normal_text(message)

    apps = list(self.apps)

    command = [
        '-m',
        'unittest',
        'discover',
        '-s', *apps,
        '-v'
    ]

    if self.failfast:
        command.append('--failfast')

    try:
        subprocess.run(self.with_venv(command), check=False)
    except Exception:
        message = 'Failed to run Python unit tests'
        log.exception(message)

        raise PythonTestError(message) from None

with_venv

A method that prepends the virtual environment Python to a command.

Parameters:

  • command (list[str]) –

    The command to modify.

Returns:

  • list[Path | str] –

    The modified command with virtual environment Python.

Source code in dev_tool/services/unittest/service.py 
162
163
164
165
166
167
168
169
170
def with_venv(self, command: list[str]) -> list[Path | str]:
    """
    A method that prepends the virtual environment Python to a command.

    :param command: The command to modify.
    :return: The modified command with virtual environment Python.
    """

    return [VENV_PYTHON, *command]