Merge branch 'feature/CG-662' into 'master'

tyler-dunkel · tyler-dunkel · commit 05be30ad225e · 2022-02-04T20:22:44.000Z
feat(plugins): Rework plugins config block.

Closes CG-662

See merge request auto-cloud/cloudgraph/cli!192
diff --git a/.cloud-graphrc.example.json b/.cloud-graphrc.example.json
@@ -28,6 +28,14 @@
     },
     "versionLimit": 10,
     "queryEngine": "playground",
-    "port": "5555"
+    "port": "5555",
+    "plugins": {
+      "policyPack": [
+        {
+          "name": "aws-cis-1.2",
+          "providers": ["aws"]
+        }
+      ]
+    }
   }
-}
+}
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
   },
   "bugs": "https://github.com/cloudgraphdev/cli/issues",
   "dependencies": {
-    "@cloudgraph/sdk": "^0.12.0",
+    "@cloudgraph/sdk": "^0.13.0",
     "@graphql-tools/load-files": "^6.3.2",
     "@graphql-tools/merge": "^8.2.0",
     "@oclif/command": "^1",
diff --git a/src/commands/init.ts b/src/commands/init.ts
@@ -1,4 +1,7 @@
-import { StorageEngineConnectionConfig } from '@cloudgraph/sdk'
+import {
+  ConfiguredPlugin,
+  StorageEngineConnectionConfig,
+} from '@cloudgraph/sdk'
 import { flags as CommandFlags } from '@oclif/command'
 import fs from 'fs'
 import path from 'path'
@@ -65,6 +68,15 @@ export default class Init extends Command {
     return client.configure()
   }
 
+  getPluginConfig(): {
+    plugins: { [pluginType: string]: ConfiguredPlugin[] }
+  } {
+    const plugins = this.getCGConfigKey('plugins')
+    return {
+      plugins: plugins ?? {},
+    }
+  }
+
   async askForDGraphConfig(overwrite = false): Promise<{
     versionLimit: string
     storageConfig: StorageEngineConnectionConfig
@@ -121,6 +133,7 @@ export default class Init extends Command {
 
   async getCloudGraphConfig(overwrite = false): Promise<CloudGraphConfig> {
     return {
+      ...this.getPluginConfig(),
       ...(await this.askForDGraphConfig(overwrite)),
       ...(await this.askForQueryEngineConfig(overwrite)),
     }
diff --git a/src/commands/policy/add.ts b/src/commands/policy/add.ts
@@ -1,4 +1,5 @@
 import { PluginType } from '@cloudgraph/sdk'
+import { isEmpty, uniqBy } from 'lodash'
 
 import OperationBaseCommand from '../operation'
 
@@ -28,10 +29,32 @@ export default class AddPolicy extends OperationBaseCommand {
 
         // Save policy to CG config file
         const config = this.getCGConfig()
-        if (config && config[provider]) {
-          config[provider].policies = config[provider].policies
-            ? [...new Set([...config[provider].policies, key])]
-            : [key]
+        if (config) {
+          let configuredPolicies =
+            config.cloudGraph.plugins[PluginType.PolicyPack] || []
+
+          if (isEmpty(configuredPolicies)) {
+            // Set new Policy Pack Plugin array
+            configuredPolicies = [
+              {
+                name: key,
+                providers: [provider],
+              },
+            ]
+          } else {
+            // Add policy to Policy Pack Plugin array
+            configuredPolicies = [
+              ...configuredPolicies,
+              {
+                name: key,
+                providers: [provider],
+              },
+            ]
+          }
+          config.cloudGraph.plugins[PluginType.PolicyPack] = uniqBy(
+            configuredPolicies,
+            'name'
+          )
           this.saveCloudGraphConfigFile(config)
         }
       }
diff --git a/src/commands/policy/remove.ts b/src/commands/policy/remove.ts
@@ -1,4 +1,5 @@
-import { PluginType } from '@cloudgraph/sdk'
+import { ConfiguredPlugin, PluginType } from '@cloudgraph/sdk'
+import isEmpty from 'lodash/isEmpty'
 
 import OperationBaseCommand from '../operation'
 
@@ -36,16 +37,20 @@ export default class RemovePolicy extends OperationBaseCommand {
         if (manager && !noSave) {
           manager.removeFromLockFile(key)
 
-          const [provider] = key.split('-')
           const config = this.getCGConfig()
-
-          if (config[provider]) {
-            config[provider].policies = [
-              ...config[provider].policies.filter(
-                (policy: string) => policy !== key
-              ),
-            ]
-            this.saveCloudGraphConfigFile(config)
+          if (config) {
+            const configuredPolicies =
+              config.cloudGraph.plugins[PluginType.PolicyPack] || []
+
+            if (!isEmpty(configuredPolicies)) {
+              // Remove policy from Policy Pack Plugin array
+              config.cloudGraph.plugins[PluginType.PolicyPack] =
+                configuredPolicies.filter(
+                  (p: ConfiguredPlugin) => p.name !== key
+                )
+
+              this.saveCloudGraphConfigFile(config)
+            }
           }
         }
       }
diff --git a/src/commands/scan.ts b/src/commands/scan.ts
@@ -1,7 +1,7 @@
 import chalk from 'chalk'
 import fs from 'fs'
 import path from 'path'
-import { cloudGraphPlugin, Opts, pluginMap } from '@cloudgraph/sdk'
+import { Opts, pluginMap, PluginType, StorageEngine } from '@cloudgraph/sdk'
 import { range } from 'lodash'
 
 import Command from './base'
@@ -31,6 +31,66 @@ export default class Scan extends Command {
 
   static args = Command.args
 
+  private async plugins({
+    storage: { isRunning, engine },
+    flags,
+  }: {
+    storage: {
+      isRunning: boolean
+      engine: StorageEngine
+    }
+    flags: {
+      [flag: string]: any
+    }
+  }): Promise<void> {
+    const config = this.getCGConfig('cloudGraph')
+    const { plugins = {} } = config
+    for (const pluginType in plugins) {
+      if (pluginType) {
+        try {
+          // Get Plugin Interface
+          const Plugin = pluginMap[pluginType]
+
+          // Execute Plugins by Provider
+          for (const provider in this.providers) {
+            if (provider) {
+              const { schemasMap, serviceKey } = this.providers[provider]
+
+              // Initialize
+              const PluginInstance = new Plugin({
+                config,
+                provider: {
+                  name: provider,
+                  schemasMap,
+                  serviceKey,
+                },
+                flags: flags as { [flag: string]: any },
+                logger: this.logger,
+              })
+
+              // Get the Plugin Manager
+              const pluginManager = this.getPluginManager(
+                pluginType as PluginType
+              )
+
+              // Configure
+              await PluginInstance.configure(pluginManager, plugins[pluginType])
+
+              // Execute plugins
+              await PluginInstance.execute({
+                storageRunning: isRunning,
+                storageEngine: engine,
+                processConnectionsBetweenEntities,
+              })
+            }
+          }
+        } catch (error) {
+          this.logger.warn('Plugin not supported by CG')
+        }
+      }
+    }
+  }
+
   async run() {
     const { argv, flags } = this.parse(Scan)
     const { dev: devMode } = flags as {
@@ -39,7 +99,6 @@ export default class Scan extends Command {
 
     const { dataDir } = this.config
     const opts: Opts = { logger: this.logger, debug: true, devMode }
-    const configuredPlugins = []
     let allProviders = argv
 
     // Run dgraph health check
@@ -112,49 +171,18 @@ export default class Scan extends Command {
       this.logger.info(
         `Beginning ${chalk.italic.green('SCAN')} for ${provider}`
       )
-      const { client: providerClient, schemasMap, serviceKey } =
-        await this.getProviderClient(provider)
+
+      const providerPlugin = await this.getProviderClient(provider)
+      const { client: providerClient, schemasMap } = providerPlugin
+
       if (!providerClient) {
         failedProviderList.push(provider)
         this.logger.warn(`No valid client found for ${provider}, skipping...`)
         continue // eslint-disable-line no-continue
       }
       const config = this.getCGConfig(provider)
+      this.providers[provider] = providerPlugin
 
-      // Configure installed plugins
-      for (const key in config) {
-        if (cloudGraphPlugin[key]) {
-          try {
-            // Get Plugin Interface
-            const Plugin = pluginMap[cloudGraphPlugin[key]]
-
-            // Initialize
-            const PluginInstance = new Plugin({
-              config,
-              provider: {
-                name: provider,
-                schemasMap,
-                serviceKey,
-              },
-              flags: flags as { [flag: string]: any },
-              logger: this.logger,
-            })
-
-            // Get the Plugin Manager
-            const pluginManager = this.getPluginManager(
-              cloudGraphPlugin[key]
-            )
-
-            // Configure
-            await PluginInstance.configure(pluginManager)
-
-            // Add to Configured Plugins list
-            configuredPlugins.push(PluginInstance)
-          } catch (error) {
-            this.logger.warn('Plugin not supported by CG')
-          }
-        }
-      }
       this.logger.debug(config)
       if (!config) {
         failedProviderList.push(provider)
@@ -263,15 +291,15 @@ export default class Scan extends Command {
 
       this.logger.successSpinner('Data insertion into Dgraph complete')
 
-      // Execute plugins
-      for (const plugin of configuredPlugins) {
-        await plugin.execute({
-          storageRunning,
-          storageEngine,
-          processConnectionsBetweenEntities,
-        })
-      }
+      await this.plugins({
+        flags: flags as { [flag: string]: any },
+        storage: {
+          isRunning: storageRunning,
+          engine: storageEngine,
+        },
+      })
     }
+
     scanReport.print()
 
     this.logger.success(
diff --git a/yarn.lock b/yarn.lock
@@ -379,10 +379,10 @@
   resolved "https://registry.yarnpkg.com/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz#75a2e8b51cb758a7553d6804a5932d7aace75c39"
   integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
 
-"@cloudgraph/sdk@^0.12.0":
-  version "0.12.0"
-  resolved "https://registry.yarnpkg.com/@cloudgraph/sdk/-/sdk-0.12.0.tgz#c95b87bed8883bde072c5e4cf171b4ef50d606dc"
-  integrity sha512-RD1HYwHlWKuyekdaLLOhfAATRaKmkHpWjU5vM6kEtiUGhGzR2ywujmIza7vbYCi6o23gLA38nAfaGi9VA239zg==
+"@cloudgraph/sdk@^0.13.0":
+  version "0.13.0"
+  resolved "https://registry.yarnpkg.com/@cloudgraph/sdk/-/sdk-0.13.0.tgz#1c093621d71cb8c10e6e638f094e8ddc01dee315"
+  integrity sha512-rqCcBuobib8cyKThxJQf4Wo0l6Thio2sNeP/AtR+EtSd4dxBTTBbTxQnuFkDLk4EJdgge2095nBvXTNeZH4Dtg==
   dependencies:
     "@graphql-tools/load-files" "^6.5.3"
     "@graphql-tools/merge" "^8.2.1"
