terrafaker 0.0.5 → 0.0.7

package/README.md

@@ -51,7 +51,7 @@ $ npm install -g terrafaker
 $ terrafaker COMMAND
 running command...
 $ terrafaker (--version)
-terrafaker/0.0.5 darwin-arm64 node-v24.8.0
+terrafaker/0.0.7 darwin-arm64 node-v24.8.0
 $ terrafaker --help [COMMAND]
 USAGE
   $ terrafaker COMMAND
@@ -74,21 +74,54 @@ Generates a terraform file.
 
 ```
 USAGE
-  $ terrafaker generate file [--name <value>] [--provider aws|gcp|azure] [--resource-count <value>] [-f] [-q]
+  $ terrafaker generate file [--chaos-tags | --tags <value> | --no-tags] [-f] [--name <value>] [--provider
+    aws|gcp|azure] [-q] [--resource-count <value>]
 
 FLAGS
-  -f, --[no-]format             Format the output terraform files. Requires `terraform` to be in your $PATH.
-  -q, --quiet                   Suppress the logging output.
-      --name=<value>            Name for the generated file, which must end in .tf
-      --provider=<option>       Cloud provider to generate resources for
-                                <options: aws|gcp|azure>
-      --resource-count=<value>  [default: 3] Number of resources per file to generate
+  -f, --[no-]format
+      Format the output terraform files. Requires `terraform` to be in your $PATH.
+
+  -q, --quiet
+      Suppress the logging output.
+
+  --chaos-tags
+      Generate random tag keys & values
+
+  --name=<value>
+      Name for the generated file, which must end in .tf
+
+  --no-tags
+      Disable any tag generation
+
+  --provider=<option>
+      Cloud provider to generate resources for
+      <options: aws|gcp|azure>
+
+  --resource-count=<value>
+      [default: 3] Number of resources per file to generate
+
+  --tags=<value>
+      [default: Environment:Dev,Service:service] Custom tags to use for generated resources. Should be a comma-separated
+      list of tag names to generate random values for, or tag names with values delimited by a colon.
+
+      Examples:
+
+      Specify just tag keys to have a random value generated.
+      --tags Service,Team → {"Service":"(random value)","Team":"(random value)"}
+
+      Specify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.
+      --tags Service:web-app,Team → {"Service":"web-app","Team":"(random value)"}
+      --tags Service:web-app,Team:core → {"Service":"web-app","Team":"core"}
+
+      When specifying a key or value that has a space in it, the entire tag string needs to be quoted.
+      --tags "Service:my awesome web app,Team Name:The Core Team" → {"Service":"my awesome web app","Team Name":"The Core
+      Team"}
 
 DESCRIPTION
   Generates a terraform file.
 ```
 
-_See code: [src/commands/generate/file.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.5/src/commands/generate/file.ts)_
+_See code: [src/commands/generate/file.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.7/src/commands/generate/file.ts)_
 
 ## `terrafaker generate repo`
 
@@ -96,28 +129,70 @@ Generates repo(s) with multiple terraform files.
 
 ```
 USAGE
-  $ terrafaker generate repo [--directory <value>] [--count <value>] [--file-count <value>] [--resource-count
-    <value>] [--prefix <value>] [--provider aws|gcp|azure] [-f] [--create-remote] [--public] [-q]
+  $ terrafaker generate repo [--chaos-tags | --tags <value> | --no-tags] [--count <value>] [--create-remote]
+    [--directory <value>] [--file-count <value>] [-f] [--prefix <value>] [--provider aws|gcp|azure] [--public] [-q]
+    [--resource-count <value>]
 
 FLAGS
-  -f, --[no-]format             Format the output terraform files. Requires `terraform` to be in your $PATH.
-  -q, --quiet                   Suppress the logging output.
-      --count=<value>           [default: 1] Number of repos to generate
-      --create-remote           Create and push a remote GitHub repo. Requires the `gh` CLI to be installed. To install,
-                                run `brew install gh`.
-      --directory=<value>       [default: .] Directory to generate the repo(s) in
-      --file-count=<value>      [default: 3] Number of files per repo to generate
-      --prefix=<value>          [default: tf_] Prefix for repo names, useful for quickly identifying generated content
-      --provider=<option>       Cloud provider to generate resources for
-                                <options: aws|gcp|azure>
-      --public                  Whether the remote repo(s) created are public.
-      --resource-count=<value>  [default: 3] Number of resources per file to generate
+  -f, --[no-]format
+      Format the output terraform files. Requires `terraform` to be in your $PATH.
+
+  -q, --quiet
+      Suppress the logging output.
+
+  --chaos-tags
+      Generate random tag keys & values
+
+  --count=<value>
+      [default: 1] Number of repos to generate
+
+  --create-remote
+      Create and push a remote GitHub repo. Requires the `gh` CLI to be installed. To install, run `brew install gh`.
+
+  --directory=<value>
+      [default: .] Directory to generate the repo(s) in
+
+  --file-count=<value>
+      [default: 3] Number of files per repo to generate
+
+  --no-tags
+      Disable any tag generation
+
+  --prefix=<value>
+      [default: tf_] Prefix for repo names, useful for quickly identifying generated content
+
+  --provider=<option>
+      Cloud provider to generate resources for
+      <options: aws|gcp|azure>
+
+  --public
+      Whether the remote repo(s) created are public.
+
+  --resource-count=<value>
+      [default: 3] Number of resources per file to generate
+
+  --tags=<value>
+      [default: Environment:Dev,Service:service] Custom tags to use for generated resources. Should be a comma-separated
+      list of tag names to generate random values for, or tag names with values delimited by a colon.
+
+      Examples:
+
+      Specify just tag keys to have a random value generated.
+      --tags Service,Team → {"Service":"(random value)","Team":"(random value)"}
+
+      Specify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.
+      --tags Service:web-app,Team → {"Service":"web-app","Team":"(random value)"}
+      --tags Service:web-app,Team:core → {"Service":"web-app","Team":"core"}
+
+      When specifying a key or value that has a space in it, the entire tag string needs to be quoted.
+      --tags "Service:my awesome web app,Team Name:The Core Team" → {"Service":"my awesome web app","Team Name":"The Core
+      Team"}
 
 DESCRIPTION
   Generates repo(s) with multiple terraform files.
 ```
 
-_See code: [src/commands/generate/repo.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.5/src/commands/generate/repo.ts)_
+_See code: [src/commands/generate/repo.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.7/src/commands/generate/repo.ts)_
 
 ## `terrafaker gh clone-repos`
 
@@ -136,7 +211,7 @@ DESCRIPTION
   `gh` CLI to be installed. To install, run `brew install gh`.
 ```
 
-_See code: [src/commands/gh/clone-repos.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.5/src/commands/gh/clone-repos.ts)_
+_See code: [src/commands/gh/clone-repos.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.7/src/commands/gh/clone-repos.ts)_
 
 ## `terrafaker gh delete-repos`
 
@@ -156,7 +231,7 @@ DESCRIPTION
   If the deletion fails, you may need to refresh your CLI permissions with `gh auth refresh -s delete_repo`
 ```
 
-_See code: [src/commands/gh/delete-repos.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.5/src/commands/gh/delete-repos.ts)_
+_See code: [src/commands/gh/delete-repos.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.7/src/commands/gh/delete-repos.ts)_
 
 ## `terrafaker help [COMMAND]`
 

package/dist/commands/generate/file.js

@@ -1,23 +1,27 @@
 import { Flags } from "@oclif/core";
 import { BaseCommand } from "../../utilities/base-command.js";
-import { formatFlag, providerFlag, quietFlag, resourceCountFlag, } from "../../utilities/flags.js";
+import { chaosTagsFlag, formatFlag, getTagsOption, noTagsFlag, providerFlag, quietFlag, resourceCountFlag, tagsFlag, } from "../../utilities/flags.js";
 import { formatTfFileName, success } from "../../utilities/string-utils.js";
 import { randomProvider } from "../../utilities/generators/generator-utils.js";
 import { FileGenerator } from "../../utilities/generators/file-generator.js";
 class File extends BaseCommand {
     static description = "Generates a terraform file.";
     static flags = {
+        "chaos-tags": chaosTagsFlag,
+        format: formatFlag,
         name: Flags.string({
             description: "Name for the generated file, which must end in .tf",
         }),
+        "no-tags": noTagsFlag,
         provider: providerFlag,
-        "resource-count": resourceCountFlag,
-        format: formatFlag,
         quiet: quietFlag,
+        "resource-count": resourceCountFlag,
+        tags: tagsFlag(),
     };
     async run() {
         const { flags } = await this.parse(File);
         const { name, quiet, format, "resource-count": resourceCount } = flags;
+        const tags = getTagsOption(flags);
         const provider = flags.provider ?? randomProvider();
         const fileName = formatTfFileName(name ?? "main.tf");
         FileGenerator.generate({
@@ -25,6 +29,7 @@ class File extends BaseCommand {
             provider,
             resourceCount,
             format,
+            tags,
         });
         if (!quiet) {
             this.log(success(`Successfully generated '${fileName}'`));

package/dist/commands/generate/repo.js

@@ -1,7 +1,7 @@
 import { Flags } from "@oclif/core";
 import path from "node:path";
 import { BaseCommand } from "../../utilities/base-command.js";
-import { formatFlag, providerFlag, quietFlag, resourceCountFlag, } from "../../utilities/flags.js";
+import { chaosTagsFlag, formatFlag, getTagsOption, noTagsFlag, providerFlag, quietFlag, resourceCountFlag, tagsFlag, } from "../../utilities/flags.js";
 import { $ } from "zx";
 import { HelpMessages } from "../../enums/help-messages.js";
 import { RepoGenerator } from "../../utilities/generators/repo-generator.js";
@@ -9,37 +9,41 @@ import { success } from "../../utilities/string-utils.js";
 class Repo extends BaseCommand {
     static description = "Generates repo(s) with multiple terraform files.";
     static flags = {
-        directory: Flags.string({
-            description: "Directory to generate the repo(s) in",
-            default: ".",
-        }),
+        "chaos-tags": chaosTagsFlag,
         count: Flags.integer({
             description: "Number of repos to generate",
             default: 1,
         }),
+        "create-remote": Flags.boolean({
+            description: `Create and push a remote GitHub repo. ${HelpMessages.RequiresGhCli}`,
+        }),
+        directory: Flags.string({
+            description: "Directory to generate the repo(s) in",
+            default: ".",
+        }),
         "file-count": Flags.integer({
             description: "Number of files per repo to generate",
             default: 3,
         }),
-        "resource-count": resourceCountFlag,
+        format: formatFlag,
+        "no-tags": noTagsFlag,
         prefix: Flags.string({
             description: "Prefix for repo names, useful for quickly identifying generated content",
             default: "tf_",
         }),
         provider: providerFlag,
-        format: formatFlag,
-        "create-remote": Flags.boolean({
-            description: `Create and push a remote GitHub repo. ${HelpMessages.RequiresGhCli}`,
-        }),
         public: Flags.boolean({
             description: "Whether the remote repo(s) created are public.",
             default: false,
         }),
         quiet: quietFlag,
+        "resource-count": resourceCountFlag,
+        tags: tagsFlag(),
     };
     async run() {
         const { flags } = await this.parse(Repo);
         const { format, prefix, count, public: isPublic, quiet, "resource-count": resourceCount, "file-count": fileCount, "create-remote": createRemote, } = flags;
+        const tags = getTagsOption(flags);
         const provider = flags.provider;
         const directory = path.resolve(process.cwd(), flags.directory);
         for (let i = 0; i < count; i++) {
@@ -51,6 +55,7 @@ class Repo extends BaseCommand {
                 provider,
                 resourceCount,
                 quiet,
+                tags,
             });
             if (createRemote) {
                 await $ `gh repo create ${name} --source ${path} ${isPublic ? "--public" : "--private"} --push`;

package/dist/commands/util/format-psv.js

@@ -1,7 +1,7 @@
 import { Args } from "@oclif/core";
 import { compact, first } from "lodash-es";
 import { BaseCommand } from "../../utilities/base-command.js";
-import { stringifySingleLineArray } from "../../utilities/string-utils.js";
+import { stringifySingleLineArray } from "../../utilities/collection-utils.js";
 const EXAMPLE_INSTANCE_TYPES = ["m5.large", "m5.xlarge", "m5.2xlarge"];
 class FormatPsv extends BaseCommand {
     static hidden = true;

package/dist/commands/util/format-tsv.js

@@ -1,6 +1,6 @@
 import { Args, Flags } from "@oclif/core";
 import { BaseCommand } from "../../utilities/base-command.js";
-import { stringifySingleLineArray } from "../../utilities/string-utils.js";
+import { stringifySingleLineArray } from "../../utilities/collection-utils.js";
 import { compact } from "lodash-es";
 const EXAMPLE = `c4d-standard-2	2	7	No	Up to 10	N/A`;
 class FormatTsv extends BaseCommand {

package/dist/constants/tags.js

@@ -1,10 +1,10 @@
-import { upperFirst } from "lodash-es";
+import { mapUpperFirstVariants } from "../utilities/collection-utils.js";
 const SHORT_ENVIRONMENT_TAGS = ["dev", "stage", "prod"];
 const LONG_ENVIRONMENT_TAGS = ["development", "staging", "production"];
-const ENVIRONMENT_TAGS = [
+const ENVIRONMENT_TAGS = mapUpperFirstVariants([
     ...SHORT_ENVIRONMENT_TAGS,
     ...LONG_ENVIRONMENT_TAGS,
-].flatMap((tag) => [tag, upperFirst(tag)]);
+]);
 const SERVICE_TAGS = [
     "web-app",
     "api",
@@ -14,4 +14,18 @@ const SERVICE_TAGS = [
     "cache",
     "database",
 ];
-export { ENVIRONMENT_TAGS, LONG_ENVIRONMENT_TAGS, SERVICE_TAGS, SHORT_ENVIRONMENT_TAGS, };
+const DEFAULT_TAGS = {
+    Environment: "Dev",
+    Service: "service",
+};
+const TAG_KEYS = mapUpperFirstVariants([
+    "environment",
+    "env",
+    "service",
+    "name",
+    "team",
+    "business",
+    "department",
+    "dept",
+]);
+export { DEFAULT_TAGS, ENVIRONMENT_TAGS, LONG_ENVIRONMENT_TAGS, SERVICE_TAGS, SHORT_ENVIRONMENT_TAGS, TAG_KEYS, };

package/dist/utilities/collection-utils.js

@@ -0,0 +1,4 @@
+import { upperFirst } from "lodash-es";
+const stringifySingleLineArray = (values) => `[${values.map((value) => `"${value}"`).join(", ")}]`;
+const mapUpperFirstVariants = (values) => values.flatMap((value) => [value, upperFirst(value)]);
+export { mapUpperFirstVariants, stringifySingleLineArray };

package/dist/utilities/flags.js

@@ -1,5 +1,7 @@
 import { Flags } from "@oclif/core";
 import { Providers } from "../enums/providers.js";
+import { DEFAULT_TAGS } from "../constants/tags.js";
+import { parseTagString, stringifyTags } from "./tag-utils.js";
 const formatFlag = Flags.boolean({
     char: "f",
     description: "Format the output terraform files. Requires `terraform` to be in your $PATH.",
@@ -18,4 +20,53 @@ const providerFlag = Flags.string({
     description: "Cloud provider to generate resources for",
     options: Object.values(Providers),
 });
-export { formatFlag, providerFlag, quietFlag, resourceCountFlag };
+const TAGS_WITH_VALUES = {
+    Service: "web-app",
+    Team: "core",
+};
+const TAGS_WITH_SPACES = {
+    Service: "my awesome web app",
+    "Team Name": "The Core Team",
+};
+const tagsFlag = Flags.custom({
+    description: `[default: ${stringifyTags(DEFAULT_TAGS)}] Custom tags to use for generated resources. Should be a comma-separated list of tag names to generate random values for, or tag names with values delimited by a colon.
+
+Examples:
+
+Specify just tag keys to have a random value generated.
+    --tags Service,Team → ${JSON.stringify({ Service: "(random value)", Team: "(random value)" })}
+
+Specify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.
+    --tags Service:web-app,Team → ${JSON.stringify({ Service: "web-app", Team: "(random value)" })}
+    --tags ${stringifyTags(TAGS_WITH_VALUES)} → ${JSON.stringify(TAGS_WITH_VALUES)}
+
+When specifying a key or value that has a space in it, the entire tag string needs to be quoted.
+    --tags "${stringifyTags(TAGS_WITH_SPACES)}" → ${JSON.stringify(TAGS_WITH_SPACES)}
+`,
+    exclusive: ["chaos-tags", "no-tags"],
+    parse: async (input) => parseTagString(input),
+});
+const noTagsFlag = Flags.boolean({
+    description: "Disable any tag generation",
+    exclusive: ["tags", "chaos-tags"],
+});
+const chaosTagsFlag = Flags.boolean({
+    description: "Generate random tag keys & values",
+    exclusive: ["tags", "no-tags"],
+});
+/**
+ * Utility for returning the underlying `tags` option for the `ProviderGenerator` based on various
+ * flag configurations.
+ */
+const getTagsOption = (flags) => {
+    const { "no-tags": noTags, "chaos-tags": chaosTags } = flags;
+    let tags = flags.tags ?? DEFAULT_TAGS;
+    if (chaosTags) {
+        tags = "chaos";
+    }
+    if (noTags) {
+        tags = undefined;
+    }
+    return tags;
+};
+export { chaosTagsFlag, formatFlag, getTagsOption, noTagsFlag, providerFlag, quietFlag, resourceCountFlag, tagsFlag, };

package/dist/utilities/generators/aws-generator.js

@@ -1,5 +1,5 @@
 import { AWS_EBS_VOLUME_TYPES, AWS_INSTANCE_TYPES, AWS_LAMBDA_RUNTIMES, AWS_REGIONS, } from "../../constants/aws.js";
-import { maybe, randomEnvironmentTag, randomId, randomItem, randomMemorableSlug, randomMemorySize, randomServiceTag, unique, } from "./generator-utils.js";
+import { maybe, randomId, randomItem, randomMemorableSlug, randomMemorySize, unique, } from "./generator-utils.js";
 import { ProviderGenerator } from "./provider-generator.js";
 const AwsResourceType = {
     ComputeInstance: "aws_instance",
@@ -11,8 +11,6 @@ class AwsGenerator extends ProviderGenerator {
     }
     addComputeInstance() {
         const name = randomMemorableSlug();
-        const environment = randomEnvironmentTag();
-        const service = randomServiceTag();
         const ami = this.randomAmi();
         const instanceType = randomItem(AWS_INSTANCE_TYPES);
         const rootBlockDevice = maybe(0.5)
@@ -31,14 +29,12 @@ class AwsGenerator extends ProviderGenerator {
             ami,
             instance_type: instanceType,
             ...rootBlockDevice,
-            tags: { name, environment, service },
+            ...this.getTagsBlock(),
         });
         return this;
     }
     addLambdaFunction() {
         const name = randomMemorableSlug();
-        const environment = randomEnvironmentTag();
-        const service = randomServiceTag();
         // https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html
         const memorySize = randomMemorySize({
             min: 128,
@@ -57,7 +53,7 @@ class AwsGenerator extends ProviderGenerator {
             function_name: functionName,
             memory_size: memorySize,
             role,
-            tags: { name, environment, service },
+            ...this.getTagsBlock(),
         });
         return this;
     }

package/dist/utilities/generators/azure-generator.js

@@ -1,5 +1,5 @@
 import { AZURE_INSTANCE_TYPES, AZURE_LAMBDA_RUNTIMES, AZURE_REGIONS, } from "../../constants/azure.js";
-import { randomEnvironmentTag, randomItem, randomMemorableSlug, randomMemorySize, randomServiceTag, } from "./generator-utils.js";
+import { randomItem, randomMemorableSlug, randomMemorySize, } from "./generator-utils.js";
 import { ProviderGenerator } from "./provider-generator.js";
 const AzureResourceType = {
     ComputeInstance: "azurerm_linux_virtual_machine",
@@ -11,19 +11,15 @@ class AzureGenerator extends ProviderGenerator {
     }
     addComputeInstance() {
         const name = randomMemorableSlug();
-        const environment = randomEnvironmentTag();
-        const service = randomServiceTag();
         const instanceType = randomItem(AZURE_INSTANCE_TYPES);
         this.tfg.resource(AzureResourceType.ComputeInstance, name, {
             size: instanceType,
-            tags: { name, environment, service },
+            ...this.getTagsBlock(),
         });
         return this;
     }
     addLambdaFunction() {
         const name = randomMemorableSlug();
-        const environment = randomEnvironmentTag();
-        const service = randomServiceTag();
         const runtime = randomItem(AZURE_LAMBDA_RUNTIMES);
         // There's a lot of different configurations listed, so just guessing here.
         // https://learn.microsoft.com/en-us/azure/azure-functions/functions-scale
@@ -36,7 +32,7 @@ class AzureGenerator extends ProviderGenerator {
             ...runtime,
             name,
             instance_memory_in_mb: instanceMemoryInMb,
-            labels: { name, environment, service },
+            ...this.getTagsBlock(),
         });
         return this;
     }

package/dist/utilities/generators/file-generator.js

@@ -2,8 +2,8 @@ import { randomProvider } from "./generator-utils.js";
 import { ProviderGeneratorFactory } from "./provider-generator-factory.js";
 class FileGenerator {
     static generate(options) {
-        const { provider = randomProvider(), resourceCount = 3, fileName, directory, format, } = options;
-        const generator = ProviderGeneratorFactory.get(provider);
+        const { provider = randomProvider(), resourceCount = 3, fileName, directory, format, tags, } = options;
+        const generator = ProviderGeneratorFactory.get(provider, { tags });
         for (let i = 0; i < resourceCount; i++) {
             generator.addRandomResource();
         }

package/dist/utilities/generators/gcp-generator.js

@@ -1,18 +1,20 @@
 import { GCP_GPU_MACHINE_TYPES, GCP_INSTANCE_TYPES, GCP_LAMBDA_RUNTIMES, GCP_REGIONS, } from "../../constants/gcp.js";
-import { maybe, randomEnvironmentTag, randomInt, randomItem, randomMemorableSlug, randomMemorySize, randomServiceTag, } from "./generator-utils.js";
+import { maybe, randomInt, randomItem, randomMemorableSlug, randomMemorySize, } from "./generator-utils.js";
 import { ProviderGenerator } from "./provider-generator.js";
 const GcpResourceType = {
     ComputeInstance: "google_compute_instance",
     LambdaFunction: "google_cloudfunctions_function",
 };
 class GcpGenerator extends ProviderGenerator {
+    constructor(options) {
+        super(options);
+        this.tagKey = "labels";
+    }
     addProvider() {
         this.tfg.provider("google", { region: this.region });
     }
     addComputeInstance() {
         const name = randomMemorableSlug();
-        const environment = randomEnvironmentTag();
-        const service = randomServiceTag();
         const machineType = randomItem(GCP_INSTANCE_TYPES);
         const guestAccelerator = maybe(0.5)
             ? {
@@ -26,14 +28,12 @@ class GcpGenerator extends ProviderGenerator {
             zone: this.region,
             machine_type: machineType,
             ...guestAccelerator,
-            labels: { name, environment, service },
+            ...this.getTagsBlock(),
         });
         return this;
     }
     addLambdaFunction() {
         const name = randomMemorableSlug();
-        const environment = randomEnvironmentTag();
-        const service = randomServiceTag();
         const runtime = randomItem(GCP_LAMBDA_RUNTIMES);
         // @see https://docs.cloud.google.com/run/docs/configuring/services/memory-limits
         const availableMemoryMb = randomMemorySize({
@@ -45,7 +45,7 @@ class GcpGenerator extends ProviderGenerator {
             runtime,
             name,
             available_memory_mb: availableMemoryMb,
-            labels: { name, environment, service },
+            ...this.getTagsBlock(),
         });
         return this;
     }

package/dist/utilities/generators/generator-utils.js

@@ -1,6 +1,6 @@
 import { faker } from "@faker-js/faker";
 import { snakeSlugify } from "../string-utils.js";
-import { ENVIRONMENT_TAGS, SERVICE_TAGS } from "../../constants/tags.js";
+import { ENVIRONMENT_TAGS, SERVICE_TAGS, TAG_KEYS, } from "../../constants/tags.js";
 import { Providers } from "../../enums/providers.js";
 import { range } from "lodash-es";
 const MAX_UNIQUE_GENERATOR_ATTEMPTS = 50;
@@ -25,10 +25,19 @@ function unique(generator) {
 }
 const randomMemorableSlug = unique(() => snakeSlugify(`${faker.word.adjective()}_${faker.color.human()}_${faker.animal.type()}`));
 const randomItem = (values) => faker.helpers.arrayElement(values);
+const randomItems = (values, count) => faker.helpers.arrayElements(values, count);
 const randomProvider = () => randomItem(Object.values(Providers));
 const randomId = unique(() => faker.internet.mac({ separator: "" }));
 const randomEnvironmentTag = () => randomItem(ENVIRONMENT_TAGS);
 const randomServiceTag = () => randomItem(SERVICE_TAGS);
+const randomTags = (additionalTags) => {
+    const keys = randomItems(TAG_KEYS, { min: 1, max: 4 });
+    const tags = keys.reduce((accumulated, key) => {
+        accumulated[key] = randomMemorableSlug();
+        return accumulated;
+    }, {});
+    return { ...tags, ...additionalTags };
+};
 const randomMemorySize = (options) => {
     const { min, max, step } = options;
     const values = range(min, max, step);
@@ -44,4 +53,4 @@ const randomInt = (options) => {
  * Returns true/false depending on the provided probability (0 to 1)
  */
 const maybe = (probability) => Math.random() < probability;
-export { maybe, randomEnvironmentTag, randomId, randomInt, randomItem, randomMemorableSlug, randomMemorySize, randomProvider, randomServiceTag, unique, };
+export { maybe, randomEnvironmentTag, randomId, randomInt, randomItem, randomItems, randomMemorableSlug, randomMemorySize, randomProvider, randomServiceTag, randomTags, unique, };

package/dist/utilities/generators/provider-generator-factory.js

@@ -3,15 +3,15 @@ import { AwsGenerator } from "./aws-generator.js";
 import { AzureGenerator } from "./azure-generator.js";
 import { GcpGenerator } from "./gcp-generator.js";
 class ProviderGeneratorFactory {
-    static get(provider) {
+    static get(provider, options) {
         switch (provider) {
             case Providers.Azure:
-                return new AzureGenerator();
+                return new AzureGenerator(options);
             case Providers.GCP:
-                return new GcpGenerator();
+                return new GcpGenerator(options);
             default:
             case Providers.AWS:
-                return new AwsGenerator();
+                return new AwsGenerator(options);
         }
     }
 }

package/dist/utilities/generators/provider-generator.js

@@ -1,14 +1,22 @@
-import { TerraformGenerator } from "terraform-generator";
+import { map, TerraformGenerator } from "terraform-generator";
 import { ResourceTypes } from "../../enums/resource-types.js";
-import { randomItem, randomMemorableSlug } from "./generator-utils.js";
+import { randomItem, randomMemorableSlug, randomTags, } from "./generator-utils.js";
 import { formatTfFileName } from "../string-utils.js";
 class ProviderGenerator {
     tfg;
     region;
-    constructor() {
+    tags;
+    /**
+     * Provider-specific key for `tags` objects.
+     * @default tags
+     */
+    tagKey;
+    constructor(options) {
         this.tfg = new TerraformGenerator();
         this.region = this.randomRegion();
         this.addProvider();
+        this.tags = options?.tags;
+        this.tagKey = "tags";
     }
     addResourceByType(type) {
         switch (type) {
@@ -24,6 +32,24 @@ class ProviderGenerator {
         const type = randomItem(Object.values(ResourceTypes));
         return this.addResourceByType(type);
     }
+    getTags() {
+        if (this.tags === "chaos") {
+            return randomTags();
+        }
+        return this.tags;
+    }
+    /**
+     * Constructs the tag object to spread onto a resource, where the key is provider specific
+     * (usually `tags` or `labels`) and the value is a `Map` constructed from the object returned from
+     * `getTags`.
+     */
+    getTagsBlock() {
+        const tags = this.getTags();
+        if (tags === undefined) {
+            return undefined;
+        }
+        return { [this.tagKey]: map(tags) };
+    }
     toString() {
         const { tf } = this.tfg.generate();
         return tf.trim();

package/dist/utilities/generators/repo-generator.js

@@ -6,7 +6,7 @@ import { mkdir } from "node:fs/promises";
 import { success } from "../string-utils.js";
 class RepoGenerator {
     static async generate(options) {
-        const { provider, prefix = "tf_", format, fileCount = 3, resourceCount, quiet, } = options;
+        const { provider, prefix = "tf_", format, fileCount = 3, resourceCount, quiet, tags, } = options;
         const directory = path.resolve(process.cwd(), options.directory ?? ".");
         const repoName = `${prefix}${randomMemorableSlug()}`;
         const repoPath = path.join(directory, repoName);
@@ -19,6 +19,7 @@ class RepoGenerator {
                 provider,
                 resourceCount,
                 format,
+                tags,
             });
         }
         await sh `git add . && git commit -m "initial commit"`;

package/dist/utilities/string-utils.js

@@ -3,6 +3,6 @@ import { ux } from "@oclif/core";
 const slugify = (value) => faker.helpers.slugify(value).toLowerCase();
 const snakeSlugify = (value) => slugify(value).replaceAll("-", "_");
 const success = (message) => `${ux.colorize("green", "✓")} ${message}`;
-const stringifySingleLineArray = (values) => `[${values.map((value) => `"${value}"`).join(", ")}]`;
+const warn = (message) => `${ux.colorize("yellow", "⚠")} ${message}`;
 const formatTfFileName = (fileName) => fileName.endsWith(".tf") ? fileName : `${fileName}.tf`;
-export { formatTfFileName, slugify, snakeSlugify, stringifySingleLineArray, success, };
+export { formatTfFileName, slugify, snakeSlugify, success, warn };

package/dist/utilities/tag-utils.js

@@ -0,0 +1,18 @@
+import { randomMemorableSlug } from "./generators/generator-utils.js";
+import { warn } from "./string-utils.js";
+const parseTagString = (tagString) => {
+    const csvTags = tagString.split(",").map((value) => value.trim());
+    const tags = csvTags.reduce((accumulated, csvTag) => {
+        const [tag, value] = csvTag.split(":");
+        if (tag in accumulated) {
+            console.warn(warn(`tag '${tag}' specified more than once, earlier value will be overwritten.`));
+        }
+        accumulated[tag] = value ?? randomMemorableSlug();
+        return accumulated;
+    }, {});
+    return tags;
+};
+const stringifyTags = (tags) => Object.entries(tags)
+    .map(([key, value]) => `${key}:${value}`)
+    .join(",");
+export { parseTagString, stringifyTags };

package/oclif.manifest.json

@@ -5,6 +5,23 @@
       "args": {},
       "description": "Generates a terraform file.",
       "flags": {
+        "chaos-tags": {
+          "description": "Generate random tag keys & values",
+          "exclusive": [
+            "tags",
+            "no-tags"
+          ],
+          "name": "chaos-tags",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "format": {
+          "char": "f",
+          "description": "Format the output terraform files. Requires `terraform` to be in your $PATH.",
+          "name": "format",
+          "allowNo": true,
+          "type": "boolean"
+        },
         "name": {
           "description": "Name for the generated file, which must end in .tf",
           "name": "name",
@@ -12,6 +29,16 @@
           "multiple": false,
           "type": "option"
         },
+        "no-tags": {
+          "description": "Disable any tag generation",
+          "exclusive": [
+            "tags",
+            "chaos-tags"
+          ],
+          "name": "no-tags",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "provider": {
           "description": "Cloud provider to generate resources for",
           "name": "provider",
@@ -24,6 +51,13 @@
           ],
           "type": "option"
         },
+        "quiet": {
+          "char": "q",
+          "description": "Suppress the logging output.",
+          "name": "quiet",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "resource-count": {
           "description": "Number of resources per file to generate",
           "name": "resource-count",
@@ -32,19 +66,16 @@
           "multiple": false,
           "type": "option"
         },
-        "format": {
-          "char": "f",
-          "description": "Format the output terraform files. Requires `terraform` to be in your $PATH.",
-          "name": "format",
-          "allowNo": true,
-          "type": "boolean"
-        },
-        "quiet": {
-          "char": "q",
-          "description": "Suppress the logging output.",
-          "name": "quiet",
-          "allowNo": false,
-          "type": "boolean"
+        "tags": {
+          "description": "[default: Environment:Dev,Service:service] Custom tags to use for generated resources. Should be a comma-separated list of tag names to generate random values for, or tag names with values delimited by a colon.\n\nExamples:\n\nSpecify just tag keys to have a random value generated.\n    --tags Service,Team → {\"Service\":\"(random value)\",\"Team\":\"(random value)\"}\n\nSpecify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.\n    --tags Service:web-app,Team → {\"Service\":\"web-app\",\"Team\":\"(random value)\"}\n    --tags Service:web-app,Team:core → {\"Service\":\"web-app\",\"Team\":\"core\"}\n\nWhen specifying a key or value that has a space in it, the entire tag string needs to be quoted.\n    --tags \"Service:my awesome web app,Team Name:The Core Team\" → {\"Service\":\"my awesome web app\",\"Team Name\":\"The Core Team\"}\n",
+          "exclusive": [
+            "chaos-tags",
+            "no-tags"
+          ],
+          "name": "tags",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -88,13 +119,15 @@
       "args": {},
       "description": "Generates repo(s) with multiple terraform files.",
       "flags": {
-        "directory": {
-          "description": "Directory to generate the repo(s) in",
-          "name": "directory",
-          "default": ".",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "chaos-tags": {
+          "description": "Generate random tag keys & values",
+          "exclusive": [
+            "tags",
+            "no-tags"
+          ],
+          "name": "chaos-tags",
+          "allowNo": false,
+          "type": "boolean"
         },
         "count": {
           "description": "Number of repos to generate",
@@ -104,22 +137,45 @@
           "multiple": false,
           "type": "option"
         },
-        "file-count": {
-          "description": "Number of files per repo to generate",
-          "name": "file-count",
-          "default": 3,
+        "create-remote": {
+          "description": "Create and push a remote GitHub repo. Requires the `gh` CLI to be installed. To install, run `brew install gh`.",
+          "name": "create-remote",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "directory": {
+          "description": "Directory to generate the repo(s) in",
+          "name": "directory",
+          "default": ".",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "resource-count": {
-          "description": "Number of resources per file to generate",
-          "name": "resource-count",
+        "file-count": {
+          "description": "Number of files per repo to generate",
+          "name": "file-count",
           "default": 3,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
+        "format": {
+          "char": "f",
+          "description": "Format the output terraform files. Requires `terraform` to be in your $PATH.",
+          "name": "format",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "no-tags": {
+          "description": "Disable any tag generation",
+          "exclusive": [
+            "tags",
+            "chaos-tags"
+          ],
+          "name": "no-tags",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "prefix": {
           "description": "Prefix for repo names, useful for quickly identifying generated content",
           "name": "prefix",
@@ -140,19 +196,6 @@
           ],
           "type": "option"
         },
-        "format": {
-          "char": "f",
-          "description": "Format the output terraform files. Requires `terraform` to be in your $PATH.",
-          "name": "format",
-          "allowNo": true,
-          "type": "boolean"
-        },
-        "create-remote": {
-          "description": "Create and push a remote GitHub repo. Requires the `gh` CLI to be installed. To install, run `brew install gh`.",
-          "name": "create-remote",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "public": {
           "description": "Whether the remote repo(s) created are public.",
           "name": "public",
@@ -165,6 +208,25 @@
           "name": "quiet",
           "allowNo": false,
           "type": "boolean"
+        },
+        "resource-count": {
+          "description": "Number of resources per file to generate",
+          "name": "resource-count",
+          "default": 3,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "tags": {
+          "description": "[default: Environment:Dev,Service:service] Custom tags to use for generated resources. Should be a comma-separated list of tag names to generate random values for, or tag names with values delimited by a colon.\n\nExamples:\n\nSpecify just tag keys to have a random value generated.\n    --tags Service,Team → {\"Service\":\"(random value)\",\"Team\":\"(random value)\"}\n\nSpecify value for a key with the : delimiter. This can be mixed with just keys that are randomly generated.\n    --tags Service:web-app,Team → {\"Service\":\"web-app\",\"Team\":\"(random value)\"}\n    --tags Service:web-app,Team:core → {\"Service\":\"web-app\",\"Team\":\"core\"}\n\nWhen specifying a key or value that has a space in it, the entire tag string needs to be quoted.\n    --tags \"Service:my awesome web app,Team Name:The Core Team\" → {\"Service\":\"my awesome web app\",\"Team Name\":\"The Core Team\"}\n",
+          "exclusive": [
+            "chaos-tags",
+            "no-tags"
+          ],
+          "name": "tags",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -356,5 +418,5 @@
       ]
     }
   },
-  "version": "0.0.5"
+  "version": "0.0.7"
 }

package/package.json

@@ -77,5 +77,5 @@
     },
     "type": "module",
     "types": "dist/index.d.ts",
-    "version": "0.0.5"
+    "version": "0.0.7"
 }