readyset icon indicating copy to clipboard operation
readyset copied to clipboard

Test for changes to CLI flags

Open ethan-readyset opened this issue 2 years ago • 2 comments

Description

Cloud relies on the consistency of our CLI flags. There have been instances where we've introduced a breaking change to our CLI flags and broken part of Cloud in the process. To avoid this, we should add a simple integration test that will fail if our CLI flags change or if the values accepted by our CLI flags change.

One way to do this would be to dump a "schema" of our CLI options by serializing the relevant struct definitions and writing it to disk. When this schema is changed, it would force us to deliberately write a new schema file to avoid the test failure. We should also add a comment near the test that reminds the developer making the change to check with the Cloud team to make sure the change doesn't break part of Cloud.

Change in user-visible behavior

No

Requires documentation change

No

ethan-readyset avatar Oct 24 '23 21:10 ethan-readyset

We should, at a minimum, add a test that breaks when CLI flags change.

gvsg-rs avatar Nov 03 '23 18:11 gvsg-rs

NOTE: this test(s) needs to include env vars, as well.

jasobrown-rs avatar Nov 08 '23 20:11 jasobrown-rs