transfermarkt-api icon indicating copy to clipboard operation
transfermarkt-api copied to clipboard

[DRAFT] Unit tests

Open felipeall opened this issue 1 year ago • 1 comments

Summary by CodeRabbit

Based on the comprehensive summary, here are the updated release notes:

  • Testing

    • Added comprehensive test suite for club, competition, and player services.
    • Introduced new test data files for various scenarios.
    • Implemented parameterized testing for robust validation.
    • Removed obsolete tests for player achievements, injuries, market value, profile, and transfers.
  • Workflow

    • Updated GitHub Actions workflows for code checks and testing.
    • Enhanced Python environment setup and dependency management.
    • Added automated testing for different service functionalities.
  • Dependencies

    • Updated pydantic to version 2.10.5.
    • Added python-dateutil dependency.
    • Removed schema dependency.
  • Infrastructure

    • Migrated test fixtures to use JSON-based test data loading.
    • Simplified test configuration and data management.

felipeall avatar Jan 11 '25 18:01 felipeall

Walkthrough

This pull request introduces comprehensive changes to the testing infrastructure of the Transfermarkt API project. The modifications include adding a new GitHub Actions workflow for running tests, updating the project's dependency configuration, and restructuring the test suite. The changes involve removing several existing test files, introducing new JSON test data files, and creating new service-level test files that leverage a new load_test_data fixture for data-driven testing.

Changes

File Change Summary
.github/workflows/tests.yml New GitHub Actions workflow for automated testing
.github/workflows/check.yml Updated code check workflow with latest Ubuntu and Python setup
pyproject.toml Updated dependencies, added python-dateutil, removed schema
tests/conftest.py Replaced regex fixtures with a new load_test_data fixture
tests/services/test_clubs.py New service-level tests for club-related functionalities
tests/services/test_competitions.py New service-level tests for competition-related functionalities
Multiple test files Deleted various test files in tests/clubs/, tests/players/, and tests/competitions/
Multiple JSON files Added new test data files in tests/data/ for clubs, competitions, and players

Poem

🐰 A Testing Tale of Code Delight
With workflows sharp and data bright,
Fixtures dance and services sing,
Our Transfermarkt API takes wing!
Hop, hop, hooray! 🚀

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.

coderabbitai[bot] avatar Jan 11 '25 18:01 coderabbitai[bot]