aws/aws-cdk

(docs): nodejs-function, document how to disable bundling for tests

Open

#12844 opened on Feb 3, 2021

View on GitHub
 (6 comments) (7 reactions) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
@aws-cdk/pipelinesdocs/inlineeffort/smallfeature-requestgood first issuep2

Description

Create an option to disable, (or automatically disable?) asset build/bundling, when using Jest to instantiate a cdk-pipeline for tests

Use Case

When using a pipeline instance in jest it causes the assets to build/bundle, it may be the intention of the test to check only that the pipeline is correctly formed, build/bundle testing may be handled else where. In this case the build/bundle process creates additional time delay on testing in synth stage of the pipeline.

Proposed Solution

Create an option to disable, (or automatically disable?) asset build/bundling, when using Jest to instantiate a cdk-pipeline for tests

Other

  • :wave: I may be able to implement this feature request
  • :warning: This feature might incur a breaking change

This is a :rocket: Feature Request

Contributor guide

Tech stack
typescriptnodejs
Domain
documentationcloud
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AWS CDK basicsJest testing experienceUnderstanding of asset bundling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the current implementation of asset bundling in the CDK pipeline library, specifically in the NodejsFunction construct. Look for existing options to disable bundling or skip asset building. Review related pull requests or comments in the issue for maintainer feedback on whether they prefer a new option or automatic detection. Examine the test files for CDK pipeline to understand how tests are currently run.