Add a Diff Visitor for BlueprintZoneConfigs #7336
Open
Conversation
This file contains 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 visitor walks a diffus generated diff and provides callbacks for users to hook into the parts of the diff that they care about. To keep things minimal, we don't provide callback trait methods for copies (when nothing changes), and we don't provide methods for most diffus_derive generated types (the ones that start with `Edited`). We anticipate composing these visitors to build up a full diff of a Blueprint. They can also be used individually as demonstrated with the included property based test. In order to easily generate `BlueprintZoneConfigs` for property tests we derived `Arbitrary` for `BlueprintZoneConfigs` and its fields using the `test-strategy` crate. Some of the types in the hierarchy don't actually implement `Arbitrary` and they come from foreign crates. In this case a corresponding generation strategy was added that allows those types to be generated based on more primitive types that do implement arbitrary. This PR is just one of many coming to build up and use automated blueprint diffs. It builds on the following PRs which must be merged in first: * oxidecomputer/newtype-uuid#56 * oxidecomputer/diffus#8
andrewjstone
commented
Jan 11, 2025
| @@ -369,7 +369,8 @@ derive-where = "1.2.7" | |||
| # Having the i-implement-... feature here makes diesel go away from the workspace-hack | |||
| diesel = { version = "2.2.4", features = ["i-implement-a-third-party-backend-and-opt-into-breaking-changes", "postgres", "r2d2", "chrono", "serde_json", "network-address", "uuid"] } | |||
| diesel-dtrace = "0.4.2" | |||
| diffus = { git = "https://github.com/oxidecomputer/diffus", branch = "oxide/main", features = ["uuid-impl", "derive", "newtype-uuid-impl", "oxnet-impl"] } | |||
| #diffus = { git = "https://github.com/oxidecomputer/diffus", branch = "oxide/main", features = ["uuid-impl", "derive", "newtype-uuid-impl", "oxnet-impl"] } | |||
There was a problem hiding this comment.
This and newtype-uuid below must be merged first and this must be updated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This visitor walks a diffus generated diff and provides callbacks for users to hook into the parts of the diff that they care about.
To keep things minimal, we don't provide callback trait methods for copies (when nothing changes), and we don't provide methods for most diffus_derive generated types (the ones that start with
Edited).We anticipate composing these visitors to build up a full diff of a Blueprint. They can also be used individually as demonstrated with the included property based test.
In order to easily generate
BlueprintZoneConfigsfor property tests we derivedArbitraryforBlueprintZoneConfigsand its fields using thetest-strategycrate. Some of the types in the hierarchy don't actually implementArbitraryand they come from foreign crates. In this case a corresponding generation strategy was added that allows those types to be generated based on more primitive types that do implement arbitrary.This PR is just one of many coming to build up and use automated blueprint diffs. It builds on the following PRs which must be merged in first: