Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the testing workflows and documentation for Holodeck by refactoring AWS environment tests to use a DescribeTable, improving the E2E testing process with a matrix strategy, and updating various documentation files for better clarity and traceability.
- Introduced a matrix strategy in the E2E workflow to run tests based on specific labels.
- Refactored AWS environment tests to use DescribeTable for parameterized test execution and improved setup/cleanup.
- Updated documentation with new release badges, reworked links, and added a placeholder for guides.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/aws_test.go | Refactored AWS tests to use DescribeTable and improved cleanup |
| docs/quick-start.md | Updated Command Reference link to point to the correct location |
| docs/guides/README.md | Added new README placeholder for in-depth guides |
| docs/examples/README.md | Updated Command Reference link |
| docs/README.md | Added latest release badge and updated navigation links |
| README.md | Added latest release link and removed outdated sections |
| .github/workflows/e2e.yaml | Introduced a matrix strategy and updated E2E test execution steps |
tests/aws_test.go
Outdated
| // Cleanup: remove cache file and artifact dir if test passes | ||
| DeferCleanup(func() { | ||
| if !CurrentSpecReport().Failed() { | ||
| os.RemoveAll(artifactDir) |
There was a problem hiding this comment.
Consider capturing and handling the error returned by os.RemoveAll in the DeferCleanup block to ensure cleanup failures are logged or addressed.
Suggested change
| os.RemoveAll(artifactDir) | |
| if err := os.RemoveAll(artifactDir); err != nil { | |
| GinkgoWriter.Println("Failed to remove artifact directory:", err) | |
| } |
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>
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
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.
This pull request introduces several updates to enhance the E2E testing process, improve documentation, and refactor AWS environment tests. Below is a summary of the most significant changes:
E2E Testing Enhancements:
default,legacy,dra,kernel) and updated the test commands to filter by label. [1] [2] [3]Documentation Improvements:
README.mdanddocs/README.mdfiles for easier access to the latest release. [1] [2]docs/guides/README.mdfile to provide a placeholder for future in-depth guides.AWS Environment Test Refactoring:
DescribeTablefor parameterized test execution, improving maintainability and readability. [1] [2]DeferCleanupto ensure proper resource cleanup after test execution. [1] [2]