Merge pull request #347 from serverless-heaven/skip-build-with-invoke-local

Add --no-build switch for invoke local to use already compiled output

Author: HyperBrain

README.md

@@ -422,6 +422,19 @@ All options that are supported by invoke local can be used as usual:
 
 > :exclamation: The old `webpack invoke` command has been disabled.
 
+#### Run a function with an existing compiled output (--no-build)
+
+On CI systems it is likely that you'll run multiple integration tests with `invoke local`
+sequentially. To improve this, you can do one compile and run multiple invokes on the
+compiled output -  it is not necessary to compile again before each and every invoke.
+
+```bash
+$ serverless webpack
+$ serverless invoke local --function <function-name-1> --no-build
+$ serverless invoke local --function <function-name-2> --no-build
+...
+```
+
 ### Run a function locally on source changes
 
 Or to run a function every time the source files change use the `--watch` option

index.js

@@ -112,9 +112,14 @@ class ServerlessWebpack {
       'before:invoke:local:invoke': () => BbPromise.bind(this)
         .then(() => {
           lib.webpack.isLocal = true;
+          // --no-build override
+          if (this.options.build === false) {
+            this.skipCompile = true;
+          }
+
           return this.serverless.pluginManager.spawn('webpack:validate');
         })
-        .then(() => this.serverless.pluginManager.spawn('webpack:compile'))
+        .then(() => this.skipCompile ? BbPromise.resolve() : this.serverless.pluginManager.spawn('webpack:compile'))
         .then(this.prepareLocalInvoke),
 
       'after:invoke:local:invoke': () => BbPromise.bind(this)
@@ -181,7 +186,7 @@ class ServerlessWebpack {
           lib.webpack.isLocal = true;
         })
         .then(this.prepareStepOfflineInvoke)
-        .then(this.compile)
+        .then(() => this.serverless.pluginManager.spawn('webpack:compile')),
     };
   }
 }

index.test.js

@@ -200,6 +200,17 @@ describe('ServerlessWebpack', () => {
               return null;
             });
           });
+
+          it('should skip compile if requested', () => {
+            slsw.options.build = false;
+            return expect(slsw.hooks['before:invoke:local:invoke']()).to.be.fulfilled
+            .then(() => {
+              expect(slsw.serverless.pluginManager.spawn).to.have.been.calledOnce;
+              expect(slsw.serverless.pluginManager.spawn).to.have.been.calledWithExactly('webpack:validate');
+              expect(slsw.prepareLocalInvoke).to.have.been.calledOnce;
+              return null;
+            });
+          });
         }
       },
       {
@@ -357,7 +368,8 @@ describe('ServerlessWebpack', () => {
             .then(() => {
               expect(ServerlessWebpack.lib.webpack.isLocal).to.be.true;
               expect(slsw.prepareStepOfflineInvoke).to.have.been.calledOnce;
-              expect(slsw.compile).to.have.been.calledOnce;
+              expect(slsw.serverless.pluginManager.spawn).to.have.been.calledOnce;
+              expect(slsw.serverless.pluginManager.spawn).to.have.been.calledWithExactly('webpack:compile');
               return null;
             });
           });

lib/validate.js

@@ -143,6 +143,15 @@ module.exports = {
       this.webpackConfig.output.path = path.join(this.serverless.config.servicePath, this.options.out);
     }
 
+    if (this.skipCompile) {
+      this.serverless.cli.log('Skipping build and using existing compiled output');
+      if (!fse.pathExistsSync(this.webpackConfig.output.path)) {
+        return BbPromise.reject(new this.serverless.classes
+          .Error('No compiled output found'));
+      }
+      this.keepOutputDirectory = true;
+    }
+
     if (!this.keepOutputDirectory) {
       this.options.verbose && this.serverless.cli.log(`Removing ${this.webpackConfig.output.path}`);
       fse.removeSync(this.webpackConfig.output.path);

tests/mocks/fs-extra.mock.js

@@ -8,6 +8,7 @@ module.exports.create = sandbox => {
   const fsExtraMock = {
     copy: sandbox.stub().yields(),
     pathExists: sandbox.stub().yields(),
+    pathExistsSync: sandbox.stub().returns(false),
     removeSync: sandbox.stub()
   };
 

tests/validate.test.js

@@ -53,6 +53,7 @@ describe('validate', () => {
 
   afterEach(() => {
     fsExtraMock.removeSync.reset();
+    fsExtraMock.pathExistsSync.reset();
     sandbox.restore();
   });
 
@@ -733,6 +734,38 @@ describe('validate', () => {
         });
       });
     });
+  });
 
+  describe('with skipped builds', () => {
+    it('should keep output directory', () => {
+      const testConfig = {
+        entry: 'test',
+        output: {},
+      };
+      const testServicePath = 'testpath';
+      module.serverless.config.servicePath = testServicePath;
+      _.set(module.serverless.service, 'custom.webpack.config', testConfig);
+      module.skipCompile = true;
+      fsExtraMock.pathExistsSync.returns(true);
+      return module
+      .validate()
+      .then(() => {
+        expect(module.keepOutputDirectory).to.be.true;
+        return null;
+      });
+    });
+
+    it('should fail without exiting output', () => {
+      const testConfig = {
+        entry: 'test',
+        output: {},
+      };
+      const testServicePath = 'testpath';
+      module.serverless.config.servicePath = testServicePath;
+      _.set(module.serverless.service, 'custom.webpack.config', testConfig);
+      module.skipCompile = true;
+      fsExtraMock.pathExistsSync.returns(false);
+      return expect(module.validate()).to.be.rejectedWith(/No compiled output found/);
+    });
   });
 });