Skip to content

Latest commit

 

History

History
124 lines (83 loc) · 4.19 KB

CONTRIBUTING.md

File metadata and controls

124 lines (83 loc) · 4.19 KB
Raw

Contributing

Background

To learn more about the design and background of this project, as well as some of the naming standards and concepts, see the documentation under the Technical Details section. You may also want to refer to the other parts of the docs to learn about the existing features.

Getting started

To get started with contributing to this project, you first want to ensure that you can build and test the project locally.

First, ensure you have the task binary available in your PATH. To download task, click here. You'll also need docker, git, pipenv, and python3 installed locally, and have the docker daemon running. Then run task init to initialize the repository.

If you'd like to run the test suite, you will also need grype downloaded and in your PATH.

If you'd like to generate an SBOM, you will also need syft downloaded and in your PATH.

Building the images

To build all of the docker images, run:

task build

If you only want to build a specific image, you can pass in a tool and/or an environment. For example:

TOOL=terraform ENVIRONMENT=none task build

To see the list of possible tools, run the following command. If you don't specify a tool, build will assume that you want to build "all" of the tools.

pipenv run python3 -c \
  "from easy_infra import constants; \
  print(list(constants.TOOLS))"

To see the possible environments, run the following command. If you don't specify a environment, build will assume that you want to build "all" of the supported environments for the specified tool(s).

pipenv run python -c \
  "from easy_infra import constants; \
  print(list(constants.ENVIRONMENTS) + ['none'])"

If you'd like to see what would have been done, and which images would have been built, you can use --dry-run, for example:

pri build --environment=azure --dry-run

Building in trace mode

If you'd like to build the container locally and allow detailed tracing, run the following:

TRACE=true task build

This will add additional troubleshooting tools to the container, and perform some tracing, putting the details in /tmp/.

Running the tests

If you are attempting to run the tests, consider running the following to ensure that the user from inside the container can write to the host:

find tests -mindepth 1 -type d -exec chmod o+w {} \;

You can now run the tests:

task test

If you are troubleshooting a specific image, you can pass a cli arg of the tag, i.e. 2023.11.01-ansible which runs the specified image tag and mounts common files that change during troubleshooting, as well as an unfiltered rendering of functions.j2, at test time. This assumes that the related image tag has already been built and is available to the docker daemon (either by pulling it from docker hub, or locally).

task test -- 2023.11.01-ansible-d7b1663

You can also pass in any combination of a specific tool, environment, and/or user.

TOOL=ansible ENVIRONMENT=none USER=easy_infra task test

See the build documentation to see the tool and environment possible inputs. To see the list of supported users, run the following command. If you don't specify a user, test will assume that you want to test with all of the supported users. Note that if you don't specify a user but see a "X is not a supported user, exiting..." error, it is because the $USER variable in your shell is being implicitly passed into task.

pipenv run python3 -c \
  "from easy_infra import constants; \
  print(constants.USERS)"

Generating the SBOMs

If you'd like to generate an SBOM, run the following:

task sbom

You will now see various sbom.*.json files in your current directory, and you can pass in the same --tool and --environment arguments as building.

Running vulnerability scans

If you'd like to run the vulnerability scans, run the following:

task vulnscan

You will now see various vulns.*.json files in your current directory, and you can pass in the same --tool and --environment arguments as outlined in the build instructions above.