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

Do not use the word "snapshot" for upgrade test data #34

Open
t0yv0 opened this issue Nov 22, 2023 · 2 comments
Open

Do not use the word "snapshot" for upgrade test data #34

t0yv0 opened this issue Nov 22, 2023 · 2 comments
Labels
kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features

Comments

@t0yv0
Copy link
Member

t0yv0 commented Nov 22, 2023

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

Multiple engineers are confused by how upgrade tests work specifically PreviewOnly and snapshot recording. It appears that the use of the word "snapshot" seems to lead people to believe these are golden tests, and recording snapshots should make failing tests pass by accepting the current behavior as the new correct behavior. This is currently not what's happening though.

Suggestion here is to try to come up with a better name and not use "snapshot".

I'm still thinking of a good name..

A verbose explanation of what the providertest system is doing, currently, when recording "snapshots". For baseline dependency version set (which is typically something like the last major provider release), the system runs the program against the cloud to observe the actual behavior and record what is happening. These records are then used to accelerate the tests by mocking out the cloud behavior of the baseline dependencies, so that the test can proceed without hitting the cloud and being slowed down by it. This is currently orthogonal to the test asserts.

Affected area/feature

@t0yv0 t0yv0 added kind/enhancement Improvements or new features needs-triage Needs attention from the triage team labels Nov 22, 2023
@t0yv0
Copy link
Member Author

t0yv0 commented Nov 22, 2023

CC @danielrbradley @VenelinMartinov @thomas11 I saw all of you making good suggestions here that "snapshot" is confusing.

@thomas11
Copy link
Contributor

the system runs the program against the cloud to observe the actual behavior and record what is happening.

Sounds like a snapshot to me.

IMO some of the confusion is more about what an "upgrade test" actually does. It's an assert-clean-diff-against-baseline-recorded-snapshot test which is not the most elegant name :)

@mjeffryes mjeffryes added kind/engineering Work that is not visible to an external user and removed needs-triage Needs attention from the triage team labels Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/engineering Work that is not visible to an external user kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

3 participants