search

betagouv / preuve-covoiturage

Registre de preuve de covoiturage
https://app.covoiturage.beta.gouv.fr
Apache License 2.0
32 stars 12 forks source link

Amélioration des helpers kernel et db pour les TI #2525

Closed jonathanfallon closed 2 months ago

jonathanfallon commented 2 months ago

:warning: l'API de sortie du helper before a été modifiée : service -> services. La propriété n'était pas utilisée.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes provide enhanced testing capabilities and setup adjustments within the PDC API codebase. Key updates include enriching database helper functions, expanding middleware usage, integrating parameter validation improvements, and refining schemas. Additionally, the modifications now support multiple service providers, facilitating more robust and flexible testing configurations.

Changes

File Path Change Summary
api/src/pdc/providers/test/dbMacro.ts Added documentation and examples for database helper functions.
api/src/pdc/providers/test/handlerMacro.ts Updated assertHandler callback signature to allow void return type.
api/src/pdc/providers/test/helpers.ts Enhanced KernelContext, makeKernel, and makeKernelBeforeAfter for multi-service setup and test configurations
...actions/CreateAction.integration.spec.ts Added integration tests for CreateActionV2 and CreateActionV3 classes.
api/src/pdc/services/export/actions/CreateActionV3.ts Introduced new middleware functions, updated parameter handling in CreateActionV3 class.
api/src/pdc/services/export/middlewares/ScopeToGroupMiddleware.integration.spec.ts Updated parameter types to use TerritorySelectorsInterface.
shared/export/create.schema.ts Changed string literals from single quotes to double quotes across schema definitions.

Sequence Diagrams

sequenceDiagram
    participant TestSuite
    participant DbMacro
    participant Kernel
    participant Services
    TestSuite->>DbMacro: makeDbBeforeAfter(cfg)
    DbMacro->>DbMacro: Setup/Cleanup Test Database
    TestSuite->>Kernel: makeKernel(...serviceProviders)
    activate Kernel
    Kernel-->>Services: Initialize Services
    Services-->>Kernel: Services Ready
    deactivate Kernel
    Kernel-->>TestSuite: Kernel Ready with Multiple Services
    TestSuite-->>TestSuite: Execute Integration Tests
sequenceDiagram
    participant Client
    participant CreateActionV3
    participant Middleware
    participant Validator
    Client->>CreateActionV3: Call CreateActionV3
    CreateActionV3->>Middleware: Process Middlewares
    Middleware-->>CreateActionV3: Processed Data
    CreateActionV3->>Validator: Validate Dates and Params
    Validator-->>CreateActionV3: Validated Params
    CreateActionV3-->>Client: Return Success Response

Poem

Amidst the code, where tests evolve,
Through middlewares, our tasks resolve.
The kernels caper, swift and bright,
Services dance, a joyous sight.
In lines of change, our strength is spun,
To better tasks, the tests are done.
🎩🐇 CodeRabbit's decree, the work's begun! 🌟

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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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.