py-rcsb_exdb/tox.ini at master · rcsb/py-rcsb_exdb · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
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
129
130
131
132
133
134
135
# File: tox.ini (Templated version)
#
[local_settings]
# project specific local settings
test_pattern_1 = "test*.py"
#
fixture_pattern_1 = "fixtureD*.py"
fixture_pattern_2 = "fixtureP*.py"
#
# Source pathls (unquoted and space separated list of files/directories) for linting and format checks
source_paths = rcsb/exdb
#
# Start directory path for test discovery
# Each path must reference valid directory that is searchable by Python (i.e. contains __init__.py)
#  ** It is harmless to point to paths containing no tests.
#
fixture_path_1 = "rcsb/exdb/tests"
# fixture_path_2 = ""
test_path_1 = "rcsb/exdb/tests"
# These are placeholders valid source directories without tests files
# test_path_2 = ""
#
# Comma separate list of directories for which test coverage will be evaluated
coverage_source_paths = "rcsb/exdb"
coverage_exclude_paths = "rcsb/exdb/cli/*,rcsb/exdb/examples-seq/*"
coverage_cutoff = 75
#
## --------------------------------------------------------------------------
##  ----------   No project specific setting beyond this point --------------
# Updated:  3-Jul-2019 jdw Cleanup
#           8-Jul-2019 jdw Disable flake8 plugin (pydocstyle compat issue)
#          12-Jul-2019 jdw Add placeholders for up to four test paths
#          13-Jul-2019 jdw Add coverage exclusion
#           4-Sep-2019 jdw Add fixture option to establish cache state
#           4-Sep-2019 jdw Add support for multiple fixtures (3)
#          11-Dec-2019 jdw Py38 version
#           9-Jan-2023 aae updates for tox 4
#          16-Oct-2024 dwp Py310
#
##
[tox]
# The complete list of supported test environments to setup and invoke
envlist = format_pep8-{py312}, lint_pylint-{py312}, format_black-{py312}, py{312}, test_coverage-{py312}
#
minversion = 3.4.0
skip_missing_interpreters = true
skipsdist = false

[testenv]
passenv = CONFIG_SUPPORT_TOKEN_ENV,OE_LICENSE,PIP_EXTRA_INDEX_URL
allowlist_externals = echo
commands =
    echo "Starting default tests in testenv"
basepython = py312: python3.12

[testenv:py312]
description = 'Run unit tests (unittest runner) using {envpython}'
platform =
       macos: darwin
       linux: linux
skip_install = false
recreate = true
alwayscopy = true
usedevelop = true
deps =
       .[tests]
commands =
    echo "Starting {envname}"
    {envpython} -V
    {envpython} -m unittest discover -v --start-directory {[local_settings]fixture_path_1} --pattern "{[local_settings]fixture_pattern_1}"
    {envpython} -m unittest discover -v --start-directory {[local_settings]fixture_path_1} --pattern "{[local_settings]fixture_pattern_2}"
    {envpython} -m unittest discover -v --start-directory {[local_settings]test_path_1} --pattern "{[local_settings]test_pattern_1}"
    echo "Completed {envname}"

#
[testenv:format_pep8-py312]
description = 'Run selected PEP8 compliance checks (flake8)'
platform =
       macos: darwin
       linux: linux
deps =
       .[tests]
commands =
    # Exceptions: D for docstrings, I for imports order and formatting, E302 is slice spacing  - W503 multiline spacing incompatible with black
    flake8 --max-line-length=185 --ignore=D,I,E203,W503  {[local_settings]source_paths}

#
[testenv:lint_pylint-py312]
description = 'Run linting compliance checks (pylint)'
platform=
       macos: darwin
       linux: linux
deps =
       .[tests]
commands =
    echo "Starting {envname}"
    pylint --disable=R,C --reports=n --rcfile={toxinidir}/pylintrc  {[local_settings]source_paths}
    echo "Completed {envname}"

#
[testenv:format_black-py312]
description = 'Run format compliance checks (black)'
platform =
       macos: darwin
       linux: linux
deps =
       .[tests]
commands =
    echo "Starting {envname}"
    black --check --line-length 185  {[local_settings]source_paths}
    echo "Completed {envname}"

#
[testenv:test_coverage-py312]
description = 'Run test coverage analysis'
platform =
       macos: darwin
       linux: linux
recreate = true
alwayscopy = true
usedevelop = true
deps =
       .[tests]
commands =
    echo "Starting {envname}"
    coverage erase
    coverage run --parallel-mode --omit="{[local_settings]coverage_exclude_paths}" --source="{[local_settings]coverage_source_paths}" -m unittest discover -v --start-directory {[local_settings]fixture_path_1} --pattern "{[local_settings]fixture_pattern_1}"
    coverage run --parallel-mode --omit="{[local_settings]coverage_exclude_paths}" --source="{[local_settings]coverage_source_paths}" -m unittest discover -v --start-directory {[local_settings]fixture_path_1} --pattern "{[local_settings]fixture_pattern_2}"
    coverage run --parallel-mode --omit="{[local_settings]coverage_exclude_paths}" --source="{[local_settings]coverage_source_paths}" -m unittest discover -v --start-directory  {[local_settings]test_path_1} --pattern "{[local_settings]test_pattern_1}"
    echo " ------- Consolidating {envname} data ----------"
    coverage combine
    echo " ------- Building {envname} reports ----------"
    coverage report --fail-under={[local_settings]coverage_cutoff}
    - coverage xml
    echo "Completed {envname}"