-
Notifications
You must be signed in to change notification settings - Fork 0
/
debug.go
259 lines (218 loc) · 6.01 KB
/
debug.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
package container
import (
"bytes"
"fmt"
"os"
"path/filepath"
"reflect"
"github.com/pkg/errors"
"github.com/goccy/go-graphviz"
"github.com/goccy/go-graphviz/cgraph"
)
// DebugOption is a functional option for running a container that controls
// debug logging and visualization output.
type DebugOption interface {
applyConfig(*debugConfig) error
}
// StdoutLogger is a debug option which routes logging output to stdout.
func StdoutLogger() DebugOption {
return Logger(func(s string) {
_, _ = fmt.Fprintln(os.Stdout, s)
})
}
// Visualizer creates an option which provides a visualizer function which
// will receive a rendering of the container in the Graphiz DOT format
// whenever the container finishes building or fails due to an error. The
// graph is color-coded to aid debugging.
func Visualizer(visualizer func(dotGraph string)) DebugOption {
return debugOption(func(c *debugConfig) error {
c.addFuncVisualizer(visualizer)
return nil
})
}
// LogVisualizer is a debug option which dumps a graphviz DOT rendering of
// the container to the log.
func LogVisualizer() DebugOption {
return debugOption(func(c *debugConfig) error {
c.enableLogVisualizer()
return nil
})
}
// FileVisualizer is a debug option which dumps a graphviz rendering of
// the container to the specified file with the specified format. Currently
// supported formats are: dot, svg, png and jpg.
func FileVisualizer(filename, format string) DebugOption {
return debugOption(func(c *debugConfig) error {
c.addFileVisualizer(filename, format)
return nil
})
}
// Logger creates an option which provides a logger function which will
// receive all log messages from the container.
func Logger(logger func(string)) DebugOption {
return debugOption(func(c *debugConfig) error {
logger("Initializing logger")
c.loggers = append(c.loggers, logger)
return nil
})
}
// Debug is a default debug option which sends log output to stdout, dumps
// the container in the graphviz DOT format to stdout, and to the file
// container_dump.svg.
func Debug() DebugOption {
return DebugOptions(
StdoutLogger(),
LogVisualizer(),
FileVisualizer("container_dump.svg", "svg"),
)
}
// DebugOptions creates a debug option which bundles together other debug options.
func DebugOptions(options ...DebugOption) DebugOption {
return debugOption(func(c *debugConfig) error {
for _, opt := range options {
err := opt.applyConfig(c)
if err != nil {
return err
}
}
return nil
})
}
type debugConfig struct {
// logging
loggers []func(string)
indentStr string
// graphing
graphviz *graphviz.Graphviz
graph *cgraph.Graph
visualizers []func(string)
logVisualizer bool
}
type debugOption func(*debugConfig) error
func (c debugOption) applyConfig(ctr *debugConfig) error {
return c(ctr)
}
var _ DebugOption = (*debugOption)(nil)
func newDebugConfig() (*debugConfig, error) {
g := graphviz.New()
graph, err := g.Graph()
if err != nil {
return nil, errors.Wrap(err, "error initializing graph")
}
return &debugConfig{
graphviz: g,
graph: graph,
}, nil
}
func (c *debugConfig) indentLogger() {
c.indentStr = c.indentStr + " "
}
func (c *debugConfig) dedentLogger() {
if len(c.indentStr) > 0 {
c.indentStr = c.indentStr[1:]
}
}
func (c debugConfig) logf(format string, args ...interface{}) {
s := fmt.Sprintf(c.indentStr+format, args...)
for _, logger := range c.loggers {
logger(s)
}
}
func (c *debugConfig) generateGraph() {
buf := &bytes.Buffer{}
err := c.graphviz.Render(c.graph, graphviz.XDOT, buf)
if err != nil {
c.logf("Error rendering DOT graph: %+v", err)
return
}
dot := buf.String()
if c.logVisualizer {
c.logf("DOT Graph: %s", dot)
}
for _, v := range c.visualizers {
v(dot)
}
err = c.graph.Close()
if err != nil {
c.logf("Error closing graph: %+v", err)
return
}
err = c.graphviz.Close()
if err != nil {
c.logf("Error closing graphviz: %+v", err)
}
}
func (c *debugConfig) addFuncVisualizer(f func(string)) {
c.visualizers = append(c.visualizers, func(dot string) {
f(dot)
})
}
func (c *debugConfig) enableLogVisualizer() {
c.logVisualizer = true
}
func (c *debugConfig) addFileVisualizer(filename string, format string) {
c.visualizers = append(c.visualizers, func(_ string) {
err := c.graphviz.RenderFilename(c.graph, graphviz.Format(format), filename)
if err != nil {
c.logf("Error saving graphviz file %s with format %s: %+v", filename, format, err)
} else {
path, err := filepath.Abs(filename)
if err == nil {
c.logf("Saved graph of container to %s", path)
}
}
})
}
func (c *debugConfig) locationGraphNode(location Location, key *moduleKey) (*cgraph.Node, error) {
graph := c.moduleSubGraph(key)
node, found, err := c.findOrCreateGraphNode(graph, location.Name())
if err != nil {
return nil, err
}
if found {
return node, nil
}
node.SetShape(cgraph.BoxShape)
node.SetColor("lightgrey")
return node, nil
}
func (c *debugConfig) typeGraphNode(typ reflect.Type) (*cgraph.Node, error) {
node, found, err := c.findOrCreateGraphNode(c.graph, typ.String())
if err != nil {
return nil, err
}
if found {
return node, nil
}
node.SetColor("lightgrey")
return node, err
}
func (c *debugConfig) findOrCreateGraphNode(subGraph *cgraph.Graph, name string) (node *cgraph.Node, found bool, err error) {
node, err = c.graph.Node(name)
if err != nil {
return nil, false, errors.Wrapf(err, "error finding graph node %s", name)
}
if node != nil {
return node, true, nil
}
node, err = subGraph.CreateNode(name)
if err != nil {
return nil, false, errors.Wrapf(err, "error creating graph node %s", name)
}
return node, false, nil
}
func (c *debugConfig) moduleSubGraph(key *moduleKey) *cgraph.Graph {
graph := c.graph
if key != nil {
gname := fmt.Sprintf("cluster_%s", key.name)
graph = c.graph.SubGraph(gname, 1)
graph.SetLabel(fmt.Sprintf("ModuleKey: %s", key.name))
}
return graph
}
func (c *debugConfig) addGraphEdge(from *cgraph.Node, to *cgraph.Node) {
_, err := c.graph.CreateEdge("", from, to)
if err != nil {
c.logf("error creating graph edge")
}
}