Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: migrate to pytest #551

Merged
merged 13 commits into from
Feb 22, 2025
Merged

chore: migrate to pytest #551

merged 13 commits into from
Feb 22, 2025

Conversation

clementb49
Copy link
Collaborator

@clementb49 clementb49 commented Feb 22, 2025

Summary by CodeRabbit

  • Tests

    • Updated automated testing to use a standardized framework with integrated coverage reporting.
    • Streamlined test execution by removing the legacy test script.
  • Chores

    • Enhanced project configuration with updated dependency and coverage settings.
    • Adjusted file tracking to improve management of configuration and coverage output files.
  • Developer Experience

    • Added new debugging configurations to support improved module and test file debugging within the development environment.
    • Suppressed specific linting warnings in the project files.

Copy link
Contributor

coderabbitai bot commented Feb 22, 2025

Walkthrough

This pull request modernizes the testing and configuration setup. The custom Python test script has been replaced by a pytest command with integrated coverage reporting in the CI workflow. VS Code settings have been updated to support debugging and pytest while removing deprecated unittest configurations. Dependencies and coverage configurations have been added in the project configuration, and a legacy test runner file has been removed. Additionally, adjustments in the .gitignore file ensure correct tracking for selected VS Code files and coverage outputs, and a minor change in how extra configuration fields are handled has been made.

Changes

File(s) Change Summary
.github/.../build_app.yml, .vscode/settings.json, pyproject.toml, run_tests.py Replaced a custom test runner with pytest --cov; updated test framework settings; added dependencies (pytest, pytest-cov, ollama) and coverage configuration; removed the legacy run_tests.py file.
.vscode/launch.json, .gitignore Introduced new VS Code debugging configurations and adjusted file tracking by now including .vscode/launch.json and ignoring coverage files (.coverage, coverage.xml).
basilisk/.../config_helper.py Modified the settings configuration by replacing the Pydantic enum (Extra.allow) with the string literal "allow".

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub Actions
    participant Test as Pytest Process
    participant Cov as Coverage Reporter

    Dev->>GH: Commit changes (trigger CI)
    GH->>Test: Execute "poetry run pytest --cov"
    Test->>Cov: Generate coverage data
    Cov-->>GH: Return test results & coverage report
Loading

Suggested reviewers

  • AAClause

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df65013 and cc2a6c6.

📒 Files selected for processing (2)
  • basilisk/__init__.py (1 hunks)
  • tests/__init__.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build_app / build_windows (x64)
🔇 Additional comments (2)
basilisk/__init__.py (1)

1-2: Suppress Docstring Warning with # noqa: D104

The addition of the # noqa: D104 directive suppresses the linting warning for missing module docstrings. This is consistent with intentionally omitting documentation when it's not necessary for this module, especially in light of the migration to pytest.

tests/__init__.py (1)

1-2: Suppress Docstring Warning for Test Module

Adding the # noqa: D104 directive at the top of the tests module suppresses the missing docstring warning, which is appropriate for test modules where detailed documentation may be unnecessary. This change aligns with the updated pytest-based testing strategy.

✨ 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.

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.

@clementb49 clementb49 merged commit 5b6b1ab into master Feb 22, 2025
9 checks passed
@clementb49 clementb49 deleted the migratePytest branch February 22, 2025 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant