Skip to content

ci(tests) Verify runtime deps #965

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

Merged
merged 3 commits into from
Feb 19, 2025
Merged

ci(tests) Verify runtime deps #965

merged 3 commits into from
Feb 19, 2025

Conversation

tony
Copy link
Member

@tony tony commented Feb 19, 2025

Changes

  • Add runtime dependency check in CI using uv run --no-dev
  • Run check before installing dev dependencies
  • Print package version and basic functionality test results
  • Document improvement in CHANGES

Verification

https://github.com/tmux-python/tmuxp/actions/runs/13411308953/job/37461974473#step:5:24

image

See also

Summary by Sourcery

CI:

  • Adds a CI job to verify that runtime dependencies are installed correctly and that the application can import its modules and dependencies.

Copy link

sourcery-ai bot commented Feb 19, 2025

Reviewer's Guide by Sourcery

This pull request adds a new job to the CI workflow that verifies the runtime dependencies of the tmuxp package. The job runs a Python script that imports modules from the tmuxp and libtmux packages and prints their versions to standard output.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a job to verify runtime dependencies.
  • Added a step to run a Python script that imports modules from the tmuxp and libtmux packages.
  • The script prints the versions of tmuxp and libtmux to standard output.
.github/workflows/tests.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @tony - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider moving the runtime dependency test to a separate job to avoid impacting the main test execution time.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

uv run --no-dev -p python3.13 -- python -c '
  from tmuxp import _internal, cli, workspace, exc, log, plugin, shell, types, util, __version__
  from tmuxp._internal import config_reader, types
  from tmuxp.workspace import builder, constants, finders, freezer, importers, loader, validation
  from libtmux import __version__ as __libtmux_version__
  print("tmuxp version:", __version__)
  print("libtmux version:", __libtmux_version__)
  '
  shell: /usr/bin/bash -e {0}
  env:
    UV_CACHE_DIR: /home/runner/work/_temp/setup-uv-cache
Using CPython 3.13.2
Creating virtual environment at: .venv
   Building tmuxp @ file:///home/runner/work/tmuxp/tmuxp
      Built tmuxp @ file:///home/runner/work/tmuxp/tmuxp
Installed 4 packages in 1ms
Traceback (most recent call last):
  File "<string>", line 3, in <module>
    from tmuxp._internal import config_reader, types
  File "/home/runner/work/tmuxp/tmuxp/src/tmuxp/_internal/types.py", line 15, in <module>
    from typing_extensions import NotRequired, TypedDict
ModuleNotFoundError: No module named 'typing_extensions'
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.07%. Comparing base (39fe784) to head (d2cb248).
Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #965      +/-   ##
==========================================
+ Coverage   73.06%   73.07%   +0.01%     
==========================================
  Files          26       26              
  Lines        1856     1857       +1     
  Branches      352      352              
==========================================
+ Hits         1356     1357       +1     
  Misses        396      396              
  Partials      104      104              

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

@tony tony merged commit 39a5dc6 into master Feb 19, 2025
18 checks passed
tony added a commit that referenced this pull request Feb 20, 2025
Follow up to #965, cover import imports to test runtime behavior to make sure
we're not importing dev deps.
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