Skip to content

fix: add missing @conda annotations#3298

Merged
johanneskoester merged 1 commit intosnakemake:mainfrom
mschubert:fixes
Feb 18, 2025
Merged

fix: add missing @conda annotations#3298
johanneskoester merged 1 commit intosnakemake:mainfrom
mschubert:fixes

Conversation

@mschubert
Copy link
Copy Markdown
Contributor

@mschubert mschubert commented Feb 17, 2025

The snakemake tests use the decorator @conda to check whether the conda executable is in the user $PATH and otherwise skips them.

However, some annotations are missing and hence failing instead of being skipped without conda:

tests/tests.py::test_conda_create_envs_only
tests/tests.py::test_get_log_none
tests/tests.py::test_get_log_both
tests/tests.py::test_get_log_stderr
tests/tests.py::test_get_log_stdout
tests/tests.py::test_get_log_complex
tests/tests.py::test_issue1046
tests/tests.py::test_containerize

This patch adds the missing decorator to those tests.

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

  • Tests
    • Expanded automated test coverage to verify environment setup processes.
    • Added validations for logging behavior across multiple scenarios, ensuring robust handling of different output conditions.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 17, 2025

📝 Walkthrough

Walkthrough

This pull request augments the test suite by adding six new test functions to tests/tests.py. Each test is decorated with @conda to ensure execution within a conda environment. The new tests verify both the conda environment creation process (by checking for the appropriate flag file) and various logging behaviors, covering scenarios with no logs, combined standard output and error logs, isolated standard output, isolated error logs, and more complex logging conditions. No existing functionality has been altered.

Changes

File Summary
tests/tests.py Added test functions: test_conda_create_envs_only, test_get_log_none, test_get_log_both, test_get_log_stderr, test_get_log_stdout, and test_get_log_complex to validate conda environment setup and different logging scenarios.

Possibly related PRs

Suggested reviewers

  • johanneskoester

📜 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 a19a0ac and b50ad61.

📒 Files selected for processing (1)
  • tests/tests.py (4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.py`: Do not try to improve formatting. Do not suggest ...

**/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

  • tests/tests.py
🔇 Additional comments (8)
tests/tests.py (8)

522-536: LGTM! Well-structured test for conda environment creation.

The test correctly verifies the conda environment setup by checking for the existence of the environment setup flag file, and includes proper cleanup. The Windows skip is well-documented.


613-615: LGTM! Simple and focused test.

The test is appropriately decorated with @conda and tests a specific logging scenario.


618-620: LGTM! Clear test for combined logging.

The test is appropriately decorated with @conda and tests a specific logging scenario.


623-625: LGTM! Focused test for stderr logging.

The test is appropriately decorated with @conda and tests a specific logging scenario.


628-630: LGTM! Clear test for stdout logging.

The test is appropriately decorated with @conda and tests a specific logging scenario.


633-635: LGTM! Test for complex logging scenarios.

The test is appropriately decorated with @conda and tests a specific logging scenario.


1334-1336: LGTM! Issue-specific test with proper conda annotation.

The test is appropriately decorated with @conda and addresses a specific issue.


1639-1641: LGTM! Containerization test with proper conda annotation.

The test is appropriately decorated with @conda and verifies containerization functionality.

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

@sonarqubecloud
Copy link
Copy Markdown

@johanneskoester johanneskoester enabled auto-merge (squash) February 18, 2025 11:56
@johanneskoester johanneskoester merged commit 0b541cc into snakemake:main Feb 18, 2025
10 of 11 checks passed
johanneskoester pushed a commit that referenced this pull request Feb 27, 2025
🤖 I have created a release *beep* *boop*
---


##
[8.29.0](v8.28.0...v8.29.0)
(2025-02-27)


### Features

* provide mechanism to link between report items (snakemake.report_href,
see docs) ([#3224](#3224))
([a024e60](a024e60))
* toggles for binary labels in report
([#3296](#3296))
([7690998](7690998))


### Bug Fixes

* add missing [@conda](https://github.com/conda) annotations
([#3298](#3298))
([0b541cc](0b541cc))
* properly handle remote storage when waiting for pipes
([#3317](#3317))
([9f7e092](9f7e092))
* provide proper error messages if output file preparation (pipe, mkdir)
fails ([#3309](#3309))
([77ef176](77ef176))
* record file extension (e.g. .tsv) in between workflow cache records in
order to avoid that files of the wrong format are erroneously returned
by the cache. This will lead to some cache misses. But avoiding errors
induced by the previous behavior of ignoring file extensions when
seeking for cache records is more important.
([#3314](#3314))
([4912f00](4912f00))
* sort results lexicographically by labels in their order of appearance
([#3293](#3293))
([a19a0ac](a19a0ac))


### Documentation

* update best practices
([7270eb3](7270eb3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
The snakemake tests use the decorator `@conda` to check whether the
`conda` executable is in the user `$PATH` and otherwise skips them.

However, some annotations are missing and hence failing instead of being
skipped without `conda`:

```
tests/tests.py::test_conda_create_envs_only
tests/tests.py::test_get_log_none
tests/tests.py::test_get_log_both
tests/tests.py::test_get_log_stderr
tests/tests.py::test_get_log_stdout
tests/tests.py::test_get_log_complex
tests/tests.py::test_issue1046
tests/tests.py::test_containerize
```

This patch adds the missing decorator to those tests.

### QC
<!-- Make sure that you can tick the boxes below. -->

* [x] The PR contains a test case for the changes or the changes are
already covered by an existing test case.
* [x] The documentation (`docs/`) is updated to reflect the changes or
this is not necessary (e.g. if the change does neither modify the
language nor the behavior or functionalities of Snakemake).


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Tests**
- Expanded automated test coverage to verify environment setup
processes.
- Added validations for logging behavior across multiple scenarios,
ensuring robust handling of different output conditions.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
kjohnsen pushed a commit to kjohnsen/snakemake that referenced this pull request Dec 15, 2025
🤖 I have created a release *beep* *boop*
---


##
[8.29.0](snakemake/snakemake@v8.28.0...v8.29.0)
(2025-02-27)


### Features

* provide mechanism to link between report items (snakemake.report_href,
see docs) ([snakemake#3224](snakemake#3224))
([a024e60](snakemake@a024e60))
* toggles for binary labels in report
([snakemake#3296](snakemake#3296))
([7690998](snakemake@7690998))


### Bug Fixes

* add missing [@conda](https://github.com/conda) annotations
([snakemake#3298](snakemake#3298))
([0b541cc](snakemake@0b541cc))
* properly handle remote storage when waiting for pipes
([snakemake#3317](snakemake#3317))
([9f7e092](snakemake@9f7e092))
* provide proper error messages if output file preparation (pipe, mkdir)
fails ([snakemake#3309](snakemake#3309))
([77ef176](snakemake@77ef176))
* record file extension (e.g. .tsv) in between workflow cache records in
order to avoid that files of the wrong format are erroneously returned
by the cache. This will lead to some cache misses. But avoiding errors
induced by the previous behavior of ignoring file extensions when
seeking for cache records is more important.
([snakemake#3314](snakemake#3314))
([4912f00](snakemake@4912f00))
* sort results lexicographically by labels in their order of appearance
([snakemake#3293](snakemake#3293))
([a19a0ac](snakemake@a19a0ac))


### Documentation

* update best practices
([7270eb3](snakemake@7270eb3))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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