terrafaker 0.0.0

package/README.md

@@ -0,0 +1,171 @@
+# terrafaker
+
+CLI for easily generating fake terraform files and repos
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/terrafaker.svg)](https://npmjs.org/package/terrafaker)
+[![Downloads/week](https://img.shields.io/npm/dw/terrafaker.svg)](https://npmjs.org/package/terrafaker)
+
+## Why this exists
+
+This tool mostly exists to quickly seed data for testing out platforms that rely on infrastructure-as-code, like [Infracost](https://www.infracost.io/). If you find it useful, or there's a feature you'd like to see, feel free to open up an [issue](https://github.com/brandongregoryscott/terrafaker/issues).
+
+## Features
+
+- Generate individual files
+- Generate git repos with multiple files (and optionally push them to GitHub)
+- Bulk clone and delete generated repos by prefix
+
+### Supported providers and resources
+
+- AWS
+    - EC2 instances
+    - Lambda functions
+- GCP
+    - Compute instances
+    - Functions
+- TODO: Azure
+
+<!-- prettier-ignore-start -->
+<!-- toc -->
+* [terrafaker](#terrafaker)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+
+# Usage
+
+<!-- usage -->
+```sh-session
+$ npm install -g terrafaker
+$ terrafaker COMMAND
+running command...
+$ terrafaker (--version)
+terrafaker/0.0.0 darwin-arm64 node-v24.8.0
+$ terrafaker --help [COMMAND]
+USAGE
+  $ terrafaker COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+
+<!-- commands -->
+* [`terrafaker generate file`](#terrafaker-generate-file)
+* [`terrafaker generate repo`](#terrafaker-generate-repo)
+* [`terrafaker gh clone-repos`](#terrafaker-gh-clone-repos)
+* [`terrafaker gh delete-repos`](#terrafaker-gh-delete-repos)
+* [`terrafaker help [COMMAND]`](#terrafaker-help-command)
+
+## `terrafaker generate file`
+
+Generates a terraform file.
+
+```
+USAGE
+  $ terrafaker generate file [--name <value>] [--provider aws|gcp] [--resource-count <value>] [-f] [-q]
+
+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>
+      --resource-count=<value>  [default: 3] Number of resources per file to generate
+
+DESCRIPTION
+  Generates a terraform file.
+```
+
+_See code: [src/commands/generate/file.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.0/src/commands/generate/file.ts)_
+
+## `terrafaker generate repo`
+
+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] [-f] [--create-remote] [--public] [-q]
+
+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>
+      --public                  Whether the remote repo(s) created are public.
+      --resource-count=<value>  [default: 3] Number of resources per file to generate
+
+DESCRIPTION
+  Generates repo(s) with multiple terraform files.
+```
+
+_See code: [src/commands/generate/repo.ts](https://github.com/brandongregoryscott/terrafaker/blob/v0.0.0/src/commands/generate/repo.ts)_
+
+## `terrafaker gh clone-repos`
+
+Clones repos from your Github account, useful for pulling down generated repos for manual modifications. Requires the `gh` CLI to be installed. To install, run `brew install gh`.
+
+```
+USAGE
+  $ terrafaker gh clone-repos --prefix <value> [--directory <value>]
+
+FLAGS
+  --directory=<value>  [default: .] Directory to clone the repo(s) in
+  --prefix=<value>     (required) Prefix for the repos to clone, such as 'tf_'
+
+DESCRIPTION
+  Clones repos from your Github account, useful for pulling down generated repos for manual modifications. Requires the
+  `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.0/src/commands/gh/clone-repos.ts)_
+
+## `terrafaker gh delete-repos`
+
+Deletes repos from your Github account, useful for cleaning up generated test data. Requires the `gh` CLI to be installed. To install, run `brew install gh`.
+
+```
+USAGE
+  $ terrafaker gh delete-repos --prefix <value>
+
+FLAGS
+  --prefix=<value>  (required) Prefix for the repos to delete, such as 'tf_'
+
+DESCRIPTION
+  Deletes repos from your Github account, useful for cleaning up generated test data. Requires the `gh` CLI to be
+  installed. To install, run `brew install gh`.
+
+  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.0/src/commands/gh/delete-repos.ts)_
+
+## `terrafaker help [COMMAND]`
+
+Display help for terrafaker.
+
+```
+USAGE
+  $ terrafaker help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for terrafaker.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.36/src/commands/help.ts)_
+<!-- commandsstop -->
+<!-- prettier-ignore-end -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import { execute } from "@oclif/core";
+
+await execute({ development: true, dir: import.meta.url });

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { execute } from "@oclif/core";
+
+await execute({ dir: import.meta.url });

package/dist/commands/generate/file.d.ts

@@ -0,0 +1,13 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class File extends BaseCommand {
+    static description: string;
+    static flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        provider: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        "resource-count": import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+export { File };

package/dist/commands/generate/file.js

@@ -0,0 +1,32 @@
+import { Flags } from "@oclif/core";
+import { BaseCommand } from "../../utilities/base-command.js";
+import { formatFlag, providerFlag, quietFlag, resourceCountFlag, } from "../../utilities/flags.js";
+import { success } from "../../utilities/string-utils.js";
+import { generateFileByProvider, randomProvider, } from "../../utilities/generators/generator-utils.js";
+class File extends BaseCommand {
+    static description = "Generates a terraform file.";
+    static flags = {
+        name: Flags.string({
+            description: "Name for the generated file, which must end in .tf",
+        }),
+        provider: providerFlag,
+        "resource-count": resourceCountFlag,
+        format: formatFlag,
+        quiet: quietFlag,
+    };
+    async run() {
+        const { flags } = await this.parse(File);
+        const { name, quiet, format, "resource-count": resourceCount } = flags;
+        const provider = flags.provider ?? randomProvider();
+        let tfFilename = name ?? "main.tf";
+        if (!tfFilename.endsWith(".tf")) {
+            tfFilename = `${tfFilename}.tf`;
+        }
+        const tfg = generateFileByProvider({ provider, resourceCount });
+        tfg.write({ format, tfFilename });
+        if (!quiet) {
+            this.log(success(`Successfully generated ${tfFilename}`));
+        }
+    }
+}
+export { File };

package/dist/commands/generate/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class Generate extends BaseCommand {
+    static hidden: boolean;
+    static description: string;
+    run(): Promise<void>;
+}
+export { Generate };

package/dist/commands/generate/index.js

@@ -0,0 +1,9 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+class Generate extends BaseCommand {
+    static hidden = true;
+    static description = "Commands for generating terraform files.";
+    async run() {
+        await this.showHelp();
+    }
+}
+export { Generate };

package/dist/commands/generate/repo.d.ts

@@ -0,0 +1,18 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class Repo extends BaseCommand {
+    static description: string;
+    static flags: {
+        directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        count: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        "file-count": import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        "resource-count": import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        prefix: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        provider: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        "create-remote": import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        public: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        quiet: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+export { Repo };

package/dist/commands/generate/repo.js

@@ -0,0 +1,60 @@
+import { Flags } from "@oclif/core";
+import path from "node:path";
+import { generateRepo, randomProvider, } from "../../utilities/generators/generator-utils.js";
+import { BaseCommand } from "../../utilities/base-command.js";
+import { formatFlag, providerFlag, quietFlag, resourceCountFlag, } from "../../utilities/flags.js";
+import { $ } from "zx";
+import { HelpMessages } from "../../enums/help-messages.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: ".",
+        }),
+        count: Flags.integer({
+            description: "Number of repos to generate",
+            default: 1,
+        }),
+        "file-count": Flags.integer({
+            description: "Number of files per repo to generate",
+            default: 3,
+        }),
+        "resource-count": resourceCountFlag,
+        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,
+    };
+    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 provider = flags.provider;
+        const directory = path.resolve(process.cwd(), flags.directory);
+        for (let i = 0; i < count; i++) {
+            const { name, path } = await generateRepo({
+                directory,
+                fileCount,
+                format,
+                prefix,
+                provider: provider ?? randomProvider(),
+                resourceCount,
+                quiet,
+            });
+            if (createRemote) {
+                await $ `gh repo create ${name} --source ${path} ${isPublic ? "--public" : "--private"} --push`;
+            }
+        }
+    }
+}
+export { Repo };

package/dist/commands/gh/clone-repos.d.ts

@@ -0,0 +1,10 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class CloneRepos extends BaseCommand {
+    static description: string;
+    static flags: {
+        directory: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        prefix: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+export { CloneRepos };

package/dist/commands/gh/clone-repos.js

@@ -0,0 +1,46 @@
+import { Flags } from "@oclif/core";
+import { execSync } from "node:child_process";
+import { confirm } from "@inquirer/prompts";
+import { isEmpty } from "lodash-es";
+import path from "node:path";
+import { listRepos, stringifyRepos } from "../../utilities/github.js";
+import { BaseCommand } from "../../utilities/base-command.js";
+import { HelpMessages } from "../../enums/help-messages.js";
+class CloneRepos extends BaseCommand {
+    static description = `Clones repos from your Github account, useful for pulling down generated repos for manual modifications. ${HelpMessages.RequiresGhCli}`;
+    static flags = {
+        directory: Flags.string({
+            description: "Directory to clone the repo(s) in",
+            default: ".",
+        }),
+        prefix: Flags.string({
+            description: "Prefix for the repos to clone, such as 'tf_'",
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(CloneRepos);
+        const { prefix } = flags;
+        const allRepos = listRepos();
+        const repos = allRepos.filter((repo) => repo.name.startsWith(prefix));
+        if (isEmpty(repos)) {
+            this.log(`Repos found:\n${stringifyRepos(allRepos)}`);
+            this.log(`No repos found with prefix '${prefix}'`);
+            this.exit();
+        }
+        this.log(`Repos to clone:\n${stringifyRepos(repos)}`);
+        const confirmation = await confirm({
+            message: "Continue with cloning these repos?",
+        });
+        if (!confirmation) {
+            return;
+        }
+        repos.forEach((repo) => {
+            const directory = path.resolve(process.cwd(), flags.directory, repo.name);
+            execSync(`gh repo clone ${repo.nameWithOwner} ${directory}`, {
+                stdio: "inherit",
+            });
+        });
+    }
+}
+export { CloneRepos };

package/dist/commands/gh/delete-repos.d.ts

@@ -0,0 +1,9 @@
+import { Command } from "@oclif/core";
+declare class DeleteRepos extends Command {
+    static description: string;
+    static flags: {
+        prefix: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}
+export { DeleteRepos };

package/dist/commands/gh/delete-repos.js

@@ -0,0 +1,41 @@
+import { Command, Flags } from "@oclif/core";
+import { execSync } from "node:child_process";
+import { confirm } from "@inquirer/prompts";
+import { isEmpty } from "lodash-es";
+import { listRepos, stringifyRepos } from "../../utilities/github.js";
+import { HelpMessages } from "../../enums/help-messages.js";
+class DeleteRepos extends Command {
+    static description = `Deletes repos from your Github account, useful for cleaning up generated test data. ${HelpMessages.RequiresGhCli}
+
+If the deletion fails, you may need to refresh your CLI permissions with \`gh auth refresh -s delete_repo\``;
+    static flags = {
+        prefix: Flags.string({
+            description: "Prefix for the repos to delete, such as 'tf_'",
+            required: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DeleteRepos);
+        const { prefix } = flags;
+        const allRepos = listRepos();
+        const repos = allRepos.filter((repo) => repo.name.startsWith(prefix));
+        if (isEmpty(repos)) {
+            this.log(`Repos found:\n${stringifyRepos(allRepos)}`);
+            this.log(`No repos found with prefix '${prefix}'`);
+            this.exit();
+        }
+        this.log(`Repos to delete:\n${stringifyRepos(repos)}`);
+        const confirmation = await confirm({
+            message: "Continue with deletion of these repos?",
+        });
+        if (!confirmation) {
+            return;
+        }
+        repos.forEach((repo) => {
+            execSync(`gh repo delete ${repo.nameWithOwner} --yes`, {
+                stdio: "inherit",
+            });
+        });
+    }
+}
+export { DeleteRepos };

package/dist/commands/gh/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class Gh extends BaseCommand {
+    static hidden: boolean;
+    static description: string;
+    run(): Promise<void>;
+}
+export { Gh };

package/dist/commands/gh/index.js

@@ -0,0 +1,10 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+import { HelpMessages } from "../../enums/help-messages.js";
+class Gh extends BaseCommand {
+    static hidden = true;
+    static description = `Utility commands that wrap the \`gh\` CLI. ${HelpMessages.RequiresGhCli}`;
+    async run() {
+        await this.showHelp();
+    }
+}
+export { Gh };

package/dist/commands/util/format-psv.d.ts

@@ -0,0 +1,10 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class FormatPsv extends BaseCommand {
+    static hidden: boolean;
+    static description: string;
+    static args: {
+        psv: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}
+export { FormatPsv };

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

@@ -0,0 +1,46 @@
+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";
+const EXAMPLE_INSTANCE_TYPES = ["m5.large", "m5.xlarge", "m5.2xlarge"];
+class FormatPsv extends BaseCommand {
+    static hidden = true;
+    static description = "Utility command for formatting a PSV (pipe-separated value) into an array or object with array values. Primarily used for parsing data from the AWS docs.";
+    static args = {
+        psv: Args.string({
+            required: true,
+            description: `Pipe-separated value to format into a string array, i.e. '${EXAMPLE_INSTANCE_TYPES.join(" | ")}'.
+If the string is multiple lines, it will be formatted into an object where the key is the first column before a tab, i.e. 'M5\t${EXAMPLE_INSTANCE_TYPES.join(" | ")}'`,
+        }),
+    };
+    async run() {
+        const { args } = await this.parse(FormatPsv);
+        const { psv } = args;
+        const lines = psv.split("\n");
+        if (lines.length === 1) {
+            const values = splitPsv(first(lines) ?? "");
+            this.log(stringifySingleLineArray(values));
+            return;
+        }
+        const value = lines.reduce((accumulated, line) => {
+            const [type, psv] = line.split("\t");
+            accumulated[type] = splitPsv(psv);
+            return accumulated;
+        }, {});
+        this.log(stringifyObjectWithSingleLineArrays(value));
+    }
+}
+const splitPsv = (psv) => compact(psv.split("|").map((value) => value.trim()));
+/**
+ * In an effort to reduce the size of the AWS constants file, we're custom stringifying the object
+ * to ensure the arrays are a single line.
+ */
+const stringifyObjectWithSingleLineArrays = (object) => {
+    const lines = ["{"];
+    Object.entries(object).forEach(([key, values]) => {
+        lines.push(`\t"${key}": ${stringifySingleLineArray(values)},`);
+    });
+    lines.push("}");
+    return lines.join("\n");
+};
+export { FormatPsv };

package/dist/commands/util/format-tsv.d.ts

@@ -0,0 +1,13 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class FormatTsv extends BaseCommand {
+    static hidden: boolean;
+    static description: string;
+    static flags: {
+        index: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    static args: {
+        tsv: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}
+export { FormatTsv };

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

@@ -0,0 +1,33 @@
+import { Args, Flags } from "@oclif/core";
+import { BaseCommand } from "../../utilities/base-command.js";
+import { stringifySingleLineArray } from "../../utilities/string-utils.js";
+import { compact } from "lodash-es";
+const EXAMPLE = `c4d-standard-2	2	7	No	Up to 10	N/A`;
+class FormatTsv extends BaseCommand {
+    static hidden = true;
+    static description = "Utility command for formatting a TSV (tab-separated value) into an array. Primarily used for parsing data from the GCP docs.";
+    static flags = {
+        index: Flags.integer({
+            char: "i",
+            description: "Column index to pull from each line.",
+            default: 0,
+        }),
+    };
+    static args = {
+        tsv: Args.string({
+            required: true,
+            description: `Tab-separated value to format into a string array, i.e. '${EXAMPLE}'.
+If the string is multiple lines (which it generally is), the specified column index from each line will be placed in the array.`,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(FormatTsv);
+        const { index } = flags;
+        const { tsv } = args;
+        const lines = tsv.split("\n");
+        const values = compact(lines.map((line) => splitTsv(line)[index]));
+        this.log(stringifySingleLineArray(values));
+    }
+}
+const splitTsv = (tsv) => compact(tsv.split("\t").map((value) => value.trim()));
+export { FormatTsv };

package/dist/commands/util/index.d.ts

@@ -0,0 +1,7 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+declare class Util extends BaseCommand {
+    static hidden: boolean;
+    static description: string;
+    run(): Promise<void>;
+}
+export { Util };

package/dist/commands/util/index.js

@@ -0,0 +1,9 @@
+import { BaseCommand } from "../../utilities/base-command.js";
+class Util extends BaseCommand {
+    static hidden = true;
+    static description = "Miscellaneous utility commands.";
+    async run() {
+        await this.showHelp();
+    }
+}
+export { Util };