8b5874dab5
This change includes a bunch of refactorings I made in prep for doing refresh (first, the command, see pulumi/pulumi#1081): * The primary change is to change the way the engine's core update functionality works with respect to deploy.Source. This is the way we can plug in new sources of resource information during planning (and, soon, diffing). The way I intend to model refresh is by having a new kind of source, deploy.RefreshSource, which will let us do virtually everything about an update/diff the same way with refreshes, which avoid otherwise duplicative effort. This includes changing the planOptions (nee deployOptions) to take a new SourceFunc callback, which is responsible for creating a source specific to the kind of plan being requested. Preview, Update, and Destroy now are primarily differentiated by the kind of deploy.Source that they return, rather than sprinkling things like `if Destroying` throughout. This tidies up some logic and, more importantly, gives us precisely the refresh hook we need. * Originally, we used the deploy.NullSource for Destroy operations. This simply returns nothing, which is how Destroy works. For some reason, we were no longer doing this, and instead had some `if Destroying` cases sprinkled throughout the deploy.EvalSource. I think this is a vestige of some old way we did configuration, at least judging by a comment, which is apparently no longer relevant. * Move diff and diff-printing logic within the engine into its own pkg/engine/diff.go file, to prepare for upcoming work. * I keep noticing benign diffs anytime I regenerate protobufs. I suspect this is because we're also on different versions. I changed generate.sh to also dump the version into grpc_version.txt. At least we can understand where the diffs are coming from, decide whether to take them (i.e., a newer version), and ensure that as a team we are monotonically increasing, and not going backwards. * I also tidied up some tiny things I noticed while in there, like comments, incorrect types, lint suppressions, and so on.
79 lines
2.7 KiB
Go
79 lines
2.7 KiB
Go
// Copyright 2018, Pulumi Corporation. All rights reserved.
|
|
|
|
package backend
|
|
|
|
import (
|
|
"github.com/pulumi/pulumi/pkg/apitype"
|
|
"github.com/pulumi/pulumi/pkg/engine"
|
|
"github.com/pulumi/pulumi/pkg/resource/config"
|
|
)
|
|
|
|
// UpdateMetadata describes optional metadata about an update.
|
|
type UpdateMetadata struct {
|
|
// Message is an optional message associated with the update.
|
|
Message string `json:"message"`
|
|
// Environment contains optional data from the deploying environment. e.g. the current
|
|
// source code control commit information.
|
|
Environment map[string]string `json:"environment"`
|
|
}
|
|
|
|
// UpdateKind is an enum for the type of update performed.
|
|
type UpdateKind string
|
|
|
|
const (
|
|
// DeployUpdate is the prototypical Pulumi program update.
|
|
DeployUpdate UpdateKind = "update"
|
|
// PreviewUpdate is a preview of an update, without impacting resources.
|
|
PreviewUpdate UpdateKind = "preview"
|
|
// DestroyUpdate is an update which removes all resources.
|
|
DestroyUpdate UpdateKind = "destroy"
|
|
)
|
|
|
|
// UpdateResult is an enum for the result of the update.
|
|
type UpdateResult string
|
|
|
|
const (
|
|
// InProgressResult is for updates that have not yet completed.
|
|
InProgressResult = "in-progress"
|
|
// SucceededResult is for updates that completed successfully.
|
|
SucceededResult UpdateResult = "succeeded"
|
|
// FailedResult is for updates that have failed.
|
|
FailedResult = "failed"
|
|
)
|
|
|
|
// Keys we use for values put into UpdateInfo.Environment.
|
|
const (
|
|
// GitHead is the commit hash of HEAD.
|
|
GitHead = "git.head"
|
|
// GitDirty ("true", "false") indiciates if there are any unstaged or modified files in the local repo.
|
|
GitDirty = "git.dirty"
|
|
|
|
// GitHubLogin is the user/organization who owns the local repo, if the origin remote is hosted on GitHub.com.
|
|
GitHubLogin = "github.login"
|
|
// GitHubRepo is the name of the GitHub repo, if the local git repo's remote origin is hosted on GitHub.com.
|
|
GitHubRepo = "github.repo"
|
|
)
|
|
|
|
// UpdateInfo describes a previous update.
|
|
type UpdateInfo struct {
|
|
// Information known before an update is started.
|
|
Kind UpdateKind `json:"kind"`
|
|
StartTime int64 `json:"startTime"`
|
|
|
|
// Message is an optional message associated with the update.
|
|
Message string `json:"message"`
|
|
|
|
// Environment contains optional data from the deploying environment. e.g. the current
|
|
// source code control commit information.
|
|
Environment map[string]string `json:"environment"`
|
|
|
|
// Config used for the update.
|
|
Config config.Map `json:"config"`
|
|
|
|
// Information obtained from an update completing.
|
|
Result UpdateResult `json:"result"`
|
|
EndTime int64 `json:"endTime"`
|
|
Deployment *apitype.Deployment `json:"deployment,omitempty"`
|
|
ResourceChanges engine.ResourceChanges `json:"resourceChanges,omitempty"`
|
|
}
|