feat(deploy): Add API_RESOLVE_GIT_REF as action param

fixes #1007

Author: tripodsan

src/deploy.cmd.js

@@ -53,6 +53,7 @@ class DeployCommand extends StaticCommand {
     this._createPackages = 'auto';
     this._addStrain = null;
     this._enableMinify = false;
+    this._resolveGitRefSvc = 'helix-services/resolve-git-ref@v1';
   }
 
   get requireConfigFile() {
@@ -139,6 +140,11 @@ class DeployCommand extends StaticCommand {
     return this;
   }
 
+  withResolveGitRefService(value) {
+    this._resolveGitRefSvc = value;
+    return this;
+  }
+
   actionName(script) {
     if (script.main.indexOf(path.resolve(__dirname, 'openwhisk')) === 0) {
       return `hlx--${script.name}`;
@@ -389,6 +395,11 @@ Alternatively you can auto-add one using the {grey --add <name>} option.`);
       .map(script => fs.readFile(script.zipFile)
         .then(action => ({ script, action })));
 
+    // get API url of resolve action
+    if (this._resolveGitRefSvc) {
+      params.RESOLVE_GITREF_SERVICE = this._resolveGitRefSvc;
+    }
+
     // create openwhisk package
     if (!this._dryRun) {
       const parameters = Object.keys(params).map((key) => {
@@ -411,10 +422,10 @@ Alternatively you can auto-add one using the {grey --add <name>} option.`);
       tick(`created package ${this._prefix}`, '');
     }
 
-    let updatestatic;
+    let bindHelixServices;
     // bind helix-services
-    if (this._bindStatic && !this._dryRun) {
-      updatestatic = openwhisk.packages.update({
+    if (!this._dryRun) {
+      bindHelixServices = openwhisk.packages.update({
         package: {
           binding: {
             namespace: 'helix', // namespace to bind from
@@ -425,10 +436,8 @@ Alternatively you can auto-add one using the {grey --add <name>} option.`);
       }).then(() => {
         tick('bound helix-services', '');
       });
-      // we don't have to wait for this.
     }
 
-
     // ... and deploy
     const deployed = read.map(p => p.then(({ script, action }) => {
       const actionoptions = {
@@ -459,7 +468,7 @@ Alternatively you can auto-add one using the {grey --add <name>} option.`);
       });
     }));
 
-    await Promise.all([...deployed, updatestatic]);
+    await Promise.all([...deployed, bindHelixServices]);
 
 
     let numErrors = 0;

src/deploy.js

@@ -91,6 +91,12 @@ module.exports = function deploy() {
           type: 'boolean',
           default: false,
         })
+        .option('svc-resolve-git-ref', {
+          alias: 'svcResolveGitRef',
+          describe: 'Service name for git-resolve-ref service',
+          type: 'string',
+          default: 'helix-services/resolve-git-ref@v1',
+        })
         .array('default')
         .nargs('default', 2)
         .coerce('default', arg => arg.reduce((result, value, index, array) => {
@@ -160,6 +166,7 @@ module.exports = function deploy() {
         .withAddStrain(argv.add)
         .withStatic(argv.static)
         .withMinify(argv.minify)
+        .withResolveGitRefService(argv.svcResolveGitRef)
         .run();
     },
 

test/fixtures/all.env

@@ -43,6 +43,7 @@ HLX_DIRTY = true
 HLX_WSK_AUTH = foobar
 HLX_WSK_NAMESPACE = 1234
 HLX_WSK_HOST = myruntime.net
+HLX_SVC_RESOLVE_GIT_REF = resolve.api
 
 #HLX_DEFAULT <forbidden use through env>
 #HLX_ADD = <forbidden use through env>

test/testDeployCli.js

@@ -48,6 +48,7 @@ describe('hlx deploy', () => {
     mockDeploy.withAddStrain.returnsThis();
     mockDeploy.withStatic.returnsThis();
     mockDeploy.withMinify.returnsThis();
+    mockDeploy.withResolveGitRefService.returnsThis();
     mockDeploy.run.returnsThis();
 
     // disable static functions as well to avoid shelljs executions.
@@ -128,6 +129,7 @@ OpenWhisk Namespace is required`);
     sinon.assert.calledWith(mockDeploy.withCircleciAuth, '');
     sinon.assert.calledWith(mockDeploy.withDryRun, false);
     sinon.assert.calledWith(mockDeploy.withMinify, false);
+    sinon.assert.calledWith(mockDeploy.withResolveGitRefService, 'helix-services/resolve-git-ref@v1');
     sinon.assert.calledOnce(mockDeploy.run);
   });
 
@@ -151,6 +153,7 @@ OpenWhisk Namespace is required`);
     sinon.assert.calledWith(mockDeploy.withCircleciAuth, 'foobar');
     sinon.assert.calledWith(mockDeploy.withDryRun, true);
     sinon.assert.calledWith(mockDeploy.withMinify, true);
+    sinon.assert.calledWith(mockDeploy.withResolveGitRefService, 'resolve.api');
     sinon.assert.calledOnce(mockDeploy.run);
   });
 
@@ -369,4 +372,17 @@ OpenWhisk Namespace is required`);
     sinon.assert.calledWith(mockDeploy.withAddStrain, '');
     sinon.assert.calledOnce(mockDeploy.run);
   });
+
+  it('hlx deploy can set the resolve api', () => {
+    new CLI()
+      .withCommandExecutor('deploy', mockDeploy)
+      .run(['deploy',
+        '--wsk-auth', 'secret-key',
+        '--wsk-namespace', 'hlx',
+        '--svc-resolve-git-ref', 'helix-services/foobar',
+      ]);
+
+    sinon.assert.calledWith(mockDeploy.withResolveGitRefService, 'helix-services/foobar');
+    sinon.assert.calledOnce(mockDeploy.run);
+  });
 });

test/testDeployCmd.js

@@ -450,7 +450,41 @@ describe('hlx deploy (Integration)', () => {
       delete res.body;
     });
     this.polly.server.put(`https://adobeioruntime.net/api/v1/namespaces/hlx/packages/${ref}`).intercept((req, res) => {
-      res.sendStatus(201);
+      const body = JSON.parse(req.body);
+      try {
+        assert.deepEqual(body, {
+          publish: true,
+          parameters: [
+            {
+              key: 'FOO',
+              value: 'bar',
+            },
+            {
+              key: 'LOGGLY_HOST',
+              value: 'loggly-host',
+            },
+            {
+              key: 'LOGGLY_KEY',
+              value: 'loggly-auth',
+            },
+            {
+              key: 'RESOLVE_GITREF_SERVICE',
+              value: 'my-resolver',
+            },
+          ],
+          annotations: [
+            {
+              key: 'hlx-code-origin',
+              value: 'ssh://git@github.com/adobe/project-helix.io.git#master',
+            },
+          ],
+        });
+        res.sendStatus(201);
+      } catch (e) {
+        // eslint-disable-next-line no-console
+        console.error(e);
+        res.sendStatus(500);
+      }
     });
     this.polly.server.put('https://adobeioruntime.net/api/v1/namespaces/hlx/actions/hlx--static').intercept((req, res) => {
       res.sendStatus(201);
@@ -478,6 +512,12 @@ describe('hlx deploy (Integration)', () => {
       .withDryRun(false)
       .withTarget(buildDir)
       .withMinify(false)
+      .withLogglyAuth('loggly-auth')
+      .withLogglyHost('loggly-host')
+      .withDefault({
+        FOO: 'bar',
+      })
+      .withResolveGitRefService('my-resolver')
       .run();
 
     assert.equal(cmd.config.strains.get('default').package, '');