@cdktn/cli-core 0.21.0

package/templates/python-pip/.hooks.sscaff.js

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+const { execSync } = require('child_process');
+const { chmodSync } = require('fs');
+const { readFileSync, writeFileSync } = require('fs');
+const os = require('os');
+
+exports.pre = () => {
+  try {
+    if (os.platform() === 'win32') {
+      execSync('where pip3')
+    }
+    else {
+      execSync('which pip3')
+    }
+  } catch {
+    console.error(`Unable to find "pip3".`)
+    process.exit(1);
+  }
+};
+
+exports.post = options => {
+  // Terraform Cloud configuration settings if the organization name and workspace is set.
+  if (options.OrganizationName != '') {
+    console.log(`\nGenerating Terraform Cloud configuration for '${options.OrganizationName}' organization and '${options.WorkspaceName}' workspace.....`)
+    terraformCloudConfig(options.$base, options.OrganizationName, options.WorkspaceName, options.TerraformRemoteHostname);
+  }
+
+  const pypi_cdktf = options.pypi_cdktf;
+  if (!pypi_cdktf) {
+    throw new Error(`missing context "pypi_cdktf"`);
+  }
+
+  writeFileSync('requirements.txt', pypi_cdktf + '\r\npytest\r\n', 'utf-8');
+
+  let installArgs = '';
+  if (!process.env.VIRTUAL_ENV) {
+    installArgs += '--user'
+  }
+  execSync(`pip3 install ${installArgs} -r requirements.txt`, { stdio: 'inherit' });
+  chmodSync('main.py', '700');
+
+  console.log(readFileSync('./help', 'utf-8'));
+};
+
+function terraformCloudConfig(baseName, organizationName, workspaceName, terraformRemoteHostname) {
+  template = readFileSync('./main.py', 'utf-8');
+
+  const templateWithImports = template.replace(`from cdktn import App, TerraformStack`,
+    `from cdktn import App, TerraformStack, CloudBackend, NamedCloudWorkspace`)
+
+  const result = templateWithImports.replace(`MyStack(app, "${baseName}")`, `stack = MyStack(app, "${baseName}")
+CloudBackend(stack,
+  hostname='${terraformRemoteHostname}',
+  organization='${organizationName}',
+  workspaces=NamedCloudWorkspace('${workspaceName}')
+)`);
+
+  writeFileSync('./main.py', result, 'utf-8');
+}

package/templates/python-pip/cdktf.json

@@ -0,0 +1,12 @@
+{
+  "language": "python",
+  "app": "python3 ./main.py",
+  "projectId": "{{projectId}}",
+  "sendCrashReports": "{{sendCrashReports}}",
+  "terraformProviders": [],
+  "terraformModules": [],
+  "codeMakerOutput": "imports",
+  "context": {
+{{futureFlags}}
+  }
+}

package/templates/python-pip/help

@@ -0,0 +1,35 @@
+========================================================================================================
+
+  Your cdktn Python project is ready!
+
+  cat help                Prints this message
+
+  Compile:
+    python3 ./main.py     Compile and run the python code.
+
+  Synthesize:
+    cdktn synth [stack]   Synthesize Terraform resources to cdktf.out/
+
+  Diff:
+    cdktn diff [stack]    Perform a diff (terraform plan) for the given stack
+
+  Deploy:
+    cdktn deploy [stack]  Deploy the given stack
+
+  Destroy:
+    cdktn destroy [stack] Destroy the given stack
+
+  Learn more about using modules and providers https://cdk.tf/modules-and-providers
+
+Use Providers:
+
+  Use the add command to add both prebuilt providers (if available) or locally generated providers:
+  
+  cdktn provider add "aws@~>3.0" null kreuzwerker/docker
+
+  You can find all prebuilt providers on PyPI: https://pypi.org/user/cdktn-team/
+  You can also add these providers directly to your requirements.txt file.
+
+  You can also build any module or provider locally. Learn more: https://cdk.tf/modules-and-providers
+
+========================================================================================================

package/templates/python-pip/main-test.py

@@ -0,0 +1,23 @@
+import pytest
+from cdktn import Testing, TerraformStack
+
+# The tests below are example tests, you can find more information at
+# https://cdk.tf/testing
+
+
+class TestMain:
+
+    stack = TerraformStack(Testing.app(), "stack")
+    #app_abstraction = MyApplicationsAbstraction(stack, "app-abstraction")
+    #synthesized = Testing.synth(stack)
+
+    # def test_should_contain_container(self):
+    #    assert Testing.to_have_resource(self.synthesized, Container.TF_RESOURCE_TYPE)
+
+    # def test_should_use_an_ubuntu_image(self):
+    #    assert Testing.to_have_resource_with_properties(self.synthesized, Image.TF_RESOURCE_TYPE, {
+    #        "name": "ubuntu:latest",
+    #    })
+
+    # def test_check_validity(self):
+    #    assert Testing.to_be_valid_terraform(Testing.full_synth(stack))

package/templates/python-pip/main.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+from constructs import Construct
+from cdktn import App, TerraformStack
+
+
+class MyStack(TerraformStack):
+    def __init__(self, scope: Construct, id: str):
+        super().__init__(scope, id)
+
+        # define resources here
+
+
+app = App()
+MyStack(app, "{{ $base }}")
+
+app.synth()

package/templates/python-pip/{{}}.gitignore

@@ -0,0 +1,7 @@
+dist/
+imports/*
+!imports/__init__.py
+.terraform
+cdktf.out
+cdktf.log
+*terraform.*.tfstate*

package/templates/typescript/.hooks.sscaff.js

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+const { execSync } = require("child_process");
+const { readFileSync, writeFileSync } = require("fs");
+
+exports.post = (ctx) => {
+  const silent = ctx.silent === "true" || ctx.silent === true;
+  // Terraform Cloud configuration settings if the organization name and workspace is set.
+  if (ctx.OrganizationName != "") {
+    if (!silent) {
+      console.log(
+        `\nGenerating Terraform Cloud configuration for '${ctx.OrganizationName}' organization and '${ctx.WorkspaceName}' workspace.....`
+      );
+    }
+    terraformCloudConfig(
+      ctx.$base,
+      ctx.OrganizationName,
+      ctx.WorkspaceName,
+      ctx.TerraformRemoteHostname
+    );
+  }
+
+  const npm_cdktf = ctx.npm_cdktf;
+  if (!npm_cdktf) {
+    throw new Error(`missing context "npm_cdktf"`);
+  }
+
+  installDeps([npm_cdktf, `constructs@10`], false, silent);
+  installDeps(
+    ["@types/node", "typescript", "jest", "@types/jest", "ts-jest", "ts-node"],
+    true,
+    silent
+  );
+
+  if (!silent) {
+    console.log(readFileSync("./help", "utf-8"));
+  }
+};
+
+function installDeps(deps, isDev, silent) {
+  const devDep = isDev ? "-D" : "";
+  // make sure we're installing dev dependencies as well
+  const env = Object.assign({}, process.env);
+  env["NODE_ENV"] = "development";
+
+  execSync(`npm install ${devDep} ${deps.join(" ")}`, {
+    stdio: silent ? "ignore" : "inherit",
+    env,
+  });
+}
+
+function terraformCloudConfig(
+  baseName,
+  organizationName,
+  workspaceName,
+  terraformRemoteHostname
+) {
+  template = readFileSync("./main.ts", "utf-8");
+
+  result = template.replace(
+    `import { App, TerraformStack } from "cdktn";`,
+    `import { App, TerraformStack, CloudBackend, NamedCloudWorkspace } from "cdktn";`
+  );
+  result = result.replace(
+    `new MyStack(app, "${baseName}");`,
+    `const stack = new MyStack(app, "${baseName}");
+new CloudBackend(stack, {
+  hostname: "${terraformRemoteHostname}",
+  organization: "${organizationName}",
+  workspaces: new NamedCloudWorkspace("${workspaceName}")
+});`
+  );
+
+  writeFileSync("./main.ts", result, "utf-8");
+}

package/templates/typescript/__tests__/main-test.ts

@@ -0,0 +1,89 @@
+// Copyright (c) HashiCorp, Inc
+// SPDX-License-Identifier: MPL-2.0
+import "cdktn/lib/testing/adapters/jest"; // Load types for expect matchers
+// import { Testing } from "cdktn";
+
+describe("My CDKTN Application", () => {
+  // The tests below are example tests, you can find more information at
+  // https://cdk.tf/testing
+  it.todo("should be tested");
+
+  // // All Unit tests test the synthesised terraform code, it does not create real-world resources
+  // describe("Unit testing using assertions", () => {
+  //   it("should contain a resource", () => {
+  //     // import { Image,Container } from "./.gen/providers/docker"
+  //     expect(
+  //       Testing.synthScope((scope) => {
+  //         new MyApplicationsAbstraction(scope, "my-app", {});
+  //       })
+  //     ).toHaveResource(Container);
+
+  //     expect(
+  //       Testing.synthScope((scope) => {
+  //         new MyApplicationsAbstraction(scope, "my-app", {});
+  //       })
+  //     ).toHaveResourceWithProperties(Image, { name: "ubuntu:latest" });
+  //   });
+  // });
+
+  // describe("Unit testing using snapshots", () => {
+  //   it("Tests the snapshot", () => {
+  //     const app = Testing.app();
+  //     const stack = new TerraformStack(app, "test");
+
+  //     new TestProvider(stack, "provider", {
+  //       accessKey: "1",
+  //     });
+
+  //     new TestResource(stack, "test", {
+  //       name: "my-resource",
+  //     });
+
+  //     expect(Testing.synth(stack)).toMatchSnapshot();
+  //   });
+
+  //   it("Tests a combination of resources", () => {
+  //     expect(
+  //       Testing.synthScope((stack) => {
+  //         new TestDataSource(stack, "test-data-source", {
+  //           name: "foo",
+  //         });
+
+  //         new TestResource(stack, "test-resource", {
+  //           name: "bar",
+  //         });
+  //       })
+  //     ).toMatchInlineSnapshot();
+  //   });
+  // });
+
+  // describe("Checking validity", () => {
+  //   it("check if the produced terraform configuration is valid", () => {
+  //     const app = Testing.app();
+  //     const stack = new TerraformStack(app, "test");
+
+  //     new TestDataSource(stack, "test-data-source", {
+  //       name: "foo",
+  //     });
+
+  //     new TestResource(stack, "test-resource", {
+  //       name: "bar",
+  //     });
+  //     expect(Testing.fullSynth(app)).toBeValidTerraform();
+  //   });
+
+  //   it("check if this can be planned", () => {
+  //     const app = Testing.app();
+  //     const stack = new TerraformStack(app, "test");
+
+  //     new TestDataSource(stack, "test-data-source", {
+  //       name: "foo",
+  //     });
+
+  //     new TestResource(stack, "test-resource", {
+  //       name: "bar",
+  //     });
+  //     expect(Testing.fullSynth(app)).toPlanSuccessfully();
+  //   });
+  // });
+});

package/templates/typescript/cdktf.json

@@ -0,0 +1,11 @@
+{
+  "language": "typescript",
+  "app": "npx ts-node main.ts",
+  "projectId": "{{projectId}}",
+  "sendCrashReports": "{{sendCrashReports}}",
+  "terraformProviders": [],
+  "terraformModules": [],
+  "context": {
+{{futureFlags}}
+  }
+}

package/templates/typescript/help

@@ -0,0 +1,51 @@
+========================================================================================================
+
+  Your CDKTN TypeScript project is ready!
+
+  cat help                Print this message
+
+  Compile:
+    npm run get           Import/update Terraform providers and modules (you should check-in this directory)
+    npm run compile       Compile typescript code to javascript (or "npm run watch")
+    npm run watch         Watch for changes and compile typescript in the background
+    npm run build         Compile typescript
+
+  Synthesize:
+    cdktn synth [stack]   Synthesize Terraform resources from stacks to cdktf.out/ (ready for 'terraform apply')
+
+  Diff:
+    cdktn diff [stack]    Perform a diff (terraform plan) for the given stack
+
+  Deploy:
+    cdktn deploy [stack]  Deploy the given stack
+
+  Destroy:
+    cdktn destroy [stack] Destroy the stack
+
+  Test:
+    npm run test        Runs unit tests (edit __tests__/main-test.ts to add your own tests)
+    npm run test:watch  Watches the tests and reruns them on change
+
+  Upgrades:
+    npm run upgrade        Upgrade cdktn modules to latest version
+    npm run upgrade:next   Upgrade cdktn modules to latest "@next" version (last commit)
+
+ Use Providers:
+
+  You can add prebuilt providers (if available) or locally generated ones using the add command:
+  
+  cdktn provider add "aws@~>3.0" null kreuzwerker/docker
+
+  You can find all prebuilt providers on npm: https://www.npmjs.com/search?q=keywords:cdktf
+  You can also install these providers directly through npm:
+
+  npm install @cdktn/provider-aws
+  npm install @cdktn/provider-google
+  npm install @cdktn/provider-azurerm
+  npm install @cdktn/provider-docker
+  npm install @cdktn/provider-github
+  npm install @cdktn/provider-null
+
+  You can also build any module or provider locally. Learn more https://cdk.tf/modules-and-providers
+
+========================================================================================================

package/templates/typescript/jest.config.js

@@ -0,0 +1,187 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/z_/v03l33d55fb57nrr3b1q03ch0000gq/T/jest_dz",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: ["ts", "js", "json", "node"],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: "ts-jest",
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  setupFilesAfterEnv: ["<rootDir>/setup.js"],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/__tests__/**/*.ts",
+    "**/?(*.)+(spec|test).ts"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: ["/node_modules/", ".d.ts", ".js"],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/templates/typescript/main.ts

@@ -0,0 +1,14 @@
+import { Construct } from "constructs";
+import { App, TerraformStack } from "cdktn";
+
+class MyStack extends TerraformStack {
+  constructor(scope: Construct, id: string) {
+    super(scope, id);
+
+    // define resources here
+  }
+}
+
+const app = new App();
+new MyStack(app, "{{ $base }}");
+app.synth();

package/templates/typescript/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "{{ $base }}",
+  "version": "1.0.0",
+  "main": "main.js",
+  "types": "main.ts",
+  "license": "MPL-2.0",
+  "private": true,
+  "scripts": {
+    "get": "cdktn get",
+    "build": "tsc",
+    "synth": "cdktn synth",
+    "compile": "tsc --pretty",
+    "watch": "tsc -w",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "upgrade": "npm i cdktn@latest cdktn-cli@latest",
+    "upgrade:next": "npm i cdktn@next cdktn-cli@next"
+  },
+  "engines": {
+    "node": ">=20.9"
+  }
+}

package/templates/typescript/setup.js

@@ -0,0 +1,2 @@
+const cdktn = require("cdktn");
+cdktn.Testing.setupJest();

package/templates/typescript/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "alwaysStrict": true,
+    "declaration": true,
+    "experimentalDecorators": true,
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "lib": [
+      "es2018"
+    ],
+    "module": "CommonJS",
+    "noEmitOnError": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "stripInternal": true,
+    "target": "ES2018",
+    "incremental": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "cdktf.out"
+  ]
+}

package/templates/typescript/{{}}.gitignore

@@ -0,0 +1,11 @@
+*.d.ts
+*.js
+node_modules
+cdktf.out
+cdktf.log
+*terraform.*.tfstate*
+.gen
+.terraform
+tsconfig.tsbuildinfo
+!jest.config.js
+!setup.js