cdktn-cli 0.0.1 → 0.21.0

package/bundle/templates/python/.hooks.sscaff.js

@@ -0,0 +1,59 @@
+/**
+ * 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 pipenv')
+    }
+    else {
+      execSync('which pipenv')
+    }
+  } catch {
+    console.error(`Unable to find "pipenv". Follow the instructions from https://pipenv.pypa.io/`)
+    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"`);
+  }
+
+  execSync('pipenv install', { stdio: 'inherit' });
+  execSync(`pipenv install ${pypi_cdktf}`, { stdio: 'inherit' });
+  execSync(`pipenv install pytest`, { 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/bundle/templates/python/Pipfile

@@ -0,0 +1,7 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[requires]
+python_version = "3"

package/bundle/templates/python/cdktf.json

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

package/bundle/templates/python/help

@@ -0,0 +1,42 @@
+========================================================================================================
+
+  Your cdktn Python project is ready!
+
+  cat help                Prints this message
+
+  Compile:
+    pipenv run ./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:
+
+  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 PyPI: https://pypi.org/user/cdktn-team/
+  You can also install these providers directly through pipenv:
+
+  pipenv install cdktn-provider-aws
+  pipenv install cdktn-provider-google
+  pipenv install cdktn-provider-azurerm
+  pipenv install cdktn-provider-docker
+  pipenv install cdktn-provider-github
+  pipenv install cdktn-provider-null
+
+  You can also build any module or provider locally. Learn more: https://cdk.tf/modules-and-providers
+
+========================================================================================================

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

@@ -0,0 +1,26 @@
+import pytest
+from cdktn import Testing
+
+# The tests below are example tests, you can find more information at
+# https://cdk.tf/testing
+
+
+class TestMain:
+
+    def test_my_app(self):
+        assert True
+
+    #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/bundle/templates/python/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/bundle/templates/python/{{}}.gitignore

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

package/bundle/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/bundle/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/bundle/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/bundle/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/bundle/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/bundle/templates/python-pip/{{}}.gitignore

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

package/bundle/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/bundle/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/bundle/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/bundle/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
+
+========================================================================================================