-
Notifications
You must be signed in to change notification settings - Fork 23
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
Fix potential off by one error #139
Conversation
We can probably simply move the early |
src/pytest_subtests/plugin.py
Outdated
return True | ||
if exc_val is not None: | ||
if self.request.session.shouldfail: | ||
pytest.exit(reason=f"subtest failed") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't seem right, but seems to leave the parent test off the test result entirely.
for more information, see https://pre-commit.ci
I updated the test to reflect what I think is desired behavior - which leaves the parent test off the test report entirely. I took a stab at a fix, but it calls |
Hi @rhoban13, Here's my example for testing: def test_foo(subtests):
with subtests.test(i=0):
assert False
with subtests.test(i=1):
assert False
with subtests.test(i=2):
assert False Executing:
So the parent test does run. Implementing your original suggestion (moving the check to the end and returning
I think having the parent test on the report is acceptable when using In summary I think your original idea of moving the check and return False to the end is the way to go. |
Updated per above - I also think it's good to have the parent test on the report. The only thing perhaps a little odd is that with |
Thanks @rhoban13, appreciate it! |
Bumps [pytest-subtests](https://github.com/pytest-dev/pytest-subtests) from 0.11.0 to 0.13.1. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/pytest-dev/pytest-subtests/releases">pytest-subtests's releases</a>.</em></p> <blockquote> <h2>v0.13.1</h2> <p>No release notes provided.</p> <h2>v0.13.0</h2> <h2>What's Changed</h2> <ul> <li>Fix compatibility with pytest 8.1 by <a href="https://github.com/nicoddemus"><code>@nicoddemus</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/126">pytest-dev/pytest-subtests#126</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/127">pytest-dev/pytest-subtests#127</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/128">pytest-dev/pytest-subtests#128</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/129">pytest-dev/pytest-subtests#129</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/130">pytest-dev/pytest-subtests#130</a></li> <li>Hide <code>SubTests.test()</code> from tracebacks by <a href="https://github.com/bswck"><code>@bswck</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/131">pytest-dev/pytest-subtests#131</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/132">pytest-dev/pytest-subtests#132</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/133">pytest-dev/pytest-subtests#133</a></li> <li>[pre-commit.ci] pre-commit autoupdate by <a href="https://github.com/pre-commit-ci"><code>@pre-commit-ci</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/135">pytest-dev/pytest-subtests#135</a></li> <li>Support -x to fail fast by <a href="https://github.com/rhoban13"><code>@rhoban13</code></a> in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/134">pytest-dev/pytest-subtests#134</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/bswck"><code>@bswck</code></a> made their first contribution in <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/131">pytest-dev/pytest-subtests#131</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/pytest-dev/pytest-subtests/compare/v0.12.1...v0.13.0">https://github.com/pytest-dev/pytest-subtests/compare/v0.12.1...v0.13.0</a></p> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/pytest-dev/pytest-subtests/blob/main/CHANGELOG.rst">pytest-subtests's changelog</a>.</em></p> <blockquote> <h2>0.13.1 (2024-07-16)</h2> <ul> <li>Fixed bug were an extra test would execute when <code>-x/--exitfirst</code> was used (<code>[#139](https://github.com/pytest-dev/pytest-subtests/issues/139)</code>_).</li> </ul> <p>.. _<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/139">#139</a>: <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/139">pytest-dev/pytest-subtests#139</a></p> <h2>0.13.0 (2024-07-07)</h2> <ul> <li>Dropped support for EOL Python 3.7.</li> <li>Added support for <code>-x/--exitfirst</code> (<code>[#134](https://github.com/pytest-dev/pytest-subtests/issues/134)</code>_).</li> <li>Hide the traceback inside the <code>SubTests.test()</code> method (<code>[#131](https://github.com/pytest-dev/pytest-subtests/issues/131)</code>_).</li> </ul> <p>.. _<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/131">#131</a>: <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/131">pytest-dev/pytest-subtests#131</a> .. _<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/134">#134</a>: <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/134">pytest-dev/pytest-subtests#134</a></p> <h2>0.12.1 (2024-03-07)</h2> <ul> <li>Fixed compatibility with upcoming pytest <code>8.1.x</code>. (<code>[#125](https://github.com/pytest-dev/pytest-subtests/issues/125)</code>_).</li> </ul> <p>.. _<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/125">#125</a>: <a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/125">pytest-dev/pytest-subtests#125</a></p> <h2>0.12.0 (2024-03-06)</h2> <ul> <li>Python 3.12 is now officially supported (<code>[#113](https://github.com/pytest-dev/pytest-subtests/issues/113)</code>_).</li> <li>Added typing support (<code>[#115](https://github.com/pytest-dev/pytest-subtests/issues/115)</code>_).</li> <li><code>SubTests</code> can be imported from <code>pytest_subtests</code> to type-annotate the <code>subtests</code> fixture.</li> </ul> <p>.. _<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/113">#113</a>: <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/113">pytest-dev/pytest-subtests#113</a> .. _<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/115">#115</a>: <a href="https://redirect.github.com/pytest-dev/pytest-subtests/pull/115">pytest-dev/pytest-subtests#115</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/3671b40691440fcb01e96e346220ac4fe62d3580"><code>3671b40</code></a> Release 0.13.1</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/c02c55e23c5e3b1b354716d6a93b88a9336d207b"><code>c02c55e</code></a> Fix off by one error when using -x (<a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/139">#139</a>)</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/cbff3e1547238584a2cf9be9aa0b0da8d8cb9bc3"><code>cbff3e1</code></a> Merge pull request <a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/138">#138</a> from nicoddemus/adjust-deploy</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/c2ccbfb53d02e7f6d3166055e73808141f12faed"><code>c2ccbfb</code></a> Fix deploy and update instructions</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/358790b3283c8e5faf5a71aa0dfd0e17365626a5"><code>358790b</code></a> Merge pull request <a href="https://redirect.github.com/pytest-dev/pytest-subtests/issues/137">#137</a> from pytest-dev/release-0.13.0</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/3c6a72c0f7a579c887d8a74cd587359db83cfb24"><code>3c6a72c</code></a> Automatically merge branch during deploy</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/ed8f899e3e347d88c2bf12a29748aeb217c3218a"><code>ed8f899</code></a> Create a GH release during deploy</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/cb5a9229de26f115e2bd4f856a68267ca95bf1e4"><code>cb5a922</code></a> Update CHANGELOG</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/79a6bc14d9479d9cda2b0fb9e9bb32da203bc033"><code>79a6bc1</code></a> Simplify CI configuration</li> <li><a href="https://github.com/pytest-dev/pytest-subtests/commit/eef3c597e1f973cd77246318bd44b1847db17b08"><code>eef3c59</code></a> Drop support for Python 3.7</li> <li>Additional commits viewable in <a href="https://github.com/pytest-dev/pytest-subtests/compare/v0.11.0...v0.13.1">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pytest-subtests&package-manager=pip&previous-version=0.11.0&new-version=0.13.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
In #134 support was added for
--exitfirst
. I think we might have an off by one error, this PR just illustrating with this small change to the tests.I think the issue is that
self.request.session.shouldfail
does not get set until we callpytest_runtest_logreport
which is after the flag is checked. The result is the tests get stopped after the 2nd failing subtest instead of the first.