Skip to content

chore: restructure testing folder#861

Merged
hwbrzzl merged 1 commit intomasterfrom
bowen/optimize-testing
Feb 7, 2025
Merged

chore: restructure testing folder#861
hwbrzzl merged 1 commit intomasterfrom
bowen/optimize-testing

Conversation

@hwbrzzl
Copy link
Contributor

@hwbrzzl hwbrzzl commented Feb 7, 2025

📑 Description

There is no logic modification in this PR, just restructure testing folder.

Summary by CodeRabbit

  • New Features

    • Enhanced Docker integration with dedicated database driver support for container management, migration, and seeding.
    • Introduced new HTTP Request and Response interfaces providing richer assertion and testing capabilities.
  • Refactor

    • Migrated legacy testing and mock implementations to specialized Docker and HTTP packages.
    • Updated method signatures and type references for improved consistency and clarity across the framework.

@hwbrzzl hwbrzzl requested a review from a team as a code owner February 7, 2025 10:51
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request refactors several parts of the framework by transitioning from the “testing” package to the “docker” (and “http”) package for database and HTTP related types. Method signatures, return types, and import statements are updated accordingly across core contracts, mocks, support, and testing files. New interfaces for Database, Request, and Response are introduced while obsolete TestRequest/TestResponse mocks are removed. Support files for container, redis, and utilities are also modified to align with the new docker-based types, streamlining the overall integration of Docker in database and HTTP testing.

Changes

File(s) Change Summary
contracts/database/driver/driver.go
mocks/database/driver/Driver.go
Updated the Docker method’s return type from testing.DatabaseDriver to docker.DatabaseDriver.
contracts/testing/docker/database.go
contracts/testing/docker/image.go
Added new interfaces and types: Database, DatabaseDriver, DatabaseConfig, and the Image struct, shifting database handling to the docker package.
contracts/testing/http/assertable_json.go
contracts/testing/http/request.go
contracts/testing/http/response.go
Changed package declarations and introduced new HTTP interfaces (Request, Response) while realigning AssertableJSON with HTTP context.
contracts/testing/test_request.go
contracts/testing/test_response.go
Removed obsolete interfaces (TestRequest and TestResponse).
contracts/testing/testing.go Updated Docker interface to return docker.Database and removed Database, DatabaseDriver, DatabaseConfig, and Image types.
mocks/testing/Docker.go
mocks/testing/docker/Database.go
mocks/testing/docker/DatabaseDriver.go
Modified mock method signatures to use docker types instead of testing types.
mocks/testing/http/AssertableJSON.go
mocks/testing/http/Request.go
mocks/testing/http/Response.go
Updated HTTP mocks to reference the http package for AssertableJSON, Request, and Response with corresponding method signature changes.
support/docker/container.go
support/docker/container_test.go
support/docker/redis.go
support/docker/utils.go
support/docker/utils_test.go
Updated support files to use docker.DatabaseDriver, docker.DatabaseConfig, and docker.Image, revising constructors, methods, and imports.
testing/docker/database.go
testing/docker/database_test.go
testing/docker/docker.go
testing/http/assertable_json.go
testing/http/test_request.go
testing/http/test_response.go
testing/http/test_response_test.go
testing/test_case.go
Revised imports and method signatures to transition from testing/contractstesting to docker or contractshttp types, ensuring consistency across core tests and HTTP testing flows.

Possibly related PRs

Suggested reviewers

  • devhaozi

📜 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 69f41c5 and 48e2882.

📒 Files selected for processing (33)
  • contracts/database/driver/driver.go (1 hunks)
  • contracts/testing/docker/database.go (1 hunks)
  • contracts/testing/docker/image.go (1 hunks)
  • contracts/testing/http/assertable_json.go (1 hunks)
  • contracts/testing/http/request.go (1 hunks)
  • contracts/testing/http/response.go (1 hunks)
  • contracts/testing/test_request.go (0 hunks)
  • contracts/testing/test_response.go (0 hunks)
  • contracts/testing/testing.go (2 hunks)
  • mocks/database/driver/Driver.go (3 hunks)
  • mocks/database/orm/Driver.go (0 hunks)
  • mocks/testing/Docker.go (4 hunks)
  • mocks/testing/TestRequest.go (0 hunks)
  • mocks/testing/TestResponse.go (0 hunks)
  • mocks/testing/docker/Database.go (7 hunks)
  • mocks/testing/docker/DatabaseDriver.go (7 hunks)
  • mocks/testing/http/AssertableJSON.go (14 hunks)
  • mocks/testing/http/Request.go (1 hunks)
  • mocks/testing/http/Response.go (1 hunks)
  • support/docker/container.go (5 hunks)
  • support/docker/container_test.go (6 hunks)
  • support/docker/redis.go (1 hunks)
  • support/docker/utils.go (2 hunks)
  • support/docker/utils_test.go (3 hunks)
  • testing/docker/database.go (1 hunks)
  • testing/docker/database_test.go (5 hunks)
  • testing/docker/docker.go (2 hunks)
  • testing/http/assertable_json.go (6 hunks)
  • testing/http/assertable_json_test.go (5 hunks)
  • testing/http/test_request.go (3 hunks)
  • testing/http/test_response.go (13 hunks)
  • testing/http/test_response_test.go (2 hunks)
  • testing/test_case.go (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov
Copy link

codecov bot commented Feb 7, 2025

Codecov Report

Attention: Patch coverage is 77.64706% with 19 lines in your changes missing coverage. Please review.

Project coverage is 67.54%. Comparing base (69f41c5) to head (48e2882).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
testing/http/test_request.go 23.80% 16 Missing ⚠️
support/docker/container.go 85.71% 1 Missing ⚠️
testing/docker/docker.go 0.00% 1 Missing ⚠️
testing/test_case.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master     #861   +/-   ##
=======================================
  Coverage   67.54%   67.54%           
=======================================
  Files         151      151           
  Lines       10343    10343           
=======================================
  Hits         6986     6986           
  Misses       2990     2990           
  Partials      367      367           

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

@hwbrzzl hwbrzzl merged commit b8242bc into master Feb 7, 2025
11 of 14 checks passed
@hwbrzzl hwbrzzl deleted the bowen/optimize-testing branch February 7, 2025 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant