Skip to content

Conversation

@germa89
Copy link
Collaborator

@germa89 germa89 commented Jun 25, 2025

Description

Improving pytest reporting

Issue linked

Extracted from #1300

Checklist

Summary by Sourcery

Enhance pytest reporting by adding an additional environment variable to the header, truncating overly long test summary lines to a maximum length, and improving the assertion message in the MAPDL fixture.

Enhancements:

  • Include PYMAPDL_ADDITIONAL_SWITCHES in the pytest report header
  • Truncate long pytest summary and failure messages to 1000 characters
  • Add wrap_len helper to enforce maximum message length in summaries
  • Clarify MAPDL fixture assertion with guidance to stop existing instances

@germa89 germa89 requested a review from a team as a code owner June 25, 2025 11:30
@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 Jun 25, 2025

Reviewer's Guide

This PR enhances pytest reporting by adding support for an extra environment variable in the header, introducing a global message‐length limit via a new wrap_len utility and applying it across all report outputs, and by improving an assertion error message in the mapdl fixture.

File-Level Changes

Change Details Files
Added additional environment variable to pytest report header
  • Insert "PYMAPDL_ADDITIONAL_SWITCHES" into the header env var list
tests/conftest.py
Implemented message length limiting utility
  • Define MAXIMUM_MESSAGE_LENGTH constant
  • Add wrap_len() helper to truncate strings over the limit
tests/conftest.py
Applied truncation across all pytest report outputs
  • Wrap get_normal_message and get_failure_message outputs with wrap_len
  • Slice messages to MAXIMUM_MESSAGE_LENGTH before write_line for passed, skipped, xfailed, xpassed, errored, and failed reports
tests/conftest.py
Enhanced mapdl fixture assertion message
  • Replace bare Path equality assertion with one that includes guidance on killing existing MAPDL instances
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

@germa89
Copy link
Collaborator Author

germa89 commented Jun 25, 2025

@pyansys-ci-bot LGTM.

@germa89 germa89 self-assigned this Jun 25, 2025
@germa89 germa89 enabled auto-merge (squash) June 25, 2025 11:31
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

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!


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 CI/CD Related with CICD, Github Actions, etc label Jun 25, 2025
@github-actions github-actions bot added CI/CD Related with CICD, Github Actions, etc and removed CI/CD Related with CICD, Github Actions, etc labels Jun 25, 2025
@codecov
Copy link

codecov bot commented Jun 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.18%. Comparing base (53ad87c) to head (126197c).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4037      +/-   ##
==========================================
+ Coverage   89.05%   89.18%   +0.13%     
==========================================
  Files         187      187              
  Lines       14970    14970              
==========================================
+ Hits        13331    13351      +20     
+ Misses       1639     1619      -20     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89 germa89 merged commit 5d31580 into main Jun 25, 2025
47 checks passed
@germa89 germa89 deleted the ci/improving-pytest-reporting branch June 25, 2025 12:06
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants