Skip to content

Conversation

@ArangoGutierrez
Copy link
Collaborator

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:

  • Introduced a matrix strategy in the E2E workflow to run tests for multiple labels (default, legacy, dra, kernel) and updated the test commands to filter by label. [1] [2] [3]
  • Updated the Ginkgo logs to include the label in the artifact name for better traceability.

Documentation Improvements:

  • Added a "Latest Release" badge and link to the README.md and docs/README.md files for easier access to the latest release. [1] [2]
  • Removed outdated sections (e.g., "Supported Cuda-Drivers") and improved cross-linking in documentation files for consistency. [1] [2] [3]
  • Introduced a new docs/guides/README.md file to provide a placeholder for future in-depth guides.

AWS Environment Test Refactoring:

  • Migrated AWS environment tests to use DescribeTable for parameterized test execution, improving maintainability and readability. [1] [2]
  • Added support for unique artifact directories and cache files for each test run to avoid conflicts and improve isolation.
  • Simplified test cleanup logic by leveraging DeferCleanup to ensure proper resource cleanup after test execution. [1] [2]

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

// Cleanup: remove cache file and artifact dir if test passes
DeferCleanup(func() {
if !CurrentSpecReport().Failed() {
os.RemoveAll(artifactDir)
Copy link

Copilot AI May 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
}

Copilot uses AI. Check for mistakes.
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
Signed-off-by: Carlos Eduardo Arango Gutierrez <[email protected]>
@ArangoGutierrez ArangoGutierrez merged commit b286058 into NVIDIA:main May 31, 2025
30 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant