feat: support all CLI commands

teddy-gustiaux · teddy-gustiaux · commit 36238195ce4d · 2018-10-21T20:11:25.000-04:00
diff --git a/src/serverless-confirm-command.js b/src/serverless-confirm-command.js
@@ -2,31 +2,37 @@ const has = Object.prototype.hasOwnProperty;
 
 class ServerlessConfirmCommand {
     constructor(serverless, options) {
-        this.serverless = serverless;
-        this.provider = this.serverless.service.provider.name;
         this.options = options;
+        this.serverless = serverless;
         this.serverlessLog = serverless.cli.log.bind(serverless.cli);
+        this.provider = this.serverless.service.provider.name;
         this.command = null;
         if (serverless.processedInput.commands.length > 0) {
-            [this.command] = serverless.processedInput.commands;
+            this.command = serverless.processedInput.commands.join(' ').trim();
         }
+        this.msgConfirmed = 'Command confirmed. Proceeding...';
+        this.msgNotConfirmed =
+            'Command not confirmed. Use [--confirm] or change the configuration of the plugin.';
         this.defaultConfiguration = {
             commands: [],
             aws: {
                 stages: [],
                 commandsForStages: [],
             },
         };
-        this.hooks = this.buildHooks();
+        this.hooks = {};
         this.buildCustomConfiguration();
-    }
-
-    buildHooks() {
-        return {
-            // Before [deploy] (as we do not want the package building to happen before checking)
-            'before:package:createDeploymentArtifacts': this.checkConfirmation.bind(this),
-            'before:remove:remove': this.checkConfirmation.bind(this),
-        };
+        /**
+         * Although performing the verification directly in the constructor is not ideal,
+         * it ensures that all commands are supported by the plugin.
+         *
+         * It also bypasses issues due to some internal workarounds of the Serverless Framework
+         * with event hooks (such as AWS API keys and usage plans).
+         *
+         * Therefore, this solution is better than hook bindings
+         * for the specific use case of this plugin.
+         */
+        this.checkConfirmation();
     }
 
     buildCustomConfiguration() {
@@ -61,17 +67,15 @@ class ServerlessConfirmCommand {
     }
 
     commandConfirmed() {
-        this.serverlessLog('Command confirmed. Proceeding...');
+        this.serverlessLog(this.msgConfirmed);
     }
 
     commandNotConfirmed() {
-        throw new this.serverless.classes.Error(
-            'Command not confirmed. Use [--confirm] or change the configuration of the plugin.',
-        );
+        throw new this.serverless.classes.Error(this.msgNotConfirmed);
     }
 
     populateStage() {
-        this.stage = this.provider === 'aws' ? this.serverless.service.provider.stage : null;
+        this.stage = this.provider === 'aws' ? this.serverless.providers.aws.getStage() : null;
     }
 
     checkConfirmation() {
diff --git a/test/integration/aws/commandsForStages.test.js b/test/integration/aws/commandsForStages.test.js
@@ -12,7 +12,7 @@ describe('Integration tests of the plugin - using command and AWS stage pairs',
     it('should indicate the command as not confirmed if the option is not provided', () => {
         const subprocess = spawnSync(
             'node',
-            [pathToServerlessFramework, 'remove', '--stage', 'prod'],
+            [pathToServerlessFramework, 'deploy function', '--stage', 'prod'],
             { cwd: `${__dirname}/${folder}` },
         );
         const stdout = subprocess.stdout.toString('utf-8');
@@ -25,7 +25,7 @@ describe('Integration tests of the plugin - using command and AWS stage pairs',
     it('should indicate the command as confirmed if the option is provided', () => {
         const subprocess = spawnSync(
             'node',
-            [pathToServerlessFramework, 'remove', '--stage', 'prod', '--confirm'],
+            [pathToServerlessFramework, 'deploy function', '--stage', 'prod', '--confirm'],
             { cwd: `${__dirname}/${folder}` },
         );
         const stdout = subprocess.stdout.toString('utf-8');
diff --git a/test/integration/aws/commandsForStages/serverless.yml b/test/integration/aws/commandsForStages/serverless.yml
@@ -18,4 +18,4 @@ custom:
   confirm:
     aws:
       commandsForStages:
-        - 'remove:prod'
+        - 'deploy function:prod'
diff --git a/test/integration/aws/stages.test.js b/test/integration/aws/stages.test.js
@@ -12,7 +12,7 @@ describe('Integration tests of the plugin - using AWS stages only', () => {
     it('should indicate the command as not confirmed if the option is not provided', () => {
         const subprocess = spawnSync(
             'node',
-            [pathToServerlessFramework, 'deploy', '--stage', 'prod'],
+            [pathToServerlessFramework, 'deploy function', '--stage', 'prod'],
             { cwd: `${__dirname}/${folder}` },
         );
         const stdout = subprocess.stdout.toString('utf-8');
@@ -25,7 +25,7 @@ describe('Integration tests of the plugin - using AWS stages only', () => {
     it('should indicate the command as confirmed if the option is provided', () => {
         const subprocess = spawnSync(
             'node',
-            [pathToServerlessFramework, 'deploy', '--stage', 'prod', '--confirm'],
+            [pathToServerlessFramework, 'deploy function', '--stage', 'prod', '--confirm'],
             { cwd: `${__dirname}/${folder}` },
         );
         const stdout = subprocess.stdout.toString('utf-8');
diff --git a/test/integration/common/commands.test.js b/test/integration/common/commands.test.js
@@ -10,7 +10,7 @@ describe('Integration tests of the plugin - using commands only', () => {
     const pathToServerlessFramework = '../../../../node_modules/serverless/bin/serverless';
 
     it('should indicate the command as not confirmed if the option is not provided', () => {
-        const subprocess = spawnSync('node', [pathToServerlessFramework, 'deploy'], {
+        const subprocess = spawnSync('node', [pathToServerlessFramework, 'deploy function'], {
             cwd: `${__dirname}/${folder}`,
         });
         const stdout = subprocess.stdout.toString('utf-8');
@@ -21,9 +21,13 @@ describe('Integration tests of the plugin - using commands only', () => {
     }).timeout(5000);
 
     it('should indicate the command as confirmed if the option is provided', () => {
-        const subprocess = spawnSync('node', [pathToServerlessFramework, 'deploy', '--confirm'], {
-            cwd: `${__dirname}/${folder}`,
-        });
+        const subprocess = spawnSync(
+            'node',
+            [pathToServerlessFramework, 'deploy function', '--confirm'],
+            {
+                cwd: `${__dirname}/${folder}`,
+            },
+        );
         const stdout = subprocess.stdout.toString('utf-8');
         const confirmed = stdout.includes('Command confirmed.');
         const serverlessError = stdout.includes('Serverless Error');
@@ -32,7 +36,7 @@ describe('Integration tests of the plugin - using commands only', () => {
     }).timeout(5000);
 
     it('should not do anything if the command does not require confirmation', () => {
-        const subprocess = spawnSync('node', [pathToServerlessFramework, 'remove'], {
+        const subprocess = spawnSync('node', [pathToServerlessFramework, 'deploy'], {
             cwd: `${__dirname}/${folder}`,
         });
         const stdout = subprocess.stdout.toString('utf-8');
diff --git a/test/integration/common/commands/serverless.yml b/test/integration/common/commands/serverless.yml
@@ -17,4 +17,4 @@ plugins:
 custom:
   confirm:
     commands:
-      - 'deploy'
+      - 'deploy function'
diff --git a/test/unit/helpers.js b/test/unit/helpers.js
@@ -14,6 +14,11 @@ module.exports = {
         'webtasks',
     ],
 
+    msgConfirmed: 'Command confirmed. Proceeding...',
+
+    msgNotConfirmed:
+        'Command not confirmed. Use [--confirm] or change the configuration of the plugin.',
+
     buildCustomConfirm(commands, stages, commandsForStages) {
         return {
             confirm: {
@@ -27,7 +32,7 @@ module.exports = {
     },
 
     buildServerless(processedCommands, stage, custom, provider) {
-        return {
+        const serverlessObject = {
             processedInput: {
                 commands: processedCommands,
                 options: {
@@ -53,6 +58,16 @@ module.exports = {
                 custom,
             },
         };
+        if (provider === 'aws') {
+            serverlessObject.providers = {
+                aws: {
+                    getStage() {
+                        return stage;
+                    },
+                },
+            };
+        }
+        return serverlessObject;
     },
 
     constructPlugin(processedCommands, stage, custom, provider) {
diff --git a/test/unit/serverless-confirm-command.test.js b/test/unit/serverless-confirm-command.test.js
