feat: OpenTofu support

Author: ServerlessLife

.github/workflows/common-test.yml

@@ -584,3 +584,59 @@ jobs:
         run: npx vitest --retry 1 test/terraform-basic.test.ts
       - name: Test - observability mode
         run: OBSERVABLE_MODE=true npx vitest --retry 1 test/terraform-basic.test.ts
+
+  test-opentofu-basic:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: test-opentofu-basic
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.node_version }}
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies
+        run: |
+          node prepareForTest.js opentofu-basic
+          npm i
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        if: ${{ inputs.mode == 'build' }}
+        with:
+          name: dist
+          path: dist
+      - name: Install lambda-live-debugger globally
+        if: ${{ inputs.mode == 'global' }}
+        run: |
+          npm i lambda-live-debugger -g
+        working-directory: test
+      - name: Install lambda-live-debugger locally
+        if: ${{ inputs.mode == 'local' }}
+        run: |
+          npm i lambda-live-debugger
+        working-directory: test
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-region: eu-west-1
+          role-to-assume: ${{ secrets.AWS_ROLE }}
+          role-session-name: GitHubActions
+      - name: Setup OpenTofu
+        uses: opentofu/setup-opentofu@v1
+      - name: OpenTofu Init
+        run: |
+          ./create_bucket.sh lld-opentofu-basic
+          tofu init -backend-config="bucket=lld-opentofu-basic"
+        working-directory: test/opentofu-basic
+      - name: Destroy
+        run: npm run destroy
+        working-directory: test/opentofu-basic
+        continue-on-error: true
+      - name: Deploy
+        run: npm run deploy
+        working-directory: test/opentofu-basic
+      - name: Test
+        run: npx vitest --retry 1 test/opentofu-basic.test.ts
+      - name: Test - observability mode
+        run: OBSERVABLE_MODE=true npx vitest --retry 1 test/opentofu-basic.test.ts

.vscode/launch.json

@@ -261,6 +261,26 @@
       "type": "node",
       "cwd": "${workspaceRoot}/test/terraform-basic"
     },
+    {
+      "name": "LLDebugger - OpenTofu basic",
+      "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",
+      "args": ["../../src/lldebugger.ts", "--config-env=test"],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "type": "node",
+      "cwd": "${workspaceRoot}/test/opentofu-basic"
+    },
+    {
+      "name": "LLDebugger - OpenTofu basic - observability",
+      "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",
+      "args": ["../../src/lldebugger.ts", "--config-env=test", "-o"],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "type": "node",
+      "cwd": "${workspaceRoot}/test/opentofu-basic"
+    },
     {
       "name": "LLDebugger - CDK config",
       "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",

package.json

@@ -72,6 +72,8 @@
     "test-sam-alt-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sam-alt.test.ts",
     "test-terraform-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/terraform-basic.test.ts",
     "test-terraform-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/terraform-basic.test.ts",
+    "test-opentofu-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/opentofu-basic.test.ts",
+    "test-opentofu-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/opentofu-basic.test.ts",
     "docs:dev": "vitepress dev",
     "docs:build": "vitepress build",
     "docs:preview": "vitepress preview"
@@ -154,6 +156,7 @@
     "test/osls-esbuild-cjs",
     "test/sam-basic",
     "test/sam-alt",
-    "test/terraform-basic"
+    "test/terraform-basic",
+    "test/opentofu-basic"
   ]
-}
+}

src/frameworks/openTofuFramework.ts

@@ -0,0 +1,33 @@
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import { TerraformFramework } from './terraformFramework.js';
+
+export const execAsync = promisify(exec);
+
+/**
+ * Support for Terraform framework
+ */
+export class OpenTofuFramework extends TerraformFramework {
+  /**
+   * Framework name
+   */
+  public get name(): string {
+    return 'opentofu';
+  }
+
+  /**
+   * Name of the framework in logs
+   */
+  protected get logName(): string {
+    return 'OpenTofu';
+  }
+
+  /**
+   * Get OpenTofu state CI command
+   */
+  protected get stateCommand(): string {
+    return 'tofu show --json';
+  }
+}
+
+export const openTofuFramework = new OpenTofuFramework();

src/frameworks/terraformFramework.ts

@@ -40,6 +40,13 @@ export class TerraformFramework implements IFramework {
     return 'terraform';
   }
 
+  /**
+   * Name of the framework in logs
+   */
+  protected get logName(): string {
+    return 'Terrform';
+  }
+
   /**
    * Can this class handle the current project
    * @returns
@@ -51,7 +58,7 @@ export class TerraformFramework implements IFramework {
 
     if (!r) {
       Logger.verbose(
-        `[Terraform] This is not a Terraform project. There are no *.tf files in ${path.resolve('.')} folder.`,
+        `[${this.logName}] This is not a Terraform or OpenTofu project. There are no *.tf files in ${path.resolve('.')} folder.`,
       );
     }
 
@@ -69,7 +76,7 @@ export class TerraformFramework implements IFramework {
     const lambdas = this.extractLambdaInfo(state);
 
     Logger.verbose(
-      '[Terraform] Found Lambdas:',
+      `[${this.logName}] Found Lambdas:`,
       JSON.stringify(lambdas, null, 2),
     );
 
@@ -78,7 +85,7 @@ export class TerraformFramework implements IFramework {
     const tsOutDir = await this.getTsConfigOutDir();
 
     if (tsOutDir) {
-      Logger.verbose('[Terraform] tsOutDir:', tsOutDir);
+      Logger.verbose(`[${this.logName}] tsOutDir:`, tsOutDir);
     }
 
     for (const func of lambdas) {
@@ -143,7 +150,7 @@ export class TerraformFramework implements IFramework {
         packageJsonPath,
         esBuildOptions: undefined,
         metadata: {
-          framework: 'terraform',
+          framework: this.name,
         },
       };
 
@@ -164,7 +171,7 @@ export class TerraformFramework implements IFramework {
     for (const resource of resources) {
       if (resource.type === 'aws_lambda_function') {
         Logger.verbose(
-          '[Terraform] Found Lambda:',
+          `[${this.logName}] Found Lambda:`,
           JSON.stringify(resource, null, 2),
         );
 
@@ -235,42 +242,49 @@ export class TerraformFramework implements IFramework {
     return lambdas;
   }
 
+  /**
+   * Get Terraform state CI command
+   */
+  protected get stateCommand(): string {
+    return 'terraform show --json';
+  }
+
   protected async readTerraformState(): Promise<TerraformResource[]> {
     // Is there a better way to get the Terraform state???
 
     let output: any;
 
     // get state by running "terraform show --json" command
     try {
-      output = await execAsync('terraform show --json');
+      output = await execAsync(this.stateCommand);
     } catch (error: any) {
       throw new Error(
-        `Failed to get Terraform state from 'terraform show --json' command: ${error.message}`,
+        `[${this.logName}] Failed to getstate from '${this.stateCommand}' command: ${error.message}`,
         { cause: error },
       );
     }
 
     if (output.stderr) {
       throw new Error(
-        `Failed to get Terraform state from 'terraform show --json' command: ${output.stderr}`,
+        `[${this.logName}] Failed to get state from '${this.stateCommand}' command: ${output.stderr}`,
       );
     }
 
     if (!output.stdout) {
       throw new Error(
-        "Failed to get Terraform state from 'terraform show --json' command",
+        `[${this.logName}] Failed to get state from '${this.stateCommand}' command`,
       );
     }
 
     let jsonString: string | undefined = output.stdout;
 
-    Logger.verbose('Terraform state:', jsonString);
+    Logger.verbose(`[${this.logName}] State:`, jsonString);
 
     jsonString = jsonString?.split('\n').find((line) => line.startsWith('{'));
 
     if (!jsonString) {
       throw new Error(
-        'Failed to get Terraform state. JSON string not found in the output.',
+        `[${this.logName}] Failed to get state. JSON string not found in the output.`,
       );
     }
 
@@ -288,10 +302,10 @@ export class TerraformFramework implements IFramework {
       return [...rootResources, ...childResources] as TerraformResource[];
     } catch (error: any) {
       //save state to file
-      await fs.writeFile('terraform-state.json', jsonString);
-      Logger.error('Failed to parse Terraform state JSON:', error);
+      await fs.writeFile(`${this.name}-state.json`, jsonString);
+      Logger.error(`[${this.logName}] Failed to parse state JSON:`, error);
       throw new Error(
-        `Failed to parse Terraform state JSON: ${error.message}`,
+        `Failed to parse ${this.logName} state JSON: ${error.message}`,
         { cause: error },
       );
     }
@@ -314,11 +328,11 @@ export class TerraformFramework implements IFramework {
       }
     }
     if (!tsConfigPath) {
-      Logger.verbose('[Terraform] tsconfig.json not found');
+      Logger.verbose(`[${this.logName}] tsconfig.json not found`);
       return undefined;
     }
 
-    Logger.verbose('[Terraform] tsconfig.json found:', tsConfigPath);
+    Logger.verbose(`[${this.logName}] tsconfig.json found:`, tsConfigPath);
     const configFile = ts.readConfigFile(tsConfigPath, ts.sys.readFile);
     const compilerOptions = ts.parseJsonConfigFileContent(
       configFile.config,

src/index.ts

@@ -9,5 +9,6 @@ export { CdkFramework } from './frameworks/cdkFramework.js';
 export { SlsFramework } from './frameworks/slsFramework.js';
 export { SamFramework } from './frameworks/samFramework.js';
 export { TerraformFramework } from './frameworks/terraformFramework.js';
+export { OpenTofuFramework } from './frameworks/openTofuFramework.js';
 export { type IFramework } from './frameworks/iFrameworks.js';
 export { type AwsConfiguration } from './types/awsConfiguration.js';

src/resourceDiscovery.ts

@@ -3,6 +3,7 @@ import { cdkFramework } from './frameworks/cdkFramework.js';
 import { slsFramework } from './frameworks/slsFramework.js';
 import { samFramework } from './frameworks/samFramework.js';
 import { terraformFramework } from './frameworks/terraformFramework.js';
+import { openTofuFramework } from './frameworks/openTofuFramework.js';
 import { LldConfig } from './types/lldConfig.js';
 import { LambdaResource } from './types/resourcesDiscovery.js';
 import { Logger } from './logger.js';
@@ -16,6 +17,7 @@ const frameworksSupported: IFramework[] = [
   slsFramework,
   samFramework,
   terraformFramework,
+  openTofuFramework,
 ];
 
 /**