Skip to content

Commit fd60d47

Browse files
phlogistonjohnmergify[bot]
authored andcommitted
tox.ini: Add descriptions to various tox envs
Add descriptions to our various tox environments and make `tox list` look nice and provide useful hints. Signed-off-by: John Mulligan <[email protected]>
1 parent 80ff5f5 commit fd60d47

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

tox.ini

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ envlist = formatting, {py3,py39}-mypy, py3, py39, schemacheck, py3-sys
44
isolated_build = True
55

66
[testenv]
7+
description = Run unit tests
78
passenv =
89
WRITABLE_PASSWD
910
NSS_WRAPPER_PASSWD
@@ -17,6 +18,7 @@ commands =
1718
py.test -v --cov=sambacc --cov-report=html {posargs:tests}
1819

1920
[testenv:{py3,py39}-mypy]
21+
description = Run mypy static checker tool
2022
deps =
2123
mypy
2224
types-setuptools
@@ -28,6 +30,7 @@ commands =
2830
mypy sambacc tests
2931

3032
[testenv:py3-sys]
33+
description = Run unit tests with system packages to validate Samba integration
3134
# py3-sys -- more like sisyphus, am I right?
3235
#
3336
# In order to run tests that rely on "system level" packages (samba,
@@ -48,6 +51,7 @@ allowlist_externals =
4851
/usr/bin/py.test
4952

5053
[testenv:formatting]
54+
description = Check the formatting for the source files
5155
deps =
5256
flake8
5357
black>=23, <24
@@ -56,6 +60,7 @@ commands =
5660
black --check -v .
5761

5862
[testenv:schemacheck]
63+
description = Check the JSON Schema files are valid
5964
deps =
6065
black>=23, <24
6166
PyYAML
@@ -71,6 +76,7 @@ setenv =
7176
MULTIDICT_NO_EXTENSIONS=1
7277

7378
[testenv:schemaupdate]
79+
description = Regenerate source files from JSON Schema file(s)
7480
deps =
7581
black>=23, <24
7682
PyYAML
@@ -80,6 +86,7 @@ commands =
8086
# this gitlint rule is not run by default.
8187
# Run it manually with: tox -e gitlint
8288
[testenv:gitlint]
89+
description = Check the formatting of Git commit messages
8390
deps =
8491
gitlint==0.19.1
8592
commands =

0 commit comments

Comments
 (0)