Enhance e2e debug information with artifact collection

[rafaelvzago]

This PR enhances e2e test debugging by implementing a comprehensive debug artifact collection system that automatically captures cluster state when tests fail.

Key Features

1. New DebugCollector Package (tests/e2e/util/debugcollector/)

   • Records initial cluster state to focus on test-created resources
   • Collects comprehensive debug information on test failure
   • Saves artifacts in organized directory structure under $ARTIFACTS

2. Integrated into All Test Suites

   • Ambient, Control Plane, Dual Stack, Multi-Control Plane, Multicluster, Operator tests
   • For multicluster tests, creates separate artifact collections per cluster
   • Only activates on test failure (no overhead on passing tests)

3. Configurable Collection Depth

   • Environment variable DEBUG_COLLECTOR_DEPTH supports: full, minimal, logs-only

4. Improved Console Output

   • Simplified LogDebugInfo to show summary and artifact location
   • Directs users to detailed artifacts instead of verbose console output

Why We Need It

Currently, when e2e tests fail, the console output has predefined commands that aren't always sufficient to diagnose failures. This enhancement provides comprehensive cluster state capture (similar to must-gather), organizes debug information for easier analysis, and saves artifacts for CI/CD systems.

Implementation Approach

Similar to the existing Cleaner pattern from PR #889, but focused on debug collection rather than cleanup.

Artifact Directory Structure

$ARTIFACTS/
  debug-<suite-name>-<timestamp>/
    cluster-scoped/
    namespaces/<namespace>/
      resources/
      logs/
      events.yaml
    istioctl/

Environment Variables

• ARTIFACTS: Directory where debug artifacts are saved (default: /tmp)
• DEBUG_COLLECTOR_DEPTH: Collection depth (full, minimal, logs-only)

Security

• Secrets handled safely: only names/types collected, NOT actual data
• No hardcoded credentials or sensitive information
• Uses environment variables for configuration

Testing

• All code compiles successfully with e2e build tags
• All linter checks pass
• Follows existing project patterns and code style
• Documentation updated in tests/e2e/README.md

Red Hat AI Compliance

This implementation was developed with AI code assistant support. All AI-generated code has been thoroughly reviewed, tested, and validated according to Red Hat AI guidelines. No sensitive information was used in development.

Assisted-by: AI Code Assistant

[istio-testing]

Hi @rafaelvzago. Thanks for your PR.

I'm waiting for a istio-ecosystem or istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.55%. Comparing base (fd7e684) to head (ccf9044).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1356      +/-   ##
==========================================
- Coverage   80.64%   80.55%   -0.09%     
==========================================
  Files          44       44              
  Lines        2299     2299              
==========================================
- Hits         1854     1852       -2     
- Misses        327      328       +1     
- Partials      118      119       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.