Component testing guide #733
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
milldr
reviewed
Mar 11, 2025
milldr
reviewed
Mar 11, 2025
Co-authored-by: Dan Miller <miller0daniel@gmail.com> Co-authored-by: RoseSecurity <72598486+RoseSecurity@users.noreply.github.com>
milldr
previously approved these changes
Mar 18, 2025
Co-authored-by: RoseSecurity <72598486+RoseSecurity@users.noreply.github.com>
milldr
approved these changes
Mar 18, 2025
osterman
reviewed
Mar 18, 2025
Member
There was a problem hiding this comment.
When I see a component named like step-1 and then step-2, it seems like we are advocating a naming convention. Is this the naming convention we use?
Member
Author
There was a problem hiding this comment.
no. this is files that reference examples for specific step number in Write test section
| @@ -0,0 +1,812 @@ | |||
| --- | |||
| title: Components Testing | |||
Member
There was a problem hiding this comment.
Suggested change
| title: Components Testing | |
| title: Component Testing |
| @@ -0,0 +1,812 @@ | |||
| --- | |||
| title: Components Testing | |||
| sidebar_label: Components Testing | |||
Member
There was a problem hiding this comment.
Suggested change
| sidebar_label: Components Testing | |
| sidebar_label: Component Testing |
| --- | ||
| title: Components Testing | ||
| sidebar_label: Components Testing | ||
| description: 'Our components testing strategy and resources' |
Member
There was a problem hiding this comment.
Suggested change
| description: 'Our components testing strategy and resources' | |
| description: 'Our guide for implementing automated component testing with Terratest' |
| </Step> | ||
|
|
||
| <Step> | ||
| ### <StepNumber/> Install Go Lang |
Member
There was a problem hiding this comment.
Suggested change
| ### <StepNumber/> Install Go Lang | |
| ### <StepNumber/> Install Golang |
| Build a Geodesic infrastructure container. This container that has all the tools like terraform and atmos for building infrastructure. It's built from the `Dockerfile` and there are some predefined targets defined in the `Makefile` to make this easy. Customize these for your organization. Here are examples of both for reference. | ||
|
|
||
| <CollapsibleText type="medium"> | ||
| <CodeBlock title="Dockerfile">{PartialDockerfile}</CodeBlock> |
| Import the dependent component for `default-test` stack | ||
| <CodeBlock language="yaml" title="test/fixtures/stacks/orgs/default/test/tests.yaml">{Step3Stack}</CodeBlock> | ||
|
|
||
| Add the dependent component to test suite with go code |
Member
There was a problem hiding this comment.
Suggested change
| Add the dependent component to test suite with go code | |
| Add the dependent component to test suite with Go code |
|
|
||
| Add the dependent component to test suite with go code | ||
| By default, the test suite will add a unique random value to the `attributes` terraform variable. | ||
| This is to avoid resoureces naming collision with other tests that are using the same component. |
Member
There was a problem hiding this comment.
Suggested change
| This is to avoid resoureces naming collision with other tests that are using the same component. | |
| This is to avoid resource naming collisions with other tests that are using the same component. |
| By default, the test suite will add a unique random value to the `attributes` terraform variable. | ||
| This is to avoid resoureces naming collision with other tests that are using the same component. | ||
| But in some cases, you may need to pass unique value to specific input for the component. | ||
| Check advanced example of the most common use case - dns delegated domain name. |
Member
There was a problem hiding this comment.
Suggested change
| Check advanced example of the most common use case - dns delegated domain name. | |
| Check out the advanced example for the most common use-case with the `dns-delegated` domain name. |
|
|
||
| Component testing framework assumes that each component's repo structure follows the convention when all component terraform source code | ||
| would be stored in `src` directory and everything related to tests will be placed in `test` directory. | ||
| Tests consists of two coupled parts - atmos configuration fixtures and tests written on go code. |
Member
There was a problem hiding this comment.
Suggested change
| Tests consists of two coupled parts - atmos configuration fixtures and tests written on go code. | |
| Tests consists of two coupled parts - atmos configuration fixtures and tests written on Go code. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
what
why