feat: added gcloud_component flag to force alpha or beta (#294)

* feat: added gcloud_components flag to force alpha or beta

* fix: addressed pr comments

* fix: inline defaults

* fix: addressed pr comments

Author: verbanicm

README.md

@@ -89,6 +89,7 @@ jobs:
 | `tag_traffic` | _optional_ | | Comma separated list of traffic assignments in the form TAG=PERCENTAGE. |
 | `flags` | _optional_ | | Space separated list of other Cloud Run flags, examples can be found: https://cloud.google.com/sdk/gcloud/reference/run/deploy#FLAGS. |
 | `gcloud_version` | _optional_ | `latest` | Pin the version of Cloud SDK `gcloud` CLI. |
+| `gcloud_component` | _optional_ | | Pin the Cloud SDK `gcloud` CLI components version, valid values are `alpha` or `beta`. |
 | `credentials`| Required if not using the `setup-gcloud` action with exported credentials. | | (**Deprecated**) This input is deprecated. See [auth section](https://github.com/google-github-actions/deploy-cloudrun#via-google-github-actionsauth) for more details. Service account key to use for authentication. This should be the JSON formatted private key which can be exported from the Cloud Console. The value can be raw or base64-encoded.  |
 
 ### Metadata customizations

action.yml

@@ -143,6 +143,13 @@ inputs:
       installed. Example: "290.0.1".
     required: false
 
+  gcloud_component:
+    description: |-
+      Version of the Cloud SDK components to install and use. If unspecified, the latest
+      or released version will be used. This is the equivalent of running 
+      'gcloud alpha run' or 'gcloud beta run'. Valid values are `alpha` or `beta`.
+    required: false
+
 outputs:
   url:
     description: The URL of your Cloud Run service

src/deploy-cloudrun.ts

@@ -17,6 +17,7 @@
 import * as core from '@actions/core';
 import { getExecOutput } from '@actions/exec';
 import * as toolCache from '@actions/tool-cache';
+import { presence } from '@google-github-actions/actions-utils/dist';
 import * as setupGcloud from '@google-github-actions/setup-cloud-sdk';
 import path from 'path';
 import { parseDeployResponse, parseUpdateTrafficResponse } from './output-parser';
@@ -54,6 +55,7 @@ export async function run(): Promise<void> {
     const credentials = core.getInput('credentials'); // Service account key
     let projectId = core.getInput('project_id');
     let gcloudVersion = core.getInput('gcloud_version');
+    let gcloudComponent = presence(core.getInput('gcloud_component')); // Cloud SDK component version
     // Flags
     const envVars = core.getInput('env_vars'); // String of env vars KEY=VALUE,...
     const secrets = core.getInput('secrets'); // String of secrets KEY=VALUE,...
@@ -77,7 +79,6 @@ export async function run(): Promise<void> {
     }
 
     let responseType = ResponseTypes.DEPLOY; // Default response type for output parsing
-    let installBeta = false; // Flag for installing gcloud beta components
     let cmd;
 
     // Throw errors if inputs aren't valid
@@ -88,6 +89,11 @@ export async function run(): Promise<void> {
       throw new Error('No service name set.');
     }
 
+    // Validate gcloud component input
+    if (gcloudComponent && gcloudComponent !== 'alpha' && gcloudComponent !== 'beta') {
+      throw new Error(`invalid input received for gcloud_component: ${gcloudComponent}`);
+    }
+
     // Find base command
     if (revTraffic || tagTraffic) {
       // Set response type for output parsing
@@ -104,7 +110,7 @@ export async function run(): Promise<void> {
         '--region',
         region,
       ];
-      installBeta = true;
+      gcloudComponent = gcloudComponent ?? 'beta';
       if (revTraffic) cmd.push('--to-revisions', revTraffic);
       if (tagTraffic) cmd.push('--to-tags', tagTraffic);
     } else if (source) {
@@ -121,7 +127,7 @@ export async function run(): Promise<void> {
         '--source',
         source,
       ];
-      installBeta = true;
+      gcloudComponent = gcloudComponent ?? 'beta';
       if (timeout) cmd.push('--timeout', timeout);
     } else if (metadata) {
       // Deploy service from metadata
@@ -131,7 +137,7 @@ export async function run(): Promise<void> {
         );
       }
       cmd = ['run', 'services', 'replace', metadata, '--platform', 'managed', '--region', region];
-      installBeta = true;
+      gcloudComponent = gcloudComponent ?? 'beta';
     } else {
       // Deploy service with image specified
       cmd = [
@@ -152,11 +158,11 @@ export async function run(): Promise<void> {
       if (envVars) cmd.push('--update-env-vars', envVars);
       if (secrets) {
         cmd.push('--update-secrets', secrets.replace('\n', ','));
-        installBeta = true;
+        gcloudComponent = gcloudComponent ?? 'beta';
       }
       if (tag) {
         cmd.push('--tag', tag);
-        installBeta = true;
+        gcloudComponent = gcloudComponent ?? 'beta';
       }
       if (suffix) cmd.push('--revision-suffix', suffix);
       if (noTraffic) cmd.push('--no-traffic');
@@ -199,10 +205,10 @@ export async function run(): Promise<void> {
     }
     if (projectId) cmd.push('--project', projectId);
 
-    // Install beta components if needed and prepend the beta command
-    if (installBeta) {
-      await setupGcloud.installComponent('beta');
-      cmd.unshift('beta');
+    // Install gcloud component if needed and prepend the command
+    if (gcloudComponent) {
+      await setupGcloud.installComponent(gcloudComponent);
+      cmd.unshift(gcloudComponent);
     }
 
     // Set output format to json

tests/unit/deploy-cloudrun.test.ts

@@ -163,6 +163,28 @@ describe('#deploy-cloudrun', function () {
       await run();
       expect(this.stubs.setFailed.callCount).to.eq(1);
     });
+    it('uses default components without gcloud_component flag', async function () {
+      await run();
+      expect(this.stubs.installComponent.callCount).to.eq(0);
+    });
+    it('throws error with invalid gcloud component flag', async function () {
+      this.stubs.getInput.withArgs('gcloud_component').returns('wrong_value');
+      await run();
+      expect(
+        this.stubs.setFailed.withArgs(`invalid input received for gcloud_component: wrong_value`)
+          .callCount,
+      ).to.be.at.least(1);
+    });
+    it('installs alpha component with alpha flag', async function () {
+      this.stubs.getInput.withArgs('gcloud_component').returns('alpha');
+      await run();
+      expect(this.stubs.installComponent.withArgs('alpha').callCount).to.eq(1);
+    });
+    it('installs beta component with beta flag', async function () {
+      this.stubs.getInput.withArgs('gcloud_component').returns('beta');
+      await run();
+      expect(this.stubs.installComponent.withArgs('beta').callCount).to.eq(1);
+    });
   });
 
   describe('#parseFlags', () => {