setup-gcloud/src/main.ts

/*
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as core from '@actions/core';
import * as toolCache from '@actions/tool-cache';
import {
  authenticateGcloudSDK,
  bestVersion,
  installComponent,
  installGcloudSDK,
  isAuthenticated,
  setProject,
} from '@google-github-actions/setup-cloud-sdk';
import {
  errorMessage,
  isPinnedToHead,
  pinnedToHeadWarning,
  parseBoolean,
  presence,
} from '@google-github-actions/actions-utils';
import path from 'path';

// Do not listen to the linter - this can NOT be rewritten as an ES6 import
// statement.
const { version: appVersion } = require('../package.json');

export async function run(): Promise<void> {
  // Note: unlike the other actions, we actually want to export this as a
  // persistent variable for future steps. Other actions should set process.env
  // or use stubEnv to only set metrics for the duration of the step.
  core.exportVariable('CLOUDSDK_METRICS_ENVIRONMENT', 'github-actions-setup-gcloud');
  core.exportVariable('CLOUDSDK_METRICS_ENVIRONMENT_VERSION', appVersion);

  process.env.CLOUDSDK_CORE_DISABLE_PROMPTS = '1';

  // Warn if pinned to HEAD
  if (isPinnedToHead()) {
    core.warning(pinnedToHeadWarning('v2'));
  }

  try {
    const skipInstall = parseBoolean(core.getInput('skip_install'));
    let version = presence(core.getInput('version'));
    const components = core.getInput('install_components');
    const projectId = core.getInput('project_id');

    if (skipInstall) {
      core.info(`Skipping installation ("skip_install" was true)`);
      if (version && version !== 'latest') {
        core.warning(`Ignoring "version" because "skip_install" was true!`);
      }

      if (components) {
        core.warning(
          `Installing custom components with the system-provided gcloud may fail. ` +
            `Set "skip_install" to false to install a managed version.`,
        );
      }
    } else {
      // Compute the version information. If the version was not specified,
      // accept any installed version. If the version was specified as "latest",
      // compute the latest version. Otherwise, accept the version/version
      // constraint as-is.
      if (!version) {
        core.debug(`version was unset, defaulting to any version`);
        version = '> 0.0.0';
      }
      if (version === 'latest') {
        core.debug(`resolving latest version`);
        version = await bestVersion('> 0.0.0');
        core.debug(`resolved latest version to ${version}`);
      }

      // Install the gcloud if not already present
      const toolPath = toolCache.find('gcloud', version);
      if (toolPath !== '') {
        core.addPath(path.join(toolPath, 'bin'));
      } else {
        core.debug(`no version of gcloud matching "${version}" is installed`);
        await installGcloudSDK(version);
      }
    }

    // Install additional components
    if (components) {
      await installComponent(components.split(',').map((comp) => comp.trim()));
    }

    // Authenticate - this comes from google-github-actions/auth
    const credFile = process.env.GOOGLE_GHA_CREDS_PATH;
    if (credFile) {
      await authenticateGcloudSDK(credFile);
      core.info('Successfully authenticated');
    } else {
      let authed;
      try {
        authed = await isAuthenticated();
      } catch {
        authed = false;
      }

      if (!authed) {
        core.warning(
          `The gcloud CLI is not authenticated (or it is not installed). ` +
            `Authenticate by adding the "google-github-actions/auth" step ` +
            `prior this one.`,
        );
      }
    }

    // Set the project ID, if given.
    if (projectId) {
      await setProject(projectId);
      core.info('Successfully set default project');
    }

    core.setOutput('version', version);
  } catch (err) {
    const msg = errorMessage(err);
    core.setFailed(`google-github-actions/setup-gcloud failed with: ${msg}`);
  }
}

if (require.main === module) {
  run();
}