Repository navigation
Expand file tree
/
Copy pathCliAnalyzer.java
More file actions
102 lines (95 loc) · 5.54 KB
/
Copy pathCliAnalyzer.java
File metadata and controls
102 lines (95 loc) · 5.54 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
package dev.archunitjava.cli;
import dev.archunitjava.importer.ClassFileInput;
import dev.archunitjava.diagnostics.AnalysisInspection;
import dev.archunitjava.diagnostics.AnalysisLogging;
import dev.archunitjava.diagnostics.LogLevel;
import dev.archunitjava.importer.ClassPathImportResolver;
import dev.archunitjava.importer.ImportResolutionResult;
import dev.archunitjava.importer.InputDiagnosticCode;
import dev.archunitjava.report.ResultReport;
import dev.archunitjava.result.Diagnostic;
import dev.archunitjava.result.RuleResult;
import dev.archunitjava.result.Severity;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.TreeMap;
/** Direct Java API for the same bounded import and rule evaluation performed by the CLI. */
public final class CliAnalyzer {
public CliAnalysisResult analyze(CliConfiguration configuration) {
CliConfiguration config = Objects.requireNonNull(configuration, "configuration");
return analyze(config, config.checkOptions().logging());
}
/** Analyze with an explicit observer without changing the configuration or result schema. */
public CliAnalysisResult analyze(CliConfiguration configuration, AnalysisLogging logging) {
CliConfiguration config = Objects.requireNonNull(configuration, "configuration");
AnalysisLogging log = Objects.requireNonNull(logging, "logging");
var options = log == config.checkOptions().logging() ? config.checkOptions()
: config.checkOptions().toBuilder().logging(log).build();
log.emit(LogLevel.INFO, "EXTRACT", "Import started", () -> Map.of("inputs", "" + config.inputs().size()));
var imports = new ClassPathImportResolver().resolve(config.inputs().stream()
.map(ClassFileInput::path).toList());
AnalysisInspection.imports(imports, log);
var graph = CliGraphBuilder.build(imports.model());
AnalysisInspection.graph(graph, log);
var failures = importFailures(imports);
var results = CliRuleFactory.createRules(config, imports.model(), graph).stream()
.map(rule -> rule.check(options))
.map(result -> withImportDiagnostics(result, failures,
config.checkOptions().allowIncompleteAnalysis()))
.toList();
if (!failures.isEmpty()) results.forEach(result -> AnalysisInspection.result(result, log));
log.emit(failures.isEmpty() ? LogLevel.INFO : LogLevel.WARN, "REPORT", "Analysis complete", () -> Map.of("rules", "" + results.size(),
"passed", "" + results.stream().filter(RuleResult::passed).count(),
"importFailures", "" + failures.size()));
return new CliAnalysisResult(imports, graph, ResultReport.of(results));
}
static List<Diagnostic> importFailures(ImportResolutionResult imports) {
List<Diagnostic> failures = new ArrayList<>();
imports.assembly().diagnostics().stream()
.filter(value -> incompleteInput(value.code()))
.forEach(value -> failures.add(importDiagnostic(
"cli.input." + value.code().name(), value.input(), value.context())));
imports.model().classFileDiagnostics().forEach(value -> failures.add(importDiagnostic(
"cli.classfile." + value.code().name(), value.resourceName(), value.context())));
imports.model().diagnostics().forEach(value -> failures.add(importDiagnostic(
"cli.model." + value.code().name(), value.resourceName(), value.context())));
return failures.stream().distinct().sorted().toList();
}
private static boolean incompleteInput(InputDiagnosticCode code) {
return switch (code) {
case ARCHIVE_RESOURCE_REJECTED, DIAGNOSTIC_LIMIT_REACHED, INVALID_IGNORE_RULE,
INVALID_RESOURCE_NAME, IO_FAILURE, MISSING_INPUT, RESOURCE_LIMIT_EXCEEDED,
UNREADABLE_INPUT, UNSUPPORTED_INPUT -> true;
// These record the documented classpath selection and exclusion policy.
case DUPLICATE_INPUT, DUPLICATE_RESOURCE, MANIFEST_CLASS_PATH_REJECTED,
MULTI_RELEASE_ENTRY_IGNORED, NESTED_ARCHIVE_REJECTED, RESOURCE_EXCLUDED,
SYMLINK_SKIPPED -> false;
};
}
private static Diagnostic importDiagnostic(
String code, String resource, Map<String, String> context) {
Map<String, String> details = new TreeMap<>(context);
details.put("resource", resource);
return new Diagnostic(code, Severity.ERROR, details);
}
private static RuleResult withImportDiagnostics(
RuleResult result, List<Diagnostic> failures, boolean allowIncomplete) {
if (failures.isEmpty()) return result;
List<Diagnostic> diagnostics = new ArrayList<>(result.diagnostics());
for (Diagnostic failure : failures) {
diagnostics.add(allowIncomplete
? new Diagnostic(failure.code(), Severity.WARNING, failure.context()) : failure);
}
if (!allowIncomplete) {
return RuleResult.incomplete(result.metadata(), result.violations(), diagnostics);
}
return switch (result.status()) {
case PASSED -> RuleResult.passed(result.metadata(), diagnostics);
case FAILED -> RuleResult.failed(result.metadata(), result.violations(), diagnostics);
case SKIPPED -> RuleResult.skipped(result.metadata(), diagnostics);
case INCOMPLETE -> RuleResult.incomplete(result.metadata(), result.violations(), diagnostics);
};
}
}