This change supports displaying manifest information for a stack and changes the way we handle Snapshots in our backend. Previously, every call to GetStack would synthesize a Snapshot by taking the set of resources returned from the `/api/stacks/<owner>/<name>` endpoint, combined with an empty manfiest (since the service was not returning the manifest). This wasn't great for two reasons: 1. We didn't have manifest information, so we couldn't display any of its information (most important the last updated time). 2. This strategy required that the service return all the resources for a stack anytime GetStack was called. While the CLI did not often need this detailed information the fact that we forced the Service to produce it (which in the case of stack managed PPC would require the service to talk to yet another service) creates a bunch of work that we end up ignoring. I've refactored the code such that `backend.Stack`'s `Snapshot()` method now lazily requests the information from the service such that we can construct a `Snapshot()` on demand and only pay the cost when we actually need it. I think making more of this stuff lazy is the long term direction we want to follow. Unfortunately, right now, it means in cases where we do need this data we end up fetching it twice. The service does it once when we call GetStack and then we do it again when we actually need to get at the Snapshot. However, once we land this change, we can update the service to no longer return resources on the apistack.Stack type. The CLI no longer needs this property. We'll likely want to continue in a direction where `apistack.Stack` can be created quickly by the service (without expensive database queries or fetching remote resources) and just add additional endpoints that let us get at the specific information we want in the specific cases when we want it instead of forcing us to return a bunch of data that we often ignore. Fixes pulumi/pulumi-service#371
244 lines
7.2 KiB
Go
244 lines
7.2 KiB
Go
// Copyright 2016-2018, Pulumi Corporation.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"os"
|
|
|
|
"github.com/pulumi/pulumi/pkg/graph"
|
|
"github.com/pulumi/pulumi/pkg/graph/dotconv"
|
|
"github.com/pulumi/pulumi/pkg/resource"
|
|
"github.com/pulumi/pulumi/pkg/resource/deploy"
|
|
"github.com/pulumi/pulumi/pkg/util/cmdutil"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// Whether or not we should ignore parent edges when building up our graph.
|
|
var ignoreParentEdges bool
|
|
|
|
// Whether or not we should ignore dependency edges when building up our graph.
|
|
var ignoreDependencyEdges bool
|
|
|
|
// The color of dependency edges in the graph. Defaults to #246C60, a blush-green.
|
|
var dependencyEdgeColor string
|
|
|
|
// The color of parent edges in the graph. Defaults to #AA6639, an orange.
|
|
var parentEdgeColor string
|
|
|
|
func newStackGraphCmd() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "graph",
|
|
Args: cmdutil.ExactArgs(1),
|
|
Short: "Export a stack's dependency graph to a file",
|
|
Long: "Export a stack's dependency graph to a file.\n" +
|
|
"\n" +
|
|
"This command can be used to view the dependency graph that a Pulumi program\n" +
|
|
"admitted when it was ran. This graph is output in the DOT format. This command operates\n" +
|
|
"on your stack's most recent deployment.",
|
|
Run: cmdutil.RunFunc(func(cmd *cobra.Command, args []string) error {
|
|
s, err := requireCurrentStack(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
snap, err := s.Snapshot(commandContext())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
dg := makeDependencyGraph(snap)
|
|
file, err := os.Create(args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := dotconv.Print(dg, file); err != nil {
|
|
_ = file.Close()
|
|
return err
|
|
}
|
|
|
|
cmd.Printf("%sWrote stack dependency graph to `%s`", cmdutil.EmojiOr("🔍 ", ""), args[0])
|
|
cmd.Println()
|
|
return file.Close()
|
|
}),
|
|
}
|
|
|
|
cmd.Flags().BoolVar(&ignoreParentEdges, "ignore-parent-edges", false,
|
|
"Ignores edges introduced by parent/child resource relationships")
|
|
cmd.Flags().BoolVar(&ignoreDependencyEdges, "ignore-dependency-edges", false,
|
|
"Ignores edges introduced by dependency resource relationships")
|
|
cmd.Flags().StringVar(&dependencyEdgeColor, "dependency-edge-color", "#246C60",
|
|
"Sets the color of dependency edges in the graph")
|
|
cmd.Flags().StringVar(&parentEdgeColor, "parent-edge-color", "#AA6639",
|
|
"Sets the color of parent edges in the graph")
|
|
return cmd
|
|
}
|
|
|
|
// All of the types and code within this file are to provide implementations of the interfaces
|
|
// in the `graph` package, so that we can use the `dotconv` package to output our graph in the
|
|
// DOT format.
|
|
//
|
|
// `dependencyEdge` implements graph.Edge, `dependencyVertex` implements graph.Vertex, and
|
|
// `dependencyGraph` implements `graph.Graph`.
|
|
type dependencyEdge struct {
|
|
to *dependencyVertex
|
|
from *dependencyVertex
|
|
}
|
|
|
|
// In this simple case, edges have no data.
|
|
func (edge *dependencyEdge) Data() interface{} {
|
|
return nil
|
|
}
|
|
|
|
// In this simple case, edges have no label.
|
|
func (edge *dependencyEdge) Label() string {
|
|
return ""
|
|
}
|
|
|
|
func (edge *dependencyEdge) To() graph.Vertex {
|
|
return edge.to
|
|
}
|
|
|
|
func (edge *dependencyEdge) From() graph.Vertex {
|
|
return edge.from
|
|
}
|
|
|
|
func (edge *dependencyEdge) Color() string {
|
|
return dependencyEdgeColor
|
|
}
|
|
|
|
// parentEdges represent edges in the parent-child graph, which
|
|
// exists alongside the dependency graph. An edge exists from node
|
|
// A to node B if node B is considered to be a parent of node A.
|
|
type parentEdge struct {
|
|
to *dependencyVertex
|
|
from *dependencyVertex
|
|
}
|
|
|
|
func (edge *parentEdge) Data() interface{} {
|
|
return nil
|
|
}
|
|
|
|
// In this simple case, edges have no label.
|
|
func (edge *parentEdge) Label() string {
|
|
return ""
|
|
}
|
|
|
|
func (edge *parentEdge) To() graph.Vertex {
|
|
return edge.to
|
|
}
|
|
|
|
func (edge *parentEdge) From() graph.Vertex {
|
|
return edge.from
|
|
}
|
|
|
|
func (edge *parentEdge) Color() string {
|
|
return parentEdgeColor
|
|
}
|
|
|
|
// A dependencyVertex contains a reference to the graph to which it belongs
|
|
// and to the resource state that it represents. Incoming and outgoing edges
|
|
// are calculated on-demand using the combination of the graph and the state.
|
|
type dependencyVertex struct {
|
|
graph *dependencyGraph
|
|
resource *resource.State
|
|
incomingEdges []graph.Edge
|
|
outgoingEdges []graph.Edge
|
|
}
|
|
|
|
func (vertex *dependencyVertex) Data() interface{} {
|
|
return vertex.resource
|
|
}
|
|
|
|
func (vertex *dependencyVertex) Label() string {
|
|
return string(vertex.resource.URN)
|
|
}
|
|
|
|
func (vertex *dependencyVertex) Ins() []graph.Edge {
|
|
return vertex.incomingEdges
|
|
}
|
|
|
|
// Outgoing edges are indirectly calculated by traversing the entire graph looking
|
|
// for edges that point to this vertex. This is slow, but our graphs aren't big enough
|
|
// for this to matter too much.
|
|
func (vertex *dependencyVertex) Outs() []graph.Edge {
|
|
return vertex.outgoingEdges
|
|
}
|
|
|
|
// A dependencyGraph is a thin wrapper around a map of URNs to vertices in
|
|
// the graph. It is constructed directly from a snapshot.
|
|
type dependencyGraph struct {
|
|
vertices map[resource.URN]*dependencyVertex
|
|
}
|
|
|
|
// Roots are edges that point to the root set of our graph. In our case,
|
|
// for simplicity, we define the root set of our dependency graph to be everything.
|
|
func (dg *dependencyGraph) Roots() []graph.Edge {
|
|
rootEdges := []graph.Edge{}
|
|
for _, vertex := range dg.vertices {
|
|
edge := &dependencyEdge{
|
|
to: vertex,
|
|
from: nil,
|
|
}
|
|
|
|
rootEdges = append(rootEdges, edge)
|
|
}
|
|
|
|
return rootEdges
|
|
}
|
|
|
|
// Makes a dependency graph from a deployment snapshot, allocating a vertex
|
|
// for every resource in the graph.
|
|
func makeDependencyGraph(snapshot *deploy.Snapshot) *dependencyGraph {
|
|
dg := &dependencyGraph{
|
|
vertices: make(map[resource.URN]*dependencyVertex),
|
|
}
|
|
|
|
for _, resource := range snapshot.Resources {
|
|
vertex := &dependencyVertex{
|
|
graph: dg,
|
|
resource: resource,
|
|
}
|
|
|
|
dg.vertices[resource.URN] = vertex
|
|
}
|
|
|
|
for _, vertex := range dg.vertices {
|
|
if !ignoreDependencyEdges {
|
|
// Incoming edges are directly stored within the checkpoint file; they represent
|
|
// resources on which this vertex immediately depends upon.
|
|
for _, dep := range vertex.resource.Dependencies {
|
|
vertexWeDependOn := vertex.graph.vertices[dep]
|
|
edge := &dependencyEdge{to: vertex, from: vertexWeDependOn}
|
|
vertex.incomingEdges = append(vertex.incomingEdges, edge)
|
|
vertexWeDependOn.outgoingEdges = append(vertexWeDependOn.outgoingEdges, edge)
|
|
}
|
|
}
|
|
|
|
// alongside the dependency graph sits the resource parentage graph, which
|
|
// is also displayed as part of this graph, although with different colored
|
|
// edges.
|
|
if !ignoreParentEdges {
|
|
if parent := vertex.resource.Parent; parent != resource.URN("") {
|
|
parentVertex := dg.vertices[parent]
|
|
vertex.outgoingEdges = append(vertex.outgoingEdges, &parentEdge{
|
|
to: parentVertex,
|
|
from: vertex,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
return dg
|
|
}
|