feat: Improve Terraform and OpenTofu support (#102)

* feat: Improve Terraform and OpenTofu support

* feat: Improve Terraform and add OpenTofu support

* Improve error log

* Improve logs

Author: ServerlessLife

.github/workflows/common-test.yml

@@ -571,7 +571,7 @@ jobs:
           role-to-assume: ${{ secrets.AWS_ROLE }}
           role-session-name: GitHubActions
       - name: Setup Terraform
-        uses: hashicorp/setup-terraform@v1
+        uses: hashicorp/setup-terraform@v3
       - name: Terraform Init
         run: |
           ./create_bucket.sh lld-terraform-basic
@@ -588,3 +588,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",

README.md

@@ -9,7 +9,7 @@ It supports the following frameworks:
 - AWS CDK v2
 - Serverless Framework v3 (SLS) and [`osls` fork](https://github.com/oss-serverless/serverless)
 - AWS Serverless Application Model (SAM)
-- Terraform
+- Terraform and OpenTofu
 - Any other framework or setup by implementing a simple function in TypeScript
 - ... (Need support for another framework? Let me know!)
 
@@ -211,11 +211,13 @@ Use the `stage` parameter to pass the stage/environment name.
 
 Use the `config-env` parameter to pass the stage/environment name.
 
-### Terraform
+### Terraform and OpenTofu
 
-Only the basic setup is supported. Check the [test case](https://github.com/ServerlessLife/lambda-live-debugger/tree/main/test/terraform-basic).
+Multiple configurations are supported, including [serverless.tf](https://serverless.tf/) framework. You can explore [relevant test cases here](https://github.com/ServerlessLife/lambda-live-debugger/tree/main/test/terraform-basic).
 
-I am not a Terraform developer, so I only know the basics. Please provide a sample project so I can build better support.
+If you use TypeScript, Lambda Live Debugger should automatically locate source files, even when they are transpiled to JavaScript.
+
+If you encounter an unsupported configuration, please open a [GitHub Issue](https://github.com/ServerlessLife/lambda-live-debugger/issues).
 
 ### Custom Setup
 

package-lock.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"
   ]
 }

package.json

@@ -0,0 +1,41 @@
+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';
+  }
+
+  /**
+   *
+   * @returns Get command to check if OpenTodu is installed
+   */
+  protected get checkInstalledCommand(): string {
+    return 'tofu --version';
+  }
+}
+
+export const openTofuFramework = new OpenTofuFramework();