-
-
Notifications
You must be signed in to change notification settings - Fork 67
/
SpotBugsRunner.kt
161 lines (153 loc) · 5.81 KB
/
SpotBugsRunner.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
/*
* Copyright 2021 SpotBugs team
*
* <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License at
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>Unless required by applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.spotbugs.snom.internal
import com.github.spotbugs.snom.SpotBugsTask
import java.io.File
import java.io.IOException
import java.nio.file.StandardOpenOption
import java.util.Locale
import kotlin.String
import kotlin.io.path.createDirectories
import kotlin.io.path.createFile
import kotlin.io.path.exists
import kotlin.io.path.writeBytes
import org.gradle.api.GradleException
import org.gradle.api.file.FileCollection
import org.slf4j.LoggerFactory
internal abstract class SpotBugsRunner {
private val log = LoggerFactory.getLogger(SpotBugsRunner::class.java)
abstract fun run(task: SpotBugsTask)
@Suppress("LongMethod", "CyclomaticComplexMethod")
protected fun buildArguments(task: SpotBugsTask): List<String> = buildList {
val plugins = task.pluginJarFiles
if (!plugins.isEmpty) {
add("-pluginList")
add(join(plugins.files))
}
add("-timestampNow")
if (!task.auxClassPaths.isEmpty) {
if (task.useAuxclasspathFile.get()) {
add("-auxclasspathFromFile")
val auxClasspathFile = createFileForAuxClasspath(task)
log.debug("Using auxclasspath file: {}", auxClasspathFile)
add(auxClasspathFile)
} else {
add("-auxclasspath")
add(join(task.auxClassPaths.files))
}
}
if (!task.sourceDirs.isEmpty) {
add("-sourcepath")
add(task.sourceDirs.asPath)
}
if (task.showProgress.getOrElse(false)) {
add("-progress")
}
task.getRequiredReports().forEach { report ->
val reportFile = report.outputLocation.asFile.get()
val dir = reportFile.parentFile
dir.mkdirs()
add(report.commandLineOption + "=" + reportFile.absolutePath)
}
if (task.effort.isPresent) {
add("-effort:" + task.effort.get().name.lowercase(Locale.getDefault()))
}
if (task.reportLevel.isPresent) {
task.reportLevel.get().commandLineOption?.let(::add)
}
if (task.visitors.isPresent && task.visitors.get().isNotEmpty()) {
add("-visitors")
add(task.visitors.get().joinToString(","))
}
if (task.omitVisitors.isPresent && task.omitVisitors.get().isNotEmpty()) {
add("-omitVisitors")
add(task.omitVisitors.get().joinToString(","))
}
if (task.includeFilter.isPresent) {
add("-include")
add(task.includeFilter.get().asFile.absolutePath)
}
if (task.excludeFilter.isPresent) {
add("-exclude")
add(task.excludeFilter.get().asFile.absolutePath)
}
if (task.baselineFile.isPresent) {
add("-excludeBugs")
add(task.baselineFile.get().asFile.absolutePath)
}
if (task.onlyAnalyze.isPresent) {
add("-onlyAnalyze")
add(task.onlyAnalyze.get().joinToString(","))
}
add("-projectName")
add(task.projectName.get())
add("-release")
add(task.release.get())
val file = task.analyseClassFile.asFile.get()
task.classes?.let { generateFile(it, file) }
add("-analyzeFromFile")
add(file.absolutePath)
addAll(task.extraArgs.getOrElse(emptyList()))
log.debug("Arguments for SpotBugs are generated: {}", this)
}
private fun createFileForAuxClasspath(task: SpotBugsTask): String {
val auxClasspath = task.auxClassPaths.files.asSequence()
.map { obj: File -> obj.absolutePath }
.joinToString("\n")
val auxClasspathFile = task.auxclasspathFile.map {
it.asFile.toPath()
}.get()
try {
auxClasspathFile.parent.createDirectories()
if (!auxClasspathFile.exists()) {
auxClasspathFile.createFile()
}
auxClasspathFile.writeBytes(auxClasspath.toByteArray(), StandardOpenOption.WRITE)
return auxClasspathFile.normalize().toString()
} catch (e: IOException) {
throw GradleException(
"Could not create auxiliary classpath file for SpotBugsTask at " +
auxClasspathFile.normalize().toString(),
e,
)
}
}
private fun generateFile(
files: FileCollection,
file: File,
) {
try {
file.bufferedWriter().use { writer ->
files.asSequence()
.filter(File::exists)
.forEach {
writer.write(it.absolutePath)
writer.newLine()
}
}
} catch (e: IOException) {
throw GradleException("Fail to generate the text file to list target .class files", e)
}
}
protected fun buildJvmArguments(task: SpotBugsTask): List<String> {
val args = task.jvmArgs.getOrElse(emptyList())
log.debug("Arguments for JVM process are generated: {}", args)
return args
}
private fun join(files: Collection<File>): String {
return files.asSequence()
.map { obj: File -> obj.absolutePath }
.joinToString(File.pathSeparator)
}
}