modules/CONTRIBUTING.md

Contributing

Getting started

This repo uses the Bun runtime to to run all code and tests. To install Bun, you can run this command on Linux/MacOS:

curl -fsSL https://bun.sh/install | bash

Or this command on Windows:

powershell -c "irm bun.sh/install.ps1 | iex"

Follow the instructions to ensure that Bun is available globally. Once Bun has been installed, clone this repository. From there, run this script to create a new module:

./new.sh NAME_OF_NEW_MODULE

Testing a Module

Note: It is the responsibility of the module author to implement tests for their module. The author must test the module locally before submitting a PR.

A suite of test-helpers exists to run terraform apply on modules with variables, and test script output against containers.

The testing suite must be able to run docker containers with the --network=host flag. This typically requires running the tests on Linux as this flag does not apply to Docker Desktop for MacOS and Windows. MacOS users can work around this by using something like colima or Orbstack instead of Docker Desktop.

Reference the existing *.test.ts files to get an idea for how to set up tests.

You can run all tests in a specific file with this command:

$ bun test -t '<module>'

Or run all tests by running this command:

$ bun test

You can test a module locally by updating the source as follows

module "example" {
  source = "git::https://github.com/<USERNAME>/<REPO>.git//<MODULE-NAME>?ref=<BRANCH-NAME>"
}