#34 Add initial support for wires (Marionette).

 Refactor Extract file from archive code

Author: Ardesco

pom.xml

@@ -87,53 +87,53 @@
         <dependency>
             <groupId>org.apache.maven</groupId>
             <artifactId>maven-core</artifactId>
-            <version>3.2.1</version>
+            <version>3.3.9</version>
         </dependency>
         <dependency>
             <groupId>org.apache.maven</groupId>
             <artifactId>maven-plugin-api</artifactId>
-            <version>3.2.1</version>
+            <version>3.3.9</version>
         </dependency>
         <dependency>
             <groupId>org.apache.maven.plugin-tools</groupId>
             <artifactId>maven-plugin-annotations</artifactId>
-            <version>3.2</version>
+            <version>3.4</version>
         </dependency>
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
             <version>2.4</version>
         </dependency>
-        <dependency>
-            <groupId>org.apache.httpcomponents</groupId>
-            <artifactId>httpclient</artifactId>
-            <version>4.3.3</version>
-        </dependency>
         <dependency>
             <groupId>commons-codec</groupId>
             <artifactId>commons-codec</artifactId>
-            <version>1.6</version>
+            <version>1.10</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-compress</artifactId>
-            <version>1.5</version>
+            <version>1.10</version>
         </dependency>
         <dependency>
             <groupId>log4j</groupId>
             <artifactId>log4j</artifactId>
             <version>1.2.17</version>
         </dependency>
         <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-            <version>10.0.1</version>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>4.3.3</version>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpcore</artifactId>
             <version>4.3.2</version>
         </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+            <version>10.0.1</version>
+        </dependency>
         <!-- Test Dependancies -->
         <dependency>
             <groupId>org.hamcrest</groupId>
@@ -161,7 +161,7 @@
         <dependency>
             <groupId>com.github.stefanbirkner</groupId>
             <artifactId>system-rules</artifactId>
-            <version>1.7.0</version>
+            <version>1.16.0</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

src/main/java/com/lazerycode/selenium/download/DownloadHandler.java

@@ -1,5 +1,6 @@
 package com.lazerycode.selenium.download;
 
+import com.lazerycode.selenium.extract.FileExtractor;
 import com.lazerycode.selenium.hash.HashType;
 import com.lazerycode.selenium.repository.DriverContext;
 import com.lazerycode.selenium.repository.DriverDetails;
@@ -14,8 +15,6 @@
 import java.net.URISyntaxException;
 import java.net.URL;
 
-import static com.lazerycode.selenium.extract.ExtractFilesFromArchive.extractFileFromArchive;
-
 public class DownloadHandler {
 
     private static final Logger LOG = Logger.getLogger(DownloadHandler.class);
@@ -51,13 +50,13 @@ private boolean checkFileHash(File fileToCheck, String hash, HashType hashType)
 
     /**
      * Perform the file download
-     * @param driverDetails Driver details extracted from Repositorymap.xml
-     * @param shouldWeCheckFileHash true if file hash should be checked
      *
+     * @param driverDetails         Driver details extracted from Repositorymap.xml
+     * @param shouldWeCheckFileHash true if file hash should be checked
      * @return File
      * @throws MojoExecutionException Unable to download file
-     * @throws IOException Error writing to file system
-     * @throws URISyntaxException Invalid URI
+     * @throws IOException            Error writing to file system
+     * @throws URISyntaxException     Invalid URI
      */
     protected File downloadFile(DriverDetails driverDetails, boolean shouldWeCheckFileHash) throws MojoExecutionException, IOException, URISyntaxException {
 
@@ -124,7 +123,8 @@ private void downloadAndExtractExecutableFiles(DriverContext driverContext, Driv
         }
 
         String extractedFileLocation = this.rootStandaloneServerDirectory.getAbsolutePath() + File.separator + driverContext.buildExtractionPathFromDriverContext();
-        driverDetails.extractedLocation = extractFileFromArchive(localZipFile, extractedFileLocation, this.overwriteFilesThatExist, driverContext.getBinaryTypeForContext());
+        FileExtractor fileExtractor = new FileExtractor(this.overwriteFilesThatExist);
+        driverDetails.extractedLocation = fileExtractor.extractFileFromArchive(localZipFile, extractedFileLocation, driverContext.getBinaryTypeForContext());
     }
 
 }

src/main/java/com/lazerycode/selenium/exceptions/ExpectedFileNotFoundException.java

@@ -0,0 +1,9 @@
+package com.lazerycode.selenium.exceptions;
+
+import org.apache.maven.plugin.MojoFailureException;
+
+public class ExpectedFileNotFoundException extends MojoFailureException {
+    public ExpectedFileNotFoundException(String message) {
+        super(message);
+    }
+}

src/main/java/com/lazerycode/selenium/exceptions/InvalidFileTypeException.java

@@ -0,0 +1,9 @@
+package com.lazerycode.selenium.exceptions;
+
+import org.apache.maven.plugin.MojoFailureException;
+
+public class InvalidFileTypeException extends MojoFailureException {
+    public InvalidFileTypeException(String message) {
+        super(message);
+    }
+}

src/main/java/com/lazerycode/selenium/extract/ArchiveType.java

@@ -0,0 +1,14 @@
+package com.lazerycode.selenium.extract;
+
+public enum ArchiveType {
+    GZ("gz"),
+    BZ2("bz2"),
+    ZIP("zip"),
+    TAR("tar");
+
+    private final String archiveFileExtension;
+
+    ArchiveType(String archiveFileExtension) {
+        this.archiveFileExtension = archiveFileExtension;
+    }
+}

src/main/java/com/lazerycode/selenium/extract/CompressedFile.java

@@ -0,0 +1,79 @@
+package com.lazerycode.selenium.extract;
+
+import com.lazerycode.selenium.exceptions.InvalidFileTypeException;
+import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
+import org.apache.commons.compress.compressors.gzip.GzipCompressorInputStream;
+import org.apache.commons.io.FilenameUtils;
+import org.apache.log4j.Logger;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+import static com.lazerycode.selenium.extract.ArchiveType.BZ2;
+import static com.lazerycode.selenium.extract.ArchiveType.GZ;
+
+public class CompressedFile {
+
+    private static final Logger LOG = Logger.getLogger(FileExtractor.class);
+    File compressedFile;
+    String decompressedFilename;
+    ArchiveType filetype = null;
+
+    /**
+     * A class that will take a compressed file.
+     *
+     * @param compressedFile A compressed file of type .gz or .bz2
+     * @throws InvalidFileTypeException
+     */
+    public CompressedFile(File compressedFile) throws InvalidFileTypeException {
+        filetype = ArchiveType.valueOf(FilenameUtils.getExtension(compressedFile.getName()).toUpperCase());
+        if (filetype != GZ && filetype != BZ2) {
+            throw new InvalidFileTypeException(compressedFile.getName() + " is an archive, not a known compressed file type");
+        }
+        this.compressedFile = compressedFile;
+        decompressedFilename = FilenameUtils.getBaseName(compressedFile.getName());
+    }
+
+    /**
+     * Get the filename of the decompressed file.
+     *
+     * @return The decompressed filename as a String.
+     */
+    public String getDecompressedFilename() {
+        return decompressedFilename;
+    }
+
+    /**
+     * Get an InputStream for the decompressed file.
+     *
+     * @return An InputStream, the type could be BZip2CompressorInputStream, or GzipCompressorInputStream depending on what type of file was initially supplied
+     * @throws IOException
+     */
+    public InputStream getInputStream() throws IOException {
+        switch (filetype) {
+            case GZ:
+                LOG.debug("Decompressing .gz file");
+                return new GzipCompressorInputStream(new FileInputStream(compressedFile));
+            case BZ2:
+                LOG.debug("Decompressing .bz2 file");
+                return new BZip2CompressorInputStream(new FileInputStream(compressedFile));
+        }
+        return null;
+    }
+
+    /**
+     * Find out if the uncompressed file is an archive
+     *
+     * @return ArchiveType.TAR if a tar, or null if not an archive
+     */
+    public ArchiveType getArchiveType() {
+        try {
+            return ArchiveType.valueOf(FilenameUtils.getExtension(decompressedFilename).toUpperCase());
+        } catch (IllegalArgumentException e) {
+            LOG.debug("Not a recognised Archive type");
+            return null;
+        }
+    }
+}