Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented May 26, 2025

Description

As the title, otherwise it gets difficult to inspect the errors

Issue linked

NA

Checklist

Summary by Sourcery

Refactor test reporting in conftest.py to show passed tests before failed ones and improve type safety for port validation.

Enhancements:

  • Display passed tests before failed tests in MyReporter output
  • Annotate VALID_PORTS constant with list[int] type

@germa89 germa89 requested a review from a team as a code owner May 26, 2025 08:39
@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 26, 2025

Reviewer's Guide

This PR refactors the test result reporter in tests/conftest.py so that passed tests are displayed before failed tests and adds a type annotation to the VALID_PORTS constant for clarity.

File-Level Changes

Change Details Files
Added a type annotation to VALID_PORTS
  • Changed VALID_PORTS = [] to VALID_PORTS: list[int] = []
tests/conftest.py
Reordered reporting blocks to display passed tests before failed tests
  • Moved the passed loop to precede skipped and error sections
  • Relocated the failed loop to follow the error section
  • Updated corresponding write_line calls for both passed and failed blocks
tests/conftest.py

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!

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
Contributor

@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 @germa89 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: 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.

@github-actions github-actions bot added the enhancement Improve any current implemented feature label May 27, 2025
@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) labels May 27, 2025
@germa89
Copy link
Collaborator Author

germa89 commented May 27, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 enabled auto-merge (squash) May 27, 2025 10:13
Copy link
Contributor

@pyansys-ci-bot pyansys-ci-bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@codecov
Copy link

codecov bot commented May 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.27%. Comparing base (f0ce90f) to head (079b281).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3947      +/-   ##
==========================================
- Coverage   88.33%   88.27%   -0.06%     
==========================================
  Files         187      187              
  Lines       14906    14906              
==========================================
- Hits        13167    13159       -8     
- Misses       1739     1747       +8     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 disabled auto-merge May 27, 2025 10:46
@germa89
Copy link
Collaborator Author

germa89 commented May 27, 2025

Output:

================================================================= PyMAPDL Pytest short summary =================================================================
[SKIPPED] tests/test_pool.py - Skipped: Skipping Pool tests on student version.
[SKIPPED] test_skip - tests/test_abc.py:4 - Skipped: Skipping this test for demonstration purposes
[ERROR] test_error - tests/test_abc.py:34: assert False
[FAILED] test_fail - tests/test_abc.py:19: AssertionError: This test should fail assert False
[XPASSED] test_xpassed - tests/test_abc.py:40 - This test was expected to fail, but it passed.
[XFAILED] test_xfailed - tests/test_abc.py:49 - This test should fail assert False
============================================ 1 failed, 1 passed, 2 skipped, 1 xfailed, 1 xpassed, 1 error in 2.62s =============================================
image

@germa89 germa89 merged commit 5606ec3 into main May 27, 2025
50 checks passed
@germa89 germa89 deleted the feat/reorg-pytest-output branch May 27, 2025 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD Related with CICD, Github Actions, etc dependencies enhancement Improve any current implemented feature maintenance General maintenance of the repo (libraries, cicd, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants