Merge pull request #14 from agorapulse/feature/fixt-copy-dir

[Fixt] Directory copy

Author: musketyr

.asciidoctorconfig

@@ -0,0 +1 @@
+:root-dir: {asciidoctorconfigdir}

.github/workflows/release.yml

@@ -53,4 +53,4 @@ jobs:
           token: ${{ secrets.AGORAPULSE_BOT_PERSONAL_TOKEN }}
           repository: ${{ matrix.repository }}
           event-type: ap-new-version-released-event
-          client-payload: '{ "group": "com.agorapulse", "module": "notification", "version": "${{ steps.version.outputs.tag }}", "property" : "testing.libraries.version", "github" : ${{ toJson(github) }} }'
+          client-payload: '{ "group": "com.agorapulse.testing", "module": "testing-libraries", "version": "${{ steps.version.outputs.tag }}", "property" : "testing.libraries.version", "github" : ${{ toJson(github) }} }'

build.gradle

@@ -96,15 +96,14 @@ config {
 
 allprojects {
     repositories {
-        jcenter()
         mavenCentral()
-        maven { url  "https://dl.bintray.com/agorapulse/libs" }
         maven { url "https://repo.spring.io/release"  }
         maven { url "https://repo.grails.org/grails/core" }
     }
 
     license {
         exclude '**/*.json'
+        exclude '**/*.txt'
         exclude '***.yml'
         exclude '**/FixtSpec/*.*'
         exclude '**/ReferenceClass/*.*'

docs/guide/src/docs/asciidoc/index.adoc

@@ -73,6 +73,8 @@ include::{root-dir}/libs/fixt/src/test/groovy/com/agorapulse/testing/fixt/FixtSp
 <5> Create all necessary directories if they do not exist yet
 <6> Write the content of the stream into a file
 <7> Write the text into a file
+<8> Copy whole directory from the test resources
+<9> All thehe files from the fixture directory are available in the new destination
 
 == Grails Job Testing Support
 

libs/fixt/src/main/groovy/com/agorapulse/testing/fixt/Fixt.java

@@ -24,9 +24,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
-import java.nio.file.FileSystems;
-import java.nio.file.Files;
-import java.nio.file.StandardCopyOption;
+import java.nio.file.*;
+import java.nio.file.attribute.BasicFileAttributes;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -157,6 +156,35 @@ public String readText(String fileName) {
         return streamToText(stream);
     }
 
+    /**
+     * Copies all files from the fixtureDirectoryPath into destinationDirectory.
+     *
+     * <p>
+     *     The files are copied from the test resources folder such as <code>src/main/test/resources</code>.
+     *     The current implementation does not support reading the directory content from the classpath (e.g. a different project)
+     * </p>
+     * @param fixtureDirectoryPath
+     * @param destinationDirectory
+     * @return
+     */
+    public File copyTo(String fixtureDirectoryPath, File destinationDirectory) {
+        File testingDirectory = new File(getTestResourcesLocation(), getFixtureLocation(fixtureDirectoryPath));
+
+        if (!testingDirectory.exists()) {
+            if (testingDirectory.mkdirs()) {
+                throw new IllegalArgumentException("The directory " + testingDirectory.getAbsolutePath() + " does not exist but it has been crated!"
+                    + "Please, pay attention that the folder must exists in the very same project as the test");
+            }
+        }
+
+        try {
+            copyFolder(testingDirectory.toPath(), destinationDirectory.toPath());
+            return testingDirectory;
+        } catch (IOException e) {
+            throw new IllegalArgumentException("Failed to copy directory", e);
+        }
+    }
+
     /**
      * Saves the fixture to the appropriate location.
      *
@@ -193,6 +221,25 @@ private static String streamToText(InputStream stream) {
         return "";
     }
 
+    public static void copyFolder(Path source, Path target, CopyOption... options) throws IOException {
+        Files.walkFileTree(source, new SimpleFileVisitor<Path>() {
+
+            @Override
+            public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs)
+                throws IOException {
+                Files.createDirectories(target.resolve(source.relativize(dir)));
+                return FileVisitResult.CONTINUE;
+            }
+
+            @Override
+            public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
+                throws IOException {
+                Files.copy(file, target.resolve(source.relativize(file)), options);
+                return FileVisitResult.CONTINUE;
+            }
+        });
+    }
+
     private InputStream readStreamFromClasspath(String fileName) {
         return clazz.getResourceAsStream(clazz.getSimpleName() + '/' + fileName);
     }

libs/fixt/src/test/groovy/com/agorapulse/testing/fixt/FixtSpec.groovy

@@ -67,4 +67,16 @@ class FixtSpec extends Specification {
             new File(contextTestFolder, TEXT_FILE).text == TEXT_CONTENT
     }
 
+    void 'copy directory'() {
+        given:
+            Fixt fixt = Fixt.create(this)
+            File destinationDir = tmp.newFolder()
+        when:
+            fixt.copyTo('testdir', destinationDir)                                      // <8>
+        then:
+            new File(destinationDir, 'root.txt').exists()                               // <9>
+            new File(destinationDir, 'firstLevel/firstLevel.txt').exists()
+            new File(destinationDir, 'firstLevel/secondLevel/secondLevel.txt').exists()
+    }
+
 }