pulumi/pkg/engine/snapshot.go
Sean Gillespie 14baf866f6
Snapshot management overhaul and refactor (#1273)
* Refactor the SnapshotManager interface

Lift snapshot management out of the engine by delegating it to the
SnapshotManager implementation in pkg/backend.

* Add a event interface for plugin loads and use that interface to record plugins in the snapshot

* Remove dead code

* Add comments to Events

* Add a number of tests for SnapshotManager

* CR feedback: use a successful bit on 'End' instead of having a separate 'Abort' API

* CR feedback

* CR feedback: register plugins one-at-a-time instead of the entire state at once
2018-04-25 17:20:08 -07:00

36 lines
1.4 KiB
Go

package engine
import (
"io"
"github.com/pulumi/pulumi/pkg/resource/deploy"
"github.com/pulumi/pulumi/pkg/workspace"
)
// SnapshotManager is responsible for maintaining the in-memory representation
// of the current state of the resource world.
type SnapshotManager interface {
io.Closer
// BeginMutation signals to the SnapshotManager that the planner intends to mutate the global
// snapshot. It provides the step that it intends to execute. Based on that step, BeginMutation
// will record this intent in the global snapshot and return a `SnapshotMutation` that, when ended,
// will complete the transaction.
BeginMutation(step deploy.Step) (SnapshotMutation, error)
// RegisterResourceOutputs registers the set of resource outputs generated by performing the
// given step. These outputs are persisted in the snapshot.
RegisterResourceOutputs(step deploy.Step) error
// RecordPlugin records that the current plan loaded a plugin and saves it in the snapshot.
RecordPlugin(plugin workspace.PluginInfo) error
}
// SnapshotMutation represents an outstanding mutation that is yet to be completed. When the engine completes
// a mutation, it must call `End` in order to record the successful completion of the mutation.
type SnapshotMutation interface {
// End terminates the transaction and commits the results to the snapshot, returning an error if this
// failed to complete.
End(step deploy.Step, successful bool) error
}