Exclude non-rc pre-releases from qpy backwards compat tests #11572
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The QPY backwards compatibility tests are setup to verify that we can load qpy files generated with historical releases using the current version of Qiskit under development. This ensures we're meeting our backwards compatibility guarantees with QPY. However, the tests were over eagerly running on pre-releases that don't have any stability guarantees, mainly alpha and beta releases indicated by "a" and "b" suffixes respectively in the version number. This commit excludes these pre-release versions from the tests as it's not valid to run with these. Release candidate pre-releases should still be run because they have stable APIs and they're not skipped by this PR.
mtreinish
added
type: qa
|
One or more of the the following people are requested to review this:
|
jakelishman
reviewed
Jan 16, 2024
Comment on lines
+32
to
39
| # Exclude any non-rc pre-releases as they don't have stable API guarantees | ||
| if [[ $version == *"b"* || $version == *"a"* ]] ; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| # If the source version is newer than the version under test exit fast because | ||
| # there is no QPY compatibility for loading a qpy file generated from a newer | ||
| # release with an older release of Qiskit. |
There was a problem hiding this comment.
Just below these lines we call out to a Python script compare_versions.py, which makes a general comparison. Maybe we ought to move the logic to there, and handle proper version normalisation in Python with packaging.version? We intend to only use the canonical forms of versions, but the logic's all going to be easier to verify if it's in Python space with typed objects.
There was a problem hiding this comment.
I can move it to python space, but compare_versions.py isn't actually using packaging.version (to avoid needing to check the dependency) it's just using the regex to match the version parts. So I'd probably just basically be doing 'a' in match.group('pre') or 'b' in match.group('pre')
There was a problem hiding this comment.
Oh, fair enough, in that case let's just leave it in bash.
Pull Request Test Coverage Report for Build 7542647377
💛 - Coveralls |
jakelishman
approved these changes
Jan 16, 2024
There was a problem hiding this comment.
Looks like it's working correctly:
+ version=1.0.0b1
+ parts=(${version//./ })
++ ./qiskit_venv/bin/python -c 'import qiskit;print(qiskit.__version__)'
+ qiskit_version=1.0.0
+ qiskit_parts=(${qiskit_version//./ })
+ [[ 1 -eq 0 ]]
+ [[ 1.0.0b1 == *\b* ]]
+ exit 0
mergify bot
pushed a commit
that referenced
this pull request
Jan 16, 2024
The QPY backwards compatibility tests are setup to verify that we can load qpy files generated with historical releases using the current version of Qiskit under development. This ensures we're meeting our backwards compatibility guarantees with QPY. However, the tests were over eagerly running on pre-releases that don't have any stability guarantees, mainly alpha and beta releases indicated by "a" and "b" suffixes respectively in the version number. This commit excludes these pre-release versions from the tests as it's not valid to run with these. Release candidate pre-releases should still be run because they have stable APIs and they're not skipped by this PR. (cherry picked from commit abb803f)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 17, 2024
…11574) The QPY backwards compatibility tests are setup to verify that we can load qpy files generated with historical releases using the current version of Qiskit under development. This ensures we're meeting our backwards compatibility guarantees with QPY. However, the tests were over eagerly running on pre-releases that don't have any stability guarantees, mainly alpha and beta releases indicated by "a" and "b" suffixes respectively in the version number. This commit excludes these pre-release versions from the tests as it's not valid to run with these. Release candidate pre-releases should still be run because they have stable APIs and they're not skipped by this PR. (cherry picked from commit abb803f) Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The QPY backwards compatibility tests are setup to verify that we can load qpy files generated with historical releases using the current version of Qiskit under development. This ensures we're meeting our backwards compatibility guarantees with QPY. However, the tests were over eagerly running on pre-releases that don't have any stability guarantees, mainly alpha and beta releases indicated by "a" and "b" suffixes respectively in the version number. This commit excludes these pre-release versions from the tests as it's not valid to run with these. Release candidate pre-releases should still be run because they have stable APIs and they're not skipped by this PR.
Details and comments