Merge pull request #54 from ServerlessLife/47-sam-config

fix: [#47] SAM config parameters

Author: ServerlessLife

.github/workflows/common-test.yml

@@ -314,6 +314,57 @@ jobs:
       - name: Test - observable mode
         run: OBSERVABLE_MODE=true npx vitest --retry 1 test/sam-basic.test.ts
 
+  test-sam-alt:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: test-sam-alt
+    steps:
+      - uses: actions/checkout@v4
+      - uses: aws-actions/setup-sam@v2
+        with:
+          use-installer: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - 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: npm ci
+      - 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: Destroy
+        run: npm run destroy
+        working-directory: test/sam-alt
+        continue-on-error: true
+      - name: Deploy
+        run: npm run deploy
+        working-directory: test/sam-alt
+      - name: Test
+        run: npx vitest --retry 1 test/sam-alt.test.ts
+      - name: Test - observable mode
+        run: OBSERVABLE_MODE=true npx vitest --retry 1 test/sam-alt.test.ts
+
   test-terraform-basic:
     runs-on: ubuntu-latest
     concurrency:

.vscode/launch.json

@@ -125,6 +125,37 @@
       "type": "node",
       "cwd": "${workspaceRoot}/test/sam-basic"
     },
+    {
+      "name": "LLDebugger - SAM alt",
+      "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",
+      "args": [
+        "../../src/lldebugger.ts",
+        "--config-env=test",
+        "--sam-config-file=alt-samconfig.yaml",
+        "--sam-template-file=alt-template.yaml"
+      ],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "type": "node",
+      "cwd": "${workspaceRoot}/test/sam-alt"
+    },
+    {
+      "name": "LLDebugger - SAM alt - observable",
+      "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",
+      "args": [
+        "../../src/lldebugger.ts",
+        "--config-env=test",
+        "-o",
+        "--sam-config-file=alt-samconfig.yaml",
+        "--sam-template-file=alt-template.yaml"
+      ],
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "console": "integratedTerminal",
+      "type": "node",
+      "cwd": "${workspaceRoot}/test/sam-alt"
+    },
     {
       "name": "LLDebugger - Terraform basic",
       "program": "${workspaceRoot}/node_modules/tsx/dist/cli.mjs",

README.md

@@ -109,6 +109,8 @@ The configuration is saved to `lldebugger.config.ts`.
  -o, --observable                Observable mode
  -i --interval <interval>        Observable mode interval (default: "3000")
  --config-env <evironment>       SAM environment
+ --sam-config-file <file>        SAM configuration file
+ --sam-template-file <file>      SAM template file
  --profile <profile>             AWS profile to use
  --region <region>               AWS region to use
  --role <role>                   AWS role to use

package-lock.json

@@ -59,6 +59,8 @@
     "test-sls-esbuild-esm-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sls-esbuild-esm.test.ts",
     "test-sam-basic": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/sam-basic.test.ts",
     "test-sam-basic-observable": "npm run build && RUN_TEST_FROM_CLI=true OBSERVABLE_MODE=true vitest run test/sam-basic.test.ts",
+    "test-sam-alt": "npm run build && RUN_TEST_FROM_CLI=true vitest run test/sam-alt.test.ts",
+    "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",
     "docs:dev": "vitepress dev",
@@ -137,6 +139,7 @@
     "test/sls-basic",
     "test/sls-esbuild",
     "test/sam-basic",
+    "test/sam-alt",
     "test/terraform-basic"
   ]
 }

package.json

@@ -23,7 +23,9 @@ async function readConfig() {
   const configFromCliArgs = await getConfigFromCliArgs(supportedFrameworks);
   Configuration.setConfig(configFromCliArgs as any); // not complete config
 
-  const currentFramework = await ResourceDiscovery.getCurrentFrameworkName();
+  const currentFramework = await ResourceDiscovery.getCurrentFrameworkName(
+    configFromCliArgs as LldConfig,
+  );
 
   Logger.setVerbose(configFromCliArgs.verbose === true);
 

src/configuration.ts

@@ -48,6 +48,8 @@ export async function getConfigFromCliArgs(
     defaultObservableInterval.toString(),
   );
   program.option('--config-env <evironment>', 'SAM environment');
+  program.option('--sam-config-file <file>', 'SAM configuration file');
+  program.option('--sam-template-file <file>', 'SAM template file');
   program.option('--profile <profile>', 'AWS profile to use');
   program.option('--region <region>', 'AWS region to use');
   program.option('--role <role>', 'AWS role to use');

src/configuration/getConfigFromCliArgs.ts

@@ -121,6 +121,22 @@ export async function getConfigFromWizard({
         message: 'Would you like to enter SAM environment?',
         default: configFromCliArgs.configEnv ?? currentConfig?.configEnv,
       },
+      {
+        type: 'input',
+        name: 'samConfigFile',
+        message:
+          'Would you like to enter SAM configuration file (default = samconfig.toml)?',
+        default:
+          configFromCliArgs.samConfigFile ?? currentConfig?.samConfigFile,
+      },
+      {
+        type: 'input',
+        name: 'samTemplateFile',
+        message:
+          'Would you like to enter SAM template file (default = template.yaml)?',
+        default:
+          configFromCliArgs.samTemplateFile ?? currentConfig?.samTemplateFile,
+      },
     ]);
 
     answers = { ...answers, ...samAnswers };
@@ -150,10 +166,9 @@ export async function getConfigFromWizard({
       name: 'observable',
       message:
         'Do you want to use observable mode, which just sends events to the debugger and do not use the respose?',
-      default:
-        configFromCliArgs.observable !== undefined
-          ? configFromCliArgs.observable
-          : currentConfig?.observable,
+      default: !!(configFromCliArgs.observable !== undefined
+        ? configFromCliArgs.observable
+        : currentConfig?.observable),
     },
   ]);
 
@@ -349,7 +364,7 @@ import { type LldConfigTs } from "lambda-live-debugger";
 export default {
   // Framework to use
   framework: "${config.framework}",
-  // AWS CDK context
+  // AWS CDK framework context
   context: ${config.context ? JSON.stringify(config.context) : undefined},
   // Serverless Framework stage
   stage: "${config.stage}",
@@ -363,8 +378,12 @@ export default {
   region: "${config.region}",
   // AWS role
   role: "${config.role}",
-  // SAM environment
+  // SAM framework environment
   configEnv: "${config.configEnv}",
+  // SAM framework configuration file
+  samConfigFile: "${config.samConfigFile}",
+  // SAM framework template file
+  samTemplateFile: "${config.samTemplateFile}",
   // Observable mode
   observable: ${config.observable},
   // Observable mode interval
@@ -408,6 +427,8 @@ function getConfigFromAnswers(answers: any): LldConfigCliArgs {
     region: answers.region,
     role: answers.role,
     configEnv: answers.configEnv,
+    samConfigFile: answers.samConfigFile,
+    samTemplateFile: answers.samTemplateFile,
     observable: answers.observable,
     interval:
       answers.interval !== undefined

src/configuration/getConfigFromWizard.ts

@@ -14,7 +14,7 @@ export interface IFramework {
    * Can this class handle the current project
    * @returns
    */
-  canHandle(): Promise<boolean>;
+  canHandle(config: LldConfigBase): Promise<boolean>;
 
   /**
    * Get Lambda functions

src/frameworks/iFrameworks.ts

@@ -15,9 +15,6 @@ import { Logger } from '../logger.js';
  * Support for AWS SAM framework
  */
 export class SamFramework implements IFramework {
-  protected samConfigFile = 'samconfig.toml';
-  protected samTemplateFile = 'template.yaml';
-
   /**
    * Framework name
    */
@@ -29,28 +26,44 @@ export class SamFramework implements IFramework {
    * Can this class handle the current project
    * @returns
    */
-  public async canHandle(): Promise<boolean> {
+  public async canHandle(config: LldConfigBase): Promise<boolean> {
+    const { samConfigFile, samTemplateFile } = this.getConfigFiles(config);
+
     try {
-      await fs.access(path.resolve(this.samConfigFile), constants.F_OK);
+      await fs.access(samConfigFile, constants.F_OK);
     } catch {
       Logger.verbose(
-        `[SAM] This is not a SAM framework project. ${path.resolve(this.samConfigFile)} not found.`,
+        `[SAM] This is not a SAM framework project. ${samConfigFile} not found.`,
       );
       return false;
     }
 
     try {
-      await fs.access(path.resolve(this.samTemplateFile), constants.F_OK);
+      await fs.access(samTemplateFile, constants.F_OK);
     } catch {
       Logger.verbose(
-        `[SAM] This is not a SAM framework project. ${path.resolve(this.samTemplateFile)} not found.`,
+        `[SAM] This is not a SAM framework project. ${samTemplateFile} not found.`,
       );
       return false;
     }
 
     return true;
   }
 
+  /**
+   * Get configuration files
+   * @param config Configuration
+   * @returns Configuration files
+   */
+  private getConfigFiles(config: LldConfigBase) {
+    const samConfigFile = config.samConfigFile ?? 'samconfig.toml';
+    const samTemplateFile = config.samTemplateFile ?? 'template.yaml';
+    return {
+      samConfigFile: path.resolve(samConfigFile),
+      samTemplateFile: path.resolve(samTemplateFile),
+    };
+  }
+
   /**
    * Get Lambda functions
    * @param config Configuration
@@ -63,24 +76,28 @@ export class SamFramework implements IFramework {
       role: config.role,
     };
 
+    const { samConfigFile, samTemplateFile } = this.getConfigFiles(config);
+
     const environment = config.configEnv ?? 'default';
 
-    const samConfigContent = await fs.readFile(
-      path.resolve(this.samConfigFile),
-      'utf-8',
-    );
+    const samConfigContent = await fs.readFile(samConfigFile, 'utf-8');
+
+    let samConfig: any;
+    // is toml extension
+    if (samConfigFile.endsWith('.toml')) {
+      samConfig = toml.parse(samConfigContent);
+    } else {
+      samConfig = yaml.parse(samConfigContent);
+    }
 
-    const samConfig = toml.parse(samConfigContent);
     const stackName = samConfig[environment]?.global?.parameters?.stack_name;
 
     if (!stackName) {
-      throw new Error(
-        `Stack name not found in ${path.resolve(this.samConfigFile)}`,
-      );
+      throw new Error(`Stack name not found in ${samConfigFile}`);
     }
 
     const samTemplateContent = await fs.readFile(
-      path.resolve(this.samTemplateFile),
+      path.resolve(samTemplateFile),
       'utf-8',
     );
     const template = yaml.parse(samTemplateContent);