Feat/compose

[vearne]

Summary by CodeRabbit

Release Notes

• New Features

  • Multi-format test report generation (HTML, JSON, CSV, JUnit)
  • Slack notifications integration for test results
  • Multi-environment support (dev/staging/prod) with environment-specific configuration
  • Automatic retry mechanism for failed HTTP and gRPC requests
  • Concurrency control and rate limiting

• Documentation

  • Expanded README with core and enterprise feature sections
  • Added comprehensive enterprise configuration examples
  • Updated cache guide with gRPC descriptor caching focus

• Bug Fixes

  • Fixed test case execution dependency ordering

• Chores

  • Simplified caching system; optimized default cache size

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation expanded with enterprise features including multi-format reporting, Slack notifications, and environment management. Code refactored to introduce unified test result handling, rate limiting, retry mechanisms, and consolidated caching (gRPC descriptors only). Configuration updated to reflect simplified logging and new service initialization.

Changes

Cohort / File(s)	Change Summary
Documentation & Config Examples README.md, README_zh.md, doc/cache_guide.md, doc/usage.md	Expanded documentation with Core/Enterprise features, multi-format reporting (HTML, JSON, CSV, JUnit), Slack integration, environment management, and enterprise configuration examples. Cache guide refocused on gRPC descriptors with default enablement.
Configuration Files config_files/autotest.yml, config_files/autotest_enhanced.yml, config_files/my_grpc_api.yml	Added environment blocks (dev/staging/prod); commented out http_rule_files; adjusted cache max_size (1000→100); removed logger rotation; fixed test step dependencies; added report/notification configs.
Test Result Unification internal/command/command.go, internal/command/http_automate.go, internal/command/grpc_automate.go	Introduced UnifiedTestResults struct and CombineResults function; updated HttpAutomateTest and GrpcAutomateTest to return aggregated results; added timing instrumentation and unified reporting/notification flow.
Request Execution with Resilience internal/command/http_call.go, internal/command/grpc_call.go	Wrapped HTTP and gRPC invocations with rate limiting and retry mechanisms via RateLimiter.ExecuteWithLimit and util.ExecuteWithRetry; removed legacy cache path in gRPC.
Service Initialization & Resource Management internal/resource/resource.go	Added global vars for RetryClient, RateLimiter, EnvironmentManager, ReportGenerator, NotificationService with corresponding init functions; removed ParseEnvFile and ReadLines helpers.
Cache Simplification internal/util/cache.go, internal/util/cache_usage_example.go	Consolidated to gRPC descriptor cache only (removed HttpResponseCache, TemplateCache, LuaScriptCache); adjusted default maxSize to 100; introduced dynamic enablement policy; deleted entire cache_usage_example.go file.
Retry Utilities internal/util/retry.go	Introduced ExecuteHttpWithRetry and ExecuteGrpcWithRetry functions with configurable attempts, delays, and retryable status/error codes; added gRPC error classification logic.
Supporting Changes internal/util/environment.go, internal/config/config.go, main.go	Added GetAllVars() accessor to EnvironmentManager; removed Rotation struct from Logger config; updated CLI flags (removed env-file, refined environment flag usage).

Sequence Diagram

sequenceDiagram
    participant CLI as CLI/main.go
    participant Cmd as RunTestCases
    participant Env as EnvironmentManager
    participant HTTP as HttpAutomateTest
    participant GRPC as GrpcAutomateTest
    participant Combine as CombineResults
    participant Report as ReportGenerator
    participant Notify as NotificationService

    CLI->>Cmd: Run with environment flag
    Cmd->>Env: LoadEnvironment(envName)
    Env-->>Cmd: Environment vars loaded
    
    rect rgb(200, 220, 255)
        Note over Cmd: Test Execution Phase
        par HTTP Tests
            Cmd->>HTTP: Execute HTTP test cases
            HTTP-->>HTTP: [Rate limit + Retry wrapper]
            HTTP-->>Cmd: Returns UnifiedTestResults (HTTP)
        and GRPC Tests
            Cmd->>GRPC: Execute gRPC test cases
            GRPC-->>GRPC: [Rate limit + Retry wrapper]
            GRPC-->>Cmd: Returns UnifiedTestResults (gRPC)
        end
    end
    
    rect rgb(220, 255, 220)
        Note over Cmd: Result Aggregation & Reporting Phase
        Cmd->>Combine: CombineResults(httpResults, grpcResults)
        Combine-->>Cmd: Unified UnifiedTestResults
        Cmd->>Report: Generate multi-format reports
        Report-->>Report: HTML, JSON, CSV, JUnit
        Cmd->>Notify: Send notifications
        Notify-->>Notify: Slack webhook dispatch
    end
    
    Cmd-->>CLI: Test execution complete with reports

Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Areas requiring extra attention:

• Request execution layer changes (internal/command/http_call.go, internal/command/grpc_call.go): Rate limiting and retry logic are now central to request execution; verify retry/backoff semantics, context propagation, and integration with existing error handling.
• Service initialization and lifecycle (internal/resource/resource.go): Multiple new global services (RetryClient, RateLimiter, EnvironmentManager, ReportGenerator, NotificationService) must be initialized in correct order and properly cleaned up; verify nil checks and initialization dependencies.
• Result aggregation and unified reporting (internal/command/command.go): New UnifiedTestResults struct and CombineResults function merge HTTP and gRPC results; confirm field accumulation logic, FailedCases concatenation, and compatibility with existing report/notification paths.
• Cache refactoring (internal/util/cache.go, cache_usage_example.go): Removal of HTTP response, template, and Lua script caches is substantial; verify no remaining code paths attempt to use deleted cache types and confirm gRPC descriptor cache provides sufficient coverage.
• Configuration structure changes (internal/config/config.go): Removal of Rotation struct from Logger may affect YAML unmarshaling; verify no lingering references in code or existing configs that depend on rotation behavior.

Possibly related PRs

• optimize #27: Adds/modifies ReportGenerator, NotificationService, RateLimiter, RetryClient, and EnvironmentManager initialization alongside cache logic changes—directly overlaps in scope and implementation.
• Feat/request #26: Modifies internal/command/http_call.go and internal/command/grpc_call.go for request execution flow; affects same request call paths being enhanced with retry/rate-limiting in this PR.

Poem

🐰 A rabbit hopped through retry loops and caches bright,
Unifying results with gRPC and HTTP in sight,
Rate limiters now guard each request with care,
Multi-format reports float through the air,
Slack notifications sing—the testing's quite rare! 🐇✨

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/compose

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1127e17 and 7a408f7.

📒 Files selected for processing (19)

• README.md (3 hunks)
• README_zh.md (3 hunks)
• config_files/autotest.yml (1 hunks)
• config_files/autotest_enhanced.yml (1 hunks)
• config_files/my_grpc_api.yml (2 hunks)
• doc/cache_guide.md (6 hunks)
• doc/usage.md (8 hunks)
• internal/command/command.go (4 hunks)
• internal/command/grpc_automate.go (3 hunks)
• internal/command/grpc_call.go (5 hunks)
• internal/command/http_automate.go (3 hunks)
• internal/command/http_call.go (2 hunks)
• internal/config/config.go (0 hunks)
• internal/resource/resource.go (3 hunks)
• internal/util/cache.go (5 hunks)
• internal/util/cache_usage_example.go (0 hunks)
• internal/util/environment.go (1 hunks)
• internal/util/retry.go (2 hunks)
• main.go (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}