Repository navigation
acc: add plan_filter.py to keep backend-owned remote_state out of plan goldens #7764
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
+193
−216
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| #!/usr/bin/env python3 | ||
| """Read `bundle plan -o json` on stdin and write the part of it a golden should record. | ||
|
|
||
| A plan entry's remote_state is the backend's GET payload, copied as is: it carries | ||
| backend-computed fields (status, timestamps, sizes, UIDs) and every field the backend | ||
| starts or stops returning. Recording it makes a golden fail on backend changes that | ||
| leave the CLI's decision (action, new_state, changes) untouched, often on every cloud | ||
| and test at once. This drops remote_state from every entry; changes[*].remote still | ||
| records the remote value of each field with a change entry. | ||
|
|
||
| Also removes the deployment stamp, as nostamp.py does, so it replaces | ||
| `nostamp | jq '.plan["KEY"] | del(.remote_state)'`. | ||
|
|
||
| Usage: | ||
| $CLI bundle plan -o json | plan_filter.py # whole plan | ||
| $CLI bundle plan -o json | plan_filter.py resources.jobs.foo # one entry | ||
|
|
||
| A test that asserts on remote_state itself should not use this. | ||
| """ | ||
|
|
||
| import argparse | ||
| import json | ||
| import sys | ||
|
|
||
| import nostamp | ||
|
|
||
|
|
||
| def filter_plan(data, key=None): | ||
| entries = data.get("plan") if isinstance(data, dict) else None | ||
| if not isinstance(entries, dict): | ||
| raise SystemExit("plan_filter.py: input is not a plan: no 'plan' object") | ||
| for entry in entries.values(): | ||
| if isinstance(entry, dict): | ||
| entry.pop("remote_state", None) | ||
| if key is None: | ||
| return data | ||
| if key not in entries: | ||
| raise SystemExit(f"plan_filter.py: no plan entry {key!r}; entries: {sorted(entries)}") | ||
| return entries[key] | ||
|
|
||
|
|
||
| def main(): | ||
| parser = argparse.ArgumentParser() | ||
| parser.add_argument("key", nargs="?", help="resource key of the one entry to print, e.g. resources.jobs.foo") | ||
| args = parser.parse_args() | ||
| text = sys.stdin.read() | ||
| try: | ||
| data = json.loads(text) | ||
| except json.JSONDecodeError as ex: | ||
| raise SystemExit(f"plan_filter.py: input is not JSON ({ex}): {text[:200]!r}") from None | ||
| data = filter_plan(data, args.key) | ||
| sys.stdout.write(nostamp.render(data, 2) + "\n") | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.