Merge pull request #2974 from Faakhir30/batch_plugin_support

Headlamp Plugins CLI: Bulk installations support

Author: illume

plugins/headlamp-plugin/README.md

@@ -52,12 +52,35 @@ headlamp-plugin --help
                                             working directory. Can also be a
                                             folder of packages.
   headlamp-plugin.js list                   List installed plugins.
-  headlamp-plugin.js install [URL]          Install a plugin from the specified
-                                            Artifact Hub URL.
+  headlamp-plugin.js install [URL]          Install plugin(s) from a configuration
+                                            file or a plugin Artifact Hub URL.
+                                            Options:
+                                            -c, --config: Path to config file
+                                            --folderName: Install folder name
+                                            --headlampVersion: Target version
+                                            -q, --quiet: Suppress logs
   headlamp-plugin.js update [pluginName]    Update the plugin to the latest version.
   headlamp-plugin.js uninstall [pluginName] Uninstall the plugin.
 ```
 
+## Template for installing plugins from a configuration file
+
+plugins.yaml:
+
+```yaml
+plugins:
+  - name: my-plugin
+    source: https://artifacthub.io/packages/headlamp/test-123/my-plugin
+    version: 1.0.0
+  - name: another-plugin
+    source: https://artifacthub.io/packages/headlamp/test-123/another-plugin
+    dependencies:
+      - my-plugin
+installOptions:
+  parallel: true
+  maxConcurrent: 3
+```
+
 ## Development notes
 
 ### Generate types
@@ -113,7 +136,6 @@ Run `npm run check-dependencies` to see if frontend/package.json and
 headlamp-plugin/package.json are synced. This is run in CI to make sure when dependencies
 are changed, they are synced appropriately.
 
-
 ### Upgrading to an alpha release
 
 You can try an alpha release for testing with the following command.
@@ -125,6 +147,7 @@ npx @kinvolk/headlamp-plugin@alpha upgrade --headlamp-plugin-version=alpha your-
 ### Making an alpha release of headlamp-plugin
 
 You can bump the version to do a new alpha release like so:
+
 ```bash
 cd plugins/headlamp-plugin
 npm version preminor --preid=alpha

plugins/headlamp-plugin/bin/headlamp-plugin.js

@@ -32,6 +32,7 @@ const headlampPluginPkg = require('../package.json');
 const PluginManager = require('../plugin-management/plugin-management').PluginManager;
 const { table } = require('table');
 const tar = require('tar');
+const MultiPluginManager = require('../plugin-management/multi-plugin-management');
 
 // ES imports
 const viteCopyPluginPromise = import('vite-plugin-static-copy');
@@ -1420,14 +1421,19 @@ yargs(process.argv.slice(2))
     }
   )
   .command(
-    'install <URL>',
-    'Install a plugin from the Artiface Hub URL',
+    'install [URL]',
+    'Install plugin(s) from a configuration file or a plugin artifact Hub URL',
     yargs => {
-      yargs
+      return yargs
         .positional('URL', {
           describe: 'URL of the plugin to install',
           type: 'string',
         })
+        .option('config', {
+          alias: 'c',
+          describe: 'Path to plugin configuration file',
+          type: 'string',
+        })
         .option('folderName', {
           describe: 'Name of the folder to install the plugin into',
           type: 'string',
@@ -1440,22 +1446,66 @@ yargs(process.argv.slice(2))
           alias: 'q',
           describe: 'Do not print logs',
           type: 'boolean',
+        })
+        .check(argv => {
+          if (!argv.URL && !argv.config) {
+            throw new Error('Either URL or --config must be specified');
+          }
+          if (argv.URL && argv.config) {
+            throw new Error('Cannot specify both URL and --config');
+          }
+          return true;
         });
     },
     async argv => {
-      const { URL, folderName, headlampVersion, quiet } = argv;
-      const progressCallback = quiet
-        ? null
-        : data => {
-            if (data.type === 'error' || data.type === 'success') {
-              console.error(data.type, ':', data.message);
-            }
-          }; // Use console.log for logs if not in quiet mode
       try {
-        await PluginManager.install(URL, folderName, headlampVersion, progressCallback);
-      } catch (e) {
-        console.error(e.message);
-        process.exit(1); // Exit with error status
+        const { URL, config, folderName, headlampVersion, quiet } = argv;
+        const progressCallback = quiet
+          ? () => {}
+          : data => {
+              const { type = 'info', message, raise = true } = data;
+              if (config && !URL) {
+                // bulk installation
+                let prefix = '';
+                if (data.current || data.total || data.plugin) {
+                  prefix = `${data.current} of ${data.total} (${data.plugin}): `;
+                }
+                if (type === 'info' || type === 'success') {
+                  console.log(`${prefix}${type}: ${message}`);
+                } else if (type === 'error' && raise) {
+                  throw new Error(message);
+                } else {
+                  console.error(`${prefix}${type}: ${message}`);
+                }
+              } else {
+                if (type === 'error' || type === 'success') {
+                  console.error(`${type}: ${message}`);
+                }
+              }
+            };
+        if (URL) {
+          // Single plugin installation
+          try {
+            await PluginManager.install(URL, folderName, headlampVersion, progressCallback);
+          } catch (e) {
+            console.error(e.message);
+            process.exit(1); // Exit with error status
+          }
+        } else if (config) {
+          const installer = new MultiPluginManager(folderName, headlampVersion, progressCallback);
+          // Bulk installation from config
+          const result = await installer.installFromConfig(config);
+          // Exit with error if any plugins failed to install
+          if (result.failed > 0) {
+            process.exit(1);
+          }
+        }
+      } catch (error) {
+        console.error('Installation failed', {
+          error: error.message,
+          stack: error.stack,
+        });
+        process.exit(1);
       }
     }
   )

plugins/headlamp-plugin/dependencies-sync.js

@@ -32,6 +32,7 @@
 // Some packages are used by headlamp-plugin that are not used by the frontend.
 // These won't be removed from headlamp-plugin/package.json
 const dependenciesFrontDoesNotHave = new Set([
+  'ajv',
   'env-paths',
   'shx',
   'fs-extra',