Skip to content

unittest

dev_tool.services.unittest

__all__ = ['UnitTestService'] module-attribute

UnitTestService

Bases: BaseService

A service class for running unit tests.

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

The constructor for the UnitTestService class.

Parameters:

  • config (dict[str, Any]) –

    The configuration dictionary for unit test settings.

  • runner (CommandRunnerProtocol) –

    The command runner for executing commands.

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

    :param config: The configuration dictionary for unit test settings.
    :param runner: The command runner for executing commands.
    """

    super().__init__()

    self._runner = runner
    self.set_config(config or {})

runner property

A property that returns the command runner.

Returns:

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 
55
56
57
58
59
60
61
62
63
64
65
66
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 
 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
125
126
127
128
@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.
    """

    """A method that runs unit tests for Python projects (including Django)."""

    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 Django unit tests...'
    self.notification.normal_text(message)

    command = ['-m', 'pytest', *self.apps, '-v']

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

    try:
        self.runner.run_python_command(command, check=True)
    except Exception as exception:
        message = 'Failed to run Python unit tests'
        log.exception(message)

        raise PythonTestError(message) from exception

run_javascript_unittest

A method that runs JavaScript unit tests.

Source code in dev_tool/services/unittest/service.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def run_javascript_unittest(self) -> None:
    """A method that runs JavaScript unit tests."""

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

    apps = self.config.get('js_apps', ['tests/js'])

    command = ['test', *apps]

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

    try:
        self.runner.run_bun_command(command, check=False)
    except Exception as exception:
        message = 'Failed to run JavaScript unit tests'
        log.exception(message)

        raise JavascriptTestError(message) from exception

run_python_unittest

A method that runs unit tests for Python projects.

Source code in dev_tool/services/unittest/service.py 
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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:
        self.runner.run_python_command(command, check=True)
    except Exception as exception:
        message = 'Failed to run Python unit tests'
        log.exception(message)

        raise PythonTestError(message) from exception

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 
187
188
189
190
191
192
193
194
195
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]