Use a new way to compare the dot object

Author: RyanSiu1995

go.mod

@@ -10,5 +10,5 @@ require (
 	github.com/spf13/cobra v1.0.0
 	github.com/stretchr/testify v1.5.1
 	google.golang.org/api v0.21.0
-	gopkg.in/yaml.v2 v2.2.8 // indirect
+	gopkg.in/yaml.v2 v2.2.8
 )

internal/utils/cloudbuild_test.go

@@ -3,6 +3,7 @@ package util
 import (
 	"bytes"
 	"fmt"
+	"gopkg.in/yaml.v2"
 	"io/ioutil"
 	"os"
 	"path"
@@ -11,11 +12,20 @@ import (
 	"testing"
 
 	graphviz "github.com/goccy/go-graphviz"
+	"github.com/goccy/go-graphviz/cgraph"
 	"github.com/stretchr/testify/assert"
 )
 
 var supportedFormat = []string{".yaml", ".yml", ".json"}
 
+type result struct {
+	Nodes []string `yaml:"nodes"`
+	Edges []struct {
+		From string `yaml:"from"`
+		To   string `yaml:"to"`
+	} `yaml:"edges"`
+}
+
 func init() {
 	// Change the current working dir to root dir
 	os.Chdir("../../")
@@ -35,24 +45,51 @@ func TestYamlToDAG(t *testing.T) {
 	}
 	for _, file := range testFiles {
 		t.Run(fmt.Sprintf("TestYamlToDAG:%s", file), func(t *testing.T) {
-			g := graphviz.New()
 			cloudBuild, err := ParseYaml(file)
 			assert.Empty(t, err)
 			graph := BuildStepsToDAG(cloudBuild.Steps)
-			var buf bytes.Buffer
-			err = g.Render(graph, "dot", &buf)
-			assert.Empty(t, err)
-			dotFilePath := getDotFilePath(file)
-			expected, err := ioutil.ReadFile(dotFilePath)
 			assert.Empty(t, err)
-			assert.Equal(t, strings.ReplaceAll(string(expected), "\r\n", "\n"), buf.String())
+
+			expectedResult := getExpectedResult(file)
+			isExpectedGraph(t, expectedResult, graph)
 		})
 	}
 }
 
-func getDotFilePath(filePath string) string {
+func getExpectedResult(filePath string) *result {
 	ext := path.Ext(filePath)
 	_, filename := filepath.Split(filePath)
-	dotFile := filename[0:len(filename)-len(ext)] + ".dot"
-	return filepath.Join("./", "test", "fixtures", "dot", dotFile)
+	yamlFile := filename[0:len(filename)-len(ext)] + ".graph.yaml"
+	fullPath := filepath.Join("./", "test", "fixtures", "graph", yamlFile)
+	resultObj := result{}
+	buf, _ := ioutil.ReadFile(fullPath)
+	yaml.Unmarshal(buf, &resultObj)
+	return &resultObj
+}
+
+func isExpectedGraph(t *testing.T, expected *result, actual *cgraph.Graph) {
+	assert.Equalf(t, len(expected.Nodes), actual.NumberNodes(), "Should have the same number of nodes.")
+	for _, node := range expected.Nodes {
+		n, err := actual.Node(node)
+		assert.Empty(t, err)
+		assert.NotEmptyf(t, n, "Expected Node %s but not found in generated graph", node)
+	}
+	assert.Equalf(t, len(expected.Edges), actual.NumberEdges(), "Should have the same number of edges.")
+	var buf bytes.Buffer
+	g := graphviz.New()
+	g.Render(actual, "dot", &buf)
+	actualOutput := buf.String()
+	for _, edge := range expected.Edges {
+		edge.From = sanitizeDotString(edge.From)
+		edge.To = sanitizeDotString(edge.To)
+		edgeInDot := fmt.Sprintf("%s -> %s", edge.From, edge.To)
+		assert.Truef(t, strings.Contains(actualOutput, edgeInDot), "Should contain the edge \"%s\"\n Actual: %s", edgeInDot, actualOutput)
+	}
+}
+
+func sanitizeDotString(s string) string {
+	if strings.Contains(s, " ") {
+		return fmt.Sprintf("\"%s\"", s)
+	}
+	return s
 }

test/fixtures/graph/cloudbuild.immediately_start.001.graph.yaml

@@ -0,0 +1,12 @@
+nodes:
+- A
+- B
+- C
+- D
+edges:
+- from: A
+  to: C
+- from: B
+  to: C
+- from: C
+  to: D

test/fixtures/graph/cloudbuild.normal.001.graph.yaml

@@ -0,0 +1,12 @@
+nodes:
+- Step 0
+- Step 1
+- Step 2
+- Step 3
+edges:
+- from: Step 0
+  to: Step 1
+- from: Step 1
+  to: Step 2
+- from: Step 2
+  to: Step 3

test/fixtures/graph/cloudbuild.normal.002.graph.yaml

@@ -0,0 +1,12 @@
+nodes:
+- Step 0
+- Step 1
+- Step 2
+- Step 3
+edges:
+- from: Step 0
+  to: Step 1
+- from: Step 1
+  to: Step 2
+- from: Step 2
+  to: Step 3

test/fixtures/graph/cloudbuild.waitFor.001.graph.yaml

@@ -0,0 +1,10 @@
+nodes:
+- A
+- Step 2
+- B
+- Step 3
+edges:
+- from: A
+  to: Step 2
+- from : B
+  to: Step 3

test/fixtures/graph/cloudbuild.waitFor.002.graph.yaml

@@ -0,0 +1,12 @@
+nodes:
+- A
+- C
+- B
+- D
+edges:
+- from: A
+  to: C
+- from: B
+  to: C
+- from: B
+  to: D

test/fixtures/graph/cloudbuild.waitFor.003.graph.yaml

@@ -0,0 +1,14 @@
+nodes:
+- A
+- C
+- B
+- D
+edges:
+- from: A
+  to: C
+- from: B
+  to: C
+- from: B
+  to: D
+- from: C
+  to: D