Merge pull request #387 from asteris-llc/feature/dont-render-module-deps

Don't render module dependencies

.gitignore

@@ -36,6 +36,7 @@ build
 
 # docs
 docs/extract
+docs/converge
 docs/resources.mk
 docs/public
 

docs/Makefile

@@ -1,7 +1,7 @@
 TASKFILE=../resource/resource.go
 TASKLOC=${TASKFILE}:\#$(shell grep -b 'type Task interface' ${TASKFILE} | cut -d: -f1)
 
-public: content/*.md static/**/* content/resources content/license.md
+public: content/*.md static/**/* content/resources content/license.md static/images/**/*.png
 	hugo
 
 publish:
@@ -41,6 +41,26 @@ resources.mk: sources.csv resourceContent.mk.tmpl
         -e "s|@@TARGET|content/resources/$$(echo $$line | cut -d, -f1 | tr -d '\n').md|g" \
         resourceContent.mk.tmpl >> $@; \
     echo >> $@; \
-  done
+	done
+
+# Images
+
+converge:
+	go build ..
+
+static/images/dependencies/with-depends.png: static/images/dependencies/with-depends.hcl converge
+	./converge graph --local $< | dot -Tpng -o$@
+
+static/images/dependencies/without-depends.png: static/images/dependencies/without-depends.hcl converge
+	./converge graph --local $< | dot -Tpng -o$@
+
+static/images/getting-started/hello-world.png: static/images/getting-started/hello-world.hcl converge
+	./converge graph --local --show-params $< | dot -Tpng -o$@
+
+static/images/getting-started/hello-world-params.png: static/images/getting-started/hello-world-params.hcl converge
+	./converge graph --local --show-params $< | dot -Tpng -o$@
+
+static/images/getting-started/hello-you.png: static/images/getting-started/hello-you.hcl converge
+	./converge graph --local --show-params $< | dot -Tpng -o$@
 
 .PHONY=publish

docs/static/images/dependencies/with-depends.hcl

@@ -0,0 +1,11 @@
+task "names" {
+  check = "test -d names"
+  apply = "mkdir names"
+}
+
+file.content "hello" {
+  destination = "names/hello.txt"
+  content     = "Hello, World!"
+
+  depends = ["task.names"] # added in the resource that needs the dependency
+}

docs/static/images/dependencies/without-depends.hcl

@@ -0,0 +1,9 @@
+task "names" {
+  check = "test -d names"
+  apply = "mkdir names"
+}
+
+file.content "hello" {
+  destination = "names/hello.txt"
+  content     = "Hello, World!"
+}

docs/static/images/getting-started/hello-world-params.hcl

@@ -0,0 +1,8 @@
+param "name" {
+  default = "World"
+}
+
+file.content "render" {
+  destination = "hello.txt"
+  content     = "Hello, {{param `name`}}!"
+}

docs/static/images/getting-started/hello-world.hcl

@@ -0,0 +1,4 @@
+file.content "render" {
+  destination = "hello.txt"
+  content     = "Hello, World!"
+}

docs/static/images/getting-started/hello-you.hcl

@@ -0,0 +1,5 @@
+module "hello-world-params.hcl" "hello" {
+  params {
+    name = "Spartacus"
+  }
+}

prettyprinters/graphviz/graphviz.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/asteris-llc/converge/graph"
 	pp "github.com/asteris-llc/converge/prettyprinters"
+	"github.com/asteris-llc/converge/rpc/pb"
 )
 
 // SubgraphMarkerKey is a type alias for an integer and represents the state
@@ -221,9 +222,15 @@ func (p *Printer) DrawEdge(g *graph.Graph, id1, id2 string) (pp.Renderable, erro
 	attributes := p.printProvider.EdgeGetProperties(sourceEntity, destEntity)
 	maybeSetProperty(attributes, "label", escapeNewline(label))
 
+	srcVert, sok := srcVal.(*pb.GraphComponent_Vertex)
+	destVert, dok := destVal.(*pb.GraphComponent_Vertex)
+	if sok && dok && srcVert.Kind == "module" && destVert.Kind != "module" {
+		return pp.HiddenString(), nil
+	}
+
 	edgeStr := fmt.Sprintf("\"%s\" -> \"%s\" %s;\n",
-		escapeNewline(sourceVertex),
 		escapeNewline(destVertex),
+		escapeNewline(sourceVertex),
 		buildAttributeString(attributes),
 	)
 	visible := sourceVertex.Visible() && destVertex.Visible()

prettyprinters/graphviz/graphviz_test.go

@@ -148,8 +148,8 @@ func Test_DrawEdge_SetsSourceAndDestVertexToSourceAndDest(t *testing.T) {
 	printer := graphviz.New(graphviz.DefaultOptions(), provider)
 	dotSource, _ := printer.DrawEdge(edgeTestGraph(), "A", "B")
 	sourceVertex, destVertex := parseDotEdge(dotSource)
-	assert.Equal(t, "A", sourceVertex)
-	assert.Equal(t, "B", destVertex)
+	assert.Equal(t, "B", sourceVertex)
+	assert.Equal(t, "A", destVertex)
 }
 
 func Test_DrawEdge_WhenFirstVertexIDReturnsError_ReturnsError(t *testing.T) {

prettyprinters/graphviz/providers/rpc.go

@@ -21,8 +21,12 @@ import (
 
 	pp "github.com/asteris-llc/converge/prettyprinters"
 	"github.com/asteris-llc/converge/prettyprinters/graphviz"
+	"github.com/asteris-llc/converge/resource/docker/container"
+	"github.com/asteris-llc/converge/resource/docker/image"
 	"github.com/asteris-llc/converge/resource/file/content"
+	"github.com/asteris-llc/converge/resource/file/directory"
 	"github.com/asteris-llc/converge/resource/param"
+	"github.com/asteris-llc/converge/resource/wait/port"
 	"github.com/asteris-llc/converge/rpc/pb"
 	"github.com/pkg/errors"
 )
@@ -62,7 +66,8 @@ func (p RPCProvider) VertexGetLabel(e graphviz.GraphEntity) (pp.VisibleRenderabl
 	if e.Name == rootNodeID {
 		name = "/"
 	} else {
-		name = strings.Split(e.Name, "root/")[1]
+		parts := strings.Split(e.Name, "/")
+		name = parts[len(parts)-1]
 	}
 
 	val, ok := e.Value.(*pb.GraphComponent_Vertex)
@@ -79,6 +84,14 @@ func (p RPCProvider) VertexGetLabel(e graphviz.GraphEntity) (pp.VisibleRenderabl
 
 		return pp.VisibleString(fmt.Sprintf("File: %s", dest.Destination)), nil
 
+	case "file.directory":
+		var dest = new(directory.Directory)
+		if err := json.Unmarshal(val.Details, dest); err != nil {
+			return nil, errors.Wrap(err, "could not unmarshal directory")
+		}
+
+		return pp.VisibleString(fmt.Sprintf("Directory: %s", dest.Destination)), nil
+
 	case "module":
 		return pp.VisibleString(fmt.Sprintf("Module: %s", name)), nil
 
@@ -93,6 +106,30 @@ func (p RPCProvider) VertexGetLabel(e graphviz.GraphEntity) (pp.VisibleRenderabl
 			p.ShowParams,
 		), nil
 
+	case "docker.image":
+		var dest = new(image.Image)
+		if err := json.Unmarshal(val.Details, dest); err != nil {
+			return nil, errors.Wrap(err, "could not unmarshal docker image")
+		}
+
+		return pp.VisibleString(fmt.Sprintf("Docker Image: %s:%s", dest.Name, dest.Tag)), nil
+
+	case "docker.container":
+		var dest = new(container.Container)
+		if err := json.Unmarshal(val.Details, dest); err != nil {
+			return nil, errors.Wrap(err, "could not unmarshal docker container")
+		}
+
+		return pp.VisibleString(fmt.Sprintf("Docker Container: %s", dest.Name)), nil
+
+	case "wait.port":
+		var dest = new(port.Port)
+		if err := json.Unmarshal(val.Details, dest); err != nil {
+			return nil, errors.Wrap(err, "could not unmarshal docker port")
+		}
+
+		return pp.VisibleString(fmt.Sprintf("Wait: %s:%d", dest.Host, dest.Port)), nil
+
 	default:
 		return pp.VisibleString(name), nil
 	}
@@ -113,8 +150,14 @@ func (p RPCProvider) VertexGetProperties(e graphviz.GraphEntity) graphviz.Proper
 	case "task":
 		properties["shape"] = "component"
 
-	case "file.content":
+	case "file.content", "file.directory":
 		properties["shape"] = "tab"
+
+	case "module":
+		properties["shape"] = "folder"
+
+	case "docker.image", "docker.container":
+		properties["shape"] = "box3d"
 	}
 
 	return properties