Skip to content
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 validation error for retry strategy #558

Conversation

lakhanjindam
Copy link
Contributor

Fix issue #552

@@ -36,7 +36,7 @@ class RetryStrategy(_BaseModel):
affinity: Optional[RetryAffinity] = None
backoff: Optional[Backoff] = None
expression: Optional[str] = None
limit: Optional[Union[int, str]] = None
limit: Optional[IntOrString] = None
Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks for submitting the PR @lakhanjindam! 🚀

There might be something strange happening here.. there's a validator for this field that is supposed to convert the limit from str | int to IntOrString

Copy link
Contributor Author

Choose a reason for hiding this comment

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

problems seems to be happening with this line https://github.com/argoproj-labs/hera/blob/main/src/hera/workflows/retry_strategy.py#L55
since i made change where limit is mapped to IntOrString type so it goes into if block and returns from there.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, yes, you are right... I think, though, that we should enrich this type so that users can pass in 1 of 3 types:

Suggested change
limit: Optional[IntOrString] = None
limit: Optional[Union[int, str, IntOrString]] = None

Also, you pointed out the __root__ usage issue. If we change line 55 from

return IntOrString(__root__=str(v)) # int or str

to

return str(v)  # int or str

everything should work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah this will work. But what if the value passed is bool for var limit, in that case it wont raise any err since it will be converting it to str type

Signed-off-by: lakhan jindam <ljindam@twilio.com>
@lakhanjindam
Copy link
Contributor Author

lakhanjindam commented Apr 6, 2023

So this is happening, i did some simple debugging on the value we are returning.
When we enter the validator function for limit var

def _convert_limit(cls, v):
    if v is None or isinstance(v, IntOrString):
        return v
    return IntOrString(__root__=str(v))  # __root__='3'
   # ------- fix ---------
   v = IntOrString(__root__=str(v))
   return v.__root__

So the value which is returned is not a valid type logically, hence its throwing error.
ref: https://docs.pydantic.dev/usage/models/#custom-root-types

@samj1912 samj1912 added semver:patch A change requiring a patch version bump type:bug A general bug labels Apr 7, 2023
Copy link
Collaborator

@flaviuvadan flaviuvadan left a comment

Choose a reason for hiding this comment

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

I left a comment on an implementation that I think will solve the problem! Also, any chance you can please add an upstream example in examples/workflows/upstream/retry_script.py? This will map to the following example: https://github.com/argoproj/argo-workflows/blob/master/examples/retry-script.yaml

Note that you will have to run make regenerate-test-data to generate the YAML for comparison/testing!

from hera.workflows import Workflow, script, RetryStrategy


@script(image="python:alpine3.6", retry_strategy=RetryStrategy(limit=10), add_cwd_to_sys_path=False)
def retry_script():
    import random
    import sys
    exit_code = random.choice([0, 1, 1])
    sys.exit(exit_code)


with Workflow(generate_name="retry-script-", entrypoint="retry-script") as w:
    retry_script()

@lakhanjindam lakhanjindam force-pushed the fix-retry-strategy-validation-err branch 2 times, most recently from ef7042b to 8245d97 Compare April 7, 2023 15:28
lakhanjindam and others added 3 commits April 7, 2023 21:07
Signed-off-by: lakhan jindam <lakhanj569@gmail.com>
Signed-off-by: lakhan jindam <lakhanj569@gmail.com>
samj1912 and others added 2 commits April 7, 2023 17:10
Signed-off-by: Sambhav Kothari <sambhavs.email@gmail.com>
Signed-off-by: lakhanjindam <lakhanj569@gmail.com>
Copy link
Collaborator

@flaviuvadan flaviuvadan left a comment

Choose a reason for hiding this comment

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

Thank you for the fix @lakhanjindam!

Might need a quick make format before we can merge

@flaviuvadan flaviuvadan changed the base branch from main to fv/o-param April 8, 2023 00:28
@flaviuvadan
Copy link
Collaborator

@lakhanjindam the PR looks great to me so I am merging it into an upstream branch that I will run make format for you on then merge that one! Thank you again 🚀

@flaviuvadan flaviuvadan merged commit 0ecec66 into argoproj-labs:fv/o-param Apr 8, 2023
3 of 11 checks passed
elliotgunton pushed a commit that referenced this pull request Nov 6, 2023
Bumps [pytest-cov](https://github.com/pytest-dev/pytest-cov) from 4.0.0
to 4.1.0.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/pytest-dev/pytest-cov/blob/master/CHANGELOG.rst">pytest-cov's
changelog</a>.</em></p>
<blockquote>
<h2>4.1.0 (2023-05-24)</h2>
<ul>
<li>Updated CI with new Pythons and dependencies.</li>
<li>Removed rsyncdir support. This makes pytest-cov compatible with
xdist 3.0.
Contributed by Sorin Sbarnea in
<code>[#558](pytest-dev/pytest-cov#558)
&lt;https://github.com/pytest-dev/pytest-cov/pull/558&gt;</code>_.</li>
<li>Optimized summary generation to not be performed if no reporting is
active (for example,
when <code>--cov-report=''</code> is used without
<code>--cov-fail-under</code>).
Contributed by Jonathan Stewmon in
<code>[#589](pytest-dev/pytest-cov#589)
&lt;https://github.com/pytest-dev/pytest-cov/pull/589&gt;</code>_.</li>
<li>Added support for JSON reporting.
Contributed by Matthew Gamble in
<code>[#582](pytest-dev/pytest-cov#582)
&lt;https://github.com/pytest-dev/pytest-cov/pull/582&gt;</code>_.</li>
<li>Refactored code to use f-strings.
Contributed by Mark Mayo in
<code>[#572](pytest-dev/pytest-cov#572)
&lt;https://github.com/pytest-dev/pytest-cov/pull/572&gt;</code>_.</li>
<li>Fixed a skip in the test suite for some old xdist.
Contributed by a bunch of people in
<code>[#565](pytest-dev/pytest-cov#565)
&lt;https://github.com/pytest-dev/pytest-cov/pull/565&gt;</code>_.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/2c9f2170d8575b21bafb6402eb30ca7de31e20b9"><code>2c9f217</code></a>
Bump version: 4.0.0 → 4.1.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/4d245df8f75e434a9e1b162b51265d6a45017465"><code>4d245df</code></a>
Update changelog and authors.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/7b095c84ae521b14058d7d520ef36372849063a8"><code>7b095c8</code></a>
Skip starting from xdist 3.0.2 (where boxed was removed).</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/605d6902b3b3d17aad0bf811b8c580fc895724ca"><code>605d690</code></a>
disabling boxed test if version xdist newer than 2.5.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/76fb2a6cb2c4a4a788a5b62710848daf9c8fb7ce"><code>76fb2a6</code></a>
introduced f-strings</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/0d63ede0d2ca9f4acc8329aa4261a7cec489ffdb"><code>0d63ede</code></a>
Update test config. Reapply some of the changes from PR567 to the right
file ...</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/f3d8d8380f6a4b265353fe7cd509b040702f1e64"><code>f3d8d83</code></a>
Add support for JSON reporter</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/dec02abeb9fa8ee3547baa054bde6006bea530ee"><code>dec02ab</code></a>
Update test deps.</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/88a7d348986bace58e26c88a713ef35f900ce2ef"><code>88a7d34</code></a>
chore: update AUTHORS and CHANGELOG</li>
<li><a
href="https://github.com/pytest-dev/pytest-cov/commit/74eb4cc8b684269b89735e31b623f0f9795c5d5c"><code>74eb4cc</code></a>
perf: only call summary when the report will be used</li>
<li>Additional commits viewable in <a
href="https://github.com/pytest-dev/pytest-cov/compare/v4.0.0...v4.1.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pytest-cov&package-manager=pip&previous-version=4.0.0&new-version=4.1.0)](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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver:patch A change requiring a patch version bump type:bug A general bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants