HGKeeper

// Convey

// 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"

"time"

log "github.com/sirupsen/logrus"

"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 *log.Entry

}

// 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.Debugf("remaining plantime: %s", rt.Timeout)

if err != nil {

stageLogger.Error("stage failed")

planErr = err

continue

}

stageLogger.Infof("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

}