Allowing custom folder name for plugin installation

Signed-off-by: Vacha Shah <[email protected]>
opensearch-project · Jun 11, 2021 · 58edde7 · 58edde7
1 parent 433165a
commit 58edde7
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 2 deletions.
diff --git a/src/cli_plugin/install/__fixtures__/replies/test_plugin_custom_folder.zip b/src/cli_plugin/install/__fixtures__/replies/test_plugin_custom_folder.zip
diff --git a/src/cli_plugin/install/install.js b/src/cli_plugin/install/install.js
@@ -63,7 +63,10 @@ export async function install(settings, logger) {
 
     assertVersion(settings);
 
-    const targetDir = path.join(settings.pluginDir, kebabCase(settings.plugins[0].id));
+    const folderName = settings.plugins[0].folderName
+      ? settings.plugins[0].folderName
+      : kebabCase(settings.plugins[0].id);
+    const targetDir = path.join(settings.pluginDir, folderName);
     await renamePlugin(settings.workingPath, targetDir);
 
     logger.log('Plugin installation complete');

diff --git a/src/cli_plugin/install/opensearch_dashboards.js b/src/cli_plugin/install/opensearch_dashboards.js
@@ -47,6 +47,18 @@ export function existingInstall(settings, logger) {
   } catch (e) {
     if (e.code !== 'ENOENT') throw e;
   }
+  if (settings.plugins[0].folderName !== '') {
+    try {
+      statSync(path.join(settings.pluginDir, settings.plugins[0].folderName));
+
+      logger.error(
+        `Plugin ${settings.plugins[0].id} already exists with custom folder name, please remove before installing a new version`
+      );
+      process.exit(70);
+    } catch (e) {
+      if (e.code !== 'ENOENT') throw e;
+    }
+  }
 }
 
 export function assertVersion(settings) {

diff --git a/src/cli_plugin/install/opensearch_dashboards.test.js b/src/cli_plugin/install/opensearch_dashboards.test.js
@@ -57,7 +57,12 @@ describe('opensearchDashboards cli', function () {
         tempArchiveFile: tempArchiveFilePath,
         plugin: 'test-plugin',
         version: '1.0.0',
-        plugins: [{ id: 'foo' }],
+        plugins: [
+          {
+            id: 'foo',
+            folderName: '',
+          },
+        ],
         pluginDir,
       };
 
@@ -86,6 +91,7 @@ describe('opensearchDashboards cli', function () {
             plugins: [
               {
                 id: 'foo',
+                folderName: '',
                 opensearchDashboardsVersion: '5.0.0-SNAPSHOT',
               },
             ],

diff --git a/src/cli_plugin/install/pack.test.js b/src/cli_plugin/install/pack.test.js
@@ -120,6 +120,7 @@ describe('opensearchDashboards cli', function () {
         expect(settings.plugins).toMatchInlineSnapshot(`
           Array [
             Object {
+              "folderName": "",
               "id": "testPlugin",
               "opensearchDashboardsVersion": "1.0.0",
               "stripPrefix": "opensearch-dashboards/test-plugin",
@@ -134,6 +135,7 @@ describe('opensearchDashboards cli', function () {
         expect(settings.plugins).toMatchInlineSnapshot(`
           Array [
             Object {
+              "folderName": "",
               "id": "testPlugin",
               "opensearchDashboardsVersion": "5.0.1",
               "stripPrefix": "opensearch-dashboards/test-plugin",
@@ -148,16 +150,19 @@ describe('opensearchDashboards cli', function () {
         expect(settings.plugins).toMatchInlineSnapshot(`
           Array [
             Object {
+              "folderName": "",
               "id": "fungerPlugin",
               "opensearchDashboardsVersion": "1.0.0",
               "stripPrefix": "opensearch-dashboards/funger-plugin",
             },
             Object {
+              "folderName": "",
               "id": "pdf",
               "opensearchDashboardsVersion": "1.0.0",
               "stripPrefix": "opensearch-dashboards/pdf",
             },
             Object {
+              "folderName": "",
               "id": "testPlugin",
               "opensearchDashboardsVersion": "1.0.0",
               "stripPrefix": "opensearch-dashboards/test-plugin",
@@ -166,6 +171,21 @@ describe('opensearchDashboards cli', function () {
         `);
       });
 
+      it('populate settings.plugin.folderName', async () => {
+        await copyReplyFile('test_plugin_custom_folder.zip');
+        await getPackData(settings, logger);
+        expect(settings.plugins).toMatchInlineSnapshot(`
+          Array [
+            Object {
+              "folderName": "customPluginName",
+              "id": "testPlugin",
+              "opensearchDashboardsVersion": "1.0.0",
+              "stripPrefix": "opensearch-dashboards/test-plugin-custom-folder",
+            },
+          ]
+        `);
+      });
+
       it('throw an error if there is no opensearch-dashboards plugin', async () => {
         await copyReplyFile('test_plugin_no_opensearch_dashboards.zip');
         await expect(getPackData(settings, logger)).rejects.toThrowErrorMatchingInlineSnapshot(

diff --git a/src/cli_plugin/install/zip.js b/src/cli_plugin/install/zip.js
@@ -82,6 +82,10 @@ export function analyzeArchive(archive) {
             plugins.push({
               id: manifest.id,
               stripPrefix: match[1],
+              folderName:
+                typeof manifest.folderName === 'string' && manifest.folderName
+                  ? manifest.folderName
+                  : '',
 
               // Plugins must specify their version, and by default that version in the plugin
               // manifest should match the version of opensearch-dashboards down to the patch level. If these

diff --git a/src/cli_plugin/install/zip.test.js b/src/cli_plugin/install/zip.test.js
@@ -63,6 +63,7 @@ describe('opensearchDashboards cli', function () {
         expect(packages).toMatchInlineSnapshot(`
           Array [
             Object {
+              "folderName": "",
               "id": "testPlugin",
               "opensearchDashboardsVersion": "1.0.0",
               "stripPrefix": "opensearch-dashboards/test-plugin",