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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
"""scrapli.noxfile"""
import re
import sys
from pathlib import Path
from typing import Dict, List
import nox
nox.options.error_on_missing_interpreters = False
nox.options.stop_on_first_error = False
nox.options.default_venv_backend = "venv"
def parse_requirements(dev: bool = True) -> Dict[str, str]:
"""
Parse requirements file
Args:
dev: parse dev requirements (or not)
Returns:
dict: dict of parsed requirements
Raises:
N/A
"""
requirements = {}
requirements_file = "requirements.txt" if not dev else "requirements-dev.txt"
with open(requirements_file, "r", encoding="utf-8") as f:
requirements_file_lines = f.readlines()
requirements_lines: List[str] = [
line
for line in requirements_file_lines
if not line.startswith("-r") and not line.startswith("#") and not line.startswith("-e")
]
editable_requirements_lines: List[str] = [
line for line in requirements_file_lines if line.startswith("-e")
]
for requirement in requirements_lines:
parsed_requirement = re.match(
pattern=r"^([a-z0-9\-\_\.\[\]]+)([><=]{1,2}\S*)(?:.*)$",
string=requirement,
flags=re.I | re.M,
)
requirements[parsed_requirement.groups()[0]] = parsed_requirement.groups()[1]
for requirement in editable_requirements_lines:
parsed_requirement = re.match(
pattern=r"^-e\s.*(?:#egg=)(\w+)$", string=requirement, flags=re.I | re.M
)
requirements[parsed_requirement.groups()[0]] = requirement
return requirements
REQUIREMENTS: Dict[str, str] = parse_requirements(dev=False)
DEV_REQUIREMENTS: Dict[str, str] = parse_requirements(dev=True)
PLATFORM: str = sys.platform
SKIP_LIST: List[str] = []
@nox.session(python=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"])
def unit_tests(session):
"""
Nox run unit tests
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
if f"unit_tests-{PLATFORM}-{session.python}" in SKIP_LIST:
return
session.run("chmod", "0600", "tests/test_data/files/scrapli_key", external=True)
session.run("chmod", "0600", "tests/test_data/files/scrapli_key_encrypted", external=True)
session.install("-U", "setuptools", "wheel", "pip")
session.install(".[dev]")
session.run(
"python",
"-m",
"pytest",
"--cov=scrapli",
"--cov-report",
"xml",
"--cov-report",
"term",
"tests/unit",
"-v",
)
@nox.session(python=["3.11"])
def integration_tests(session):
"""
Nox run integration tests
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
if f"integration_tests-{PLATFORM}-{session.python}" in SKIP_LIST:
return
session.install("-U", "setuptools", "wheel", "pip")
session.install(".[dev]")
# setting scrapli boxen -> 1 so that the saved scrapli replay sessions are "correctly"
# pointing to the boxen dev env (i.e. port 21022 instead of 22 for iosxe, etc.)
session.run(
"python",
"-m",
"pytest",
"--cov=scrapli",
"--cov-report",
"xml",
"--cov-report",
"term",
"tests/integration",
"-v",
env={"SCRAPLI_BOXEN": "1"},
)
@nox.session(python=["3.11"])
def isort(session):
"""
Nox run isort
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
session.install(f"toml{DEV_REQUIREMENTS['toml']}")
session.install(f"isort{DEV_REQUIREMENTS['isort']}")
session.run("python", "-m", "isort", "-c", ".")
@nox.session(python=["3.11"])
def black(session):
"""
Nox run black
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
session.install(f"toml{DEV_REQUIREMENTS['toml']}")
session.install(f"black{DEV_REQUIREMENTS['black']}")
session.run("python", "-m", "black", "--check", ".")
@nox.session(python=["3.11"])
def pylama(session):
"""
Nox run pylama
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
session.install(".[dev]")
session.run("python", "-m", "pylama", ".")
@nox.session(python=["3.11"])
def pydocstyle(session):
"""
Nox run pydocstyle
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
session.install(f"toml{DEV_REQUIREMENTS['toml']}")
session.install(f"pydocstyle{DEV_REQUIREMENTS['pydocstyle']}")
session.run("python", "-m", "pydocstyle", ".")
@nox.session(python=["3.11"])
def mypy(session):
"""
Nox run mypy
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
session.install(".")
session.install(f"mypy{DEV_REQUIREMENTS['mypy']}")
session.install(f"types-paramiko{DEV_REQUIREMENTS['types-paramiko']}")
session.install(f"types-pkg-resources{DEV_REQUIREMENTS['types-pkg-resources']}")
session.run("python", "-m", "mypy", "--strict", "scrapli/")
@nox.session(python=["3.11"])
def darglint(session):
"""
Nox run darglint
Args:
session: nox session
Returns:
None
Raises:
N/A
"""
session.install(f"darglint{DEV_REQUIREMENTS['darglint']}")
for file in Path("scrapli").rglob("*.py"):
session.run("darglint", f"{file.absolute()}")
|
