Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix handling empty inputs in diktat-gradle-plugin #611

Merged
merged 1 commit into from
Dec 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ open class DiktatJavaExecTaskBase @Inject constructor(
@get:Internal
internal val ignoreFailuresProp: Property<Boolean> = project.objects.property(Boolean::class.javaObjectType)

@get:Internal
internal var shouldRun = true

init {
group = "verification"
if (isMainClassPropertySupported(gradleVersionString)) {
Expand All @@ -48,18 +51,36 @@ open class DiktatJavaExecTaskBase @Inject constructor(
if (diktatExtension.debug) {
add("--debug")
}
diktatExtension.inputs.files.forEach {
val pattern = project.trimRootDir(it.path)
add("\"$pattern\"")
}
diktatExtension.inputs
.also {
if (it.isEmpty) {
/*
If ktlint receives empty patterns, it implicitly uses &#42;&#42;/*.kt, **/*.kts instead.
This can lead to diktat analyzing gradle buildscripts and so on. We want to prevent it.
*/
logger.warn("Inputs for $name do not exist, will not run diktat")
shouldRun = false
}
}
.files
.forEach {
add("\"${it.path}\"")
}
diktatExtension.excludes?.files?.forEach {
val pattern = project.trimRootDir(it.path)
add("\"!$pattern\"")
add("\"!${it.path}\"")
}
}
logger.debug("Setting JavaExec args to $args")
}

override fun exec() {
if (shouldRun) {
super.exec()
} else {
logger.info("Skipping diktat execution")
}
}

/**
* @param ignoreFailures whether failure in this plugin should be ignored by a build
*/
Expand Down Expand Up @@ -99,10 +120,3 @@ fun Project.registerDiktatFixTask(diktatExtension: DiktatExtension, diktatConfig
DIKTAT_FIX_TASK, DiktatJavaExecTaskBase::class.java, gradle.gradleVersion,
diktatExtension, diktatConfiguration, listOf("-F ")
)

private fun Project.trimRootDir(path: String) = if (path.startsWith(rootDir.absolutePath)) {
path.drop(rootDir.absolutePath.length)
} else {
path
}
.trim(File.separatorChar)
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ class DiktatGradlePluginTest {
@BeforeEach
fun setUp() {
project = projectBuilder.build()
// mock kotlin sources
project.mkdir("src/main/kotlin")
project.file("src/main/kotlin/Test.kt").createNewFile()
project.pluginManager.apply(DiktatGradlePlugin::class.java)
}

Expand All @@ -27,5 +30,6 @@ class DiktatGradlePluginTest {
val diktatExtension = project.extensions.getByName("diktat") as DiktatExtension
Assertions.assertFalse(diktatExtension.debug)
Assertions.assertIterableEquals(project.fileTree("src").files, diktatExtension.inputs.files)
Assertions.assertTrue(diktatExtension.inputs.files.isNotEmpty())
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class DiktatJavaExecTaskTest {
@Test
fun `check command line for various inputs`() {
assertCommandLineEquals(
listOf(null, "\"${listOf("src", "**", "*.kt").joinToString(File.separator)}\""),
listOf(null, "\"${combinePathParts("src", "**", "*.kt")}\""),
DiktatExtension().apply {
inputs = project.files("src/**/*.kt")
}
Expand All @@ -29,7 +29,7 @@ class DiktatJavaExecTaskTest {
@Test
fun `check command line in debug mode`() {
assertCommandLineEquals(
listOf(null, "--debug", "\"${listOf("src", "**", "*.kt").joinToString(File.separator)}\""),
listOf(null, "--debug", "\"${combinePathParts("src", "**", "*.kt")}\""),
DiktatExtension().apply {
inputs = project.files("src/**/*.kt")
debug = true
Expand All @@ -40,8 +40,8 @@ class DiktatJavaExecTaskTest {
@Test
fun `check command line with excludes`() {
assertCommandLineEquals(
listOf(null, "\"${listOf("src", "**", "*.kt").joinToString(File.separator)}\"",
"\"!${listOf("src", "main", "kotlin", "generated").joinToString(File.separator)}\""
listOf(null, "\"${combinePathParts("src", "**", "*.kt")}\"",
"\"!${combinePathParts("src", "main", "kotlin", "generated")}\""
),
DiktatExtension().apply {
inputs = project.files("src/**/*.kt")
Expand All @@ -50,13 +50,26 @@ class DiktatJavaExecTaskTest {
)
}

@Test
fun `check command line with non-existent inputs`() {
val task = registerDiktatTask(
DiktatExtension().apply {
inputs = project.files()
}
).get()
Assertions.assertFalse(task.shouldRun)
}

private fun registerDiktatTask(extension: DiktatExtension) = project.tasks.register(
"test", DiktatJavaExecTaskBase::class.java,
"diktatTask4Test", DiktatJavaExecTaskBase::class.java,
"6.7", extension, project.configurations.create("diktat")
)

private fun assertCommandLineEquals(expected: List<String?>, extension: DiktatExtension) {
val task = registerDiktatTask(extension).get()
Assertions.assertIterableEquals(expected, task.commandLine)
}

private fun combinePathParts(vararg parts: String) = project.projectDir.absolutePath +
parts.joinToString(File.separator, prefix = File.separator)
}