@hiiretail/gcp-infra-cli 0.104.0 → 1.0.1

package/generators/common-resources/monitoring/templates/service/terragrunt.hcl

@@ -1,37 +0,0 @@
-# Terragrunt will copy the Terraform configurations specified by the source parameter, along with any files in the
-# working directory, into a temporary folder, and execute your Terraform commands in that folder.
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-alert-policy//?ref=v2.0.0"
-}
-
-# Include all settings from the root terragrunt.hcl file
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-dependency "notification_channels" {
-  config_path = "../notification-channels"
-  mock_outputs = {
-    notification_channels = ["dummy-channel"]
-  }
-}
-
-locals {
-  project_vars = read_terragrunt_config(find_in_parent_folders("project.hcl"))
-  common_vars  = read_terragrunt_config(find_in_parent_folders("common.hcl"))
-  alerts       = flatten([for file in fileset(get_terragrunt_dir(), "./*.yaml") : yamldecode(file(file))])
-  labels = merge(local.common_vars.locals.default_user_labels, local.project_vars.locals.default_user_labels, {
-    component    = local.common_vars.locals.component
-    product      = local.common_vars.locals.product
-    tenant-alias = local.common_vars.locals.tenant_alias
-  })
-}
-
-# These are the variables we have to pass in to use the module specified in the terragrunt configuration above
-inputs = {
-  project                        = local.project_vars.locals.project_id,
-  policies                       = local.alerts,
-  notification_channel_ids       = dependency.notification_channels.outputs.notification_channels,
-  fallback_notification_channels = dependency.notification_channels.outputs.fallback_channels_ids,
-  default_user_labels            = local.labels,
-}

package/generators/common-resources/monitoring/templates/uptime-checks/terragrunt.hcl

@@ -1,36 +0,0 @@
-# Terragrunt will copy the Terraform configurations specified by the source parameter, along with any files in the
-# working directory, into a temporary folder, and execute your Terraform commands in that folder.
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-uptime-check//?ref=v1.0.1"
-}
-
-# Include all settings from the root terragrunt.hcl file
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-dependency "notification_channels" {
-  config_path = "../notification-channels"
-  mock_outputs = {
-    notification_channels = ["dummy-channel"]
-  }
-}
-
-locals {
-  project_vars = read_terragrunt_config(find_in_parent_folders("project.hcl"))
-  common_vars  = read_terragrunt_config(find_in_parent_folders("common.hcl"))
-  labels = merge(local.common_vars.locals.default_user_labels, local.project_vars.locals.default_user_labels, {
-    component    = local.common_vars.locals.component
-    product      = local.common_vars.locals.product
-    tenant-alias = local.common_vars.locals.tenant_alias
-  })
-}
-
-# These are the variables we have to pass in to use the module specified in the terragrunt configuration above
-inputs = {
-  project                        = local.project_vars.locals.project_id,
-  uptime_checks                  = yamldecode(file("${get_terragrunt_dir()}/uptime-checks.yaml"))
-  notification_channel_ids       = dependency.notification_channels.outputs.notification_channels,
-  fallback_notification_channels = dependency.notification_channels.outputs.fallback_channels_ids,
-  default_user_labels            = local.labels
-}

package/generators/common-resources/monitoring/templates/uptime-checks/uptime-checks.yaml

@@ -1,3 +0,0 @@
-service_name: <%-systemName%>.<%-serviceName%>
-hostname: <%-hostname%>
-path: <%-path%>

package/generators/common-resources/monitoring/validate.js

@@ -1,58 +0,0 @@
-const validate = {};
-
-const hasWhitespace = (str) => /\s/.test(str);
-
-const isUrl = (str) => {
-  try {
-    return Boolean(new URL(str));
-  } catch (error) {
-    return false;
-  }
-};
-
-validate.clan = (input) => {
-  if (!hasWhitespace(input)) return true;
-  return 'Clan name must not include spaces';
-};
-
-validate.projectId = (input) => {
-  if (input.trim() !== '' && !hasWhitespace(input)) return true;
-  return 'Project ID must not be empty or contain spaces';
-};
-
-validate.hostname = (input) => {
-  if (input.split('.').at(-1) === 'com' && !hasWhitespace(input)) return true;
-  return 'Hostname must not include path to the page to run the check against or spaces';
-};
-
-validate.systemName = (input) => {
-  if (input.length === 3 && !hasWhitespace(input)) return true;
-  return 'System name must be 3 characters';
-};
-
-validate.confluenceUrl = (input) => {
-  if (input === '' || (isUrl(input) && !hasWhitespace(input))) return true;
-  return 'You must enter a valid URL';
-};
-
-validate.instanceID = (input) => {
-  if (input.split('/').length === 6 && !hasWhitespace(input)) return true;
-  return 'You must enter the full instance path (example: projects/example/locations/europe-west1/instances/instanceID)';
-};
-
-validate.databaseId = (input) => {
-  if (input.split(':').length === 2 && !hasWhitespace(input)) return true;
-  return 'You must enter the full database path (example: my-project:databaseID)';
-};
-
-validate.pubSubSubscription = (input) => {
-  if (input.split('/').length === 4 && !hasWhitespace(input)) return true;
-  return 'You must enter the full subscription path (example: projects/example/subscriptions/subscriptionId)';
-};
-
-validate.path = (input) => {
-  if (input.includes('/') && !hasWhitespace(input)) return true;
-  return 'Path must contain a slash and not include spaces';
-};
-
-module.exports = validate;

package/generators/common-resources/pubsub/append.js

@@ -1,120 +0,0 @@
-const yaml = require('js-yaml');
-const fs = require('fs');
-
-const addDLQ = async (yamlArray, env, dlqTopic) => {
-  if (env === 'prod') {
-    /* eslint-disable */
-    yamlArray[0].dead_letter_topic = dlqTopic;
-    /* eslint-enable */
-  }
-};
-
-const appendNotIncludePull = async (inputs, subscriptionFilePath, dlqTopic) => {
-  const pullArray = [];
-
-  pullArray.push(
-    {
-      name: `${inputs.existingTopic}+${inputs.subscriberName}`,
-      ack_deadline_seconds: '60',
-      expiration_policy: '',
-    },
-  );
-
-  await addDLQ(pullArray, inputs.env, dlqTopic);
-  const yamlPullArray = yaml.dump(pullArray);
-  fs.appendFileSync(subscriptionFilePath, `pull_subscriptions:\n${yamlPullArray}`);
-};
-
-const appendIncludePull = async (
-  fileContent,
-  originalContentYaml,
-  subscriptionFilePath,
-  input,
-  dlqTopic) => {
-  if (fileContent.includes('pull_subscriptions')) {
-    const pullArray = Object.values(originalContentYaml.pull_subscriptions);
-    const yamlPullArray = yaml.dump(pullArray);
-    fs.writeFileSync(subscriptionFilePath, `pull_subscriptions:\n${yamlPullArray}`);
-  }
-
-  const newPullArray = [];
-
-  newPullArray.push(
-    {
-      name: `${input.existingTopic}+${input.subscriberName}`,
-      ack_deadline_seconds: '60',
-      expiration_policy: '',
-    },
-  );
-
-  await addDLQ(newPullArray, input.env, dlqTopic);
-  const finalYamlPullArray = yaml.dump(newPullArray);
-  fs.appendFileSync(subscriptionFilePath, finalYamlPullArray);
-
-  if (fileContent.includes('push_subscriptions')) {
-    const pushArray = Object.values(originalContentYaml.push_subscriptions);
-    const yamlPushArray = yaml.dump(pushArray);
-    fs.appendFileSync(subscriptionFilePath, `push_subscriptions:\n${yamlPushArray}`);
-  }
-};
-
-const appendNotIncludePush = async (inputs, subscriptionFilePath, dlqTopic) => {
-  const pushArray = [];
-
-  pushArray.push(
-    {
-      name: `${inputs.existingTopic}+${inputs.subscriberName}`,
-      push_endpoint: inputs.pushEndpoint,
-      oidc_service_account_email: inputs.oidcEmail,
-      audience: inputs.audience,
-      expiration_policy: '',
-      filter: `attributes.Consumer = "${inputs.subscriberName}" OR NOT attributes:Consumer`,
-    },
-  );
-
-  await addDLQ(pushArray, inputs.env, dlqTopic);
-  const yamlPushArray = yaml.dump(pushArray);
-  fs.appendFileSync(subscriptionFilePath, `push_subscriptions:\n${yamlPushArray}`);
-};
-
-const appendIncludePush = async (
-  fileContent,
-  originalContentYaml,
-  subscriptionFilePath,
-  input,
-  dlqTopic) => {
-  if (fileContent.includes('push_subscriptions')) {
-    const pushArray = Object.values(originalContentYaml.push_subscriptions);
-    const yamlPushArray = yaml.dump(pushArray);
-    fs.writeFileSync(subscriptionFilePath, `push_subscriptions:\n${yamlPushArray}`);
-  }
-
-  const newPushArray = [];
-
-  newPushArray.push(
-    {
-      name: `${input.existingTopic}+${input.subscriberName}`,
-      push_endpoint: input.pushEndpoint,
-      oidc_service_account_email: input.oidcEmail,
-      audience: input.audience,
-      expiration_policy: '',
-      filter: `attributes.Consumer = "${input.subscriberName}" OR NOT attributes:Consumer`,
-    },
-  );
-  await addDLQ(newPushArray, input.env, dlqTopic);
-  const yamlPushArray = yaml.dump(newPushArray);
-  fs.appendFileSync(subscriptionFilePath, yamlPushArray);
-
-  if (fileContent.includes('pull_subscriptions')) {
-    const pullArray = Object.values(originalContentYaml.pull_subscriptions);
-    const yamlPullArray = yaml.dump(pullArray);
-    fs.appendFileSync(subscriptionFilePath, `pull_subscriptions:\n${yamlPullArray}`);
-  }
-};
-
-module.exports = {
-  appendNotIncludePull,
-  appendIncludePull,
-  appendNotIncludePush,
-  appendIncludePush,
-};

package/generators/common-resources/pubsub/generator.json

@@ -1,4 +0,0 @@
-{
-  "name": "Pub/Sub",
-  "description": "Create a PubSub resource"
-}

package/generators/common-resources/pubsub/get-gcp-projects.js

@@ -1,34 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-
-const getKeyValue = (content, key) => {
-  let value = '';
-  content.split(/\r?\n/).forEach((line) => {
-    if (line.startsWith(key)) {
-      value = line.split('=')[1].replace('"', '').replace('"', '').trim();
-    }
-  });
-  return value;
-};
-
-const getProjectId = (env) => {
-  let projectId = '';
-  const projectHCL = path.join('infra', env, 'project.hcl');
-  if (fs.existsSync(projectHCL)) {
-    const projectHCLContent = fs.readFileSync(projectHCL, 'utf8');
-    projectId = getKeyValue(projectHCLContent, '  project_id');
-  }
-
-  return projectId;
-};
-
-const getProdPushEndopint = (pushEndpoint) => {
-  let prodPushEndopint = '';
-  prodPushEndopint = pushEndpoint.replace('.dev', '.com');
-  return prodPushEndopint;
-};
-
-module.exports = {
-  getProjectId,
-  getProdPushEndopint,
-};

package/generators/common-resources/pubsub/handle-subscribers.js

@@ -1,63 +0,0 @@
-const fs = require('fs');
-const yaml = require('js-yaml');
-const {
-  appendNotIncludePull, appendIncludePull, appendNotIncludePush, appendIncludePush,
-} = require('./append');
-
-const handleSubscribers = async (
-  env,
-  answers,
-  oidcEmail,
-  pushEndpoint,
-  subscriptionFilePath,
-  dlqTopic) => {
-  const {
-    subscriberName,
-    existingTopic,
-    pushOrPull,
-    audience,
-  } = answers;
-
-  const subscriptionFileContent = fs.readFileSync(subscriptionFilePath, 'utf8');
-
-  const inputs = {
-    ...this.answers,
-    env,
-    existingTopic,
-    subscriberName,
-    audience,
-    oidcEmail,
-    pushEndpoint,
-    dlqTopic,
-  };
-
-  if (pushOrPull === 'pull') {
-    if (subscriptionFileContent.length === 0 || !subscriptionFileContent.includes('pull_subscriptions')) {
-      await appendNotIncludePull(inputs, subscriptionFilePath, dlqTopic);
-    } else {
-      const originalContentYaml = yaml.load(subscriptionFileContent);
-      const fileContent = subscriptionFileContent;
-      await appendIncludePull(
-        fileContent,
-        originalContentYaml,
-        subscriptionFilePath,
-        inputs,
-        dlqTopic,
-      );
-    }
-  } else if (subscriptionFileContent.length === 0 || !subscriptionFileContent.includes('push_subscriptions')) {
-    await appendNotIncludePush(inputs, subscriptionFilePath, dlqTopic);
-  } else {
-    const originalContentYaml = yaml.load(subscriptionFileContent);
-    const fileContent = subscriptionFileContent;
-    await appendIncludePush(
-      fileContent,
-      originalContentYaml,
-      subscriptionFilePath,
-      inputs,
-      dlqTopic,
-    );
-  }
-};
-
-module.exports = handleSubscribers;

package/generators/common-resources/pubsub/index.js

@@ -1,316 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const fs = require('fs');
-const BaseGenerator = require('../../../src/BaseGenerator');
-const { required } = require('../../../src/validators');
-const {
-  validSystemName,
-  validVersion,
-  validSubscriberName,
-  checkExistingTopicPath,
-} = require('./validate');
-const handleSubscribers = require('./handle-subscribers');
-const { getProjectId, getProdPushEndopint } = require('./get-gcp-projects');
-
-module.exports = class extends BaseGenerator {
-  prompting() {
-    const prompts = [
-      {
-        type: 'list',
-        name: 'createResource',
-        message: 'Do you want to create a new topic or a subscription?',
-        default: 'subscription',
-        choices: ['topic', 'subscription'],
-      },
-      {
-        when: (response) => response.createResource === 'topic',
-        type: 'input',
-        name: 'systemName',
-        message: 'Please provide three-letter system name as defined in Styra',
-        validate: (input) => required(input) && validSystemName(input),
-      },
-      {
-        when: (response) => response.createResource === 'topic',
-        type: 'list',
-        name: 'scope',
-        message: 'Please select the scope for the topic',
-        default: 'private',
-        choices: ['private', 'public'],
-      },
-      {
-        when: (response) => response.createResource === 'topic',
-        type: 'list',
-        name: 'intention',
-        message: 'Please select the intention of the topic',
-        default: 'input',
-        choices: ['input', 'output', 'event', 'notification', 'audit', 'logging'],
-      },
-      {
-        when: (response) => response.createResource === 'topic',
-        type: 'input',
-        name: 'payload',
-        message: 'Please provide the payload (plural for entities, events - verb in the past tense)',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'topic',
-        type: 'input',
-        name: 'version',
-        message: 'Please provide the version',
-        default: 'v1',
-        validate: (input) => required(input) && validVersion(input),
-      },
-      {
-        when: (response) => response.createResource === 'subscription',
-        type: 'list',
-        name: 'externalSub',
-        message: 'Do you want to create an external subscription?',
-        default: 'no',
-        choices: ['no', 'yes'],
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.externalSub === 'yes',
-        type: 'input',
-        name: 'clanName',
-        message: 'Please provide the name of your clan',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.externalSub === 'yes',
-        type: 'input',
-        name: 'stagingProjectIdConsumer',
-        message: 'Please provide STAGING project_id of your clan',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.externalSub === 'yes',
-        type: 'input',
-        name: 'prodProjectIdConsumer',
-        message: 'Please provide PRODUCTION project_id of your clan',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.externalSub === 'yes',
-        type: 'input',
-        name: 'costCenter',
-        message: 'Please provide the cost center of your project (specified in your common.hcl file)',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription',
-        type: 'list',
-        name: 'pushOrPull',
-        message: 'Please select what type of subscription you want to create',
-        default: 'push',
-        choices: ['push', 'pull'],
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription',
-        type: 'input',
-        name: 'subscriberName',
-        message: 'Please provide the subscriber name in format <system-name>.<service-name>',
-        validate: (input) => required(input) && validSubscriberName(input),
-      },
-      {
-        when: (response) => response.createResource === 'subscription',
-        type: 'input',
-        name: 'existingTopic',
-        message: 'Please provide the name of the existing topic you want to subscribe to',
-        validate: (input) => required(input) && checkExistingTopicPath(input),
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.pushOrPull === 'push',
-        type: 'input',
-        name: 'stagePushEndpoint',
-        message: 'Please provide the push endpoint for the STAGING environment',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.pushOrPull === 'push',
-        type: 'input',
-        name: 'oidcName',
-        message: 'Please provide the service account name for generating the OIDC token (part after @ will be added automatically)',
-        validate: required,
-      },
-      {
-        when: (response) => response.createResource === 'subscription' && response.pushOrPull === 'push',
-        type: 'input',
-        name: 'audience',
-        message: 'Please provide the audience that will be used when generating OIDC token',
-        validate: required,
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = props;
-    });
-  }
-
-  writing() {
-    const {
-      systemName,
-      scope,
-      intention,
-      payload,
-      version,
-      topicName = `${systemName}.${scope}.${intention}.${payload}.${version}`,
-      subscriberName,
-      createResource,
-      existingTopic,
-      audience,
-      stagePushEndpoint,
-      oidcName,
-      pushOrPull,
-      clanName,
-      stagingProjectIdConsumer,
-      prodProjectIdConsumer,
-      costCenter,
-      externalSub,
-    } = this.answers;
-
-    const dlqTopicName = `dlq.${getProjectId('prod').split('-prod')[0]}.common`;
-    let dlqTopic = `projects/${getProjectId('prod')}/topics/${dlqTopicName}`;
-
-    const dlqTopicDirPath = path.join(process.cwd(), 'infra', 'prod', 'pubsub', dlqTopicName);
-    this.fs.copyTpl(
-      this.templatePath('pubsub-dlq/terragrunt.hcl'),
-      this.destinationPath(`${dlqTopicDirPath}/terragrunt.hcl`),
-      {
-        ...this.answers,
-      },
-    );
-
-    ['prod', 'staging'].forEach(async (env) => {
-      if (createResource === 'topic') {
-        const topicDirPath = path.join(process.cwd(), 'infra', env, 'pubsub', topicName);
-        ['terragrunt.hcl', 'spec.hcl'].forEach(async (file) => {
-          this.fs.copyTpl(
-            this.templatePath(`pubsub/${file}`),
-            this.destinationPath(`${topicDirPath}/${file}`),
-            {
-              ...this.answers,
-              env,
-              topicName,
-              subscriberName,
-              dlqTopic,
-            },
-          );
-        });
-      }
-
-      let projectId = getProjectId(env);
-      let oidcEmail = `${oidcName}@${projectId}.iam.gserviceaccount.com`;
-      let pushEndpoint = '';
-      if (env === 'prod' && pushOrPull === 'push') {
-        pushEndpoint = getProdPushEndopint(stagePushEndpoint);
-      } if (env === 'staging' && pushOrPull === 'push') {
-        pushEndpoint = stagePushEndpoint;
-      }
-
-      if (createResource === 'subscription' && externalSub === 'no') {
-        const subscriptionDirPath = path.join(process.cwd(), 'infra', env, 'pubsub', existingTopic);
-        const fullPath = `${subscriptionDirPath}/subscribers.yaml`;
-        if (!fs.existsSync(fullPath)) {
-          fs.writeFileSync(fullPath, '');
-          this.fs.copyTpl(
-            this.templatePath('pubsub/subscribers.yaml'),
-            this.destinationPath(fullPath),
-            {
-              ...this.answers,
-              env,
-              existingTopic,
-              subscriberName,
-              audience,
-              oidcEmail,
-              pushEndpoint,
-              dlqTopic,
-            },
-          );
-        }
-
-        ['terragrunt.hcl', 'spec.hcl'].forEach(async (file) => {
-          this.fs.copyTpl(
-            this.templatePath(`pubsub/${file}`),
-            this.destinationPath(`${subscriptionDirPath}/${file}`),
-            {
-              ...this.answers,
-              env,
-              existingTopic,
-            },
-          );
-        });
-
-        await handleSubscribers(env, this.answers, oidcEmail, pushEndpoint, `${subscriptionDirPath}/subscribers.yaml`, dlqTopic);
-      }
-      if (createResource === 'subscription' && externalSub === 'yes') {
-        const externalDirPath = path.join(process.cwd(), 'infra', 'prod', 'pubsub', existingTopic, `${clanName}-${env}`);
-        projectId = getProjectId('prod');
-        if (!fs.existsSync(externalDirPath)) {
-          fs.mkdirSync(externalDirPath);
-        }
-
-        ['terragrunt.hcl', 'spec.hcl'].forEach(async (file) => {
-          this.fs.copyTpl(
-            this.templatePath(`pubsub-external/${file}`),
-            this.destinationPath(`${externalDirPath}/${file}`),
-            {
-              ...this.answers,
-              env,
-              existingTopic,
-              stagingProjectIdConsumer,
-              prodProjectIdConsumer,
-              costCenter,
-              subscriberName,
-              projectId,
-            },
-          );
-        });
-
-        const externalSubPath = `${externalDirPath}/subscribers.yaml`;
-        if (env === 'staging') {
-          oidcEmail = `${oidcName}@${stagingProjectIdConsumer}.iam.gserviceaccount.com`;
-        } else {
-          oidcEmail = `${oidcName}@${prodProjectIdConsumer}.iam.gserviceaccount.com`;
-          dlqTopic = `projects/${prodProjectIdConsumer}/topics/${prodProjectIdConsumer.split('-')[0]}-common-dlq`;
-        }
-        if (!fs.existsSync(externalSubPath)) {
-          fs.writeFileSync(externalSubPath, '');
-          this.fs.copyTpl(
-            this.templatePath('pubsub-external/subscribers.yaml'),
-            this.destinationPath(externalSubPath),
-            {
-              ...this.answers,
-              env,
-              existingTopic,
-              subscriberName,
-              audience,
-              oidcEmail,
-              pushEndpoint,
-              dlqTopic,
-            },
-          );
-        }
-
-        await handleSubscribers(
-          env,
-          this.answers,
-          oidcEmail,
-          pushEndpoint,
-          externalSubPath,
-          dlqTopic,
-        );
-      }
-    });
-  }
-
-  end() {
-    this.log(`
-${chalk.green(`Your PubSub resources have now been created. To finalize your configuration, please continue
-with manual editing of the generated files.`)}
-${chalk.green('1.')} Review created subscribers.
-${chalk.green('2.')} Push this change in a feature branch and open a pull request.
-`);
-  }
-};

package/generators/common-resources/pubsub/templates/pubsub/spec.hcl

@@ -1,7 +0,0 @@
-locals {<% if (createResource == 'topic') { %>
-  topic                = "<%-topicName%>"
-  create_subscriptions = false<% } else { %>
-  topic                = "<%-existingTopic%>"
-  create_subscriptions = true <% } %>
-  create_topic         = true
-}