From 854219d44a001428a8aefaf212bd7aba882fc857 Mon Sep 17 00:00:00 2001 From: Jean-Laurent de Morlhon Date: Wed, 16 Dec 2015 16:51:03 +0100 Subject: [PATCH] Clearer writer name Signed-off-by: Jean-Laurent de Morlhon --- commands/config.go | 2 +- commands/env.go | 2 +- .../drivers/plugin/localbinary/plugin_test.go | 8 ++-- libmachine/log/fmt_machine_logger.go | 44 +++++++++---------- libmachine/log/fmt_machine_logger_test.go | 12 ++--- libmachine/log/log.go | 8 ++-- libmachine/log/machine_logger.go | 4 +- 7 files changed, 40 insertions(+), 40 deletions(-) diff --git a/commands/config.go b/commands/config.go index c23ecc169a..0b01f418b0 100644 --- a/commands/config.go +++ b/commands/config.go @@ -12,7 +12,7 @@ import ( func cmdConfig(c CommandLine, api libmachine.API) error { // Ensure that log messages always go to stderr when this command is // being run (it is intended to be run in a subshell) - log.SetOut(os.Stderr) + log.SetOutWriter(os.Stderr) if len(c.Args()) != 1 { return ErrExpectedOneMachine diff --git a/commands/env.go b/commands/env.go index ce1125e5c0..9663fb7f25 100644 --- a/commands/env.go +++ b/commands/env.go @@ -50,7 +50,7 @@ func cmdEnv(c CommandLine, api libmachine.API) error { // Ensure that log messages always go to stderr when this command is // being run (it is intended to be run in a subshell) - log.SetOut(os.Stderr) + log.SetOutWriter(os.Stderr) if c.Bool("unset") { shellCfg, err = shellCfgUnset(c, api) diff --git a/libmachine/drivers/plugin/localbinary/plugin_test.go b/libmachine/drivers/plugin/localbinary/plugin_test.go index 897ee9cc63..a8d7c461b2 100644 --- a/libmachine/drivers/plugin/localbinary/plugin_test.go +++ b/libmachine/drivers/plugin/localbinary/plugin_test.go @@ -81,13 +81,13 @@ func TestExecServer(t *testing.T) { logReader, logWriter := io.Pipe() log.SetDebug(true) - log.SetOut(logWriter) - log.SetErr(logWriter) + log.SetOutWriter(logWriter) + log.SetErrWriter(logWriter) defer func() { log.SetDebug(false) - log.SetOut(os.Stdout) - log.SetErr(os.Stderr) + log.SetOutWriter(os.Stdout) + log.SetErrWriter(os.Stderr) }() stdoutReader, stdoutWriter := io.Pipe() diff --git a/libmachine/log/fmt_machine_logger.go b/libmachine/log/fmt_machine_logger.go index 08147f5831..2a9747c99f 100644 --- a/libmachine/log/fmt_machine_logger.go +++ b/libmachine/log/fmt_machine_logger.go @@ -7,19 +7,19 @@ import ( ) type FmtMachineLogger struct { - out io.Writer - err io.Writer - debug bool - history *HistoryRecorder + outWriter io.Writer + errWriter io.Writer + debug bool + history *HistoryRecorder } // NewFmtMachineLogger creates a MachineLogger implementation used by the drivers func NewFmtMachineLogger() MachineLogger { return &FmtMachineLogger{ - out: os.Stdout, - err: os.Stderr, - debug: false, - history: NewHistoryRecorder(), + outWriter: os.Stdout, + errWriter: os.Stderr, + debug: false, + history: NewHistoryRecorder(), } } @@ -27,68 +27,68 @@ func (ml *FmtMachineLogger) SetDebug(debug bool) { ml.debug = debug } -func (ml *FmtMachineLogger) SetOut(out io.Writer) { - ml.out = out +func (ml *FmtMachineLogger) SetOutWriter(out io.Writer) { + ml.outWriter = out } -func (ml *FmtMachineLogger) SetErr(err io.Writer) { - ml.err = err +func (ml *FmtMachineLogger) SetErrWriter(err io.Writer) { + ml.errWriter = err } func (ml *FmtMachineLogger) Debug(args ...interface{}) { ml.history.Record(args...) if ml.debug { - fmt.Fprintln(ml.err, args...) + fmt.Fprintln(ml.errWriter, args...) } } func (ml *FmtMachineLogger) Debugf(fmtString string, args ...interface{}) { ml.history.Recordf(fmtString, args...) if ml.debug { - fmt.Fprintf(ml.err, fmtString+"\n", args...) + fmt.Fprintf(ml.errWriter, fmtString+"\n", args...) } } func (ml *FmtMachineLogger) Error(args ...interface{}) { ml.history.Record(args...) - fmt.Fprintln(ml.err, args...) + fmt.Fprintln(ml.errWriter, args...) } func (ml *FmtMachineLogger) Errorf(fmtString string, args ...interface{}) { ml.history.Recordf(fmtString, args...) - fmt.Fprintf(ml.err, fmtString+"\n", args...) + fmt.Fprintf(ml.errWriter, fmtString+"\n", args...) } func (ml *FmtMachineLogger) Info(args ...interface{}) { ml.history.Record(args...) - fmt.Fprintln(ml.out, args...) + fmt.Fprintln(ml.outWriter, args...) } func (ml *FmtMachineLogger) Infof(fmtString string, args ...interface{}) { ml.history.Recordf(fmtString, args...) - fmt.Fprintf(ml.out, fmtString+"\n", args...) + fmt.Fprintf(ml.outWriter, fmtString+"\n", args...) } func (ml *FmtMachineLogger) Fatal(args ...interface{}) { ml.history.Record(args...) - fmt.Fprintln(ml.err, args...) + fmt.Fprintln(ml.errWriter, args...) os.Exit(1) } func (ml *FmtMachineLogger) Fatalf(fmtString string, args ...interface{}) { ml.history.Recordf(fmtString, args...) - fmt.Fprintf(ml.err, fmtString+"\n", args...) + fmt.Fprintf(ml.errWriter, fmtString+"\n", args...) os.Exit(1) } func (ml *FmtMachineLogger) Warn(args ...interface{}) { ml.history.Record(args...) - fmt.Fprintln(ml.out, args...) + fmt.Fprintln(ml.outWriter, args...) } func (ml *FmtMachineLogger) Warnf(fmtString string, args ...interface{}) { ml.history.Recordf(fmtString, args...) - fmt.Fprintf(ml.out, fmtString+"\n", args...) + fmt.Fprintf(ml.outWriter, fmtString+"\n", args...) } func (ml *FmtMachineLogger) History() []string { diff --git a/libmachine/log/fmt_machine_logger_test.go b/libmachine/log/fmt_machine_logger_test.go index dea9daa160..daa0d5aa70 100644 --- a/libmachine/log/fmt_machine_logger_test.go +++ b/libmachine/log/fmt_machine_logger_test.go @@ -12,7 +12,7 @@ import ( func captureOutput(testLogger MachineLogger, lambda func()) string { pipeReader, pipeWriter := io.Pipe() scanner := bufio.NewScanner(pipeReader) - testLogger.SetOut(pipeWriter) + testLogger.SetOutWriter(pipeWriter) go lambda() scanner.Scan() return scanner.Text() @@ -21,7 +21,7 @@ func captureOutput(testLogger MachineLogger, lambda func()) string { func captureError(testLogger MachineLogger, lambda func()) string { pipeReader, pipeWriter := io.Pipe() scanner := bufio.NewScanner(pipeReader) - testLogger.SetErr(pipeWriter) + testLogger.SetErrWriter(pipeWriter) go lambda() scanner.Scan() return scanner.Text() @@ -42,14 +42,14 @@ func TestSetDebugToFalse(t *testing.T) { func TestSetOut(t *testing.T) { testLogger := NewFmtMachineLogger().(*FmtMachineLogger) - testLogger.SetOut(ioutil.Discard) - assert.Equal(t, ioutil.Discard, testLogger.out) + testLogger.SetOutWriter(ioutil.Discard) + assert.Equal(t, ioutil.Discard, testLogger.outWriter) } func TestSetErr(t *testing.T) { testLogger := NewFmtMachineLogger().(*FmtMachineLogger) - testLogger.SetErr(ioutil.Discard) - assert.Equal(t, ioutil.Discard, testLogger.err) + testLogger.SetErrWriter(ioutil.Discard) + assert.Equal(t, ioutil.Discard, testLogger.errWriter) } func TestDebug(t *testing.T) { diff --git a/libmachine/log/log.go b/libmachine/log/log.go index b068534448..5ed2f0a8f3 100644 --- a/libmachine/log/log.go +++ b/libmachine/log/log.go @@ -69,12 +69,12 @@ func SetDebug(debug bool) { logger.SetDebug(debug) } -func SetOut(out io.Writer) { - logger.SetOut(out) +func SetOutWriter(out io.Writer) { + logger.SetOutWriter(out) } -func SetErr(err io.Writer) { - logger.SetErr(err) +func SetErrWriter(err io.Writer) { + logger.SetErrWriter(err) } func History() []string { diff --git a/libmachine/log/machine_logger.go b/libmachine/log/machine_logger.go index 3adfd78d4f..9583a00fb5 100644 --- a/libmachine/log/machine_logger.go +++ b/libmachine/log/machine_logger.go @@ -5,8 +5,8 @@ import "io" type MachineLogger interface { SetDebug(debug bool) - SetOut(io.Writer) - SetErr(io.Writer) + SetOutWriter(io.Writer) + SetErrWriter(io.Writer) Debug(args ...interface{}) Debugf(fmtString string, args ...interface{})