Add component tests #17
Conversation
WalkthroughThis pull request updates Terraform and test configuration files. The Terraform changes streamline the handling of the Kubernetes provider’s execution role by removing an intermediate variable and updating a module version. Multiple YAML configuration files have been added for CLI settings, EKS, VPC, account mapping, and vendor management. A new test suite for the metrics-server component has been introduced, along with a Go module for testing, and an obsolete test script has been removed. Changes
Sequence Diagram(s)sequenceDiagram
participant TR as Test Runner
participant CS as ComponentSuite
participant KS as Kubernetes Cluster
TR->>CS: Invoke TestRunSuite()
CS->>CS: SetupSuite() initializes configuration
CS->>CS: Execute TestBasic()
CS->>KS: Deploy metrics-server component
KS-->>CS: Return deployment metadata
CS->>CS: Assert deployment properties and drift
CS->>CS: Execute TestEnabledFlag() for flag verification
TR->>CS: Complete test execution
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Require terratestWonderful, this rule succeeded.This rule require terratest status
|
|
/terratest |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
src/remote-state.tf (1)
2-3: Module Version UpdateThe "eks" module version has been updated to "1.8.0". Please ensure that all configurations interacting with this module have been reviewed for compatibility with any new changes or behavior introduced in the updated version.
test/fixtures/stacks/catalog/vpc.yaml (1)
1-20: VPC Configuration CheckThe YAML configuration for the VPC component is well-structured with clear metadata and variable definitions. Please verify that the availability zones ("b" and "c") and other variable values (like
max_nats,nat_gateway_enabled, etc.) are intentional and reflect your target environment's requirements.test/fixtures/stacks/catalog/usecase/disabled.yaml (1)
1-11: YAML Configuration for Disabled Metrics-Server Component Looks CorrectThe file clearly sets the component’s state parameters to
false(both forenabledandkube_exec_auth_role_arn_enabled), ensuring that no resources will be created when the metrics server is disabled. Verify that these settings match the intended behavior for your disabled test case.test/fixtures/vendor.yaml (1)
1-43: Vendor Manifest Configuration is Well-StructuredThe vendor configuration defines an
AtmosVendorConfigwith multiple sources for different components. The use of inline version numbers, repository paths, and inclusion/exclusion patterns appears consistent. Please ensure that the version numbers and source references are kept up-to-date with upstream changes.test/fixtures/stacks/orgs/default/test/_defaults.yaml (1)
1-67: Terraform Backend and Variables Definition ReviewedThis file establishes a local backend and a set of Terraform variables along with component configurations for the account map. The dynamic path construction using
getenvis appropriate for test environments. Confirm that the environment variables likeCOMPONENT_HELPER_STATE_DIRandTEST_ACCOUNT_IDare correctly set when running tests.src/provider-helm.tf (1)
136-138: Streamlined Exec Role Assignment with Inline CoalesceThe update directly applies the
coalescefunction in theexec_roleassignment, eliminating the need for an intermediate local variable. This simplifies the code while preserving the fallback logic betweenvar.kube_exec_auth_role_arnandmodule.iam_roles.terraform_role_arn. Please verify thatmodule.iam_roles.terraform_role_arnis consistently available when needed.test/fixtures/stacks/catalog/account-map.yaml (1)
1-47: Account-Map Configuration for Static Remote State Looks SolidThe file defines the account-map component with appropriate metadata and variables, and it uses a static remote state backend tailored for testing purposes. The commented section providing an alternative S3 backend configuration serves as a useful reminder for potential future enhancements. Ensure that dynamic elements (such as references to
TEST_ACCOUNT_ID) are properly supplied in the testing environment.test/fixtures/stacks/catalog/eks-cluster.yaml (1)
1-94: EKS cluster configuration looks well-structured and comprehensive.The configuration provides a solid foundation for EKS cluster testing with appropriate settings for node groups, addons, and cluster parameters. The node group configuration with t3.small instances and proper sizing (min: 2, max: 3) is suitable for testing purposes.
Add a newline at the end of the file to resolve the YAMLlint warning:
aws-efs-csi-driver: addon_version: "v2.0.8-eksbuild.1" +🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 94-94: no new line character at the end of file
(new-line-at-end-of-file)
test/component_test.go (1)
57-57: Fix typo in variable name.There's a typo in the variable name
clusrerIdwhich should beclusterId.- clusrerId := atmos.Output(s.T(), clusterOptions, "eks_cluster_id") + clusterId := atmos.Output(s.T(), clusterOptions, "eks_cluster_id")And update the variable usage:
- cluster := awsHelper.GetEksCluster(s.T(), context.Background(), awsRegion, clusrerId) + cluster := awsHelper.GetEksCluster(s.T(), context.Background(), awsRegion, clusterId)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
test/go.sumis excluded by!**/*.sum
📒 Files selected for processing (15)
src/provider-helm.tf(1 hunks)src/remote-state.tf(1 hunks)test/.gitignore(1 hunks)test/component_test.go(1 hunks)test/fixtures/atmos.yaml(1 hunks)test/fixtures/stacks/catalog/account-map.yaml(1 hunks)test/fixtures/stacks/catalog/eks-cluster.yaml(1 hunks)test/fixtures/stacks/catalog/usecase/basic.yaml(1 hunks)test/fixtures/stacks/catalog/usecase/disabled.yaml(1 hunks)test/fixtures/stacks/catalog/vpc.yaml(1 hunks)test/fixtures/stacks/orgs/default/test/_defaults.yaml(1 hunks)test/fixtures/stacks/orgs/default/test/tests.yaml(1 hunks)test/fixtures/vendor.yaml(1 hunks)test/go.mod(1 hunks)test/run.sh(0 hunks)
💤 Files with no reviewable changes (1)
- test/run.sh
🧰 Additional context used
🪛 YAMLlint (1.35.1)
test/fixtures/stacks/catalog/eks-cluster.yaml
[error] 94-94: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Mergify Merge Protections
- GitHub Check: Mergify Merge Protections
- GitHub Check: Summary
🔇 Additional comments (9)
test/.gitignore (1)
1-5: Test Artifacts Exclusion ConfirmedThe new
.gitignorein the test directory appropriately excludes temporary files and directories (such asstate/,.cache,test/test-suite.json,.atmos, andtest_suite.yaml), which will help keep your test outputs and temporary artifacts from polluting version control.test/fixtures/stacks/orgs/default/test/tests.yaml (1)
1-7: Test Imports Setup ReviewThis file establishes the import structure for your test environments by listing essential configurations (defaults, VPC, EKS cluster, and the two metrics-server use cases). Confirm that all referenced import paths are correctly configured and that they exist in the expected directories.
test/fixtures/stacks/catalog/usecase/basic.yaml (1)
1-11: Basic Metrics Server Configuration VerificationThe configuration for the basic metrics server use case is clearly defined, setting key variables such as
enabled,kube_exec_auth_role_arn_enabled,name, andkubernetes_namespace. Ensure these settings match the intended deployment and testing requirements for the metrics-server component.test/go.mod (2)
3-5:❓ Verification inconclusive
Verify the Go version compatibility.
The specified Go version (1.23.4) and toolchain (1.23.7) appear to be future versions that may not be widely available yet. Ensure that this is intentional and compatible with your CI/CD environment.
🌐 Web query:
What is the latest stable version of Go as of March 2025?💡 Result:
The latest stable version of Go as of March 2025 is Go 1.24.1, released on March 4, 2025[1][4][7][9][14]. This minor update includes security fixes to the
net/httpandcrypto/ellipticpackages, along with bug fixes in the compiler, runtime, and standard library components likereflectandsyscall[7][9].Key details about Go's versioning:
- Major releases occur every six months, with each supported until two subsequent releases arrive[1][4].
- The current support status as of March 2025:
- Go 1.24 (latest): Actively supported
- Go 1.23: Still supported
- Go 1.22 and earlier: Unsupported[1][7]
Notable features in Go 1.24 include full support for generic type aliases, improved FIPS 140-3 compliance mechanisms, and enhanced WebAssembly tooling[13][14]. Developers are encouraged to update using official distribution channels listed on go.dev/dl[15].
Citations:
- 1: https://endoflife.date/go
- 2: http://xahlee.info/golang/golang_version_dates.html
- 3: https://developer.android.com/about/versions/16/release-notes
- 4: https://en.wikipedia.org/wiki/Go_(programming_language)
- 5: https://www.bytesizego.com/blog/go-language-history
- 6: https://blog.jetbrains.com/go/2025/01/16/the-goland-2025-1-early-access-program-has-started/
- 7: https://go.dev/doc/devel/release
- 8: https://antonz.org/which-go/
- 9: https://www.gitclear.com/open_repos/golang/go/releases
- 10: https://ssojet.com/blog/unlocking-the-future-of-golang-trends-predictions-and-business-impact-in-2025/
- 11: https://tip.golang.org/doc/go1.23
- 12: https://www.jetbrains.com/go/download/other.html
- 13: https://tip.golang.org/doc/go1.24
- 14: https://www.yellowduck.be/posts/go-1-24-is-released-the-go-programming-language
- 15: https://go.dev/dl/
- 16: https://dev.to/empiree/why-you-should-learn-go-in-2025-308l/comments
Go Version Compatibility Check
The
test/go.modfile currently specifies:
go 1.23.4toolchain go1.23.7Based on the available information as of March 2025:
- Go 1.23 is still supported alongside the latest stable release (Go 1.24.1).
- The versions in the file are not "future" releases but part of an actively supported release branch.
Please verify that using these specific Go 1.23 versions is intentional for your project and compatible with your CI/CD environment. If your intent is to run on the most current release, you might consider upgrading to Go 1.24.1.
17-17:❓ Verification inconclusive
Clarify the intention of the commented-out replace directive.
The replace directive is currently commented out. If this replacement is needed for the tests to function correctly, it should be uncommented.
🏁 Script executed:
#!/bin/bash # Check if the aws-nuke library is being used in the test code rg "github.com/rebuy-de/aws-nuke/v2/mocks|github.com/ekristen/aws-nuke/v3" -t go .Length of output: 84
Attention: Please clarify whether the commented-out replace directive at line 17 in
test/go.modis still required for the tests to function correctly.
- The directive (
// replace github.com/rebuy-de/aws-nuke/v2/mocks => github.com/ekristen/aws-nuke/v3/ v3.29.0) remains disabled.- A search for references to these libraries in the Go code did not return any results. If the directive is necessary for the tests, it should be uncommented with a brief explanation of its intended effect.
- If it’s not needed, consider removing the commented-out line to avoid confusion.
test/fixtures/atmos.yaml (1)
1-78: Well-structured Atmos CLI configuration with comprehensive documentation.The configuration file includes clear documentation for all settings, properly defines paths for components, stacks, and workflows, and includes appropriate settings for Terraform, logging, and templates.
test/component_test.go (3)
23-79: Comprehensive test for metrics-server deployment.The test properly validates:
- Successful component deployment
- Correct metadata (version, chart name, namespace)
- API service registration in the cluster
- Configuration drift detection
This provides good coverage of the component's functionality and integration with EKS.
81-85: Simple but effective test for the 'enabled' flag.The test verifies that when the component is disabled, no resources are created. This is an important test case for component configuration.
93-98: Well-structured test setup with dependencies.The test correctly adds dependencies for VPC and EKS cluster before running the metrics-server tests, ensuring the proper order of resource creation.
|
/terratest |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
test/go.mod (2)
1-6: Module Declaration and Go Version Specification
The module declaration (module test), Go version (go 1.23.4), and toolchain (go1.23.7) are clearly specified. Consider if the module name "test" is sufficiently descriptive for the component tests; if this module is solely for testing the AWS EKS Metrics Server, a more descriptive name (e.g.,eks-metrics-server-test) could improve clarity.
21-182: Comprehensive Indirect Dependencies Block
This extensive block lists numerous indirect dependencies needed by your test module. While these entries are typically auto-managed (especially viago mod tidy), consider periodically tidying the module to remove any unused dependencies. Additionally, consolidating multiplerequireblocks (if possible) could improve readability and maintainability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
test/go.sumis excluded by!**/*.sum
📒 Files selected for processing (1)
test/go.mod(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Mergify Merge Protections
- GitHub Check: Mergify Merge Protections
- GitHub Check: Summary
🔇 Additional comments (2)
test/go.mod (2)
7-15: Primary Dependency Block for Core Test Libraries
This block lists essential dependencies for your test suite (such asgithub.com/cloudposse/test-helpers,terratest, andtestify) with explicit version pinning. This ensures consistency for component tests. Ensure these versions remain compatible with other parts of your codebase as updates occur.
19-20: Kubernetes Apimachinery Dependency
The explicit require fork8s.io/apimachinery v0.32.3is clear. Verify that this version harmonizes with the rest of your Kubernetes-related dependencies in the module.
|
/terratest |
|
These changes were released in v1.535.1. |
What
basiccomponent testdisabledcomponent testWhy
enabled: falsesetReferences
Summary by CodeRabbit
New Features
Bug Fixes
Tests
Chores