d3f25bac79
Previously secrets would be shown in log output as provided. This commit updates the stepLogFormatter to replace any instance of the secret string with "***", as GitHub Actions would Known issues: If the secret is a generic string (such as "docker"), all occurances of that string will be replaced in the output Co-authored-by: Casey Lee <cplee@nektos.com>
129 lines
2.9 KiB
Go
129 lines
2.9 KiB
Go
package runner
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"strings"
|
|
"sync"
|
|
|
|
"github.com/nektos/act/pkg/common"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
"golang.org/x/crypto/ssh/terminal"
|
|
)
|
|
|
|
const (
|
|
//nocolor = 0
|
|
red = 31
|
|
green = 32
|
|
yellow = 33
|
|
blue = 34
|
|
magenta = 35
|
|
cyan = 36
|
|
gray = 37
|
|
)
|
|
|
|
var colors []int
|
|
var nextColor int
|
|
var mux sync.Mutex
|
|
|
|
func init() {
|
|
nextColor = 0
|
|
colors = []int{
|
|
blue, yellow, green, magenta, red, gray, cyan,
|
|
}
|
|
}
|
|
|
|
// WithJobLogger attaches a new logger to context that is aware of steps
|
|
func WithJobLogger(ctx context.Context, jobName string, secrets map[string]string) context.Context {
|
|
mux.Lock()
|
|
defer mux.Unlock()
|
|
formatter := new(stepLogFormatter)
|
|
formatter.color = colors[nextColor%len(colors)]
|
|
formatter.secrets = secrets
|
|
nextColor++
|
|
|
|
logger := logrus.New()
|
|
logger.SetFormatter(formatter)
|
|
logger.SetOutput(os.Stdout)
|
|
logger.SetLevel(logrus.GetLevel())
|
|
rtn := logger.WithFields(logrus.Fields{"job": jobName, "dryrun": common.Dryrun(ctx)})
|
|
|
|
return common.WithLogger(ctx, rtn)
|
|
}
|
|
|
|
type stepLogFormatter struct {
|
|
color int
|
|
secrets map[string]string
|
|
}
|
|
|
|
func (f *stepLogFormatter) Format(entry *logrus.Entry) ([]byte, error) {
|
|
b := &bytes.Buffer{}
|
|
|
|
// Replace any secrets in the entry
|
|
for _, v := range f.secrets {
|
|
entry.Message = strings.ReplaceAll(entry.Message, v, "***")
|
|
}
|
|
|
|
if f.isColored(entry) {
|
|
f.printColored(b, entry)
|
|
} else {
|
|
f.print(b, entry)
|
|
}
|
|
|
|
b.WriteByte('\n')
|
|
return b.Bytes(), nil
|
|
}
|
|
|
|
func (f *stepLogFormatter) printColored(b *bytes.Buffer, entry *logrus.Entry) {
|
|
entry.Message = strings.TrimSuffix(entry.Message, "\n")
|
|
jobName := entry.Data["job"]
|
|
|
|
if entry.Data["raw_output"] == true {
|
|
fmt.Fprintf(b, "\x1b[%dm|\x1b[0m %s", f.color, entry.Message)
|
|
} else if entry.Data["dryrun"] == true {
|
|
fmt.Fprintf(b, "\x1b[1m\x1b[%dm\x1b[7m*DRYRUN*\x1b[0m \x1b[%dm[%s] \x1b[0m%s", gray, f.color, jobName, entry.Message)
|
|
} else {
|
|
fmt.Fprintf(b, "\x1b[%dm[%s] \x1b[0m%s", f.color, jobName, entry.Message)
|
|
}
|
|
}
|
|
|
|
func (f *stepLogFormatter) print(b *bytes.Buffer, entry *logrus.Entry) {
|
|
entry.Message = strings.TrimSuffix(entry.Message, "\n")
|
|
jobName := entry.Data["job"]
|
|
|
|
if entry.Data["raw_output"] == true {
|
|
fmt.Fprintf(b, "[%s] | %s", jobName, entry.Message)
|
|
} else if entry.Data["dryrun"] == true {
|
|
fmt.Fprintf(b, "*DRYRUN* [%s] %s", jobName, entry.Message)
|
|
} else {
|
|
fmt.Fprintf(b, "[%s] %s", jobName, entry.Message)
|
|
}
|
|
}
|
|
|
|
func (f *stepLogFormatter) isColored(entry *logrus.Entry) bool {
|
|
|
|
isColored := checkIfTerminal(entry.Logger.Out)
|
|
|
|
if force, ok := os.LookupEnv("CLICOLOR_FORCE"); ok && force != "0" {
|
|
isColored = true
|
|
} else if ok && force == "0" {
|
|
isColored = false
|
|
} else if os.Getenv("CLICOLOR") == "0" {
|
|
isColored = false
|
|
}
|
|
|
|
return isColored
|
|
}
|
|
|
|
func checkIfTerminal(w io.Writer) bool {
|
|
switch v := w.(type) {
|
|
case *os.File:
|
|
return terminal.IsTerminal(int(v.Fd()))
|
|
default:
|
|
return false
|
|
}
|
|
}
|