formancehq / stack

Open Source Infrastructure for the Financial Internet
https://www.formance.com
Other
361 stars 50 forks source link

test: rework some helpers #1674

Closed gfyrag closed 2 months ago

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes primarily involve modifications to various test files across the codebase, specifically updating the instantiation of the NewDatabase method to include a testing context parameter. This adjustment enhances the database initialization process in tests, allowing for improved error handling and logging capabilities. Additionally, several files underwent refactoring to replace imports from apitesting with sharedapi, consolidating testing utilities.

Changes

File(s) Change Summary
components/ledger/internal/engine/command/commander_test.go, components/ledger/internal/storage/ledgerstore/main_test.go, components/ledger/internal/storage/storagetesting/storage.go, components/ledger/internal/storage/systemstore/ledgers_test.go, components/payments/cmd/api/internal/storage/main_test.go, components/payments/cmd/connectors/internal/storage/main_test.go, ee/auth/pkg/api/authorization/accesstoken_test.go, ee/auth/pkg/api/clients_test.go, ee/auth/pkg/api/users_test.go, ee/auth/pkg/oidc/oidc_test.go, ee/orchestration/internal/api/v1/handler_delete_workflow_test.go, ee/orchestration/internal/api/v1/handler_list_instances_test.go, ee/orchestration/internal/api/v1/handler_read_instance_test.go, ee/orchestration/internal/api/v1/handler_run_workflow_test.go, ee/orchestration/internal/api/v1/main_test.go, ee/orchestration/internal/api/v2/handler_delete_workflow_test.go, ee/orchestration/internal/api/v2/handler_list_instances_test.go, ee/orchestration/internal/api/v2/handler_read_instance_test.go, ee/orchestration/internal/api/v2/handler_run_workflow_test.go, ee/orchestration/internal/api/v2/handler_test_trigger_test.go, ee/orchestration/internal/api/v2/main_test.go, ee/orchestration/internal/storage/migrations_test.go, ee/orchestration/internal/triggers/workflow_trigger_test.go, ee/orchestration/internal/workflow/activities_test.go, ee/orchestration/internal/workflow/manager_test.go, ee/webhooks/pkg/storage/postgres/postgres_test.go, libs/go-libs/bun/bunpaginate/pagination_column_test.go, libs/go-libs/bun/bunpaginate/pagination_offset_test.go Updated NewDatabase calls to include a testing context parameter t.
libs/go-libs/health/controller.go Changed NewHealthController to accept variadic NamedCheck parameters instead of a slice.
libs/go-libs/httpserver/serverport.go Added deferred logging for server start and stop events.
libs/go-libs/logging/adapter_logrus.go Removed unused imports and simplified the Testing function.
libs/go-libs/migrations/migrator_test.go Updated NewDatabase call to include a testing parameter.
libs/go-libs/publish/nats.go, libs/go-libs/publish/module.go Enhanced NATS configuration with new fields for subscription options and acknowledgment delays.
libs/go-libs/service/app.go Added deferred logging for application stop events.
libs/go-libs/testing/api/matchers.go, libs/go-libs/testing/api/utils.go Changed package declarations to api from ginkgo and apitesting, respectively.
libs/go-libs/testing/platform/clickhousetesting/clickhouse.go, libs/go-libs/testing/platform/clickhousetesting/ginkgo.go Introduced new methods for managing ClickHouse databases and testing contexts.
libs/go-libs/testing/platform/elastictesting/elastic.go Added timeout configuration for server creation.
libs/go-libs/testing/platform/natstesting/ginkgo.go, libs/go-libs/testing/platform/natstesting/nats.go Introduced new functions for testing with NATS servers and enhanced server management capabilities.
libs/go-libs/testing/platform/pgtesting/ginkgo.go, libs/go-libs/testing/platform/pgtesting/postgres.go, libs/go-libs/testing/platform/pgtesting/postgres_test.go Updated PostgreSQL server and database struct fields for visibility and added testing context to database creation.
libs/go-libs/testing/utils/deferred.go Implemented a generic Deferred type for asynchronous operations.
libs/go-libs/testing/utils/testing_main.go Added command-line flag parsing to WithTestMain function.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Testing Framework
    participant DB as Database
    Test->>DB: NewDatabase(t)
    DB-->>Test: Initialize with context

🐰 In the meadow, I hop with glee,
New tests and changes, oh what a spree!
With context now, we dance and play,
Logging and structuring, brightens the day.
Hooray for the code, so fresh and neat,
A joyful rabbit's hop, oh what a treat! 🐇


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.