Skip to main content

Fix the problem with CDK's integ-runner breaking the python path and current working directory.

Project description

CDK integ-runner CWD Fix

When running integ-test on python, the CWD is set to the directory which contains your test file - not the directory which contains your cdk.json.

It also blows away the PYTHONPATH, so that no longer has your cdk project.

This means that your test file has no access to the stacks you create, and you get a lot of ModuleNotFoundError when you try to import your stacks into the test case.

It also breaks the lambda (and likely other) builds which rely on a path. So, If you're using Code.from_asset("./lambda") you should start using Code.from_asset(f"{os.getcwd()}/lambda") instead, after using this fix.

This is likely to be applicable to other constructs that rely on a relative path.

This is a workaround to fix the CWD and PYTHONPATH so that your test file can import your stacks and run the integ tests.

Usage

Installation

pip install cdk-integ-runner-cwd-fix

In your code

Then, in your test file, add the following lines:

from cdk_integ_runner_cwd_fix import fix_cwd

fix_cwd()

# You can now import your stack
from my_cdk_project.my_stack import MyStack

# And write your test code here
app = cdk.App()
stack = MyStack(app, "TestStack")

app.synth()

Running tests

You'll need to set the project path in the environment variable CDK_INTEG_RUNNER_CWD:

The below will set it to your current directory - which is likely to be what you need:

export CDK_INTEG_RUNNER_CWD=$(pwd)

or to be explicit, or to set it to something other than the path you're currently in:

export CDK_INTEG_RUNNER_CWD=/path/to/your/cdk/project

Then, run your tests as usual:

integ-runner

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk_integ_runner_cwd_fix-0.1.1.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

cdk_integ_runner_cwd_fix-0.1.1-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page