grim/convey

Port from logrus to log/slog
default tip
5 months ago, Elliott Sales de Andrade
c588f9b3f559
Port from logrus to log/slog

This doesn't really take much advantage of structured logging beyond what is already done (`id` and `idColor`), and consequently the log handler does not try to do any handling of anything more than that (i.e., grouping, or arbitrary attributes beyond those defined).

One should maybe have a `Context` available to pass in, but there isn't one, and anyway, the log handler doesn't use it, so I've passed in a `TODO` instead.

Everything else is just normal import/rename changes.

Testing Done:
Ran `go run . run`

Reviewed at https://reviews.imfreedom.org/r/2871/
// Convey
// Copyright 2016-2018 Gary Kramlich <grim@reaperworld.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// Package plans contains the plans structure.
package runtime
import (
"errors"
"fmt"
"log/slog"
"time"
"keep.imfreedom.org/grim/convey/logging"
"keep.imfreedom.org/grim/convey/yaml"
)
var (
// ErrNoStages is an error that can be returned from Plan.Valid.
ErrNoStages = errors.New("no stages found")
)
// Plan is the representation of a Plan.
type Plan struct {
Environment yaml.StringOrSlice `yaml:"environment"`
Stages []Stage `yaml:"stages"`
logger *slog.Logger
}
// Execute runs the plan.
func (p *Plan) Execute(path string, rt *Runtime) error {
if err := p.Valid(); err != nil {
return err
}
planEnv := rt.ConfigEnvironment.Copy().MergeSlice(p.Environment).Merge(rt.Environment)
p.logger = logging.NewAdapter(path)
// set a flag on whether or not we've failed
var planErr error
for idx, stage := range p.Stages {
start := time.Now()
absStageName := ""
if stage.Name != "" {
absStageName = fmt.Sprintf("%s/%s", path, stage.Name)
} else {
absStageName = fmt.Sprintf("%s/%d", path, idx)
}
stageLogger := logging.NewAdapter(absStageName)
if stage.ShouldRun(planErr) {
stageLogger.Info("stage starting")
err := stage.Execute(absStageName, stageLogger, planEnv, rt)
elapsed := time.Since(start)
rt.Timeout -= elapsed
p.logger.Debug(fmt.Sprintf("remaining plantime: %s", rt.Timeout))
if err != nil {
stageLogger.Error("stage failed")
planErr = err
continue
}
stageLogger.Info(fmt.Sprintf("stage finished [%s]", elapsed.Round(10*time.Millisecond)))
}
}
return planErr
}
// Valid validates the plan.
func (p *Plan) Valid() error {
if len(p.Stages) == 0 {
return ErrNoStages
}
return nil
}