grim/convey

Fix an issue where an expired timeout would cause the network and workspace to not be cleaned up. Fixed #137

2018-01-14, Gary Kramlich
2d01f20e84e7
Fix an issue where an expired timeout would cause the network and workspace to not be cleaned up. Fixed #137
// 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 plans
import (
"errors"
"fmt"
"time"
"github.com/aphistic/gomol"
"bitbucket.org/rw_grim/convey/docker"
"bitbucket.org/rw_grim/convey/environment"
"bitbucket.org/rw_grim/convey/logging"
"bitbucket.org/rw_grim/convey/stages"
"bitbucket.org/rw_grim/convey/state"
"bitbucket.org/rw_grim/convey/tasks"
"bitbucket.org/rw_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 []stages.Stage `yaml:"stages"`
Merge bool `yaml:"merge"`
}
func (p *Plan) setup(logger *gomol.LogAdapter, st *state.State) error {
// create the network
logger.Info("creating network...")
network, err := docker.NewNetwork(st)
if err != nil {
logger.Fatal("failed to create network")
return err
}
st.Network = network
logger.Infof("created network %s", st.Network.Name())
// create the workspace
logger.Info("creating workspace...")
ws, err := docker.NewWorkspace(st)
if err != nil {
logger.Fatal("failed to create workspace")
return err
}
st.Workspace = ws
logger.Infof("created workspace %s", st.Workspace.Name())
return nil
}
func (p *Plan) teardown(logger *gomol.LogAdapter, st *state.State) {
// run through the DetachedContainers and stop them
for _, cid := range st.GetDetached() {
logger.Infof("removing detached container %s", cid)
docker.StopContainer(cid, logger, st)
}
// remove the workspace (if requested)
if st.KeepWorkspace {
logger.Infof("not removing workspace %s as requested", st.Workspace.Name())
} else {
logger.Infof("removing workspace %s", st.Workspace.Name())
if err := st.Workspace.Destroy(); err != nil {
logger.Fatalf("failed to remove workspace %s", st.Workspace.Name())
} else {
logger.Infof("removed workspace %s", st.Workspace.Name())
}
}
// remove the network
logger.Infof("removing network %s", st.Network.Name())
if err := st.Network.Destroy(); err != nil {
logger.Fatalf("failed to remove network %s", st.Network.Name())
} else {
logger.Infof("removed network %s", st.Network.Name())
}
}
// Execute runs the plan.
func (p *Plan) Execute(path string, tasks map[string]tasks.Task, env []string, st *state.State) error {
logger := logging.NewAdapter(path)
planEnv := environment.Merge(env, p.Environment)
// Teardown plan on defer on app exit
cleanupFn := st.CleanupList.Add(func() { p.teardown(logger, st) })
// Call cleanup function on defer, which may instead be called
// if the cleanup thread traps a signal.
defer cleanupFn()
if err := p.setup(logger, st); err != nil {
return err
}
// set a flag on whether or not we've failed
var planErr error
for _, stage := range p.Stages {
start := time.Now()
absStageName := fmt.Sprintf("%s/%s", path, stage.Name)
stageLogger := logging.NewAdapter(absStageName)
if stage.ShouldRun(planErr) {
stageLogger.Info("stage starting")
err := stage.Execute(absStageName, stageLogger, tasks, planEnv, st)
if err != nil {
stageLogger.Fatal("stage failed")
planErr = err
continue
}
elapsed := time.Since(start)
st.PlanTimeout -= elapsed
logger.Debugf("remaining plantime: %s", st.PlanTimeout)
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
}