Repository navigation
Expand file tree
/
Copy pathcodemodder.py
More file actions
304 lines (260 loc) · 9.78 KB
/
Copy pathcodemodder.py
File metadata and controls
304 lines (260 loc) · 9.78 KB
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
import datetime
import itertools
import logging
import os
import sys
from collections import defaultdict
from pathlib import Path
from typing import DefaultDict, Sequence
from codemodder import __version__, providers, registry
from codemodder.cli import parse_args
from codemodder.codemods.api import BaseCodemod
from codemodder.codemods.semgrep import SemgrepRuleDetector
from codemodder.codetf import CodeTF
from codemodder.context import CodemodExecutionContext
from codemodder.dependency import Dependency
from codemodder.llm import TokenUsage, log_token_usage
from codemodder.logging import configure_logger, log_list, log_section, logger
from codemodder.project_analysis.file_parsers.package_store import PackageStore
from codemodder.project_analysis.python_repo_manager import PythonRepoManager
from codemodder.result import ResultSet
from codemodder.sarifs import detect_sarif_tools
from codemodder.semgrep import run as run_semgrep
def find_semgrep_results(
context: CodemodExecutionContext,
codemods: Sequence[BaseCodemod],
files_to_analyze: list[Path] | None = None,
) -> ResultSet:
"""Run semgrep once with all configuration files from all codemods and return a set of applicable rule IDs"""
if not (
yaml_files := list(
itertools.chain.from_iterable(
[
codemod.detector.get_yaml_files(codemod._internal_name)
for codemod in codemods
if codemod.detector
and isinstance(codemod.detector, SemgrepRuleDetector)
]
)
)
):
return ResultSet()
return run_semgrep(context, yaml_files, files_to_analyze)
def log_report(context, output, elapsed_ms, files_to_analyze, token_usage):
log_section("report")
logger.info("scanned: %s files", len(files_to_analyze))
all_failures = context.get_failed_files()
logger.info(
"failed: %s files (%s unique)",
len(all_failures),
len(set(all_failures)),
)
all_changes = context.get_changed_files()
logger.info(
"changed: %s files (%s unique)",
len(all_changes),
len(set(all_changes)),
)
logger.info("report file: %s", output)
log_token_usage("All", token_usage)
logger.info("total elapsed: %s ms", elapsed_ms)
logger.info(" semgrep: %s ms", context.timer.get_time_ms("semgrep"))
logger.info(" parse: %s ms", context.timer.get_time_ms("parse"))
logger.info(" transform: %s ms", context.timer.get_time_ms("transform"))
logger.info(" write: %s ms", context.timer.get_time_ms("write"))
def apply_codemods(
context: CodemodExecutionContext,
codemods_to_run: Sequence[BaseCodemod],
remediation: bool,
) -> TokenUsage:
log_section("scanning")
token_usage = TokenUsage()
if not context.files_to_analyze:
logger.info("no files to scan")
return token_usage
if not codemods_to_run:
logger.info("no codemods to run")
return token_usage
# run codemods one at a time making sure to respect the given sequence
for codemod in codemods_to_run:
# NOTE: this may be used as a progress indicator by upstream tools
logger.info("running codemod %s", codemod.id)
if codemod_token_usage := codemod.apply(context, remediation):
log_token_usage(f"Codemod {codemod.id}", codemod_token_usage)
token_usage += codemod_token_usage
record_dependency_update(context.process_dependencies(codemod.id))
context.log_changes(codemod.id)
return token_usage
def record_dependency_update(dependency_results: dict[Dependency, PackageStore | None]):
# TODO populate dependencies in CodeTF here
inverse: dict[None | str, list[Dependency]] = {}
for k, v in dependency_results.items():
inv_key = str(v.file) if v else None
if inv_key in inverse:
inverse.get(inv_key, []).append(k)
else:
inverse[inv_key] = [k]
for file in inverse.keys():
str_list = str([d.requirement.name for d in inverse[file]])[2:-2]
if file:
logger.debug(
"The following dependencies were added to '%s': %s", file, str_list
)
else:
logger.debug("The following dependencies could not be added: %s", str_list)
def run(
directory: Path | str,
dry_run: bool,
output: Path | str | None = None,
output_format: str = "codetf",
verbose: bool = False,
tool_result_files_map: DefaultDict[str, list[Path]] = defaultdict(list),
path_include: list[str] | None = None,
path_exclude: list[str] | None = None,
codemod_include: list[str] | None = None,
codemod_exclude: list[str] | None = None,
max_workers: int = 1,
original_cli_args: list[str] | None = None,
codemod_registry: registry.CodemodRegistry | None = None,
sast_only: bool = False,
log_matched_files: bool = False,
remediation: bool = False,
) -> tuple[CodeTF | None, int, TokenUsage]:
start = datetime.datetime.now()
codemod_registry = codemod_registry or registry.load_registered_codemods()
path_include = path_include or []
path_exclude = path_exclude or []
codemod_include = codemod_include or []
codemod_exclude = codemod_exclude or []
provider_registry = providers.load_providers()
token_usage = TokenUsage()
log_section("startup")
logger.info("codemodder: python/%s", __version__)
for file_name in itertools.chain(*tool_result_files_map.values()):
if not os.path.exists(file_name):
logger.error(
f"FileNotFoundError: [Errno 2] No such file or directory: '{file_name}'"
)
return None, 1, token_usage
repo_manager = PythonRepoManager(Path(directory))
context = CodemodExecutionContext(
Path(directory),
dry_run,
verbose,
codemod_registry,
provider_registry,
repo_manager,
path_include,
path_exclude,
tool_result_files_map,
max_workers,
)
context.repo_manager.parse_project()
# TODO: this should be a method of CodemodExecutionContext
codemods_to_run = codemod_registry.match_codemods(
codemod_include,
codemod_exclude,
sast_only=sast_only,
)
log_section("setup")
log_list(logging.INFO, "running", codemods_to_run, predicate=lambda c: c.id)
log_list(logging.INFO, "including paths", context.included_paths)
log_list(logging.INFO, "excluding paths", path_exclude)
if log_matched_files:
log_list(
logging.DEBUG,
"matched files",
(str(path) for path in context.files_to_analyze),
)
context.semgrep_prefilter_results = find_semgrep_results(
context,
codemods_to_run,
context.find_and_fix_paths,
)
token_usage = apply_codemods(context, codemods_to_run, remediation)
elapsed = datetime.datetime.now() - start
elapsed_ms = int(elapsed.total_seconds() * 1000)
logger.debug("Output format %s", output_format)
codetf = CodeTF.build(
context,
elapsed_ms,
original_cli_args or [],
context.compile_results(codemods_to_run),
)
if output:
codetf.write_report(output)
log_report(
context,
output,
elapsed_ms,
[] if not codemods_to_run else context.files_to_analyze,
token_usage,
)
return codetf, 0, token_usage
def _run_cli(original_args, remediation=False) -> int:
codemod_registry = registry.load_registered_codemods()
argv = parse_args(original_args, codemod_registry)
if not os.path.exists(argv.directory):
logger.error(
"given directory '%s' doesn't exist or can’t be read",
argv.directory,
)
return 1
try:
tool_result_files_map: DefaultDict[str, list[Path]] = detect_sarif_tools(
[Path(name) for name in argv.sarif or []]
)
except FileNotFoundError as err:
logger.error(err)
return 1
if argv.sonar_issues_json:
print(
"NOTE: --sonar-issues-json is deprecated, use --sonar-json instead",
file=sys.stderr,
)
if argv.sonar_hotspots_json:
print(
"NOTE: --sonar-hotspots-json is deprecated, use --sonar-json instead",
file=sys.stderr,
)
tool_result_files_map["sonar"].extend(argv.sonar_issues_json or [])
tool_result_files_map["sonar"].extend(argv.sonar_hotspots_json or [])
tool_result_files_map["sonar"].extend(argv.sonar_json or [])
tool_result_files_map["defectdojo"].extend(argv.defectdojo_findings_json or [])
logger.info("command: %s %s", Path(sys.argv[0]).name, " ".join(original_args))
configure_logger(argv.verbose, argv.log_format, argv.project_name)
_, status, _ = run(
argv.directory,
# Force dry-run if remediation
True if remediation else argv.dry_run,
argv.output,
argv.output_format,
argv.verbose,
tool_result_files_map,
argv.path_include,
argv.path_exclude,
argv.codemod_include,
argv.codemod_exclude,
max_workers=argv.max_workers,
original_cli_args=original_args,
codemod_registry=codemod_registry,
sast_only=argv.sonar_issues_json
or argv.sarif
or argv.sonar_hotspots_json
or argv.sonar_json,
log_matched_files=True,
remediation=remediation,
)
return status
def main():
"""
Hardens a project. The application will write all the fixes into the files.
"""
sys_argv = sys.argv[1:]
sys.exit(_run_cli(sys_argv))
def remediate():
"""
Remediates a project. The application will suggest fix for each separate issue found. No files will be written.
"""
sys_argv = sys.argv[1:]
sys.exit(_run_cli(sys_argv, True))