Mechanism to exclude files from check (#563)

### What's done: * Logic in maven plugin * Tests for maven plugin * Logic in gradle plugin * Tests for gradle plugin * Fixes for metrics_yml
saveourtool · Nov 26, 2020 · 89873bb · 89873bb
1 parent 3e91e26
commit 89873bb
Show file tree

Hide file tree

Showing 10 changed files with 140 additions and 8 deletions.
diff --git a/.github/workflows/metrics_for_master.yml b/.github/workflows/metrics_for_master.yml
@@ -28,7 +28,8 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-maven-build-
       - name: Run tests
-        run: mvn -B test -DskipPluginMarker
+        # we need to run `install` goal here so that gradle will be able to resolve dependencies and run tests on diktat-gradle-plugin
+        run: mvn -B install -DskipPluginMarker
       - name: Generate code coverage report
         uses: codecov/codecov-action@v1
         with:

diff --git a/README.md b/README.md
@@ -93,6 +93,9 @@ Add this plugin to your pom.xml:
                                 <input>${project.basedir}/src/test/kotlin</input>
                             </inputs>
                             <diktatConfigFile>diktat-analysis.yml</diktatConfigFile>
+                           <excludes>
+                              <exclude>${project.basedir}/src/test/kotlin/excluded</exclude>
+                           </excludes>
                         </configuration>
                     </execution>
                 </executions>
@@ -130,6 +133,7 @@ You can then configure diktat using `diktat` extension:
 diktat {
     inputs = files("src/**/*.kt")  // file collection that will be checked by diktat
     debug = true  // turn on debug logging
+    excludes = files("src/test/kotlin/excluded")  // these files will not be checked by diktat
 }
 ```
 

diff --git a/diktat-gradle-plugin/src/main/kotlin/org/cqfn/diktat/plugin/gradle/DiktatExtension.kt b/diktat-gradle-plugin/src/main/kotlin/org/cqfn/diktat/plugin/gradle/DiktatExtension.kt
@@ -28,4 +28,9 @@ open class DiktatExtension {
      * Paths that will be scanned for .kt(s) files
      */
     lateinit var inputs: FileCollection
+
+    /**
+     * Paths that will be excluded from diktat run
+     */
+    var excludes: FileCollection? = null
 }
diff --git a/diktat-gradle-plugin/src/main/kotlin/org/cqfn/diktat/plugin/gradle/DiktatGradlePlugin.kt b/diktat-gradle-plugin/src/main/kotlin/org/cqfn/diktat/plugin/gradle/DiktatGradlePlugin.kt
@@ -20,6 +20,7 @@ class DiktatGradlePlugin : Plugin<Project> {
         diktatExtension.inputs = project.fileTree("src").apply {
             include("**/*.kt")
         }
+        diktatExtension.excludes = project.files()
         diktatExtension.reporter = PlainReporter(System.out)
 
         // only gradle 7+ (or maybe 6.8) will embed kotlin 1.4+, kx.serialization is incompatible with kotlin 1.3, so until then we have to use JavaExec wrapper

diff --git a/diktat-gradle-plugin/src/main/kotlin/org/cqfn/diktat/plugin/gradle/DiktatJavaExecTaskBase.kt b/diktat-gradle-plugin/src/main/kotlin/org/cqfn/diktat/plugin/gradle/DiktatJavaExecTaskBase.kt
@@ -12,6 +12,7 @@ import org.gradle.api.tasks.JavaExec
 import org.gradle.api.tasks.TaskProvider
 import org.gradle.api.tasks.VerificationTask
 import javax.inject.Inject
+import java.io.File
 
 /**
  * A base diktat task for gradle <6.8, which wraps [JavaExec]
@@ -45,8 +46,16 @@ open class DiktatJavaExecTaskBase @Inject constructor(
             if (diktatExtension.debug) {
                 add("--debug")
             }
-            add(diktatExtension.inputs.files.joinToString { it.path })
+            diktatExtension.inputs.files.forEach {
+                val pattern = project.trimRootDir(it.path)
+                add("\"$pattern\"")
+            }
+            diktatExtension.excludes?.files?.forEach {
+                val pattern = project.trimRootDir(it.path)
+                add("\"!$pattern\"")
+            }
         }
+        logger.debug("Setting JavaExec args to $args")
     }
 
     /**
@@ -88,3 +97,10 @@ 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)
diff --git a/diktat-gradle-plugin/src/test/kotlin/org/cqfn/diktat/plugin/gradle/DiktatJavaExecTaskTest.kt b/diktat-gradle-plugin/src/test/kotlin/org/cqfn/diktat/plugin/gradle/DiktatJavaExecTaskTest.kt
@@ -20,7 +20,7 @@ class DiktatJavaExecTaskTest {
     fun `check command line for various inputs`() {
         val pwd = project.file(".")
         assertCommandLineEquals(
-            listOf(null, "$pwd" + listOf("src", "**", "*.kt").joinToString(File.separator, prefix = File.separator)),
+            listOf(null, "\"${listOf("src", "**", "*.kt").joinToString(File.separator)}\""),
             DiktatExtension().apply {
                 inputs = project.files("src/**/*.kt")
             }
@@ -31,14 +31,28 @@ class DiktatJavaExecTaskTest {
     fun `check command line in debug mode`() {
         val pwd = project.file(".")
         assertCommandLineEquals(
-            listOf(null, "--debug", "$pwd${listOf("src", "**", "*.kt").joinToString(File.separator, prefix = File.separator)}"),
+            listOf(null, "--debug", "\"${listOf("src", "**", "*.kt").joinToString(File.separator)}\""),
             DiktatExtension().apply {
                 inputs = project.files("src/**/*.kt")
                 debug = true
             }
         )
     }
 
+    @Test
+    fun `check command line with excludes`() {
+        val pwd = project.file(".")
+        assertCommandLineEquals(
+            listOf(null, "\"${listOf("src", "**", "*.kt").joinToString(File.separator)}\"",
+                "\"!${listOf("src", "main", "kotlin", "generated").joinToString(File.separator)}\""
+            ),
+            DiktatExtension().apply {
+                inputs = project.files("src/**/*.kt")
+                excludes = project.files("src/main/kotlin/generated")
+            }
+        )
+    }
+
     private fun registerDiktatTask(extension: DiktatExtension) = project.tasks.register(
         "test", DiktatJavaExecTaskBase::class.java,
         "6.7", extension, project.configurations.create("diktat")

diff --git a/diktat-maven-plugin/pom.xml b/diktat-maven-plugin/pom.xml
@@ -47,6 +47,25 @@
             <artifactId>ktlint-reporter-plain</artifactId>
             <version>${ktlint.version}</version>
         </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>3.8.2</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.plugin-testing</groupId>
+            <artifactId>maven-plugin-testing-harness</artifactId>
+            <version>3.3.0</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <!-- to use org.apache.maven.repository.RepositorySystem in newer maven versions and maybe other classes -->
+            <groupId>org.apache.maven</groupId>
+            <artifactId>maven-compat</artifactId>
+            <version>${maven.api.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -77,6 +96,10 @@
                         </configuration>
                     </execution>
                 </executions>
+                <configuration>
+                    <apiVersion>1.4</apiVersion>
+                    <languageVersion>1.4</languageVersion>
+                </configuration>
             </plugin>
         </plugins>
     </build>

diff --git a/diktat-maven-plugin/src/main/kotlin/org/cqfn/diktat/plugin/maven/DiktatBaseMojo.kt b/diktat-maven-plugin/src/main/kotlin/org/cqfn/diktat/plugin/maven/DiktatBaseMojo.kt
@@ -23,8 +23,14 @@ abstract class DiktatBaseMojo : AbstractMojo() {
     /**
      * Paths that will be scanned for .kt(s) files
      */
-    @Parameter(property = "diktat.inputs")
-    var inputs = listOf("\${project.basedir}/src")
+    @Parameter(property = "diktat.inputs", defaultValue = "\${project.basedir}/src")
+    lateinit var inputs: List<String>
+
+    /**
+     * Paths that will be excluded if encountered during diktat run
+     */
+    @Parameter(property = "diktat.excludes", defaultValue = "")
+    lateinit var excludes: List<String>
 
     /**
      * Flag that indicates whether to turn debug logging on
@@ -45,7 +51,7 @@ abstract class DiktatBaseMojo : AbstractMojo() {
      * Property that can be used to access various maven settings
      */
     @Parameter(defaultValue = "\${project}", readonly = true)
-    lateinit var mavenProject: MavenProject
+    private lateinit var mavenProject: MavenProject
 
     /**
      * @param params instance of [KtLint.Params] used in analysis
@@ -63,7 +69,9 @@ abstract class DiktatBaseMojo : AbstractMojo() {
         if (!File(configFile).exists()) {
             throw MojoExecutionException("Configuration file $configFile doesn't exist")
         }
-        log.info("Running diKTat plugin with configuration file $configFile and inputs $inputs")
+        log.info("Running diKTat plugin with configuration file $configFile and inputs $inputs" +
+                if (excludes.isNotEmpty()) " and excluding $excludes" else ""
+        )
 
         val ruleSets by lazy {
             listOf(DiktatRuleSetProvider(configFile).get())
@@ -97,12 +105,14 @@ abstract class DiktatBaseMojo : AbstractMojo() {
      * @throws MojoExecutionException if [RuleExecutionException] has been thrown by ktlint
      */
     private fun checkDirectory(directory: File, lintErrors: MutableList<LintError>, ruleSets: Iterable<RuleSet>) {
+        val (excludedDirs, excludedFiles) = excludes.map(::File).partition { it.isDirectory }
         directory
                 .walk()
                 .filter { file ->
                     file.isDirectory || file.extension.let { it == "kt" || it == "kts" }
                 }
                 .filter { it.isFile }
+                .filterNot { file -> file in excludedFiles || excludedDirs.any { file.startsWith(it) } }
                 .forEach { file ->
                     log.debug("Checking file $file")
                     try {

diff --git a/diktat-maven-plugin/src/test/kotlin/org/cqfn/diktat/plugin/maven/DiktatBaseMojoTest.kt b/diktat-maven-plugin/src/test/kotlin/org/cqfn/diktat/plugin/maven/DiktatBaseMojoTest.kt
@@ -0,0 +1,55 @@
+package org.cqfn.diktat.plugin.maven
+
+import junit.framework.Assert
+import org.apache.maven.plugin.testing.AbstractMojoTestCase
+import kotlin.io.path.ExperimentalPathApi
+import kotlin.io.path.createTempFile
+import kotlin.io.path.writeText
+
+/**
+ * Tests for mojo configuration
+ * FixMe: inject project version from outside
+ * FixMe: `@Parameter` properties are not set
+ */
+@OptIn(ExperimentalPathApi::class)
+class DiktatBaseMojoTest : AbstractMojoTestCase() {
+    fun `test plugin configuration`() {
+        val pom = createTempFile()
+        pom.writeText(
+            """
+                <project xmlns="http://maven.apache.org/POM/4.0.0"
+                        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+                    <modelVersion>4.0.0</modelVersion>
+                    
+                    <groupId>org.cqfn.diktat</groupId>
+                    <artifactId>diktat-test</artifactId>
+                    <version>0.1.6-SNAPSHOT</version>
+                    
+                    <build>
+                        <plugins>
+                            <plugin>
+                                <groupId>org.cqfn.diktat</groupId>
+                                <artifactId>diktat-maven-plugin</artifactId>
+                                <version>0.1.6-SNAPSHOT</version>
+                                <configuration>
+                                    <diktatConfigFile>diktat-analysis.yml</diktatConfigFile>
+                                </configuration>
+                                <executions>
+                                    <execution>
+                                        <goals>
+                                            <goal>check</goal>
+                                        </goals>
+                                    </execution>
+                                </executions>
+                            </plugin>
+                        </plugins>
+                    </build>
+                </project>
+            """.trimIndent()
+        )
+        val diktatCheckMojo = lookupMojo("check", pom.toFile()) as DiktatCheckMojo
+        Assert.assertEquals(false, diktatCheckMojo.debug)
+        Assert.assertEquals("diktat-analysis.yml", diktatCheckMojo.diktatConfigFile)
+    }
+}
diff --git a/pom.xml b/pom.xml
@@ -327,6 +327,9 @@
                                 <input>${project.basedir}/src/main/kotlin</input>
                                 <input>${project.basedir}/src/test/kotlin</input>
                             </inputs>
+                            <excludes>
+                                <exclude>${project.basedir}/src/main/kotlin/generated</exclude>
+                            </excludes>
                             <diktatConfigFile>diktat-analysis.yml</diktatConfigFile>
                         </configuration>
                     </execution>