pulumi/sdk/go/common/diag/sink_test.go

138 lines
3.5 KiB
Go

// 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"
"strings"
"sync"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag/colors"
)
func discardSink() Sink {
// Create a new default sink with /dev/null writers to avoid spamming the test log.
return newDefaultSink(FormatOptions{Color: colors.Never}, map[Severity]io.Writer{
Debug: io.Discard,
Info: io.Discard,
Infoerr: io.Discard,
Error: io.Discard,
Warning: io.Discard,
})
}
func TestCounts(t *testing.T) {
t.Parallel()
sink := discardSink()
const numEach = 10
for i := 0; i < numEach; i++ {
sink.Warningf(&Diag{Message: "A test of the emergency warning system: %v."}, i)
}
for i := 0; i < numEach; i++ {
sink.Errorf(&Diag{Message: "A test of the emergency error system: %v."}, i)
}
}
// 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.
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)
// Passing % chars in the format string, on the other hand, should.
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)
}
func TestDefaultSink_concurrency(t *testing.T) {
t.Parallel()
// Verifies that we can safely log to the sink concurrently.
const (
NumWorkers = 10 // number of concurrent loggers
NumLogs = 100 // number of logs per worker
)
levels := []Severity{Debug, Info, Infoerr, Warning, Error}
var out bytes.Buffer
sink := DefaultSink(&out, &out, FormatOptions{
Debug: true,
Color: colors.Never,
})
var wg sync.WaitGroup
for i := 0; i < NumWorkers; i++ {
wg.Add(1)
go func(i int) {
defer wg.Done()
for j := 0; j < NumLogs; j++ {
for _, level := range levels {
sink.Logf(level, Message("", "worker(%d) log(%d) level(%s)"), i, j, level)
}
}
}(i)
}
wg.Wait()
got := out.String()
assert.Equal(t,
len(levels)*NumWorkers*NumLogs,
strings.Count(got, "\n"))
for i := 0; i < NumWorkers; i++ {
for j := 0; j < NumLogs; j++ {
for _, level := range levels {
want := fmt.Sprintf("worker(%d) log(%d) level(%s)\n", i, j, level)
require.Contains(t, got, want)
// Require instead of assert to avoid flooding
// the test log in case of failures.
}
}
}
}
func TestDefaultSink_uncomparableWriters(t *testing.T) {
t.Parallel()
// Verifies that we don't panic
// when a writer is not comparable with ==.
out := struct {
io.Writer
// Slices are not comparable with ==.
Foo []string
}{Writer: io.Discard}
assert.NotPanics(t, func() {
DefaultSink(out, out, FormatOptions{Color: colors.Never})
})
}