From c73048a3e035719bd64cb0057cbebdcaf05e6b8d Mon Sep 17 00:00:00 2001
From: Peter Trifanov <peter.trifanov@mail.ru>
Date: Mon, 7 Dec 2020 17:50:57 +0300
Subject: [PATCH] Integration tests for diktat-maven-plugin (#607)

### What's done:
* Added integration tests via maven-itf for diktat-maven-plugin
---
 .github/workflows/build_and_test.yml          |  4 +-
 diktat-maven-plugin/pom.xml                   | 94 ++++++++++++++++++-
 .../maven/DiktatMavenPluginIntegrationTest.kt | 32 +++++++
 diktat-rules/pom.xml                          |  2 +
 4 files changed, 126 insertions(+), 6 deletions(-)
 create mode 100644 diktat-maven-plugin/src/test/kotlin/org/cqfn/diktat/plugin/maven/DiktatMavenPluginIntegrationTest.kt

diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
index 9ac717ed6f..9dafb60c08 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -26,8 +26,8 @@ jobs:
             ${{ runner.os }}-maven-build-
       - name: Maven Package
         run: mvn -B clean package -DskipTests
-      - name: Maven Verify
-        run: mvn -B verify
+      - name: Maven Install
+        run: mvn -B install
       - name: Code coverage report
         uses: codecov/codecov-action@v1
         with:
diff --git a/diktat-maven-plugin/pom.xml b/diktat-maven-plugin/pom.xml
index 8086a04d03..b531f83920 100644
--- a/diktat-maven-plugin/pom.xml
+++ b/diktat-maven-plugin/pom.xml
@@ -15,6 +15,7 @@
     <properties>
         <maven.api.version>3.6.3</maven.api.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.itf.version>0.9.0</maven.itf.version>
     </properties>
 
     <dependencies>
@@ -48,9 +49,15 @@
             <version>${ktlint.version}</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.13.1</version>
+            <groupId>org.junit.vintage</groupId>
+            <artifactId>junit-vintage-engine</artifactId>
+            <version>${junit.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.soebes.itf.jupiter.extension</groupId>
+            <artifactId>itf-jupiter-extension</artifactId>
+            <version>${maven.itf.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -66,6 +73,11 @@
             <version>${maven.api.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
@@ -78,7 +90,7 @@
                 <executions>
                     <execution>
                         <id>compile</id>
-                        <phase>compile</phase>
+                        <phase>process-sources</phase>
                         <goals>
                             <goal>compile</goal>
                         </goals>
@@ -91,6 +103,7 @@
                         </goals>
                         <configuration>
                             <sourceDirs>
+                                <!-- for some weird reason this is essential to compile kotlin test sources despite testSourceDirectory is set -->
                                 <source>src/test/kotlin</source>
                             </sourceDirs>
                         </configuration>
@@ -101,7 +114,80 @@
                     <languageVersion>1.4</languageVersion>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <configuration>
+                    <excludes>
+                        <exclude>*IntegrationTest*</exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>com.soebes.itf.jupiter.extension</groupId>
+                <artifactId>itf-maven-plugin</artifactId>
+                <version>${maven.itf.version}</version>
+                <executions>
+                    <execution>
+                        <id>installing</id>
+                        <phase>pre-integration-test</phase>
+                        <goals>
+                            <goal>install</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <configuration>
+                    <systemProperties>
+                        <maven.version>${maven.version}</maven.version>
+                        <maven.home>${maven.home}</maven.home>
+                    </systemProperties>
+                    <includes>
+                        <include>**/*IntegrationTest*</include>
+                    </includes>
+                    <testSourceDirectory>${project.build.testSourceDirectory}</testSourceDirectory>
+                    <testClassesDirectory>${project.build.testOutputDirectory}</testClassesDirectory>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>integration-test</goal>
+                            <goal>verify</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <!-- override jacoco config to include integration test results -->
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>post-integration-test</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
+        <testResources>
+            <testResource>
+                <directory>../examples/maven</directory>
+                <!-- setting filtering to false keeps unresolved properties, which in diktat-examples do not depend on diktat properties -->
+                <filtering>false</filtering>
+                <targetPath>${project.build.testOutputDirectory}/org/cqfn/diktat/plugin/maven/DiktatMavenPluginIntegrationTest/maven</targetPath>
+            </testResource>
+        </testResources>
     </build>
 
     <profiles>
diff --git a/diktat-maven-plugin/src/test/kotlin/org/cqfn/diktat/plugin/maven/DiktatMavenPluginIntegrationTest.kt b/diktat-maven-plugin/src/test/kotlin/org/cqfn/diktat/plugin/maven/DiktatMavenPluginIntegrationTest.kt
new file mode 100644
index 0000000000..4e2baa9e1f
--- /dev/null
+++ b/diktat-maven-plugin/src/test/kotlin/org/cqfn/diktat/plugin/maven/DiktatMavenPluginIntegrationTest.kt
@@ -0,0 +1,32 @@
+package org.cqfn.diktat.plugin.maven
+
+import com.soebes.itf.jupiter.extension.MavenGoal
+import com.soebes.itf.jupiter.extension.MavenJupiterExtension
+import com.soebes.itf.jupiter.extension.MavenTest
+import com.soebes.itf.jupiter.maven.MavenExecutionResult
+import org.junit.jupiter.api.Assertions
+import kotlin.io.path.ExperimentalPathApi
+import kotlin.io.path.readText
+
+/**
+ * Integration tests for diktat-maven-plugin.
+ * Run against the project from diktat-examples.
+ * Note: for maven itf test name should equal example project's directory name, which we have in pom.xml.
+ */
+@OptIn(ExperimentalPathApi::class)
+@MavenJupiterExtension
+class DiktatMavenPluginIntegrationTest {
+    @MavenTest
+    @MavenGoal("diktat:check@diktat")
+    fun maven(result: MavenExecutionResult) {
+        Assertions.assertEquals(1, result.returnCode)
+        Assertions.assertFalse(result.isError)
+        Assertions.assertFalse(result.isSuccesful)
+        Assertions.assertTrue(result.isFailure)
+
+        val mavenLog = result.mavenLog.stdout.readText()
+        Assertions.assertTrue(
+            mavenLog.contains("[HEADER_MISSING_OR_WRONG_COPYRIGHT]")
+        )
+    }
+}
diff --git a/diktat-rules/pom.xml b/diktat-rules/pom.xml
index 6503fb69f3..575060b87a 100644
--- a/diktat-rules/pom.xml
+++ b/diktat-rules/pom.xml
@@ -110,6 +110,8 @@
                         </goals>
                         <configuration>
                             <sourceDirs>
+                                <source>src/main/kotlin</source>
+                                <source>src/test/kotlin</source>
                                 <source>${project.basedir}/src/main/kotlin</source>
                                 <source>${project.basedir}/src/test/kotlin</source>
                             </sourceDirs>