@hiiretail/gcp-infra-cli 0.103.1 → 1.0.0

package/generators/organization/clan-project/index.js

@@ -1,139 +0,0 @@
-const path = require('path');
-const chalk = require('chalk');
-const BaseGenerator = require('../../../src/BaseGenerator');
-const {
-  chain,
-  required,
-  filename,
-  maxLength,
-} = require('../../../src/validators');
-const googleapis = require('./googlecloud');
-
-const resolveAnswer = (answers, name) => answers[`new-${name}`] || answers[name];
-
-module.exports = class extends BaseGenerator {
-  constructor(args, opts) {
-    super(args, opts);
-
-    // Output directory relative to the tf-infra-gcp directory.
-    this.destinationRoot('organization');
-  }
-
-  prompting() {
-    const prompts = [
-      {
-        type: 'list',
-        name: 'domain',
-        default: 'extendaretail-com',
-        message: 'Choose GCP Organization',
-        store: true,
-        choices: this.listSubDirectories(this.destinationPath()),
-        validate: required,
-      },
-      ...this.chooseOrCreatePrompts(
-        'department',
-        (answers) => path.join(this.destinationPath(), answers.domain, 'departments'),
-      ),
-      ...this.chooseOrCreatePrompts(
-        'tribe',
-        (answers) => path.join(
-          this.destinationPath(), answers.domain, 'departments', resolveAnswer(answers, 'department'),
-        ),
-      ),
-      {
-        type: 'input',
-        name: 'clan',
-        message: 'Clan name',
-        store: false,
-        // Max project name length is 30. But we must account for -staging-RAND suffix
-        validate: (input) => chain(input, required, filename, (s) => maxLength(s, 17)),
-        filter: this.kebabCase,
-      },
-      {
-        type: 'input',
-        name: 'commonInfraRepo',
-        message: 'Name of GitHub repository for clan common infrastructure',
-        default: (answers) => `${answers.tribe}-${answers.clan}-common`,
-      },
-      {
-        type: 'input',
-        name: 'costCenter',
-        message: 'Please provide the Cost Center of the Clan',
-        validate: required,
-      },
-    ];
-
-    return this.prompt(prompts).then((props) => {
-      this.answers = {
-        ...props,
-        department: resolveAnswer(props, 'department'),
-        tribe: resolveAnswer(props, 'tribe'),
-      };
-    });
-  }
-
-  writing() {
-    const {
-      domain,
-      department,
-      tribe,
-      clan,
-    } = this.answers;
-
-    // Department
-    this.copyDir(
-      'department',
-      path.join(domain, 'departments', department),
-      this.answers,
-      true,
-    );
-
-    // Tribe
-    this.copyDir(
-      'tribe',
-      path.join(domain, 'departments', department, tribe),
-      this.answers,
-      true,
-    );
-
-    // Clan
-    this.copyDir(
-      'clans-folder',
-      path.join(domain, 'departments', department, tribe, 'clans'),
-      this.answers,
-      true,
-    );
-    const clanDir = path.join(domain, 'departments', department, tribe, 'clans', clan);
-    this.copyDir('clan', clanDir, this.answers, true);
-
-    // Clan GCP projects
-    ['staging', 'prod'].forEach((env) => {
-      this.copyDir('clan-project', path.join(clanDir, env), {
-        ...this.answers,
-        activate_apis: googleapis.apisYaml([]),
-        env,
-        clan,
-        tribe,
-      });
-    });
-  }
-
-  end() {
-    const {
-      domain,
-      department,
-      tribe,
-      clan,
-    } = this.answers;
-    const clanDir = path.join(domain, 'departments', department, tribe, 'clans', clan);
-    this.log(`
-${chalk.green('Your clan projects have now been created. To finalize your configuration, please continue with manual editing of the generated files.')}
-${chalk.green('1.')} Add clan members and groups
-   \u2192 ${chalk.cyan(path.join(clanDir, 'clan.yaml'))}
-${chalk.green('2.')} Configure APIs, service accounts and repositories
-   \u2192 ${chalk.cyan(path.join(clanDir, 'prod', 'project.yaml'))}
-   \u2192 ${chalk.cyan(path.join(clanDir, 'staging', 'project.yaml'))}
-${chalk.green('3.')} Push this change in a feature branch and open a pull request.
-`);
-  }
-};

package/generators/organization/clan-project/templates/clan/clan.yaml

@@ -1,22 +0,0 @@
-# Please add corporate email addresses for each user member of your Clan.
-# If no groups or users are specified you must leave the brackets [] in place
-# to indicate an empty list
-# You MUST include at least 1 Group or User member
-
-### example
-#
-# members:
-#   groups: []
-#    users:
-#       - name: Alice Test
-#         email: alice@extendaretail.com
-#       - name: Bob Test
-#         email: bob@extendaretail.com
-###
----
-common-infra-repo: "<%-commonInfraRepo%>"
-members:
-  groups: []
-  users: []
-
-costcenter: "<%-costCenter%>"

package/generators/organization/clan-project/templates/clan/terragrunt.hcl

@@ -1,39 +0,0 @@
-# Here we specifify the Terraform Module which we will execute. We pin to a specific version.
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-organization//?ref=v1.0.1"
-}
-
-# This dependency block is used to fetch outputs from the parent folder
-# We use mock_ouputs to support the "first time" deployment scenario where
-# these outputs do not yet exist.
-dependency "tribe_folder" {
-  config_path = "../../"
-  mock_outputs = {
-    folder_id = "folder-dummy-id"
-  }
-}
-
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-# We fetch common variables from the yaml files which MUST exist in these paths
-locals {
-  tribe_name = basename(dirname(dirname(get_terragrunt_dir())))
-  clan_name  = basename(get_terragrunt_dir())
-  clan_vars  = yamldecode(file("${get_terragrunt_dir()}/clan.yaml"))
-}
-
-# These are the inputs that we pass to the Terraform module specified in the Terraform block above
-inputs = {
-  folder_name = "${local.clan_name}"
-
-  # We fetch our tribe folder ID from the dependency block
-  folder_parent_id = dependency.tribe_folder.outputs.folder_id
-
-  # Default Group membership for each Folder is based on the Tribe and Clan name. We expect that there will be a GSuite for every
-  # Clan which follows the convention of <tribe_name>@extendaretail.com
-  gsuite_group_name = "tribe-${local.tribe_name}-${local.clan_name}"
-
-  gsuite_group_members = "${local.clan_vars.members}"
-}

package/generators/organization/clan-project/templates/clan-project/project.yaml

@@ -1,14 +0,0 @@
-# Uncomment APIs you want to activate. This list includes common APIs.
-activate_apis:
-<%- activate_apis %>
-
-# Uncomment and add service(s) that defines the service accounts that will be used by
-# Cloud Run services. The granted roles determines what resources the service can access.
-# services:
-#   - name: my-service-name
-#     iam_roles:
-#       - roles/my-service-role
-#
-# Uncomment and add repository(s) that defines the GitHub repositories that should be given
-# secrets to allow them to deploy resources to the GCP project.
-# repositories: my-service-github-repository

package/generators/organization/clan-project/templates/clan-project/terragrunt.hcl

@@ -1,51 +0,0 @@
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-project//?ref=v2.0.0-autopilot"
-}
-
-dependency "parent_folder" {
-  config_path = "../"
-  mock_outputs = {
-    folder_id = "folder-dummy-id"
-  }
-}
-
-locals {
-  tribe_name  = basename(dirname(dirname(dirname(get_terragrunt_dir()))))
-  clan_name   = basename(dirname(get_terragrunt_dir()))
-  env_name    = basename(get_terragrunt_dir())
-  name        = "${local.clan_name}-${local.env_name}"
-  bucket_name = "tf-state-${local.tribe_name}-${local.name}"
-
-  service_group_name = "gcp-${local.tribe_name}-${local.name}"
-  clan_gsuite_group  = "tribe-${local.tribe_name}-${local.clan_name}"
-  tribe_yaml         = yamldecode(file(find_in_parent_folders("tribe.yaml")))
-}
-
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-inputs = merge(
-
-  yamldecode(
-    file("${get_terragrunt_dir()}/project.yaml")),
-  {
-    labels = {
-      cc          = local.tribe_yaml.costcenter
-      tribe       = local.tribe_name
-      clan        = local.clan_name
-      environment = local.env_name
-    }
-
-    name        = local.name
-    bucket_name = local.bucket_name
-    folder_id   = dependency.parent_folder.outputs.folder_id
-
-    service_group_name = local.service_group_name
-    clan_gsuite_group  = local.clan_gsuite_group
-    env_name           = local.env_name
-    bucket_labels = {
-      cc = local.tribe_yaml.costcenter
-    }
-  }
-)

package/generators/organization/clan-project/templates/clans-folder/terragrunt.hcl

@@ -1,3 +0,0 @@
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}

package/generators/organization/clan-project/templates/department/terragrunt.hcl

@@ -1,32 +0,0 @@
-# Here we specifify the Terraform Module which we will execute. We pin to a specific version.
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-organization//?ref=v1.0.1"
-}
-
-# This dependency block is used to fetch outputs from the parent folder
-# We use mock_ouputs to support the "first time" deployment scenario where
-# these outputs do not yet exist.
-dependency "parent_folder" {
-  config_path = "../"
-  mock_outputs = {
-    folder_id = "folder-dummy-id"
-  }
-}
-
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-# We fetch common variables from the yaml files which MUST exist in these paths
-locals {
-  # fetch the name of the current directory
-  department_name = basename(get_terragrunt_dir())
-}
-
-# These are the inputs that we pass to the Terraform module specified in the Terraform block above
-inputs = {
-  folder_name = "${local.department_name}"
-
-  # We fetch our parent folder ID from the dependency block
-  folder_parent_id = dependency.parent_folder.outputs.folder_id
-}

package/generators/organization/clan-project/templates/tribe/terragrunt.hcl

@@ -1,67 +0,0 @@
-# Here we specifify the Terraform Module which we will execute. We pin to a specific version.
-terraform {
-  source = "git::https://github.com/extenda/tf-module-gcp-organization//?ref=v1.0.1"
-}
-
-# This dependency block is used to fetch outputs from the parent folder
-# We use mock_ouputs to support the "first time" deployment scenario where
-# these outputs do not yet exist.
-dependency "parent_folder" {
-  config_path = "../"
-  mock_outputs = {
-    folder_id = "folder-dummy-id"
-  }
-}
-
-include {
-  path = find_in_parent_folders("terragrunt_root.hcl")
-}
-
-# We fetch common variables from the yaml files which MUST exist in these paths
-locals {
-  # fetch the name of the current directory
-  tribe_name = basename(get_terragrunt_dir())
-  tribe_vars = yamldecode(file("${get_terragrunt_dir()}/tribe.yaml"))
-}
-
-# These are the inputs that we pass to the Terraform module specified in the Terraform block above
-inputs = {
-  folder_name = "${local.tribe_name}"
-
-  # We fetch our parent folder ID from the dependency block
-  folder_parent_id = dependency.parent_folder.outputs.folder_id
-
-  # Default Group membership for each Folder is based on the Tribe and Clan name. We expect that there will be a GSuite for every
-  # Clan which follows the convention of tribe-<tribe_name>@extendaretail.com
-  gsuite_group_name = "tribe-${local.tribe_name}"
-
-  gsuite_group_members = "${local.tribe_vars.members}"
-
-  folder_iam_roles = [
-    "roles/container.viewer",
-    "roles/compute.viewer",
-    "roles/errorreporting.user",
-    "roles/logging.viewer",
-    "roles/logging.configWriter",
-    "roles/cloudtrace.user",
-    "roles/pubsub.viewer",
-    "roles/run.viewer",
-    "roles/viewer",
-    "roles/monitoring.viewer",
-    "roles/monitoring.uptimeCheckConfigViewer",
-    "roles/monitoring.servicesViewer",
-    "roles/monitoring.notificationChannelViewer",
-    "roles/monitoring.metricsScopesViewer",
-    "roles/monitoring.dashboardEditor",
-    "roles/monitoring.alertPolicyViewer"
-  ]
-
-  roles_map = [
-    {
-      project = "extenda"
-      iam_roles = [
-        "roles/storage.objectViewer"
-      ]
-    }
-  ]
-}

package/generators/organization/clan-project/templates/tribe/tribe.yaml

@@ -1,19 +0,0 @@
-# Please add corporate email addresses for each user member of your Tribe.
-# If no groups or users are specified you must leave the brackets [] in place
-# to indicate an empty list
-# You MUST include at least 1 Group or User member
-
-### example
-#
-# members:
-#   groups: []
-#    users:
-#       - alice@extendaretail.com
-#       - bob@extendaretail.com
-###
----
-members:
-  groups: []
-  users: []
-
-costcenter: "<%- costCenter %>"

package/generators/organization/command.json

@@ -1,8 +0,0 @@
-{
-  "description": "Create a GCP organization structure.",
-  "query": "What organization resource do you want to create?",
-  "require": [
-    "git-repo",
-    "org"
-  ]
-}

package/src/BaseGenerator.js

@@ -1,73 +0,0 @@
-const Generator = require('yeoman-generator');
-const path = require('path');
-const fs = require('fs');
-const inquirer = require('inquirer');
-const {
-  chain,
-  required,
-  filename,
-} = require('./validators');
-
-module.exports = class extends Generator {
-  constructor(args, opts) {
-    super(args, opts);
-
-    this.baseDir = path.resolve(path.join(__dirname, '..'));
-    this.destinationRoot(process.cwd());
-
-    const [command, generator] = opts.namespace.split(':').slice(-2);
-    this.generatorId = path.join(command, generator);
-    this.sourceRoot(path.join(this.baseDir, 'generators', this.generatorId, 'templates'));
-
-    this.copyDir = (templateDir, targetDir, answers = this.answers, skipIfExists = false) => {
-      if (skipIfExists && fs.existsSync(targetDir)) {
-        return;
-      }
-      this.fs.copyTpl(
-        this.templatePath(`${templateDir}/**/*`),
-        this.destinationPath(targetDir),
-        answers,
-      );
-    };
-
-    this.listSubDirectories = (parent) => fs.readdirSync(parent)
-      .filter((f) => !f.startsWith('.'))
-      .filter((f) => fs.lstatSync(path.join(parent, f)).isDirectory())
-      .sort();
-
-    this.kebabCase = (input) => input.replace(/\s|_/g, '-');
-
-    this.chooseOrCreatePrompts = (name, getChoicesDirectory) => [{
-      when: (answers) => fs.existsSync(getChoicesDirectory(answers)),
-      type: 'list',
-      name,
-      message: `Choose ${name}`,
-      store: true,
-      choices: (answers) => [
-        ...this.listSubDirectories(getChoicesDirectory(answers)),
-        new inquirer.Separator(),
-        `Create new ${name}`,
-      ],
-      validate: required,
-      filter: this.kebabCase,
-    },
-    {
-      when: (answers) => !fs.existsSync(getChoicesDirectory(answers)) || answers[name] === `Create-new-${name}`,
-      type: 'input',
-      name: `new-${name}`,
-      message: `New ${name} name`,
-      store: false,
-      validate: (input) => chain(input, required, filename),
-      filter: this.kebabCase,
-    },
-    {
-      when: (answers) => !fs.existsSync(getChoicesDirectory(answers)) || answers[name] === 'Create-new-tribe',
-      type: 'input',
-      name: 'costCenter',
-      message: 'Please provide the Cost Center of the Tribe',
-      store: false,
-      validate: (input) => chain(input, required, filename),
-      filter: this.kebabCase,
-    }];
-  }
-};

package/src/SecretsGenerator.js

@@ -1,105 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-const printf = require('sprintf-js').sprintf;
-const chalk = require('chalk');
-const BaseGenerator = require('./BaseGenerator');
-
-function getMaxStrLength(strings) {
-  let maxLength = 0;
-  Object.values(strings).forEach((string) => {
-    if (string.length > maxLength) {
-      maxLength = string.length;
-    }
-  });
-  return maxLength;
-}
-
-module.exports = class extends BaseGenerator {
-  writeSecrets(resource, instanceResource, instanceType, resourceName) {
-    ['prod', 'staging'].forEach((env) => {
-      this.init(env, resource, instanceResource, instanceType, resourceName);
-
-      if (fs.existsSync(path.resolve(this.secretsDir, 'terragrunt.hcl'))) {
-        fs.unlinkSync(path.join(this.secretsDir, 'terragrunt.hcl'));
-      } else {
-        fs.mkdirSync(this.secretsDir, { recursive: true });
-      }
-      this.createTemplate();
-    });
-  }
-
-  init(env, resource, instanceResource, instanceType, resourceName) {
-    this.resourceName = resourceName;
-    this.instanceType = instanceType;
-    this.resource = resource;
-    this.outputs = JSON.parse(fs.readFileSync(path.join(this.baseDir, 'generators', this.generatorId, 'templates', this.instanceType, 'outputs.json'), 'utf8'));
-    this.secretsDir = path.join('infra', env, resource, instanceType, instanceResource, 'secrets');
-    if (fs.existsSync(path.join(this.secretsDir, 'state.json'))) {
-      this.stateNames = JSON.parse(fs.readFileSync(path.join(this.secretsDir, 'state.json'), 'utf8'));
-      this.checkUniqueState();
-      this.stateNames.secrets.push(this.resourceName);
-    } else {
-      this.stateNames = { secrets: [this.resourceName] };
-    }
-    this.outputLen = getMaxStrLength(this.outputs);
-    this.stateLen = getMaxStrLength(this.stateNames.secrets);
-  }
-
-  checkUniqueState() {
-    this.stateNames.secrets.forEach((state) => {
-      if (state === this.resourceName) {
-        process.stderr.write(`${chalk.red('ERROR!')} resource already exists\n`);
-        process.exit(1);
-      }
-    });
-  }
-
-  buildDependencies() {
-    const dependencies = [];
-    this.stateNames.secrets.forEach((secret) => {
-      let fp = `dependency "${secret}" {\n  config_path = "../${secret}"\n  mock_outputs = {\n`;
-      Object.values(this.outputs).forEach((value) => {
-        fp += printf(`%-4s%-${this.outputLen}s %s`, '', `${value}`, `= "dummy-${value}"\n`);
-      });
-      fp += '  }\n}\n';
-      dependencies.push(fp);
-    });
-    return dependencies;
-  }
-
-  buildSecrets() {
-    const secrets = [];
-    const resourceType = this.instanceType === '' ? this.resource : this.instanceType;
-    const padding = resourceType.length + this.outputLen + this.stateLen + 2;
-    this.stateNames.secrets.forEach((secret) => {
-      const secretsSet = [];
-      Object.values(this.outputs).forEach((value) => {
-        secretsSet.push(printf(`\n%-6s%-${padding}s %s`, '', `${resourceType}_${secret}_${value}`, `= dependency.${secret}.outputs.${value}`));
-      });
-      secrets.push(secretsSet.join(''));
-    });
-    return secrets.join('');
-  }
-
-  updateState() {
-    fs.writeFileSync(
-      path.join(this.secretsDir, 'state.json'),
-      JSON.stringify(this.stateNames, null, 2),
-    );
-  }
-
-  createTemplate() {
-    const dependencies = this.buildDependencies().join('');
-    const secrets = this.buildSecrets();
-    this.updateState();
-    this.copyDir(
-      path.join(this.instanceType, 'secrets'),
-      this.secretsDir,
-      {
-        ...this.answers,
-        dependencies,
-        secrets,
-      },
-    );
-  }
-};

package/src/cli.js

@@ -1,73 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-const glob = require('glob');
-const { Command } = require('commander');
-const packageJson = require('../package.json');
-const { runYeoman } = require('./yeoman');
-const dependencyCheck = require('./dependency-check');
-const { isUpdateRequired, printUpdateMessage } = require('./update-check');
-
-const addGenerators = (commandDir, command, require) => {
-  glob.sync(`${commandDir}/*/generator.json`).forEach((file) => {
-    const dir = path.dirname(file);
-    const info = JSON.parse(fs.readFileSync(file, 'utf8'));
-    const name = path.basename(dir);
-    command.command(name)
-      .description(info.description)
-      .action(() => {
-        dependencyCheck.requireCheck(require);
-        return runYeoman(commandDir, name);
-      });
-  });
-};
-
-const createCommands = (program) => {
-  const opts = {
-    cwd: path.resolve(__dirname, '..'),
-    absolute: true,
-  };
-  glob.sync('generators/*/command.json', opts).forEach((file) => {
-    const dir = path.dirname(file);
-    const name = path.basename(dir);
-    const {
-      query = 'Choose a generator',
-      description = '',
-      require = [],
-    } = JSON.parse(fs.readFileSync(path.join(file), 'utf8'));
-    const command = program.command(name)
-      .description(description)
-      .action(() => {
-        dependencyCheck.requireCheck(require);
-        return runYeoman(dir, '', query);
-      });
-    addGenerators(dir, command, require);
-  });
-  return program;
-};
-
-const cli = async (argv, exitOverride) => {
-  const needsUpdate = await isUpdateRequired();
-  if (needsUpdate) {
-    await printUpdateMessage();
-    process.exit(1);
-  }
-
-  const command = new Command();
-  if (exitOverride) {
-    command.exitOverride(exitOverride);
-  }
-
-  return createCommands(command)
-    .version(packageJson.version)
-    .description(packageJson.description)
-    .addHelpCommand(false)
-    .parseAsync(argv);
-};
-
-if (require.main === module) {
-  cli().then(() => {
-    process.exit(0);
-  });
-}
-
-module.exports = cli;