/
sink.go
206 lines (180 loc) 路 6.29 KB
/
sink.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
// 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 diag
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag/colors"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/logging"
)
// Sink facilitates pluggable diagnostics messages.
type Sink interface {
// Logf issues a log message.
Logf(sev Severity, diag *Diag, args ...interface{})
// Debugf issues a debugging message.
Debugf(diag *Diag, args ...interface{})
// Infof issues an informational message (to stdout).
Infof(diag *Diag, args ...interface{})
// Infoerrf issues an informational message (to stderr).
Infoerrf(diag *Diag, args ...interface{})
// Errorf issues a new error diagnostic.
Errorf(diag *Diag, args ...interface{})
// Warningf issues a new warning diagnostic.
Warningf(diag *Diag, args ...interface{})
// Stringify stringifies a diagnostic into a prefix and message that is appropriate for printing.
Stringify(sev Severity, diag *Diag, args ...interface{}) (string, string)
}
// Severity dictates the kind of diagnostic.
type Severity string
const (
Debug Severity = "debug"
Info Severity = "info"
Infoerr Severity = "info#err"
Warning Severity = "warning"
Error Severity = "error"
)
// FormatOptions controls the output style and content.
type FormatOptions struct {
Pwd string // the working directory.
Color colors.Colorization // how output should be colorized.
Debug bool // if true, debugging will be output to stdout.
}
// DefaultSink returns a default sink that simply logs output to stderr/stdout.
func DefaultSink(stdout io.Writer, stderr io.Writer, opts FormatOptions) Sink {
contract.Require(stdout != nil, "stdout")
contract.Require(stderr != nil, "stderr")
// Discard debug output by default unless requested.
debug := ioutil.Discard
if opts.Debug {
debug = stdout
}
return newDefaultSink(opts, map[Severity]io.Writer{
Debug: debug,
Info: stdout,
Infoerr: stderr,
Error: stderr,
Warning: stderr,
})
}
func newDefaultSink(opts FormatOptions, writers map[Severity]io.Writer) *defaultSink {
contract.Assert(writers[Debug] != nil)
contract.Assert(writers[Info] != nil)
contract.Assert(writers[Infoerr] != nil)
contract.Assert(writers[Error] != nil)
contract.Assert(writers[Warning] != nil)
contract.Assertf(opts.Color != "", "FormatOptions.Color must be set")
return &defaultSink{
opts: opts,
writers: writers,
}
}
const DefaultSinkIDPrefix = "PU"
// defaultSink is the default sink which logs output to stderr/stdout.
type defaultSink struct {
opts FormatOptions // a set of options that control output style and content.
writers map[Severity]io.Writer // the writers to use for each kind of diagnostic severity.
}
func (d *defaultSink) Logf(sev Severity, diag *Diag, args ...interface{}) {
switch sev {
case Debug:
d.Debugf(diag, args...)
case Info:
d.Infof(diag, args...)
case Infoerr:
d.Infoerrf(diag, args...)
case Warning:
d.Warningf(diag, args...)
case Error:
d.Errorf(diag, args...)
default:
contract.Failf("Unrecognized severity: %v", sev)
}
}
func (d *defaultSink) createMessage(sev Severity, diag *Diag, args ...interface{}) string {
prefix, msg := d.Stringify(sev, diag, args...)
return prefix + msg
}
func (d *defaultSink) Debugf(diag *Diag, args ...interface{}) {
// For debug messages, write both to the glogger and a stream, if there is one.
logging.V(3).Infof(diag.Message, args...)
msg := d.createMessage(Debug, diag, args...)
if logging.V(9) {
logging.V(9).Infof("defaultSink::Debug(%v)", msg[:len(msg)-1])
}
fmt.Fprint(d.writers[Debug], msg)
}
func (d *defaultSink) Infof(diag *Diag, args ...interface{}) {
msg := d.createMessage(Info, diag, args...)
if logging.V(5) {
logging.V(5).Infof("defaultSink::Info(%v)", msg[:len(msg)-1])
}
fmt.Fprint(d.writers[Info], msg)
}
func (d *defaultSink) Infoerrf(diag *Diag, args ...interface{}) {
msg := d.createMessage(Info /* not Infoerr, just "info: "*/, diag, args...)
if logging.V(5) {
logging.V(5).Infof("defaultSink::Infoerr(%v)", msg[:len(msg)-1])
}
fmt.Fprint(d.writers[Infoerr], msg)
}
func (d *defaultSink) Errorf(diag *Diag, args ...interface{}) {
msg := d.createMessage(Error, diag, args...)
if logging.V(5) {
logging.V(5).Infof("defaultSink::Error(%v)", msg[:len(msg)-1])
}
fmt.Fprint(d.writers[Error], msg)
}
func (d *defaultSink) Warningf(diag *Diag, args ...interface{}) {
msg := d.createMessage(Warning, diag, args...)
if logging.V(5) {
logging.V(5).Infof("defaultSink::Warning(%v)", msg[:len(msg)-1])
}
fmt.Fprint(d.writers[Warning], msg)
}
func (d *defaultSink) Stringify(sev Severity, diag *Diag, args ...interface{}) (string, string) {
var prefix bytes.Buffer
if sev != Info && sev != Infoerr {
// Unless it's an ordinary stdout message, prepend the message category's prefix (error/warning).
switch sev {
case Debug:
prefix.WriteString(colors.SpecDebug)
case Error:
prefix.WriteString(colors.SpecError)
case Warning:
prefix.WriteString(colors.SpecWarning)
default:
contract.Failf("Unrecognized diagnostic severity: %v", sev)
}
prefix.WriteString(string(sev))
prefix.WriteString(": ")
prefix.WriteString(colors.Reset)
}
// Finally, actually print the message itself.
var buffer bytes.Buffer
buffer.WriteString(colors.SpecNote)
if diag.Raw {
buffer.WriteString(diag.Message)
} else {
buffer.WriteString(fmt.Sprintf(diag.Message, args...))
}
buffer.WriteString(colors.Reset)
buffer.WriteRune('\n')
// Ensure that any sensitive data we know about is filtered out preemptively.
filtered := logging.FilterString(buffer.String())
// If colorization was requested, compile and execute the directives now.
return d.opts.Color.Colorize(prefix.String()), d.opts.Color.Colorize(filtered)
}