maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
pulumi/pkg/util/testutil/testdiagsink.go

73 lines
2.5 KiB
Go
Raw Normal View History

Add license headers
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.
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
package testutil
import (
Have engine emit "events" instead of writing to streams Previously, the engine would write to io.Writer's to display output. When hosted in `pulumi` these writers were tied to os.Stdout and os.Stderr, but other applications hosting the engine could send them other places (e.g. a log to be sent to an another application later). While much better than just using the ambient streams, this was still not the best. It would be ideal if the engine could just emit strongly typed events and whatever is hosting the engine could care about displaying them. As a first step down that road, we move to a model where operations on the engine now take a `chan engine.Event` and during the course of the operation, events are written to this channel. It is the responsibility of the caller of the method to read from the channel until it is closed (singifying that the operation is complete). The events we do emit are still intermingle presentation with data, which is unfortunate, but can be improved over time. Most of the events today are just colorized in the client and printed to stdout or stderr without much thought.
2017-10-05 23:08:46 +02:00
"io/ioutil"
Rename pulumi-fabric to pulumi This includes a few changes: * The repo name -- and hence the Go modules -- changes from pulumi-fabric to pulumi. * The Node.js SDK package changes from @pulumi/pulumi-fabric to just pulumi. * The CLI is renamed from lumi to pulumi.
2017-09-22 04:18:21 +02:00
"github.com/pulumi/pulumi/pkg/diag"
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
)
// TestDiagSink suppresses message output, but captures them, so that they can be compared to expected results.
type TestDiagSink struct {
Pwd string
sink diag.Sink
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
messages map[diag.Severity][]string
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
}
func NewTestDiagSink(pwd string) *TestDiagSink {
Colorize Mu output This change adds colorization to the core Mu tool's output, similar to what we added to MuJS in https://github.com/marapongo/mu/commit/cf6bbd460d8153bc64f7ace2cd01fc7b7b705360.
2017-02-10 02:26:49 +01:00
return &TestDiagSink{
Pwd: pwd,
Have engine emit "events" instead of writing to streams Previously, the engine would write to io.Writer's to display output. When hosted in `pulumi` these writers were tied to os.Stdout and os.Stderr, but other applications hosting the engine could send them other places (e.g. a log to be sent to an another application later). While much better than just using the ambient streams, this was still not the best. It would be ideal if the engine could just emit strongly typed events and whatever is hosting the engine could care about displaying them. As a first step down that road, we move to a model where operations on the engine now take a `chan engine.Event` and during the course of the operation, events are written to this channel. It is the responsibility of the caller of the method to read from the channel until it is closed (singifying that the operation is complete). The events we do emit are still intermingle presentation with data, which is unfortunate, but can be improved over time. Most of the events today are just colorized in the client and printed to stdout or stderr without much thought.
2017-10-05 23:08:46 +02:00
sink: diag.DefaultSink(ioutil.Discard, ioutil.Discard, diag.FormatOptions{
Colorize Mu output This change adds colorization to the core Mu tool's output, similar to what we added to MuJS in https://github.com/marapongo/mu/commit/cf6bbd460d8153bc64f7ace2cd01fc7b7b705360.
2017-02-10 02:26:49 +01:00
Pwd: pwd,
}),
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
messages: make(map[diag.Severity][]string),
Colorize Mu output This change adds colorization to the core Mu tool's output, similar to what we added to MuJS in https://github.com/marapongo/mu/commit/cf6bbd460d8153bc64f7ace2cd01fc7b7b705360.
2017-02-10 02:26:49 +01:00
}
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
}
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
func (d *TestDiagSink) DebugMsgs() []string { return d.messages[diag.Debug] }
Echo resource provider outputs This change introduces a new informational message category to the overall diagnostics infrastructure, and then wires up the resource provider plugins stdout/stderr streams to it. In particular, a write to stdout implies an informational message, whereas a write to stderr implies an error. This is just a very simple and convenient way for plugins to provide progress reporting; eventually we may need something more complex, due to parallel evaluation of resource graphs, however I hope we don't have to deviate too much from this.
2017-02-23 03:53:36 +01:00
func (d *TestDiagSink) InfoMsgs() []string { return d.messages[diag.Info] }
func (d *TestDiagSink) ErrorMsgs() []string { return d.messages[diag.Error] }
func (d *TestDiagSink) WarningMsgs() []string { return d.messages[diag.Warning] }
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
func (d *TestDiagSink) Logf(sev diag.Severity, dia *diag.Diag, args ...interface{}) {
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
d.messages[sev] = append(d.messages[sev], d.combine(sev, dia, args...))
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
}
func (d *TestDiagSink) Debugf(dia *diag.Diag, args ...interface{}) {
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
d.messages[diag.Debug] = append(d.messages[diag.Debug], d.combine(diag.Debug, dia, args...))
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
}
Echo resource provider outputs This change introduces a new informational message category to the overall diagnostics infrastructure, and then wires up the resource provider plugins stdout/stderr streams to it. In particular, a write to stdout implies an informational message, whereas a write to stderr implies an error. This is just a very simple and convenient way for plugins to provide progress reporting; eventually we may need something more complex, due to parallel evaluation of resource graphs, however I hope we don't have to deviate too much from this.
2017-02-23 03:53:36 +01:00
func (d *TestDiagSink) Infof(dia *diag.Diag, args ...interface{}) {
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
d.messages[diag.Info] = append(d.messages[diag.Info], d.combine(diag.Info, dia, args...))
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
}
func (d *TestDiagSink) Errorf(dia *diag.Diag, args ...interface{}) {
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
d.messages[diag.Error] = append(d.messages[diag.Error], d.combine(diag.Error, dia, args...))
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
}
func (d *TestDiagSink) Warningf(dia *diag.Diag, args ...interface{}) {
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
d.messages[diag.Warning] = append(d.messages[diag.Warning], d.combine(diag.Warning, dia, args...))
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
}
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
func (d *TestDiagSink) Stringify(sev diag.Severity, dia *diag.Diag, args ...interface{}) (string, string) {
Introduce an interface to read config This change adds an engine gRPC interface, and associated implementation, so that plugins may do interesting things that require "phoning home". Previously, the engine would fire up plugins and talk to them directly, but there was no way for a plugin to ask the engine to do anything. The motivation here is so that plugins can read evaluator state, such as config information, but this change also allows richer logging functionality than previously possible. We will still auto-log any stdout/stderr writes; however, explicit errors, warnings, informational, and even debug messages may be written over the Log API.
2017-06-21 04:45:07 +02:00
return d.sink.Stringify(sev, dia, args...)
Revive some compiler tests This change revives some compiler tests that are still lingering around from the old architecture, before our latest round of ship burning. It also fixes up some bugs uncovered during this: * Don't claim that a symbol's kind is incorrect in the binder error message when it wasn't found. Instead, say that it was missing. * Do not attempt to compile if an error was issued during workspace resolution and/or loading of the Mufile. This leads to trying to load an empty path and badness quickly ensues (crash). * Issue an error if the Mufile wasn't found (this got lost apparently). * Rename the ErrorMissingPackageName message to ErrorInvalidPackageName, since missing names are now caught by our new fancy decoder that understands required versus optional fields. We still need to guard against illegal characters in the name, including the empty string "". * During decoding, reject !src.IsValid elements. This represents the zero value and should be treated equivalently to a missing field. * Do not permit empty strings "" as Names or QNames. The old logic accidentally permitted them because regexp.FindString("") == "", no matter the regex! * Move the TestDiagSink abstraction to a new pkg/util/testutil package, allowing us to share this common code across multiple package tests. * Fix up a few messages that needed tidying or to use Infof vs. Info. The binder tests -- deleted in this -- are about to come back, however, I am splitting up the changes, since this represents a passing fixed point.
2017-01-27 00:30:08 +01:00
}
Restore streaming of plugin outputs to the progress display. (#1333)
2018-05-08 00:11:52 +02:00
func (d *TestDiagSink) combine(sev diag.Severity, dia *diag.Diag, args ...interface{}) string {
p, s := d.sink.Stringify(sev, dia, args...)
return p + s
}
Reference in a new issue Copy permalink