Add profile property to bundle with different profiles. (#49)

Signed-off-by: David Calavera <[email protected]>

Author: calavera

API.md

@@ -85,11 +85,26 @@ new RustFunction(this, 'Rust function', {
 });
 ```
 
+### Cargo Build profiles
+
+Use the `profile` option if you want to build with a different Cargo profile that's not `release`:
+
+```ts
+import { RustFunction } from 'cargo-lambda-cdk';
+
+new RustFunction(this, 'Rust function', {
+  manifestPath: 'path/to/package/directory/with/Cargo.toml',
+  bundling: {
+    profile: 'dev'
+  },
+});
+```
+
 ### Cargo Lambda Build flags
 
 Use the `cargoLambdaFlags` option to add additional flags to the `cargo lambda build` command that's executed to bundle your function. You don't need to use this flag to set options like the target architecture or the binary to compile, since the construct infers those from other props.
 
-If these flags include a `--target` flag, it will override the `architecture` option. If these flags include a `--release` or `--debug` flag, it will override the CDK's debug option.
+If these flags include a `--target` flag, it will override the `architecture` option. If these flags include a `--release` or `--profile` flag, it will override the release or any other profile specified.
 
 ```ts
 import { RustFunction } from 'cargo-lambda-cdk';

README.md

@@ -43,6 +43,7 @@ interface CommandOptions {
   readonly architecture?: Architecture;
   readonly lambdaExtension?: boolean;
   readonly cargoLambdaFlags: string[];
+  readonly profile: string;
   readonly manifest: Manifest;
 }
 
@@ -99,12 +100,14 @@ export class Bundling implements cdk.BundlingOptions {
     const manifest = getManifest(props.manifestPath);
 
     const cargoLambdaFlags = props.cargoLambdaFlags ?? [];
+    const profile = props.profile ?? 'release';
 
     const osPlatform = platform();
     const bundlingCommand = this.createBundlingCommand({
       osPlatform,
       manifest,
       cargoLambdaFlags,
+      profile,
       outputDir: cdk.AssetStaging.BUNDLING_OUTPUT_DIR,
       inputDir: cdk.AssetStaging.BUNDLING_INPUT_DIR,
       binaryName: props.binaryName,
@@ -123,6 +126,7 @@ export class Bundling implements cdk.BundlingOptions {
           manifest,
           outputDir,
           cargoLambdaFlags,
+          profile,
           inputDir: projectRoot,
           binaryName: props.binaryName,
           architecture: props.architecture,
@@ -170,9 +174,14 @@ export class Bundling implements cdk.BundlingOptions {
       props.outputDir,
     ];
 
-    if (!props.cargoLambdaFlags.includes('--release') &&
-      !props.cargoLambdaFlags.includes('--debug')) {
-      buildBinary.push('--release');
+    if (!props.cargoLambdaFlags.includes('--profile')
+      && !props.cargoLambdaFlags.includes('--release')) {
+      if (props.profile === 'release') {
+        buildBinary.push('--release');
+      } else {
+        buildBinary.push('--profile');
+        buildBinary.push(props.profile);
+      }
     }
 
     if (props.lambdaExtension) {

src/bundling.ts

@@ -180,6 +180,13 @@ export interface BundlingOptions {
    * Additional list of flags to pass to `cargo lambda build`.
    */
   readonly cargoLambdaFlags?: string[];
+
+  /**
+   * Specify the Cargo Build profile to use.
+   *
+   * @default - `release`
+   */
+  readonly profile?: string;
 }
 
 /**

src/types.ts

@@ -145,4 +145,63 @@ describe('bundlingOptionsOverrideDefaults', () => {
 
     expect((bundlingOptions as any).options.bundling.command).toContain(command);
   });
+
+  describe('Add Cargo Lambda Build with release flag', () => {
+    const bundlingOptions = Bundling.bundle({
+      manifestPath: getTestManifestPath(),
+      forcedDockerBundling: true,
+      cargoLambdaFlags: ['--release'],
+    });
+
+    const command = 'cargo lambda build --lambda-dir /asset-output --flatten simple-package --release';
+
+    expect((bundlingOptions as any).options.bundling.command).toContain(command);
+  });
+
+  describe('Add Cargo Lambda Build with profile flag', () => {
+    const bundlingOptions = Bundling.bundle({
+      manifestPath: getTestManifestPath(),
+      forcedDockerBundling: true,
+      cargoLambdaFlags: ['--profile', 'dev'],
+    });
+
+    const command = 'cargo lambda build --lambda-dir /asset-output --flatten simple-package --profile dev';
+
+    expect((bundlingOptions as any).options.bundling.command).toContain(command);
+  });
+
+  describe('Add Cargo Lambda Build without profile info', () => {
+    const bundlingOptions = Bundling.bundle({
+      manifestPath: getTestManifestPath(),
+      forcedDockerBundling: true,
+    });
+
+    const command = 'cargo lambda build --lambda-dir /asset-output --release --flatten simple-package';
+
+    expect((bundlingOptions as any).options.bundling.command).toContain(command);
+  });
+
+  describe('Add Cargo Lambda Build with profile info', () => {
+    const bundlingOptions = Bundling.bundle({
+      manifestPath: getTestManifestPath(),
+      forcedDockerBundling: true,
+      profile: 'test',
+    });
+
+    const command = 'cargo lambda build --lambda-dir /asset-output --profile test --flatten simple-package';
+
+    expect((bundlingOptions as any).options.bundling.command).toContain(command);
+  });
+
+  describe('Add Cargo Lambda Build with release profile info', () => {
+    const bundlingOptions = Bundling.bundle({
+      manifestPath: getTestManifestPath(),
+      forcedDockerBundling: true,
+      profile: 'release',
+    });
+
+    const command = 'cargo lambda build --lambda-dir /asset-output --release --flatten simple-package';
+
+    expect((bundlingOptions as any).options.bundling.command).toContain(command);
+  });
 });