-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Yiwei
committed
Jul 2, 2020
1 parent
db8f1cf
commit 7327e8e
Showing
6 changed files
with
732 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,279 @@ | ||
| // Copyright 2020 Antrea Authors | ||
| // | ||
| // 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 graphviz | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "log" | ||
| "strings" | ||
|
|
||
| "github.com/goccy/go-graphviz" | ||
| "github.com/goccy/go-graphviz/cgraph" | ||
|
|
||
| opsv1alpha1 "github.com/vmware-tanzu/antrea/pkg/apis/ops/v1alpha1" | ||
| ) | ||
|
|
||
| var ( | ||
| clusterSrcName = "cluster_source" | ||
| clusterDstName = "cluster_dest" | ||
| ) | ||
|
|
||
| func genSubGraph(graph *cgraph.Graph, result *opsv1alpha1.NodeResult, firstNodeName string, dir cgraph.DirType, addNodeNum int) []*cgraph.Node { | ||
| var nodes []*cgraph.Node | ||
| obs := result.Observations | ||
|
|
||
| // Show the name of cluster. | ||
| if len(result.Node) > 0 { | ||
| graph.SetLabel(result.Node) | ||
| if dir == cgraph.ForwardDir { | ||
| graph.SetLabelJust(cgraph.LeftJust) | ||
| } else { | ||
| graph.SetLabelJust(cgraph.RightJust) | ||
| } | ||
| } | ||
|
|
||
| // Construct the first node. Show it only if we know the name of it. | ||
| node, _ := graph.CreateNode(firstNodeName) | ||
| nodes = append(nodes, node) | ||
| if len(firstNodeName) > 0 { | ||
| node.SetFontColor("white") | ||
| node.SetColor("royalblue1") | ||
| node.SetStyle(cgraph.FilledNodeStyle) | ||
| } else { | ||
| node.SetStyle("invis") | ||
| } | ||
|
|
||
| // Reorder the observations according to the direction of edges. | ||
| if dir == cgraph.BackDir { | ||
| for i := len(obs)/2 - 1; i >= 0; i-- { | ||
| opp := len(obs) - 1 - i | ||
| obs[i], obs[opp] = obs[opp], obs[i] | ||
| } | ||
| } | ||
|
|
||
| // Draw the actual observations of traceflow. | ||
| for _, o := range obs { | ||
| // Construct node and edge. | ||
| nodeName := fmt.Sprintf("%s_%d", graph.Name(), len(nodes)) | ||
| node, _ := graph.CreateNode(nodeName) | ||
| node.SetLabel(string(o.Component)) | ||
| node.SetShape(cgraph.BoxShape) | ||
| node.SetStyle(cgraph.RoundedNodeStyle + "," + cgraph.FilledNodeStyle) | ||
| node.SetFontColor("white") | ||
| nodes = append(nodes, node) | ||
| if len(nodes) > 1 { | ||
| edgeName := fmt.Sprintf("%s_%d", graph.Name(), len(nodes)) | ||
| edge, _ := graph.CreateEdge(edgeName, nodes[len(nodes)-2], nodes[len(nodes)-1]) | ||
| edge.SetDir(dir) | ||
| edge.SetPenWidth(3.0) | ||
| edge.SetColor("limegreen") | ||
| if len(nodes) == 2 { | ||
| edge.SetMinLen(1 + addNodeNum) | ||
| } else { | ||
| edge.SetMinLen(1) | ||
| } | ||
| if o.Action == opsv1alpha1.Dropped && dir == cgraph.BackDir { | ||
| edge.SetStyle("invis") | ||
| } | ||
| } | ||
| // Set the pattern of node. | ||
| labelStr := string(o.Component) | ||
| if len(o.ComponentInfo) > 0 { | ||
| labelStr += "\n" + o.ComponentInfo | ||
| } | ||
| labelStr += "\n" + string(o.Action) | ||
| if o.Component == opsv1alpha1.NetworkPolicy && len(o.NetworkPolicy) > 0 { | ||
| labelStr += "\nNetpol: " + o.NetworkPolicy | ||
| } | ||
| if o.Action == opsv1alpha1.Dropped { | ||
| node.SetColor("violet") | ||
| } else { | ||
| node.SetColor("turquoise3") | ||
| if len(o.TunnelDstIP) > 0 { | ||
| labelStr += "\nTo: " + o.TunnelDstIP | ||
| } | ||
| } | ||
| node.SetLabel(labelStr) | ||
| } | ||
| return nodes | ||
| } | ||
|
|
||
| func isSender(result opsv1alpha1.NodeResult) bool { | ||
| if len(result.Observations) == 0 { | ||
| return false | ||
| } | ||
| if result.Observations[0].Component != opsv1alpha1.SpoofGuard || result.Observations[0].Action != opsv1alpha1.Forwarded { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func isReceiver(result opsv1alpha1.NodeResult) bool { | ||
| if len(result.Observations) == 0 { | ||
| return false | ||
| } | ||
| if result.Observations[0].Component != opsv1alpha1.Forwarding || result.Observations[0].Action != opsv1alpha1.Received { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func getNodeResult(tf *opsv1alpha1.Traceflow, fn func(result opsv1alpha1.NodeResult) bool) *opsv1alpha1.NodeResult { | ||
| for _, result := range tf.Status.Results { | ||
| if fn(result) { | ||
| return &result | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func getSrcNodeName(tf *opsv1alpha1.Traceflow) string { | ||
| if len(tf.Spec.Source.Namespace) > 0 && len(tf.Spec.Source.Pod) > 0 { | ||
| return tf.Spec.Source.Namespace + "/" + tf.Spec.Source.Pod | ||
| } | ||
| return "" | ||
| } | ||
|
|
||
| func getDstNodeName(tf *opsv1alpha1.Traceflow) string { | ||
| if len(tf.Spec.Destination.Namespace) > 0 && len(tf.Spec.Destination.Pod) > 0 { | ||
| return tf.Spec.Destination.Namespace + "/" + tf.Spec.Destination.Pod | ||
| } | ||
| return "" | ||
| } | ||
|
|
||
| // In Graphviz, clusters are surrounded by a pair of "{}" with string "subgraph ClusterName" before them. | ||
| // The function finds the start and end index of specific cluster. | ||
| func findClusterString(graphStr string, clusterName string) (startIndex int, endIndex int) { | ||
| startIndex = strings.Index(graphStr, "subgraph "+clusterName) | ||
| if startIndex == -1 { | ||
| return 0, 1 | ||
| } | ||
| endIndex = startIndex | ||
| for graphStr[endIndex] != '{' { | ||
| endIndex++ | ||
| } | ||
| // Depth represents the number of "{" minus the number of "}" from the start index of current cluster to endIndex. | ||
| // When depth is zero for the first time, it indicates that we successfully find the end index of the cluster. | ||
| depth := 1 | ||
| for depth > 0 { | ||
| endIndex++ | ||
| if graphStr[endIndex] == '{' { | ||
| depth++ | ||
| } | ||
| if graphStr[endIndex] == '}' { | ||
| depth-- | ||
| } | ||
| } | ||
| return startIndex, endIndex + 1 | ||
| } | ||
|
|
||
| func genOutput(g *graphviz.Graphviz, graph *cgraph.Graph, isSingleCluster bool) string { | ||
| var buf bytes.Buffer | ||
| if err := g.Render(graph, "dot", &buf); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| if err := graph.Close(); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| g.Close() | ||
|
|
||
| str := buf.String() | ||
| if isSingleCluster { | ||
| return str | ||
| } | ||
| // In Graphviz, cluster is a subgraph which is surrounded by a rectangle and the nodes belonging to the cluster are drawn together. | ||
| // Swap source and destination cluster if destination cluster appears before source cluster. | ||
| srcStartIdx, srcEndIdx := findClusterString(str, clusterSrcName) | ||
| dstStartIdx, dstEndIdx := findClusterString(str, clusterDstName) | ||
| if dstEndIdx <= srcStartIdx { | ||
| return str[:dstStartIdx] + str[srcStartIdx:srcEndIdx] + str[dstEndIdx:srcStartIdx] + str[dstStartIdx:dstEndIdx] + str[srcEndIdx:] | ||
| } | ||
| return str | ||
| } | ||
|
|
||
| func GenGraph(tf *opsv1alpha1.Traceflow) string { | ||
| var err error | ||
| g := graphviz.New() | ||
| graph, err := g.Graph() | ||
| if err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| graph.SetCenter(true) | ||
| graph.SetLabel(tf.Name) | ||
| graph.SetLabelLocation(cgraph.TopLocation) | ||
|
|
||
| senderRst := getNodeResult(tf, isSender) | ||
| receiverRst := getNodeResult(tf, isReceiver) | ||
| if tf == nil || senderRst == nil || tf.Status.Phase != opsv1alpha1.Succeeded || len(senderRst.Observations) == 0 { | ||
| return genOutput(g, graph, true) | ||
| } | ||
|
|
||
| cluster1 := graph.SubGraph(clusterSrcName, 1) | ||
| cluster1.SetStyle(cgraph.FilledGraphStyle) | ||
| // Handle single node traceflow. | ||
| if receiverRst == nil { | ||
| nodes := genSubGraph(cluster1, senderRst, getSrcNodeName(tf), cgraph.ForwardDir, 0) | ||
| // Draw the destination pod and involved edge. | ||
| edgeName := fmt.Sprintf("%s_%d", cluster1.Name(), len(senderRst.Observations)) | ||
| if len(nodes) == 0 { | ||
| return genOutput(g, graph, true) | ||
| } | ||
| switch senderRst.Observations[len(senderRst.Observations)-1].Action { | ||
| // If the last action of the sender is FORWARDED, | ||
| // then the packet has been sent out by sender, implying that there is a disconnection. | ||
| case opsv1alpha1.Forwarded: | ||
| lastNode, _ := graph.CreateNode(getDstNodeName(tf)) | ||
| edge, _ := graph.CreateEdge(edgeName, nodes[len(nodes)-1], lastNode) | ||
| edge.SetColor("red") | ||
| edge.SetStyle(cgraph.DashedEdgeStyle) | ||
| case opsv1alpha1.Delivered: | ||
| lastNode, _ := cluster1.CreateNode(getDstNodeName(tf)) | ||
| edge, _ := cluster1.CreateEdge(edgeName, nodes[len(nodes)-1], lastNode) | ||
| edge.SetPenWidth(3.0) | ||
| lastNode.SetFontColor("white") | ||
| lastNode.SetColor("royalblue1") | ||
| lastNode.SetStyle(cgraph.FilledNodeStyle) | ||
| edge.SetColor("limegreen") | ||
| } | ||
| return genOutput(g, graph, true) | ||
| } | ||
|
|
||
| // Make the graph centered by equalizing the number of nodes on both sides. | ||
| var nodeNum int | ||
| if len(senderRst.Observations) > len(receiverRst.Observations) { | ||
| nodeNum = len(senderRst.Observations) | ||
| } else { | ||
| nodeNum = len(receiverRst.Observations) | ||
| } | ||
|
|
||
| // Draw the nodes for the sender. | ||
| nodes1 := genSubGraph(cluster1, senderRst, getSrcNodeName(tf), cgraph.ForwardDir, nodeNum-len(senderRst.Observations)) | ||
|
|
||
| // Draw the nodes for the receiver. | ||
| cluster2 := graph.SubGraph(clusterDstName, 1) | ||
| cluster2.SetStyle(cgraph.FilledGraphStyle) | ||
| nodes2 := genSubGraph(cluster2, receiverRst, getDstNodeName(tf), cgraph.BackDir, nodeNum-len(receiverRst.Observations)) | ||
|
|
||
| // Draw the cross-cluster edge. | ||
| if len(nodes1) > 0 && len(nodes2) > 0 { | ||
| edge, _ := graph.CreateEdge("cross_node", nodes1[len(nodes1)-1], nodes2[len(nodes2)-1]) | ||
| edge.SetConstraint(false) | ||
| edge.SetPenWidth(3.0) | ||
| edge.SetColor("limegreen") | ||
| } | ||
|
|
||
| return genOutput(g, graph, false) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.