summaryrefslogtreecommitdiff
path: root/tox.ini
blob: 6ed69cb3d120522c9f710716ca46d7624dd3903f (plain)
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
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
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
[tox]
envlist = py3, lowest-supported-dev, black, flake8, isort, mypy, pylint
recreate = True

[testenv]
basepython = python3
setenv =
    LC_ALL = en_US.utf-8
passenv=
    PYTEST_ADDOPTS

[format_deps]
black==22.3.0
flake8==3.9.2
isort==5.10.1
mypy==0.931
pylint==2.11.1
pytest==7.0.0
types-jsonschema==4.4.2
types-oauthlib==3.1.6
types-PyYAML==6.0.4
types-requests==2.27.8
types-setuptools==57.4.9

[testenv:flake8]
deps =
    flake8=={[format_deps]flake8}
commands = {envpython} -m flake8 {posargs:cloudinit/ tests/ tools/ conftest.py setup.py}

[testenv:pylint]
deps =
    pylint=={[format_deps]pylint}
    -r{toxinidir}/test-requirements.txt
    -r{toxinidir}/integration-requirements.txt
commands = {envpython} -m pylint {posargs:cloudinit/ tests/ tools/ conftest.py setup.py}

[testenv:black]
deps =
    black=={[format_deps]black}
commands = {envpython} -m black . --check

[testenv:isort]
deps =
    isort=={[format_deps]isort}
commands = {envpython} -m isort . --check-only

[testenv:mypy]
deps =
    mypy=={[format_deps]mypy}
    types-jsonschema=={[format_deps]types-jsonschema}
    types-oauthlib=={[format_deps]types-oauthlib}
    types-pyyaml=={[format_deps]types-PyYAML}
    types-requests=={[format_deps]types-requests}
    types-setuptools=={[format_deps]types-setuptools}
    pytest=={[format_deps]pytest}
commands = {envpython} -m mypy cloudinit/ tests/ tools/

[testenv:check_format]
deps =
    black=={[format_deps]black}
    flake8=={[format_deps]flake8}
    isort=={[format_deps]isort}
    mypy=={[format_deps]mypy}
    pylint=={[format_deps]pylint}
    pytest=={[format_deps]pytest}
    types-jsonschema=={[format_deps]types-jsonschema}
    types-oauthlib=={[format_deps]types-oauthlib}
    types-pyyaml=={[format_deps]types-PyYAML}
    types-requests=={[format_deps]types-requests}
    types-setuptools=={[format_deps]types-setuptools}
    -r{toxinidir}/test-requirements.txt
    -r{toxinidir}/integration-requirements.txt
commands =
    {[testenv:black]commands}
    {[testenv:flake8]commands}
    {[testenv:isort]commands}
    {[testenv:mypy]commands}
    {[testenv:pylint]commands}

[testenv:do_format]
deps =
    black=={[format_deps]black}
    isort=={[format_deps]isort}
commands =
    {envpython} -m isort .
    {envpython} -m black .

[testenv:py3]
deps =
    -r{toxinidir}/test-requirements.txt
commands = {envpython} -m pytest \
            --durations 10 \
            {posargs:--cov=cloudinit --cov-branch \
            tests/unittests}

[lowest-supported-deps]
# Tox is going to install requirements from pip. This is fine for
# testing python version compatibility, but when we build cloud-init, we are
# building against the dependencies in the OS repo, not pip. The OS
# dependencies will generally be older than what is found in pip.

# To obtain these versions, check the versions of these libraries
# in the oldest support Ubuntu distro.

# httpretty isn't included here because python2.7 requires a higher version
# than whats run on bionic, so we need two different definitions.
deps =
    jinja2==2.10
    oauthlib==2.0.6
    pyserial==3.4
    configobj==5.0.6
    pyyaml==3.12
    requests==2.18.4
    jsonpatch==1.16
    jsonschema==2.6.0
    netifaces==0.10.4
    # test-requirements
    pytest==3.3.2
    pytest-cov==2.5.1
    # Needed by pytest and default causes failures
    attrs==17.4.0

[testenv:lowest-supported]
# This definition will run on bionic with the version of httpretty
# that runs there
deps =
    {[lowest-supported-deps]deps}
    httpretty==0.8.14
commands = {[testenv:py3]commands}

[testenv:lowest-supported-dev]
# The oldest httpretty version to work with Python 3.7+ is 0.9.5,
# because it is the first to include this commit:
# https://github.com/gabrielfalcao/HTTPretty/commit/5776d97da3992b9071db5e21faf175f6e8729060
deps =
    {[lowest-supported-deps]deps}
    httpretty==0.9.5
commands = {[testenv:py3]commands}

[testenv:doc]
deps =
    -r{toxinidir}/doc-requirements.txt
commands =
    {envpython} -m sphinx {posargs:doc/rtd doc/rtd_html}
    doc8 doc/rtd

[testenv:tip-flake8]
commands = {envpython} -m flake8 {posargs:cloudinit/ tests/ tools/ conftest.py setup.py}
deps = flake8

[testenv:tip-mypy]
commands = {envpython} -m mypy --install-types --non-interactive cloudinit/ tests/ tools/
deps =
    mypy
    pytest
    types-jsonschema
    types-oauthlib
    types-PyYAML
    types-requests
    types-setuptools

[testenv:tip-pylint]
commands = {envpython} -m pylint {posargs:cloudinit/ tests/ tools/ conftest.py setup.py}
deps =
    # requirements
    pylint
    # test-requirements
    -r{toxinidir}/test-requirements.txt
    -r{toxinidir}/integration-requirements.txt

[testenv:integration-tests]
commands = {envpython} -m pytest --log-cli-level=INFO -vv {posargs:tests/integration_tests}
deps =
    -r{toxinidir}/integration-requirements.txt
passenv = CLOUD_INIT_* PYCLOUDLIB_* SSH_AUTH_SOCK OS_*

[testenv:integration-tests-ci]
commands = {[testenv:integration-tests]commands}
deps = {[testenv:integration-tests]deps}
passenv = CLOUD_INIT_* SSH_AUTH_SOCK OS_* TRAVIS
setenv =
    PYTEST_ADDOPTS="-m ci and not adhoc"

[testenv:integration-tests-jenkins]
commands = {[testenv:integration-tests]commands}
deps = {[testenv:integration-tests]deps}
passenv = *_proxy CLOUD_INIT_* PYCLOUDLIB_* SSH_AUTH_SOCK OS_* GOOGLE_* GCP_*
setenv =
    PYTEST_ADDOPTS="-m not adhoc"

[flake8]
# E203: whitespace before ':', doesn't adhere to pep8 or black formatting
# W503: line break before binary operator
ignore=E203,W503
exclude = .venv,.tox,dist,doc,*egg,.git,build,tools
per-file-ignores =
    cloudinit/cmd/main.py:E402

[pytest]
# TODO: s/--strict/--strict-markers/ once pytest version is high enough
testpaths = tests/unittests
addopts = --strict
log_format = %(asctime)s %(levelname)-9s %(name)s:%(filename)s:%(lineno)d %(message)s
log_date_format = %Y-%m-%d %H:%M:%S
markers =
    allow_subp_for: allow subp usage for the given commands (disable_subp_usage)
    allow_all_subp: allow all subp usage (disable_subp_usage)
    ci: run this integration test as part of CI test runs
    ds_sys_cfg: a sys_cfg dict to be used by datasource fixtures
    ec2: test will only run on EC2 platform
    gce: test will only run on GCE platform
    azure: test will only run on Azure platform
    oci: test will only run on OCI platform
    openstack: test will only run on openstack platform
    lxd_config_dict: set the config_dict passed on LXD instance creation
    lxd_container: test will only run in LXD container
    lxd_setup: specify callable to be called between init and start
    lxd_use_exec: `execute` will use `lxc exec` instead of SSH
    lxd_vm: test will only run in LXD VM
    not_bionic: test cannot run on the bionic release
    no_container: test cannot run in a container
    user_data: the user data to be passed to the test instance
    instance_name: the name to be used for the test instance
    ubuntu: this test should run on Ubuntu
    unstable: skip this test because it is flakey
    adhoc: only run on adhoc basis, not in any CI environment (travis or jenkins)