-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
ProjectAnalyzer.kt
203 lines (175 loc) · 8.61 KB
/
ProjectAnalyzer.kt
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
package com.dipien.byebyejetifier
import com.dipien.byebyejetifier.archive.Archive
import com.dipien.byebyejetifier.common.LoggerHelper
import com.dipien.byebyejetifier.scanner.ScanResult
import com.dipien.byebyejetifier.scanner.ScannerProcessor
import org.gradle.api.Project
import org.gradle.api.artifacts.Configuration
import org.gradle.api.artifacts.ProjectDependency
import org.gradle.api.artifacts.ResolvedDependency
import java.util.LinkedList
import java.util.Queue
class ProjectAnalyzer(
private val project: Project,
private var excludedConfigurations: List<String>,
private var legacyGroupIdPrefixes: List<String>,
private val scannerProcessor: ScannerProcessor,
private val excludeSupportAnnotations: Boolean
) {
fun analyze(projectAnalyzerResult: ProjectAnalyzerResult) {
var includeSupportLibrary = false
var thereAreSupportLibraryDependencies = false
var hasExternalDependencies = false
val projectScanResult = mutableMapOf<ExternalDependency, List<ScanResult>>()
LoggerHelper.lifeCycle("")
LoggerHelper.lifeCycle("=========================================")
LoggerHelper.lifeCycle("Project: ${project.name}")
LoggerHelper.lifeCycle("=========================================")
val configurations = project.configurations
.filter {
!excludedConfigurations.contains(it.name)
}
LoggerHelper.log("Configurations to scan: $configurations")
val legacyArtifactsFirstLevel = mutableListOf<ExternalDependency>()
val allExternalDependencies = configurations
.map {
it.getExternalDependencies()
}
.flatten()
allExternalDependencies
// Gradle does not resolve the entire tree of dependencies for each Configuration.
// Then an artifact can appear in an Configurations without children and in other with children.
.groupBy { it.artifactDefinition }
.forEach { (_, groupedExtDependencies) ->
val externalDependency = groupedExtDependencies.first()
if (!externalDependency.isAndroidX && !externalDependency.isLegacyAndroidSupport) {
val result = mutableListOf<ScanResult>()
externalDependency.moduleArtifacts.forEach {
hasExternalDependencies = true
val library = Archive.Builder.extract(it.file)
result.addAll(projectAnalyzerResult.scanResultsCache.getOrPut(library.relativePath) { filterSupportAnnotationsIfNeeded(scannerProcessor.scanLibrary(library)) })
}
groupedExtDependencies
.map { it.children }
.flatten()
.distinct()
.forEach {
if (it.isLegacyAndroidSupport) {
includeSupportLibrary = true
result.add(ScanResult("pom", it.artifactDefinition))
}
}
projectScanResult[externalDependency] = result
} else if (externalDependency.isFirstLevel && externalDependency.isLegacyAndroidSupport) {
legacyArtifactsFirstLevel.add(externalDependency)
}
}
projectScanResult.forEach { (dependencyToReport, scanResults) ->
if (scanResults.isNotEmpty()) {
LoggerHelper.lifeCycle("")
LoggerHelper.lifeCycle("Scanning ${dependencyToReport.artifactDefinition}")
// Artifact paths
dependencyToReport.moduleArtifacts.forEach {
LoggerHelper.lifeCycle(" Absoulute path: ${it.file}")
}
// All possible graphs
LoggerHelper.lifeCycle(" Graphs to this dependency:")
allExternalDependencies
.filter { it.artifactDefinition == dependencyToReport.artifactDefinition }
.map { it.buildDependencyGraphs() }
.flatten()
.distinctBy { graph -> graph.toString() }
.forEach { it.print() }
// Issues found
LoggerHelper.lifeCycle(" Issues found:")
scanResults.forEach { scanResult ->
LoggerHelper.lifeCycle(" * ${scanResult.relativePath} -> ${scanResult.legacyDependency}")
}
thereAreSupportLibraryDependencies = true
} else {
LoggerHelper.info("")
LoggerHelper.info("Scanning ${dependencyToReport.artifactDefinition}")
LoggerHelper.info(" * No legacy android support usages found")
}
}
if (legacyArtifactsFirstLevel.isNotEmpty()) {
includeSupportLibrary = true
LoggerHelper.lifeCycle("")
LoggerHelper.lifeCycle("Explicit declarations of legacy support dependencies on this project:")
legacyArtifactsFirstLevel.sortedBy { it.artifactDefinition }.forEach {
LoggerHelper.lifeCycle(" * ${it.artifactDefinition}")
}
}
if (LoggerHelper.verbose) {
if (!includeSupportLibrary && !hasExternalDependencies) {
LoggerHelper.info(" * No legacy android support usages found")
}
} else {
if (!thereAreSupportLibraryDependencies && !includeSupportLibrary) {
LoggerHelper.lifeCycle(" * No legacy android support usages found")
}
}
if (includeSupportLibrary) {
projectAnalyzerResult.includeSupportLibrary = true
}
if (thereAreSupportLibraryDependencies) {
projectAnalyzerResult.thereAreSupportLibraryDependencies = true
}
}
private fun filterSupportAnnotationsIfNeeded(results: List<ScanResult>): List<ScanResult> {
if (excludeSupportAnnotations) {
return results.filter { scanResult ->
!scanResult.legacyDependency.startsWith("android/support/annotation") &&
!scanResult.legacyDependency.startsWith("android.support.annotation")
}
}
return results
}
private fun Configuration.getExternalDependencies(): Set<ExternalDependency> {
var firstLevelDependencies = emptySet<ResolvedDependency>()
try {
if (isCanBeResolved) {
firstLevelDependencies = resolvedConfiguration.firstLevelModuleDependencies
}
} catch (e: Throwable) {
if (name.endsWith("Metadata") || name.endsWith("archives")) {
// TODO analyze errors from Configurations whose name ends in "metadata"
// https://github.com/gradle/gradle/issues/5426
LoggerHelper.info("Error when accessing configuration $name" + e.message)
} else {
LoggerHelper.warn("Error when accessing configuration $name")
throw e
}
}
val resolvedDependencies = mutableSetOf<ExternalDependency>()
val projectDependencies = allDependencies.filterIsInstance(ProjectDependency::class.java)
firstLevelDependencies
.forEach { firstLevelDependency ->
if (firstLevelDependency.isExternalDependency(projectDependencies)) {
val externalDependencyFirstLevel = ExternalDependency.FirstLevel(firstLevelDependency, legacyGroupIdPrefixes)
resolvedDependencies.add(externalDependencyFirstLevel)
resolvedDependencies.traverseAndAddChildren(externalDependencyFirstLevel)
}
}
return resolvedDependencies
}
private data class QueueElement(val children: List<ExternalDependency>)
private fun MutableSet<ExternalDependency>.traverseAndAddChildren(firstLevelDependency: ExternalDependency) {
val queue: Queue<QueueElement> = LinkedList()
queue.offer(QueueElement(firstLevelDependency.children))
while (queue.isNotEmpty()) {
val element = queue.poll()
element.children.forEach { child ->
if (!child.isAndroidX) {
add(child)
queue.offer(QueueElement(child.children))
}
}
}
}
private fun ResolvedDependency.isExternalDependency(projectDependencies: List<ProjectDependency>): Boolean {
return projectDependencies.none { projectDependency ->
projectDependency.group == this.moduleGroup && projectDependency.name == this.moduleName
}
}
}