-
Notifications
You must be signed in to change notification settings - Fork 1
/
SConstruct
283 lines (215 loc) · 6.7 KB
/
SConstruct
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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
"""
Build script to wrap commands for docs, test coverage, badge generation, etc.
Generate coverage reports:
scons cov
Clean coverage reports:
scons cov --clean
"""
from SCons import Node
from typing import Callable
import json
import subprocess
REGRESSION_PATHS = [
"trilium_alchemy/core/note/note.py",
"trilium_alchemy/core/note/extension.py",
"trilium_alchemy/core/cache.py",
"trilium_alchemy/core/declarative.py",
"trilium_alchemy/core/exceptions.py",
"trilium_alchemy/core/session.py",
]
"""
Paths currently compliant with static analysis tools. Once the whole project is
compliant this can be removed.
"""
def run(*args, **kwargs) -> subprocess.CompletedProcess:
"""
Run the command and return the CompletedProcess. Essentially a wrapper for
subprocess.run() with custom defaults.
"""
cmd = list(args)
print(f"Running: {' '.join(cmd)}")
process: subprocess.CompletedProcess = subprocess.run(
cmd, text=True, **kwargs
)
return process
def alias(
name: str,
targets: list[Node],
sources: list[Node],
builder: Callable,
always: bool = False,
shell: bool = True,
):
"""
Create and return an alias, and perform bookkeeping.
"""
node = env.Command(targets, sources, builder, shell=shell)
env.Clean(node, targets)
if always:
AlwaysBuild(node)
return env.Alias(name, node)
def get_analysis_files() -> list[str]:
"""
Return a list of files to analyze based on command-line options.
"""
files: list[str]
# check if --regression was passed
if GetOption("regression"):
files = REGRESSION_PATHS
else:
files = GetOption("filter") or [PACKAGE]
return files
AddOption(
"--regression",
dest="regression",
action="store_true",
help="Filter analysis to all files currently compliant",
)
AddOption(
"--filter",
dest="filter",
type="string",
action="append",
help="Filter analysis to provided path(s)",
)
env = Environment()
Default(None)
PACKAGE = "trilium_alchemy"
BUILD_DIR = "build"
# output directories
TEST_BUILD_DIR = f"{BUILD_DIR}/test"
MYPY_BUILD_DIR = f"{BUILD_DIR}/mypy"
PYRIGHT_BUILD_DIR = f"{BUILD_DIR}/pyright"
DOC_BUILD_DIR = f"{BUILD_DIR}/doc"
BADGE_BUILD_DIR = "badges"
# ------------------------------------------------------------------------------
# Alias: test
# ------------------------------------------------------------------------------
test_junit = env.File(f"{TEST_BUILD_DIR}/junit.xml")
test_cov_data = env.File(f"{TEST_BUILD_DIR}/.coverage")
test_cov_html = env.Dir(f"{TEST_BUILD_DIR}/htmlcov")
test_cov_xml = env.File(f"{TEST_BUILD_DIR}/coverage.xml")
test_targets = [
test_junit,
test_cov_data,
test_cov_html,
test_cov_xml,
]
def run_pytest(target, source, env):
run(
"pytest",
"--cov",
"--cov-report=html",
"--cov-report=xml",
f"--junitxml={str(target[0])}",
)
test = alias("test", test_targets, [], run_pytest)
# ------------------------------------------------------------------------------
# Alias: mypy
# ------------------------------------------------------------------------------
mypy_html = env.Dir(f"{MYPY_BUILD_DIR}/html")
mypy_xml = env.Dir(f"{MYPY_BUILD_DIR}/xml")
mypy_targets = [
mypy_html,
mypy_xml,
]
def run_mypy(target, source, env):
run(
"mypy",
"--html-report",
str(target[0]),
"--cobertura-xml-report",
str(target[1]),
*get_analysis_files(),
)
mypy = alias("mypy", mypy_targets, [], run_mypy, always=True)
# ------------------------------------------------------------------------------
# Alias: pyright
# ------------------------------------------------------------------------------
pyright_json = env.File(f"{PYRIGHT_BUILD_DIR}/report.json")
pyright_targets = [
pyright_json,
]
def run_pyright(target, source, env):
process = run(
"pyright",
"--outputjson",
*get_analysis_files(),
capture_output=True,
)
with open(str(target[0]), "w") as fh:
fh.write(process.stdout)
print(f"Saved pyright report to: {str(target[0])}")
# parse report
report = json.loads(process.stdout)
files = report["summary"]["filesAnalyzed"]
errors = report["summary"]["errorCount"]
warnings = report["summary"]["warningCount"]
informations = report["summary"]["informationCount"]
print(
f" {files} files, {errors} errors, {warnings} warnings, {informations} informations"
)
pyright = alias("pyright", pyright_targets, [], run_pyright, always=True)
# ------------------------------------------------------------------------------
# Alias: analysis
# ------------------------------------------------------------------------------
analysis = env.Alias("analysis", [mypy, pyright])
# ------------------------------------------------------------------------------
# Alias: doc
# ------------------------------------------------------------------------------
doc_html = env.Dir(f"{DOC_BUILD_DIR}/html")
doc_targets = [
doc_html,
]
def run_sphinx(target, source, env):
run(
"sphinx-build",
"-T", # show full traceback upon error
"doc",
str(target[0]),
)
# always=True to always rebuild and rely on sphinx's caching mechanism
doc = alias("doc", doc_targets, [], run_sphinx, always=True)
# ------------------------------------------------------------------------------
# Alias: badges
# ------------------------------------------------------------------------------
badge_pytest = env.File(f"{BADGE_BUILD_DIR}/tests.svg")
badge_cov = env.File(f"{BADGE_BUILD_DIR}/cov.svg")
badge_targets = [
badge_pytest,
badge_cov,
]
def run_genbadge(target, source, env):
run(
"genbadge",
"tests",
"-i",
str(source[0]),
"-o",
str(target[0]),
)
run(
"genbadge",
"coverage",
"-i",
str(source[1]),
"-o",
str(target[1]),
)
badges = alias(
"badges", badge_targets, [test_junit, test_cov_xml], run_genbadge
)
# ------------------------------------------------------------------------------
# Alias: format
# ------------------------------------------------------------------------------
def run_format(target, source, env):
run(
"black",
".",
)
run(
"toml-sort",
"-i",
"pyproject.toml",
)
format_ = alias("format", ["format"], [], run_format, always=True)