Merge pull request #6083 from epixa/6074-tgz-plugins

Plugin installer support for .tgz file types

src/cli/plugin/__tests__/file_type.js

@@ -0,0 +1,31 @@
+import expect from 'expect.js';
+import fileType, { ZIP, TAR } from '../file_type';
+
+describe('kibana cli', function () {
+  describe('file_type', function () {
+    it('returns ZIP for .zip filename', function () {
+      const type = fileType('wat.zip');
+      expect(type).to.equal(ZIP);
+    });
+    it('returns TAR for .tar.gz filename', function () {
+      const type = fileType('wat.tar.gz');
+      expect(type).to.equal(TAR);
+    });
+    it('returns TAR for .tgz filename', function () {
+      const type = fileType('wat.tgz');
+      expect(type).to.equal(TAR);
+    });
+    it('returns undefined for unknown file type', function () {
+      const type = fileType('wat.unknown');
+      expect(type).to.equal(undefined);
+    });
+    it('accepts paths', function () {
+      const type = fileType('/some/path/to/wat.zip');
+      expect(type).to.equal(ZIP);
+    });
+    it('accepts urls', function () {
+      const type = fileType('http://example.com/wat.zip');
+      expect(type).to.equal(ZIP);
+    });
+  });
+});

src/cli/plugin/__tests__/plugin_downloader.js

@@ -124,6 +124,25 @@ describe('kibana cli', function () {
           });
         });
 
+        it('should consider .tgz files as archive type .tar.gz', function () {
+          const filePath = join(__dirname, 'replies/test_plugin_master.tar.gz');
+
+          const couchdb = nock('http://www.files.com')
+            .defaultReplyHeaders({
+              'content-length': '10'
+            })
+            .get('/plugin.tgz')
+            .replyWithFile(200, filePath);
+
+          const sourceUrl = 'http://www.files.com/plugin.tgz';
+
+          return downloader._downloadSingle(sourceUrl)
+          .then(function (data) {
+            expect(data.archiveType).to.be('.tar.gz');
+            expectWorkingPathNotEmpty();
+          });
+        });
+
         it('should download a zip from a valid http url', function () {
           const filePath = join(__dirname, 'replies/test_plugin_master.zip');
 

src/cli/plugin/downloaders/file.js

@@ -1,5 +1,6 @@
 import getProgressReporter from '../progress_reporter';
 import { createWriteStream, createReadStream, unlinkSync, statSync } from 'fs';
+import fileType from '../file_type';
 
 function openSourceFile({ sourcePath }) {
   try {
@@ -36,15 +37,6 @@ async function copyFile({ readStream, writeStream, progressReporter }) {
   });
 }
 
-function getArchiveTypeFromFilename(path) {
-  if (/\.zip$/i.test(path)) {
-    return '.zip';
-  }
-  if (/\.tar\.gz$/i.test(path)) {
-    return '.tar.gz';
-  }
-}
-
 /*
 // Responsible for managing local file transfers
 */
@@ -67,7 +59,7 @@ export default async function copyLocalFile(logger, sourcePath, targetPath) {
     }
 
     // all is well, return our archive type
-    const archiveType = getArchiveTypeFromFilename(sourcePath);
+    const archiveType = fileType(sourcePath);
     return { archiveType };
   } catch (err) {
     logger.error(err);

src/cli/plugin/downloaders/http.js

@@ -2,6 +2,7 @@ import Wreck from 'wreck';
 import getProgressReporter from '../progress_reporter';
 import { fromNode as fn } from 'bluebird';
 import { createWriteStream, unlinkSync } from 'fs';
+import fileType, { ZIP, TAR } from '../file_type';
 
 function sendRequest({ sourceUrl, timeout }) {
   const maxRedirects = 11; //Because this one goes to 11.
@@ -49,18 +50,12 @@ function getArchiveTypeFromResponse(resp, sourceUrl) {
   const contentType = (resp.headers['content-type'] || '');
 
   switch (contentType.toLowerCase()) {
-    case 'application/zip': return '.zip';
-    case 'application/x-gzip': return '.tar.gz';
+    case 'application/zip': return ZIP;
+    case 'application/x-gzip': return TAR;
     default:
       //If we can't infer the archive type from the content-type header,
       //fall back to checking the extension in the url
-      if (/\.zip$/i.test(sourceUrl)) {
-        return '.zip';
-      }
-      if (/\.tar\.gz$/i.test(sourceUrl)) {
-        return '.tar.gz';
-      }
-      break;
+      return fileType(sourceUrl);
   }
 }
 

src/cli/plugin/file_type.js

@@ -0,0 +1,14 @@
+export const TAR = '.tar.gz';
+export const ZIP = '.zip';
+
+export default function fileType(filename) {
+  if (/\.zip$/i.test(filename)) {
+    return ZIP;
+  }
+  if (/\.tar\.gz$/i.test(filename)) {
+    return TAR;
+  }
+  if (/\.tgz$/i.test(filename)) {
+    return TAR;
+  }
+}

src/cli/plugin/plugin_extractor.js

@@ -1,12 +1,13 @@
 import zipExtract from './extractors/zip';
 import tarGzExtract from './extractors/tar_gz';
+import { ZIP, TAR } from './file_type';
 
 export default function extractArchive(settings, logger, archiveType) {
   switch (archiveType) {
-    case '.zip':
+    case ZIP:
       return zipExtract(settings, logger);
       break;
-    case '.tar.gz':
+    case TAR:
       return tarGzExtract(settings, logger);
       break;
     default: