Improve stderr logging for PostCSS and simlilar
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Thu, 20 Aug 2020 16:43:09 +0000 (18:43 +0200)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Thu, 20 Aug 2020 20:32:20 +0000 (22:32 +0200)
Fixes #7584

common/loggers/loggers.go
common/loggers/loggers_test.go
hugolib/resource_chain_babel_test.go
hugolib/resource_chain_test.go
modules/client.go
resources/resource_transformers/babel/babel.go
resources/resource_transformers/postcss/postcss.go

index 2b2ddb4d1643820d1453c6a070b625dc53b6115e..d406e5f20700461703c67a8862083b67ba20e97d 100644 (file)
@@ -39,6 +39,23 @@ func init() {
        jww.SetLogListeners(jww.LogCounter(GlobalErrorCounter, jww.LevelError))
 }
 
+func LoggerToWriterWithPrefix(logger *log.Logger, prefix string) io.Writer {
+       return prefixWriter{
+               logger: logger,
+               prefix: prefix,
+       }
+}
+
+type prefixWriter struct {
+       logger *log.Logger
+       prefix string
+}
+
+func (w prefixWriter) Write(p []byte) (n int, err error) {
+       w.logger.Printf("%s: %s", w.prefix, p)
+       return len(p), nil
+}
+
 // Logger wraps a *loggers.Logger and some other related logging state.
 type Logger struct {
        *jww.Notepad
@@ -93,17 +110,32 @@ func NewLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle
 
 // NewDebugLogger is a convenience function to create a debug logger.
 func NewDebugLogger() *Logger {
-       return newBasicLogger(jww.LevelDebug)
+       return NewBasicLogger(jww.LevelDebug)
 }
 
 // NewWarningLogger is a convenience function to create a warning logger.
 func NewWarningLogger() *Logger {
-       return newBasicLogger(jww.LevelWarn)
+       return NewBasicLogger(jww.LevelWarn)
+}
+
+// NewInfoLogger is a convenience function to create a info logger.
+func NewInfoLogger() *Logger {
+       return NewBasicLogger(jww.LevelInfo)
 }
 
 // NewErrorLogger is a convenience function to create an error logger.
 func NewErrorLogger() *Logger {
-       return newBasicLogger(jww.LevelError)
+       return NewBasicLogger(jww.LevelError)
+}
+
+// NewBasicLogger creates a new basic logger writing to Stdout.
+func NewBasicLogger(t jww.Threshold) *Logger {
+       return newLogger(t, jww.LevelError, os.Stdout, ioutil.Discard, false)
+}
+
+// NewBasicLoggerForWriter creates a new basic logger writing to w.
+func NewBasicLoggerForWriter(t jww.Threshold, w io.Writer) *Logger {
+       return newLogger(t, jww.LevelError, w, ioutil.Discard, false)
 }
 
 var (
@@ -215,7 +247,3 @@ func newLogger(stdoutThreshold, logThreshold jww.Threshold, outHandle, logHandle
                errors:       errorBuff,
        }
 }
-
-func newBasicLogger(t jww.Threshold) *Logger {
-       return newLogger(t, jww.LevelError, os.Stdout, ioutil.Discard, false)
-}
index f572ba17063cf485f90be361489747de51f3aff8..bf52d97c1c6dd668c70e79ce701cfd03174acb8b 100644 (file)
@@ -14,6 +14,9 @@
 package loggers
 
 import (
+       "bytes"
+       "fmt"
+       "log"
        "testing"
 
        qt "github.com/frankban/quicktest"
@@ -30,3 +33,17 @@ func TestLogger(t *testing.T) {
        c.Assert(l.ErrorCounter.Count(), qt.Equals, uint64(2))
 
 }
+
+func TestLoggerToWriterWithPrefix(t *testing.T) {
+       c := qt.New(t)
+
+       var b bytes.Buffer
+
+       logger := log.New(&b, "", 0)
+
+       w := LoggerToWriterWithPrefix(logger, "myprefix")
+
+       fmt.Fprint(w, "Hello Hugo!")
+
+       c.Assert(b.String(), qt.Equals, "myprefix: Hello Hugo!\n")
+}
index d3351dfd46812f28367bcce16e49c500233825b8..e6e4ed8d3c6815c2313f4826c712169366508075 100644 (file)
 package hugolib
 
 import (
+       "bytes"
        "os"
        "os/exec"
        "path/filepath"
        "runtime"
        "testing"
 
+       jww "github.com/spf13/jwalterweatherman"
+
        "github.com/gohugoio/hugo/htesting"
 
        "github.com/spf13/viper"
@@ -80,10 +83,13 @@ class Car {
        c.Assert(err, qt.IsNil)
        defer clean()
 
+       var logBuf bytes.Buffer
+       logger := loggers.NewBasicLoggerForWriter(jww.LevelInfo, &logBuf)
+
        v := viper.New()
        v.Set("workingDir", workDir)
        v.Set("disableKinds", []string{"taxonomy", "term", "page"})
-       b := newTestSitesBuilder(t).WithLogger(loggers.NewWarningLogger())
+       b := newTestSitesBuilder(t).WithLogger(logger)
 
        // Need to use OS fs for this.
        b.Fs = hugofs.NewDefault(v)
@@ -108,12 +114,10 @@ Transpiled: {{ $transpiled.Content | safeJS }}
        _, err = exec.Command("npm", "install").CombinedOutput()
        b.Assert(err, qt.IsNil)
 
-       out, err := captureStderr(func() error {
-               return b.BuildE(BuildCfg{})
+       b.Build(BuildCfg{})
 
-       })
        // Make sure Node sees this.
-       b.Assert(out, qt.Contains, "Hugo Environment: production")
+       b.Assert(logBuf.String(), qt.Contains, "babel: Hugo Environment: production")
        b.Assert(err, qt.IsNil)
 
        b.AssertFileContent("public/index.html", `
index c687ca3421b217224a6419ab2b8309b9944f50d7..64484f1f4528d8950980fe97fa2d9acd4f62ef51 100644 (file)
 package hugolib
 
 import (
+       "bytes"
+
+       jww "github.com/spf13/jwalterweatherman"
+
        "fmt"
        "io"
        "math/rand"
        "os"
+
        "os/exec"
        "path/filepath"
        "runtime"
@@ -893,10 +898,13 @@ h1 {
        c.Assert(err, qt.IsNil)
        defer clean()
 
+       var logBuf bytes.Buffer
+
        newTestBuilder := func(v *viper.Viper) *sitesBuilder {
                v.Set("workingDir", workDir)
                v.Set("disableKinds", []string{"taxonomy", "term", "page"})
-               b := newTestSitesBuilder(t).WithLogger(loggers.NewWarningLogger())
+               logger := loggers.NewBasicLoggerForWriter(jww.LevelInfo, &logBuf)
+               b := newTestSitesBuilder(t).WithLogger(logger)
                // Need to use OS fs for this.
                b.Fs = hugofs.NewDefault(v)
                b.WithWorkingDir(workDir)
@@ -942,14 +950,10 @@ class-in-b {
        b.Assert(os.Chdir(workDir), qt.IsNil)
        _, err = exec.Command("npm", "install").CombinedOutput()
        b.Assert(err, qt.IsNil)
-
-       out, _ := captureStderr(func() error {
-               b.Build(BuildCfg{})
-               return nil
-       })
+       b.Build(BuildCfg{})
 
        // Make sure Node sees this.
-       b.Assert(out, qt.Contains, "Hugo Environment: production")
+       b.Assert(logBuf.String(), qt.Contains, "Hugo Environment: production")
 
        b.AssertFileContent("public/index.html", `
 Styles RelPermalink: /css/styles.css
index 8ee9f588aaf6c814789ca04255774edf49c98c40..c66311d0577c115b6d559d81cf24acdd0255dc48 100644 (file)
@@ -531,8 +531,6 @@ func (c *Client) runGo(
                return nil
        }
 
-       //defer c.logger.PrintTimer(time.Now(), fmt.Sprint(args))
-
        stderr := new(bytes.Buffer)
        cmd := exec.CommandContext(ctx, "go", args...)
 
index 72a6b485b7130d3060cf6c6c55807dc127c6411e..c5ab48dd8377dfe1f1287307ba848d2902b2d18f 100644 (file)
@@ -15,11 +15,12 @@ package babel
 
 import (
        "io"
-       "os"
        "os/exec"
        "path/filepath"
        "strconv"
 
+       "github.com/gohugoio/hugo/common/loggers"
+
        "github.com/gohugoio/hugo/common/hugo"
        "github.com/gohugoio/hugo/resources/internal"
 
@@ -157,7 +158,7 @@ func (t *babelTransformation) Transform(ctx *resources.ResourceTransformationCtx
        cmd := exec.Command(binary, cmdArgs...)
 
        cmd.Stdout = ctx.To
-       cmd.Stderr = os.Stderr
+       cmd.Stderr = loggers.LoggerToWriterWithPrefix(logger.INFO, "babel")
        cmd.Env = hugo.GetExecEnviron(t.rs.Cfg)
 
        stdin, err := cmd.StdinPipe()
index 1f2e51fd8d8bc32281185c54b74765363d8e0392..258185a406a87779dfb0ea0382f60a09cfec68f6 100644 (file)
@@ -36,7 +36,6 @@ import (
        "github.com/gohugoio/hugo/hugofs"
        "github.com/pkg/errors"
 
-       "os"
        "os/exec"
 
        "github.com/mitchellh/mapstructure"
@@ -199,9 +198,10 @@ func (t *postcssTransformation) Transform(ctx *resources.ResourceTransformationC
        cmd := exec.Command(binary, cmdArgs...)
 
        var errBuf bytes.Buffer
+       infoW := loggers.LoggerToWriterWithPrefix(logger.INFO, "postcss")
 
        cmd.Stdout = ctx.To
-       cmd.Stderr = io.MultiWriter(os.Stderr, &errBuf)
+       cmd.Stderr = io.MultiWriter(infoW, &errBuf)
        cmd.Env = hugo.GetExecEnviron(t.rs.Cfg)
 
        stdin, err := cmd.StdinPipe()