@microsoft/terraform-cdk-constructs 0.0.3-pre.6

package/package.json

@@ -0,0 +1,159 @@
+{
+  "name": "@microsoft/terraform-cdk-constructs",
+  "description": "A collection of CDK modules for provisioning and managing Terraform resources efficiently.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/azure/terraform-cdk-modules.git"
+  },
+  "scripts": {
+    "build": "npx projen build",
+    "bump": "npx projen bump",
+    "clobber": "npx projen clobber",
+    "compat": "npx projen compat",
+    "compile": "npx projen compile",
+    "default": "npx projen default",
+    "docgen": "npx projen docgen",
+    "eject": "npx projen eject",
+    "eslint": "npx projen eslint",
+    "package": "npx projen package",
+    "package-all": "npx projen package-all",
+    "package:js": "npx projen package:js",
+    "post-compile": "npx projen post-compile",
+    "post-upgrade": "npx projen post-upgrade",
+    "pre-compile": "npx projen pre-compile",
+    "release": "npx projen release",
+    "test": "npx projen test",
+    "test:update": "npx projen test:update",
+    "test:watch": "npx projen test:watch",
+    "unbump": "npx projen unbump",
+    "upgrade": "npx projen upgrade",
+    "watch": "npx projen watch",
+    "projen": "npx projen",
+    "generate-index": "node ./scripts/generate-index.js"
+  },
+  "author": {
+    "name": "Microsoft",
+    "url": "https://microsoft.com",
+    "organization": false
+  },
+  "devDependencies": {
+    "@cdktf/provider-azurerm": "9.0.8",
+    "@types/jest": "^29.5.11",
+    "@types/moment": "^2.13.0",
+    "@types/node": "^20",
+    "@typescript-eslint/eslint-plugin": "^6",
+    "@typescript-eslint/parser": "^6",
+    "cdktf": "0.17.3",
+    "constructs": "10.1.106",
+    "eslint": "^8",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "jest": "^29.7.0",
+    "jest-junit": "^15",
+    "jsii": "~5.2.0",
+    "jsii-diff": "^1.94.0",
+    "jsii-docgen": "^10.3.9",
+    "jsii-pacmak": "^1.94.0",
+    "jsii-rosetta": "~5.2.0",
+    "prettier": "^3.2.4",
+    "projen": "^0.79.1",
+    "standard-version": "^9",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "typescript": "~5.2.0"
+  },
+  "peerDependencies": {
+    "@cdktf/provider-azurerm": "9.0.8",
+    "cdktf": "0.17.3",
+    "constructs": "^10.1.106"
+  },
+  "dependencies": {
+    "@cdktf/provider-azurerm": "9.0.8",
+    "cdktf": "0.17.3",
+    "moment": "^2.30.1",
+    "nanoid": "^4.0.2",
+    "ts-md5": "^1.3.1"
+  },
+  "bundledDependencies": [
+    "moment",
+    "nanoid",
+    "ts-md5"
+  ],
+  "keywords": [
+    "azure",
+    "cdk",
+    "cdktf",
+    "cloud",
+    "devops",
+    "infrastructure",
+    "terraform"
+  ],
+  "engines": {
+    "node": ">= 20.10.0"
+  },
+  "main": "lib/index.js",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.0.3-pre.6",
+  "jest": {
+    "testMatch": [
+      "<rootDir>/src/**/__tests__/**/*.ts?(x)",
+      "<rootDir>/(|src)/**/*(*.)@(spec|test).ts?(x)"
+    ],
+    "clearMocks": true,
+    "collectCoverage": true,
+    "coverageReporters": [
+      "json",
+      "lcov",
+      "clover",
+      "cobertura",
+      "text"
+    ],
+    "coverageDirectory": "coverage",
+    "coveragePathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "watchPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "reporters": [
+      "default",
+      [
+        "jest-junit",
+        {
+          "outputDirectory": "test-reports"
+        }
+      ]
+    ],
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.dev.json"
+        }
+      ]
+    },
+    "setupFilesAfterEnv": [
+      "<rootDir>/setup.js"
+    ],
+    "globals": {}
+  },
+  "types": "lib/index.d.ts",
+  "stability": "stable",
+  "jsii": {
+    "outdir": "dist",
+    "targets": {},
+    "tsc": {
+      "outDir": "lib",
+      "rootDir": "src"
+    }
+  },
+  "//": "~~ Generated by projen. To modify, edit .projenrc.ts and run \"npx projen\"."
+}

package/scripts/generate-index.js

@@ -0,0 +1,52 @@
+const fs = require('fs');
+const path = require('path');
+
+const baseDir = './src';
+const excludeDirs = ['test', 'module', 'util', 'testing']; // Add any directories you want to exclude
+
+function generateLibIndex(libDir) {
+  const files = fs.readdirSync(libDir, { withFileTypes: true });
+  const exports = files
+    .filter(file => file.isFile() && file.name.endsWith('.ts') && file.name !== 'index.ts')
+    .map(file => `export * from './${path.basename(file.name, '.ts')}';\n`)
+    .join('');
+
+  fs.writeFileSync(path.join(libDir, 'index.ts'), exports);
+  console.log(`index.ts generated in ${libDir}`);
+}
+
+function generateModuleIndex(moduleDir) {
+  const libDir = path.join(moduleDir, 'lib');
+  if (fs.existsSync(libDir) && fs.statSync(libDir).isDirectory()) {
+    generateLibIndex(libDir);
+    const exportStatement = `export * from './lib';\n`;
+    fs.writeFileSync(path.join(moduleDir, 'index.ts'), exportStatement);
+    console.log(`index.ts generated in ${moduleDir}`);
+  }
+}
+
+function findSubdirectories(dir, dirList = []) {
+  const entries = fs.readdirSync(dir, { withFileTypes: true });
+  entries.forEach(entry => {
+    if (entry.isDirectory() && !excludeDirs.includes(entry.name)) {
+      dirList.push(path.join(dir, entry.name));
+    }
+  });
+  return dirList;
+}
+
+function generateIndex() {
+  const subdirectories = findSubdirectories(baseDir);
+  const exports = subdirectories.map(dir => {
+    const dirName = path.basename(dir).replace(/-/g, '_');
+    const relativePath = path.relative(baseDir, dir);
+    return `export * as ${dirName} from './${relativePath}';\n`;
+  }).join('');
+
+  fs.writeFileSync(path.join(baseDir, 'index.ts'), exports);
+  console.log('index.ts generated in src');
+
+  subdirectories.forEach(generateModuleIndex);
+}
+
+generateIndex();

package/setup.js

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

package/tfsec.json

@@ -0,0 +1,4 @@
+{
+    "exclude": ["AZU020", "azure-keyvault-specify-network-acl", "azure-compute-disable-password-authentication", "GEN003", "azure-container-use-rbac-permissions", "azure-container-logging"]
+}
+  

package/util/compute.go

@@ -0,0 +1,106 @@
+package util
+
+import (
+	"context"
+
+	"github.com/Azure/azure-sdk-for-go/services/compute/mgmt/2019-07-01/compute"
+
+	"github.com/gruntwork-io/terratest/modules/azure"
+	"github.com/gruntwork-io/terratest/modules/testing"
+	"github.com/stretchr/testify/require"
+)
+
+// GetVirtualMachineScaleSetClient is a helper function that will setup an Azure Virtual Machine Scale Set client on your behalf.
+func GetVirtualMachineScaleSetClient(t testing.TestingT, subscriptionID string) *compute.VirtualMachineScaleSetsClient {
+	vmssClient, err := GetVirtualMachineScaleSetClientE(subscriptionID)
+	require.NoError(t, err)
+	return vmssClient
+}
+
+// GetVirtualMachineScaleSetClientE is a helper function that will setup an Azure Virtual Machine Scale Set client on your behalf.
+func GetVirtualMachineScaleSetClientE(subscriptionID string) (*compute.VirtualMachineScaleSetsClient, error) {
+	// Create a VMSS client
+	vmssClient := compute.NewVirtualMachineScaleSetsClient(subscriptionID)
+
+	// Create an authorizer
+	authorizer, err := azure.NewAuthorizer()
+	if err != nil {
+		return nil, err
+	}
+
+	// Attach authorizer to the client
+	vmssClient.Authorizer = *authorizer
+	return &vmssClient, nil
+}
+
+// VirtualMachineScaleSetExists indicates whether the specified Azure Virtual Machine Scale Set exists.
+// This function would fail the test if there is an error.
+func VirtualMachineScaleSetExists(t testing.TestingT, vmssName string, resGroupName string, subscriptionID string) bool {
+	exists, err := VirtualMachineScaleSetExistsE(vmssName, resGroupName, subscriptionID)
+	require.NoError(t, err)
+	return exists
+}
+
+// VirtualMachineScaleSetExistsE indicates whether the specified Azure Virtual Machine Scale Set exists.
+func VirtualMachineScaleSetExistsE(vmssName string, resGroupName string, subscriptionID string) (bool, error) {
+	// Get VMSS client
+	client, err := GetVirtualMachineScaleSetClientE(subscriptionID)
+	if err != nil {
+		return false, err
+	}
+
+	// Get the VMSS
+	_, err = client.Get(context.Background(), resGroupName, vmssName)
+	if err != nil {
+		if azure.ResourceNotFoundErrorExists(err) {
+			return false, nil
+		}
+		return false, err
+	}
+	return true, nil
+}
+
+// GetVirtualMachineScaleSet gets a Virtual Machine Scale Set in the specified Azure Resource Group.
+// This function would fail the test if there is an error.
+func GetVirtualMachineScaleSet(t testing.TestingT, vmssName string, resGroupName string, subscriptionID string) *compute.VirtualMachineScaleSet {
+	vmss, err := GetVirtualMachineScaleSetE(vmssName, resGroupName, subscriptionID)
+	require.NoError(t, err)
+	return vmss
+}
+
+// GetVirtualMachineScaleSetE gets a Virtual Machine Scale Set in the specified Azure Resource Group.
+func GetVirtualMachineScaleSetE(vmssName string, resGroupName string, subscriptionID string) (*compute.VirtualMachineScaleSet, error) {
+	// Get the VMSS client reference
+	client, err := GetVirtualMachineScaleSetClientE(subscriptionID)
+	if err != nil {
+		return nil, err
+	}
+
+	// Get the VMSS object
+	vmss, err := client.Get(context.Background(), resGroupName, vmssName)
+	if err != nil {
+		return nil, err
+	}
+
+	return &vmss, nil
+}
+
+// GetSkuOfVirtualMachineScaleSet gets the SKU of the specified Azure Virtual Machine Scale Set.
+// This function would fail the test if there is an error.
+func GetSkuOfVirtualMachineScaleSet(t testing.TestingT, vmssName string, resGroupName string, subscriptionID string) *compute.Sku {
+	sku, err := GetSkuOfVirtualMachineScaleSetE(vmssName, resGroupName, subscriptionID)
+	require.NoError(t, err)
+
+	return sku
+}
+
+// GetSkuOfVirtualMachineScaleSetE gets the SKU of the specified Azure Virtual Machine Scale Set.
+func GetSkuOfVirtualMachineScaleSetE(vmssName string, resGroupName string, subscriptionID string) (*compute.Sku, error) {
+	// Get VMSS Object
+	vmss, err := GetVirtualMachineScaleSetE(vmssName, resGroupName, subscriptionID)
+	if err != nil {
+		return nil, err
+	}
+
+	return vmss.Sku, nil
+}

package/util/terraform.go

@@ -0,0 +1,213 @@
+package util
+
+import (
+	"fmt"
+	"os"
+	"path"
+	"strings"
+
+	"github.com/gruntwork-io/terratest/modules/terraform"
+	"github.com/gruntwork-io/terratest/modules/testing"
+	"github.com/stretchr/testify/require"
+)
+
+// CdkTFInvalidBinary occurs when a cdktf function is called and the TerraformBinary is
+// set to a value other than cdktf
+type CdkTFInvalidBinary string
+
+func (err CdkTFInvalidBinary) Error() string {
+	return fmt.Sprintf("cdktf must be set as TerraformBinary to use this function. [ TerraformBinary : %s ]", string(err))
+}
+
+func CdkTFSynth(t testing.TestingT, options *terraform.Options, exampleFile string) (string, error) {
+	if options.TerraformBinary != "cdktf" {
+		t.Errorf("Invalid Terraform Binary")
+		return "Failure", CdkTFInvalidBinary(options.TerraformBinary)
+	}
+
+	// Get the directory of the example_file
+	dir := path.Dir(exampleFile)
+
+	// Replace the filename with "tempstacks"
+	tempstackfolder := path.Join(dir, ".tempstacks")
+
+	// RunTerraformCommandE doesn't actually raise any errors. It returns them.
+	result, err := terraform.RunTerraformCommandE(t, options, terraform.FormatArgs(options, "synth", "--app", "npx ts-node"+" "+exampleFile, "--output", tempstackfolder)...)
+	if err != nil {
+		t.Errorf("%s", err.Error())
+	}
+	return result, err
+}
+
+func CdkTFOutput(t testing.TestingT, options *terraform.Options, variableName string) string {
+	options.TerraformBinary = "terraform"
+
+	// Clone options with deep copy
+	tfoutputOptions, err := options.Clone()
+	if err != nil {
+		return fmt.Sprintf("%s", err)
+	}
+
+	// List all directories inside stacksFolder
+	stackDirs, err := os.ReadDir(".tempstacks/stacks")
+
+	if err != nil {
+		return fmt.Sprintf("%s", err)
+	}
+
+	// Iterate through each directory inside the "stacks" folder and run terraform.Output
+	for _, stackDir := range stackDirs {
+		if stackDir.IsDir() {
+			currentDir := path.Join(".tempstacks/stacks", stackDir.Name())
+			tfoutputOptions.TerraformDir = currentDir
+
+			outputValue := terraform.Output(t, tfoutputOptions, variableName)
+			if outputValue != "" {
+				return outputValue
+			}
+		}
+	}
+
+	// If no value is found after iterating through all directories
+	return ""
+}
+
+func CdkTFApplyAll(t testing.TestingT, options *terraform.Options, exampleFile string) (string, error) {
+
+	options.TerraformBinary = "cdktf"
+
+	// Get the directory of the example_file
+	dir := path.Dir(exampleFile)
+
+	// Replace the filename with "tempstacks"
+	tempstackfolder := path.Join(dir, ".tempstacks")
+
+	// If Vars is present, convert it to Args and remove it from the struct
+	var args []string
+	var varsArgs []string
+	if options.Vars != nil {
+		varsArgs = FormatTerraformVarsAsArgs(options.Vars)
+		options.Vars = nil
+	}
+
+	// Format the remaining options into arguments
+	args = append(args, terraform.FormatArgs(options, "deploy", "*", "--auto-approve", "--app", "npx ts-node"+" "+exampleFile, "--output", tempstackfolder)...)
+
+	// If Vars was present, append its arguments to the end
+	if varsArgs != nil {
+		args = append(args, varsArgs...)
+	}
+
+	// RunTerraformCommandE doesn't actually raise any errors. It returns them.
+	result, err := terraform.RunTerraformCommandE(t, options, args...)
+
+	if err != nil {
+		t.Errorf("%s", err.Error())
+	}
+	return result, err
+}
+
+func CdkTFDestroyAll(t testing.TestingT, options *terraform.Options, exampleFile string) (string, error) {
+
+	options.TerraformBinary = "cdktf"
+
+	// Get the directory of the example_file
+	dir := path.Dir(exampleFile)
+
+	// Replace the filename with "tempstacks"
+	tempstackfolder := path.Join(dir, ".tempstacks")
+
+	cmdoutput := fmt.Sprintf("--output %s", tempstackfolder)
+
+	// RunTerraformCommandE doesn't actually raise any errors. It returns them.
+	result, err := terraform.RunTerraformCommandE(t, options, terraform.FormatArgs(options, "destroy", "*", "--skip-synth", "--auto-approve", "--app", "npx ts-node"+" "+exampleFile, cmdoutput)...)
+	if err != nil {
+		t.Errorf("%s", err.Error())
+	}
+	return result, err
+
+}
+
+func CdkTFApplyAllAndIdempotent(t testing.TestingT, options *terraform.Options, exampleFile string) (string, error) {
+	options.TerraformBinary = "cdktf"
+
+	// Clone options with deep copy
+	tfplanOptions, err := options.Clone()
+	if err != nil {
+		return "", err
+	}
+
+	out, err := CdkTFApplyAll(t, options, exampleFile)
+	if err != nil {
+		return out, err
+	}
+
+	nonIdempotentStacks, err := CheckStacksIdempotency(t, tfplanOptions, ".tempstacks/stacks")
+	if err != nil {
+		return out, err
+	}
+
+	if len(nonIdempotentStacks) > 0 {
+		stacksStr := strings.Join(nonIdempotentStacks, ", ")
+		err = fmt.Errorf("terraform configuration not idempotent for stacks: %s", stacksStr)
+	}
+
+	require.NoError(t, err)
+
+	return out, err
+}
+
+func CheckStacksIdempotency(t testing.TestingT, options *terraform.Options, tempstackfolder string) ([]string, error) {
+	options.TerraformBinary = "terraform"
+
+	// List all directories under .tempstacks/stacks
+	stackFolders, err := os.ReadDir(tempstackfolder)
+	if err != nil {
+		return nil, err
+	}
+
+	nonIdempotentStacks := []string{} // Slice to store stack directories with non-zero planexitcode
+
+	for _, stackFolder := range stackFolders {
+		if stackFolder.IsDir() {
+			stackPath := path.Join(tempstackfolder, stackFolder.Name())
+			options.TerraformDir = stackPath
+
+			exitCode := terraform.PlanExitCode(t, options)
+
+			// First, check the exit code.
+			if exitCode != 0 {
+				fmt.Printf("terraform plan exit code: %d\n", exitCode)
+				nonIdempotentStacks = append(nonIdempotentStacks, stackFolder.Name())
+			}
+
+			// Then, handle any other errors from the PlanExitCodeE function.
+			if err != nil {
+				t.Errorf("%s", err.Error())
+				require.NoError(t, err) // This will fail the test immediately if there's an error.
+				return nil, err
+			}
+		}
+	}
+
+	return nonIdempotentStacks, nil
+}
+
+func formatTerraformArgs(vars map[string]interface{}, prefix string, useSpaceAsSeparator bool) []string {
+	var args []string
+
+	for key, value := range vars {
+		argValue := fmt.Sprintf("%s=%s", key, value)
+		if useSpaceAsSeparator {
+			args = append(args, prefix, argValue)
+		} else {
+			args = append(args, fmt.Sprintf("%s=%s", prefix, argValue))
+		}
+	}
+
+	return args
+}
+
+func FormatTerraformVarsAsArgs(vars map[string]interface{}) []string {
+	return formatTerraformArgs(vars, "--var", true)
+}

package/util/util.go

@@ -0,0 +1,100 @@
+package util
+
+import (
+	"encoding/json"
+	"math/rand"
+	"os"
+	"os/exec"
+	"strings"
+	"time"
+)
+
+func GetSubscriptionID() string {
+	subscriptionID := os.Getenv("ARM_SUBSCRIPTION_ID")
+
+	if subscriptionID == "" {
+		out, err := exec.Command("az", "account", "show", "--query", "id", "-o", "tsv").Output()
+		if err != nil {
+			return "" // or handle error appropriately
+		}
+
+		subscriptionID = strings.TrimSpace(string(out))
+	}
+
+	return subscriptionID
+}
+
+func ReadFile(filePath string) ([]byte, error) {
+	return os.ReadFile(filePath)
+}
+
+func UnmarshalJSON(data []byte) (map[string]interface{}, error) {
+	var jsonData map[string]interface{}
+	err := json.Unmarshal(data, &jsonData)
+	return jsonData, err
+}
+
+func RandomizeResourceNames(resourceData map[string]interface{}, resourceName string) {
+	if specificResourceData, ok := resourceData[resourceName].(map[string]interface{}); ok {
+		for _, v := range specificResourceData {
+			if specificResource, ok := v.(map[string]interface{}); ok {
+				if _, ok := specificResource["name"]; ok {
+					specificResource["name"] = randomString(10)
+				}
+			}
+		}
+	}
+}
+
+func MarshalJSON(jsonData map[string]interface{}) ([]byte, error) {
+	return json.Marshal(jsonData)
+}
+
+func WriteFile(filePath string, jsonDataBytes []byte) error {
+	return os.WriteFile(filePath, jsonDataBytes, os.ModePerm)
+}
+
+func RandomizeUniqueResources(filePath string) error {
+	data, err := ReadFile(filePath)
+	if err != nil {
+		return err
+	}
+
+	jsonData, err := UnmarshalJSON(data)
+	if err != nil {
+		return err
+	}
+
+	if resourceData, ok := jsonData["resource"].(map[string]interface{}); ok {
+		RandomizeResourceNames(resourceData, "azurerm_storage_account")
+		RandomizeResourceNames(resourceData, "azurerm_resource_group")
+		RandomizeResourceNames(resourceData, "azurerm_eventhub_namespace")
+		RandomizeResourceNames(resourceData, "azurerm_key_vault")
+		RandomizeResourceNames(resourceData, "azurerm_container_registry")
+	}
+
+	jsonDataBytes, err := MarshalJSON(jsonData)
+	if err != nil {
+		return err
+	}
+
+	err = WriteFile(filePath, jsonDataBytes)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// Generate a random string of the specified length
+const allowedChars = "abcdefghijklmnopqrstuvwxyz0123456789"
+
+func randomString(length int) string {
+	rand.Seed(time.Now().UnixNano())
+	chars := []rune(allowedChars)
+	result := make([]rune, length)
+	for i := range result {
+		result[i] = chars[rand.Intn(len(chars))]
+	}
+	return string(result)
+}