[WIP] [reconfigurator] introduce a simulator, make CLI use it #6856
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
Created using spr 1.3.6-beta.1
sunshowers
commented
Oct 14, 2024
| @@ -0,0 +1,3 @@ | |||
| // This Source Code Form is subject to the terms of the Mozilla Public | |||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | |||
| // file, You can obtain one at https://mozilla.org/MPL/2.0/. | |||
There was a problem hiding this comment.
TODO: remove this file
| //! | ||
| //! This library contains facilities to track and simulate successive system | ||
| //! states in the face of reconfiguration events. The library uses an operation | ||
| //! log internally to make it possible to rewind to previous states. |
There was a problem hiding this comment.
TODO: expand on this
sunshowers
commented
Oct 14, 2024
sunshowers
commented
Oct 14, 2024
sunshowers
commented
Oct 14, 2024
Comment on lines
+811
to
+813
| struct SubnetIterator { | ||
| subnets: Ipv6Subnets, | ||
| } |
There was a problem hiding this comment.
Can split this into its own PR.
sunshowers
commented
Oct 14, 2024
|
|
||
| use crate::errors::{DuplicateError, MissingError, NonEmptySystemError}; | ||
|
|
||
| /// A versioned, simulated reconfigurator system. |
There was a problem hiding this comment.
More documentation.
Created using spr 1.3.6-beta.1
Created using spr 1.3.6-beta.1
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.
For non-deterministic testing, it's useful to have a higher-level notion of a
succession of system states, which can be inspected, rewound, and other
branches explored as desired. Introduce this via a new
Simulatorstruct.The individual states are roughly identical to the existing
ReconfiguratorSimin the CLI, and are a pretty standard tree structure. Fornow I've chosen not to use a Merkle tree, just a UUID-based tree, but if
there's a good use case for it we may choose to make it a Merkle tree in the
future.
I've added a few basic features like storing the log of changes (though it's
not complete... I think I'll want to make
SystemDescriptionfollow the samestructure with read-only and mutable versions.)
As a proof of concept, this PR also rebuilds the current reconfigurator-cli
script on top of the simulator. I've not made any functional changes to the
CLI, but hope to add features like looking at the tree of states and undoing
them, and with non-deterministic testing to be able to load up the tree of
states.
The simulator uses a bunch of structural sharing via
Arc. I was wonderingwhether I could use the
imcrate, but it doesn't seem to have anIndexMapequivalent, but it doesn't seem to have an
IndexMapequivalent that I couldtell. The
Arcs should make cloning cheap enough that I don't think it's anissue in any case. (There's a comment in the PR about why I haven't used an
object-store-like style instead -- it's just easier to use
Arcfor now.)There's a bunch of work to be done before this can be landed, but I wanted to
put it up for folks to have an early look.
TODO fill this out in more detail.