Skip to content

Don't test forward compatibility in qpy compat tests (backport #11101) #11150

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

Merged
merged 1 commit into from
Oct 30, 2023

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 30, 2023

This is an automatic backport of pull request #11101 done by Mergify.


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

* Don't test forward compatibility in qpy compat tests

The qpy compatibility tests are designed to test backwards
compatibility. They generate QPY files using all historical releases
of Qiskit with QPY support and test that all proposed changes are
able to load the qpy files. There was an underlying assumption to how
the tests were written that the version under test is always newer
than all the historical releases. This has been true in the past because
the release model for qiskit mean that we were maintaining at most one
stable release at a time, and when we released a new minor version of
qiskit we retired the previous minor version release series's branch.
However, moving forward this assumption will no longer be true as we're
moving to a model where we support > 1 branch at a time. When we start
supporting > 1 release series at a time, PRs proposed to the older
stable branches will no longer be able to test all releases because QPY
only support backwards compatibility and will not be able to load QPY
files generated from newer releases. The example of this was in the
0.25.x series, there is overlap in the support of the stable/0.25 branch
and the stable/0.45 branch, and after the release of 0.45.0rc1 the tests
started to fail because you can't load QPY files generated with
0.45.0rc1 with 0.25.x.

This commit address this by adding a condition to the QPY compat scripts
to ensure that the version under test is >= the QPY file source version.
If we encounter that scenario we just skip the tests. This should
prevent this situation from occurring for future releases as we expand
our support windows.

* Fix syntax errors

* Use a Python script to compare versions

This commit adds a small python script to compare two version strings
and determine whether the version under test is newer (or the same) as
the source version. The logic for making this determination was a bit
more involved in bash, so using a python script lets us reuse the regex
built into qpy's interface to support this comparison already.

* Fix lint

* Fix return code with invalid version

This commit fixes the return code generation if an invalid comparison is
requested. We want to handle this with a 0 return code to treat it as a
skip, but the previous logic would error before we evaluated the if
statement.

Co-authored-by: Jake Lishman <jake.lishman@ibm.com>

---------

Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
(cherry picked from commit 2b5503c)
@mergify mergify bot requested a review from a team as a code owner October 30, 2023 20:22
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

  • @Qiskit/terra-core
  • @mtreinish
  • @nkanazawa1989

@github-actions github-actions bot added type: qa Issues and PRs that relate to testing and code quality Changelog: None Do not include in changelog labels Oct 30, 2023
@github-actions github-actions bot added this to the 0.45.0 milestone Oct 30, 2023
@jakelishman jakelishman enabled auto-merge October 30, 2023 20:26
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6698303203

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 2 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.02%) to 86.911%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/expr.rs 1 93.76%
crates/qasm2/src/lex.rs 1 91.16%
Totals Coverage Status
Change from base Build 6696437722: 0.02%
Covered Lines: 73893
Relevant Lines: 85021

💛 - Coveralls

@jakelishman jakelishman added this pull request to the merge queue Oct 30, 2023
Merged via the queue into stable/0.45 with commit 56cd2f2 Oct 30, 2023
@mergify mergify bot deleted the mergify/bp/stable/0.45/pr-11101 branch October 30, 2023 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog type: qa Issues and PRs that relate to testing and code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants