2018-05-22 21:43:36 +02:00
|
|
|
// 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.
|
2016-11-17 02:52:14 +01:00
|
|
|
|
|
|
|
package diag
|
|
|
|
|
|
|
|
import (
|
2017-02-23 03:53:36 +01:00
|
|
|
"io"
|
2016-11-17 02:52:14 +01:00
|
|
|
"io/ioutil"
|
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
2017-12-18 20:42:32 +01:00
|
|
|
|
|
|
|
"github.com/pulumi/pulumi/pkg/diag/colors"
|
2016-11-17 02:52:14 +01:00
|
|
|
)
|
|
|
|
|
2018-08-31 21:33:01 +02:00
|
|
|
func discardSink() Sink {
|
2016-11-17 02:52:14 +01:00
|
|
|
// Create a new default sink with /dev/null writers to avoid spamming the test log.
|
2017-12-18 20:42:32 +01:00
|
|
|
return newDefaultSink(FormatOptions{Color: colors.Never}, map[Severity]io.Writer{
|
2017-07-14 02:09:46 +02:00
|
|
|
Debug: ioutil.Discard,
|
2017-02-23 03:53:36 +01:00
|
|
|
Info: ioutil.Discard,
|
Improve output formatting
This change improves our output formatting by generally adding
fewer prefixes. As shown in pulumi/pulumi#359, we were being
excessively verbose in many places, including prefixing every
console.out with "langhost[nodejs].stdout: ", displaying full
stack traces for simple errors like missing configuration, etc.
Overall, this change includes the following:
* Don't prefix stdout and stderr output from the program, other
than the standard "info:" prefix. I experimented with various
schemes here, but they all felt gratuitous. Simply emitting
the output seems fine, especially as it's closer to what would
happen if you just ran the program under node.
* Do NOT make writes to stderr fail the plan/deploy. Previously
we assumed that any console.errors, for instance, meant that
the overall program should fail. This simply isn't how stderr
is treated generally and meant you couldn't use certain
logging techniques and libraries, among other things.
* Do make sure that stderr writes in the program end up going to
stderr in the Pulumi CLI output, however, so that redirection
works as it should. This required a new Infoerr log level.
* Make a small fix to the planning logic so we don't attempt to
print the summary if an error occurs.
* Finally, add a new error type, RunError, that when thrown and
uncaught does not result in a full stack trace being printed.
Anyone can use this, however, we currently use it for config
errors so that we can terminate with a pretty error message,
rather than the monstrosity shown in pulumi/pulumi#359.
2017-09-23 14:20:11 +02:00
|
|
|
Infoerr: ioutil.Discard,
|
2017-02-23 03:53:36 +01:00
|
|
|
Error: ioutil.Discard,
|
|
|
|
Warning: ioutil.Discard,
|
|
|
|
})
|
2017-06-03 03:35:53 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestCounts(t *testing.T) {
|
|
|
|
t.Parallel()
|
|
|
|
|
|
|
|
sink := discardSink()
|
2016-11-17 02:52:14 +01:00
|
|
|
|
|
|
|
const numEach = 10
|
|
|
|
|
|
|
|
for i := 0; i < numEach; i++ {
|
2018-08-31 21:33:01 +02:00
|
|
|
sink.Warningf(&Diag{Message: "A test of the emergency warning system: %v."}, i)
|
2016-11-17 02:52:14 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
for i := 0; i < numEach; i++ {
|
2018-08-31 21:33:01 +02:00
|
|
|
sink.Errorf(&Diag{Message: "A test of the emergency error system: %v."}, i)
|
2016-11-17 02:52:14 +01:00
|
|
|
}
|
|
|
|
}
|
2017-06-03 03:35:53 +02:00
|
|
|
|
|
|
|
// TestEscape ensures that arguments containing format-like characters aren't interpreted as such.
|
|
|
|
func TestEscape(t *testing.T) {
|
|
|
|
t.Parallel()
|
|
|
|
|
|
|
|
sink := discardSink()
|
|
|
|
|
|
|
|
// Passing % chars in the argument should not yield %!(MISSING)s.
|
2018-05-08 00:11:52 +02:00
|
|
|
p, s := sink.Stringify(Error, Message("", "%s"), "lots of %v %s %d chars")
|
|
|
|
assert.Equal(t, "error: lots of %v %s %d chars\n", p+s)
|
2017-06-03 03:35:53 +02:00
|
|
|
|
|
|
|
// Passing % chars in the format string, on the other hand, should.
|
2018-05-08 00:11:52 +02:00
|
|
|
pmiss, smiss := sink.Stringify(Error, Message("", "lots of %v %s %d chars"))
|
|
|
|
assert.Equal(t, "error: lots of %!v(MISSING) %!s(MISSING) %!d(MISSING) chars\n", pmiss+smiss)
|
2017-06-03 03:35:53 +02:00
|
|
|
}
|