Implemented cucumber support

Author: patrickf314

.gitignore

@@ -1,6 +1,5 @@
 #Target folder
 **/target
-/test-shards
 /${env.M3_REPO}
 
 #IDE settings

pom.xml

@@ -73,13 +73,6 @@
             <scope>test</scope>
         </dependency>
 
-        <!-- Cucumber test execution -->
-        <dependency>
-            <groupId>io.cucumber</groupId>
-            <artifactId>cucumber-core</artifactId>
-            <version>RELEASE</version>
-        </dependency>
-
         <!-- Test dependencies -->
         <dependency>
             <groupId>junit</groupId>

src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/AbstractShardCreatorMojo.java

@@ -23,7 +23,6 @@
 public abstract class AbstractShardCreatorMojo extends AbstractShardMojo {
 
     private ShardFileWriter writer;
-    private TestFileReader reader;
 
     @Parameter(property = "shard.create.shardCount", required = true)
     protected int shardCount;
@@ -37,15 +36,11 @@ public abstract class AbstractShardCreatorMojo extends AbstractShardMojo {
     @Parameter(property = "shard.create.testFolders")
     protected String[] testFolders;
 
-    @Parameter(property = "shard.create.pathToPackage", defaultValue = "java")
-    protected String pathToPackage;
-
     /**
      * Default constructor, initializes a reader for the test classes and a writer for the test shards.
      */
     public AbstractShardCreatorMojo() {
         writer = new ShardFileWriter();
-        reader = new TestFileReader();
     }
 
     /**
@@ -60,6 +55,8 @@ public AbstractShardCreatorMojo() {
     public void createShards(String shardNamePattern, TestClassFileFilter fileFilter) throws MojoExecutionException, MojoFailureException {
         getLog().info("Start creation of " + shardNamePattern + " files.");
 
+        TestFileReader reader = getReader();
+
         writer.clear();
         reader.setFilenameFilter(fileFilter);
 
@@ -163,7 +160,5 @@ private void adjustSplitList(List<String[]> splitList, int i) {
      *
      * @return the test file reader
      */
-    public TestFileReader getReader() {
-        return reader;
-    }
+    public abstract TestFileReader getReader();
 }

src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/AbstractShardExecutorMojo.java

@@ -15,7 +15,7 @@
  */
 public abstract class AbstractShardMojo extends AbstractMojo {
 
-    @Parameter(property = "tests.outputFolder", defaultValue = "${project.build.directory}/test-shards")
+    @Parameter(property = "shard.outputFolder", defaultValue = "${project.build.directory}/test-shards")
     protected String outputFolder;
 
     @Parameter(property = "project", readonly = true, defaultValue = "${project}")

src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/AbstractShardMojo.java

@@ -17,8 +17,8 @@
  *
  * @author Patrick Fischer patrick.fischer@qaware.de
  */
-@Mojo(name = "shard-clean")
-public class TestShardCleanerMojo extends AbstractShardMojo {
+@Mojo(name = "clean-shards")
+public class ShardCleanerMojo extends AbstractShardMojo {
 
     /**
      * The execution function for this goal.
@@ -33,7 +33,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             return;
         }
 
-        File[] shardFiles = folder.listFiles(this::isShardFile);
+        File[] shardFiles = folder.listFiles(((dir, name) -> ShardConstants.isShardFile(name)));
 
         if(shardFiles == null){
             return;
@@ -46,10 +46,4 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         }
         getLog().info("Deleted all test shards");
     }
-
-    private boolean isShardFile(File dir, String fileName) {
-        return  fileName.matches(ShardConstants.JUNIT_SHARD_REGEX) ||
-                fileName.matches(ShardConstants.CUCUMBER_SHARD_REGEX);
-
-    }
 }

…d/maven/plugin/TestShardCleanerMojo.java …shard/maven/plugin/ShardCleanerMojo.javasrc/main/java/com/telekom/gis/psa/test/shard/maven/plugin/TestShardCleanerMojo.java renamed to src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/ShardCleanerMojo.java src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/TestShardCleanerMojo.java renamed to src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/ShardCleanerMojo.java

@@ -0,0 +1,78 @@
+/**
+ * Copyright 2012, Deutsche Telekom AG, DTAG GHS GIS. All rights reserved.
+ */
+
+package com.telekom.gis.psa.test.shard.maven.plugin;
+
+import com.telekom.gis.psa.test.shard.maven.plugin.cucumber.CucumberFeatureFileManager;
+import com.telekom.gis.psa.test.shard.maven.plugin.utils.ShardConstants;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * The include mojo, loads one shard file an puts it into the surefire plugin
+ *
+ * @author Patrick Fischer patrick.fischer@qaware.de
+ */
+@Mojo(name = "execute-shard")
+public class ShardExecutorMojo extends AbstractShardMojo {
+    
+    @Parameter(property = "shard.execute.cucumberWrapperClass")
+    protected String cucumberWrapperClass;
+
+    @Parameter(property = "shard.execute.shardIndex", required = true)
+    private int shardIndex;
+
+    /**
+     * The execution function for this goal. It checks the given shardIndex and executes just the shard with the given
+     * shard index
+     *
+     * @throws MojoFailureException if something wrong with the dependencies or sources of a the plugin
+     * @throws MojoExecutionException if there is a problem in the properties
+     */
+    @Override
+    public void execute() throws MojoExecutionException, MojoFailureException {
+        File outputFolder = new File(this.outputFolder);
+        List<String> testShardPath = getTestShards(outputFolder);
+
+        if(shardIndex < 0 || shardIndex >= testShardPath.size()){
+            throw new MojoExecutionException("Invalid shard number, (shard count: " + testShardPath.size() + "; index: " +
+                    shardIndex);
+        }
+
+        String shardName = testShardPath.get(shardIndex);
+
+        if(shardName.matches(ShardConstants.CUCUMBER_SHARD_REGEX)){
+            CucumberFeatureFileManager.disableOtherFeatures(outputFolder, shardName);
+
+            if(cucumberWrapperClass == null || cucumberWrapperClass.isEmpty()){
+                throw new MojoExecutionException("Failed to include cucumber file: missing cucumber wrapper class, use" +
+                    " property <cucumberWrapperClass>");
+            }
+
+            project.getProperties().setProperty("surefire.includes", cucumberWrapperClass);
+        }else if(shardName.matches(ShardConstants.JUNIT_SHARD_REGEX)){
+            project.getProperties().setProperty("surefire.includesFile", outputFolder + File.separator + shardName);
+        }else{
+            getLog().warn(shardName + " does not match any shard regex, the file will be ignored");
+            return;
+        }
+
+        getLog().info("Added test shard \"" + shardName + "\" to surefire.");
+    }
+
+    private List<String> getTestShards(File outputFolder) throws MojoExecutionException {
+        String[] testShardArray = outputFolder.list((dir, name) -> ShardConstants.isShardFile(name));
+        if(testShardArray == null || testShardArray.length == 0){
+            throw new MojoExecutionException("No test shards found, shards must be created first.");
+        }
+
+        return Arrays.asList(testShardArray);
+    }
+}

src/main/java/com/telekom/gis/psa/test/shard/maven/plugin/ShardExecutorMojo.java

@@ -0,0 +1,124 @@
+/**
+ * Copyright 2012, Deutsche Telekom AG, DTAG GHS GIS. All rights reserved.
+ */
+
+package com.telekom.gis.psa.test.shard.maven.plugin.cucumber;
+
+import com.telekom.gis.psa.test.shard.maven.plugin.utils.ShardConstants;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * The Cucumber feature file manager handles the .feature files. They can be disable by appending .ignore to the file
+ * name. This manager renames the .feature files.
+ *
+ * @author Patrick Fischer patrick.fischer@qaware.de
+ */
+public final class CucumberFeatureFileManager {
+
+    private CucumberFeatureFileManager() {
+        //No instances
+    }
+
+    /**
+     * Renames all cucumber shards, which where not used. The result file as the file type .ignore and will not be
+     * recognized buy cucumber
+     *
+     * @param shardDirectory the directory of the test shards
+     * @param shardName      the name of the excluded cucumber shard
+     * @throws MojoExecutionException if there is a problem in the properties
+     */
+    public static void disableOtherFeatures(File shardDirectory, String shardName) throws MojoExecutionException {
+        File[] otherShards = shardDirectory
+                .listFiles((dir, name) -> name.matches(ShardConstants.CUCUMBER_SHARD_REGEX) && !name.equals(shardName));
+
+        if (otherShards == null) {
+            throw new MojoExecutionException("Shard directory " + shardDirectory.getPath() + " does not exist.");
+        }
+
+        for (File shard : otherShards) {
+            disableAllFeaturesOf(shard);
+        }
+    }
+
+    private static void disableAllFeaturesOf(File shard) throws MojoExecutionException {
+        List<String> featureFiles = getAllFeatureFileOf(shard);
+
+        for (String featureFileName : featureFiles) {
+            File featureFile = new File(featureFileName);
+            File disabledFeatureFile = new File(featureFile.getPath() + ".ignore");
+            if (disabledFeatureFile.exists()) {
+                throw new MojoExecutionException(
+                        "Failed to disable " + featureFile.getPath() + ": ignored feature already exists, " +
+                                "call the clean-cucumber-features goal to clean the feature files.");
+            }
+
+            if (!featureFile.renameTo(disabledFeatureFile)) {
+                throw new MojoExecutionException("Failed to disable " + featureFile.getPath() + ": renaming failed.");
+            }
+        }
+    }
+
+    /**
+     * Returns a list of all feature files in a cucumber shard file.
+     *
+     * @param shard the shard file
+     * @return the list of the feature files
+     * @throws MojoExecutionException if there is a problem in the properties
+     */
+    public static List<String> getAllFeatureFileOf(File shard) throws MojoExecutionException {
+        List<String> features = new ArrayList<>();
+        BufferedReader reader = null;
+        try {
+            reader = Files.newBufferedReader(shard.toPath());
+
+            String line;
+            while ((line = reader.readLine()) != null) {
+                features.add(line);
+            }
+        } catch (IOException e) {
+            throw new MojoExecutionException("Failed to read feature files.", e);
+        } finally {
+            if (reader != null) {
+                try {
+                    reader.close();
+                } catch (IOException ignore) {
+                }
+            }
+        }
+        return features;
+    }
+
+    /**
+     * Enables a disabled feature file by removing the .ignore file name ending
+     *
+     * @param file the feature file to enable
+     * @throws MojoFailureException   if something wrong with the dependencies or sources of a the plugin
+     * @throws MojoExecutionException if there is a problem in the properties
+     */
+    public static void enableFeatureFile(File file) throws MojoFailureException, MojoExecutionException {
+        String fileName = file.getPath();
+        fileName = fileName.substring(0, fileName.lastIndexOf('.'));
+
+        if (!fileName.endsWith(".feature")) {
+            throw new MojoFailureException("Invalid ignored feature file " + file.getPath());
+        }
+
+        File renamedFile = new File(fileName);
+        if (renamedFile.exists()) {
+            throw new MojoExecutionException(
+                    "Failed to enable " + file.getPath() + ", non-ignored file already exists.");
+        }
+
+        if (!file.renameTo(renamedFile)) {
+            throw new MojoExecutionException("Failed to enable " + file.getPath() + ": renaming failed.");
+        }
+    }
+}