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

build: prepare for test matrix #107

Merged
merged 2 commits into from
Jan 13, 2025
Merged

build: prepare for test matrix #107

merged 2 commits into from
Jan 13, 2025

Conversation

alex-liang3
Copy link
Contributor

@alex-liang3 alex-liang3 commented Jan 10, 2025

Adds a new Makefile directive to be used in CI to facilitate unit testing multiple Python versions. This should be merged BEFORE open-space-collective/open-space-toolkit#144, and will only kick in after the latter is merged.

Summary by CodeRabbit

  • New Features
    • Added a new Makefile target for running Python unit tests in a Docker container
    • Implemented a dedicated testing method for Python tests with dependency installation

@alex-liang3 alex-liang3 self-assigned this Jan 10, 2025
Copy link

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request introduces a new ci-test-python target in the Makefile, specifically designed to run Python unit tests within a Docker container. This target ensures that Python packages are installed from the packages/python directory before executing tests using pytest, providing a standardized and isolated testing environment for Python components.

Changes

File Change Summary
Makefile Added .PHONY target ci-test-python for running Python unit tests in a Docker container

Poem

🐰 In Docker's cozy test domain,
Where Python tests now softly reign,
A Makefile target springs to life,
Dispatching tests without a strife!
Pytest dances, packages in tow,
Our rabbit code begins to grow! 🚀


📜 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 be57aa0 and 33512b9.

📒 Files selected for processing (1)
  • Makefile (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Makefile
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Test / Run Python Unit Tests
  • GitHub Check: Test / Run C++ Unit Tests
  • GitHub Check: Test / Check Python Format
  • GitHub Check: Test / Check C++ Format

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.

@alex-liang3 alex-liang3 changed the title build: test matrix build: prepare for test matrix Jan 10, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
Makefile (2)

545-546: Fix typo and improve target documentation.

The target description has a typo and could be more specific about its prerequisites.

-ci-test-python: ## Run Python unit tests. Assumes the dev image has already been built, AND that bindings have been built and are avaliable at `packages/python`
+ci-test-python: ## Run Python unit tests. Assumes the dev image has already been built, and bindings have been built and are available at 'packages/python'

549-558: Consider adding error handling for missing prerequisites.

The target assumes that the development image and Python bindings exist but doesn't verify these prerequisites. This could lead to confusing errors if they're missing.

Consider adding checks at the beginning of the target:

 ci-test-python:
+	@ if [ ! -d "packages/python" ]; then \
+		echo "Error: Python bindings not found in packages/python. Run 'make build-packages-python' first." >&2; \
+		exit 1; \
+	fi
+
 	@ echo "Running Python unit tests..."
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7c5853 and be57aa0.

📒 Files selected for processing (2)
  • .github/workflows/build-test.yml (1 hunks)
  • Makefile (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build Development Image / Build Development Image

.github/workflows/build-test.yml Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.47%. Comparing base (d7c5853) to head (33512b9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #107   +/-   ##
=======================================
  Coverage   69.47%   69.47%           
=======================================
  Files           7        7           
  Lines         498      498           
=======================================
  Hits          346      346           
  Misses        152      152           

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

@vishwa2710 vishwa2710 force-pushed the build/prep-test-matrix branch from a0b0619 to 33512b9 Compare January 13, 2025 20:22
@vishwa2710 vishwa2710 enabled auto-merge (squash) January 13, 2025 20:24
@vishwa2710 vishwa2710 merged commit 521b0f1 into main Jan 13, 2025
14 checks passed
@vishwa2710 vishwa2710 deleted the build/prep-test-matrix branch January 13, 2025 20:28
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.

2 participants