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

release-23.2: roachtest: allow tests to specify a cockroach binary to use #114060

Merged
merged 4 commits into from
Nov 10, 2023

Conversation

DarrylWong
Copy link
Contributor

Backport 3/3 commits from #113301.

/cc @cockroachdb/release

Release Justification: test-only change


Currently, roachtests must manually upload their own cockroach binary if needed through the Put API.
However, almost all roachtests upload the standard t.Cockroach() binary to ./cockroach on all nodes,
resulting in the same Put code being duplicated at the start of most tests. Additionally, to collect artifacts
we still need a cockroach binary at a discoverable path, leading to the same binary being copied twice in many
cases, see: #97814

This change adds a TestSpec option which lets tests specify a cockroach binary to use. If one is not specified,
we now upload the t.Cockroach() binary to ./cockroach. This lets us remove cockroach-default logic for artifacts,
and removes the need to manually upload binaries at the start of each test.

Release note: None
Fixes: #104729

Currently, roachtests must manually upload their own cockroach binary if needed through the Put API.
However, almost all roachtests upload the standard t.Cockroach() binary to ./cockroach on all nodes,
resulting in the same Put code being duplicated at the start of most tests. Additionally, to collect artifacts
we still need a cockroach binary at a discoverable path, leading to the same binary being copied twice in many
cases, see: cockroachdb#97814

This change adds a TestSpec option which lets tests specify a cockroach binary to use. If one is not specified,
we now upload the t.Cockroach() binary to ./cockroach. This lets us remove cockroach-default logic for artifacts,
and removes the need to manually upload binaries at the start of each test.

Release note: None
Fixes: cockroachdb#104729
This change prints the cockroach random seed used by metamorphic
builds to test.log for ease of debugging. Before this seed was found
only in cockroach.log.
@DarrylWong DarrylWong requested a review from a team as a code owner November 8, 2023 18:34
@DarrylWong DarrylWong requested review from srosenberg and renatolabs and removed request for a team November 8, 2023 18:34
Copy link

blathers-crl bot commented Nov 8, 2023

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL and one additional
    TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Nov 8, 2023
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@yuzefovich
Copy link
Member

This needs to include #114212.

@DarrylWong DarrylWong force-pushed the backport23.2-113301 branch 2 times, most recently from 2cae3a5 to 5c182d1 Compare November 10, 2023 18:35
@DarrylWong
Copy link
Contributor Author

Thanks, added 👍

RFAL @renatolabs

A little old but heres a low prob test run I did

@renatolabs
Copy link
Contributor

I don't see #114212; did you forget to push?

@DarrylWong
Copy link
Contributor Author

Ahh, i just added the changes to my own commit. In hindsight for book keeping I see why just adding the commit would be better. Should i revert the changes and do that?

@renatolabs
Copy link
Contributor

Oh, I see! Yes, cherry-picking the commits individually would be better, it is quite confusing to have the "same" commit doing different things across branches.

Before if a test uploaded a non t.Cockroach() binary github posting
would have no knowledge of that and naively use t.Cockroach() to
determine metamorphism or not. This fixes that.
@DarrylWong
Copy link
Contributor Author

Done.

Good to know that!

@DarrylWong
Copy link
Contributor Author

TFTR!

bors r=renatolabs

@craig
Copy link
Contributor

craig bot commented Nov 10, 2023

👎 Rejected by label

@renatolabs
Copy link
Contributor

Ops 🙂 This is a backport (i.e., no bors).

@DarrylWong DarrylWong merged commit 9a06105 into cockroachdb:release-23.2 Nov 10, 2023
@DarrylWong
Copy link
Contributor Author

🤦

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants