// Copyright 2019 Drone IO, Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package reaper import ( "context" "runtime/debug" "time" "github.com/drone/drone/core" "github.com/hashicorp/go-multierror" "github.com/sirupsen/logrus" ) // Reaper finds and kills zombie jobs that are permanently // stuck in a pending or running state. type Reaper struct { Repos core.RepositoryStore Builds core.BuildStore Stages core.StageStore Canceler core.Canceler Pending time.Duration // Pending is the pending pipeline deadline Running time.Duration // Running is the running pipeline deadline } // New returns a new Reaper. func New( repos core.RepositoryStore, builds core.BuildStore, stages core.StageStore, canceler core.Canceler, running time.Duration, pending time.Duration, ) *Reaper { if running == 0 { running = time.Hour * 24 } if pending == 0 { pending = time.Hour * 24 } return &Reaper{ Repos: repos, Builds: builds, Stages: stages, Canceler: canceler, Pending: pending, Running: running, } } // Start starts the reaper. func (r *Reaper) Start(ctx context.Context, dur time.Duration) error { ticker := time.NewTicker(dur) defer ticker.Stop() for { select { case <-ctx.Done(): return ctx.Err() case <-ticker.C: r.reap(ctx) } } } func (r *Reaper) reap(ctx context.Context) error { defer func() { // taking the paranoid approach to recover from // a panic that should absolutely never happen. if r := recover(); r != nil { logrus.Errorf("reaper: unexpected panic: %s", r) debug.PrintStack() } }() logrus.Traceln("reaper: finding zombie builds") var result error pending, err := r.Builds.Pending(ctx) if err != nil { logrus.WithError(err). Errorf("reaper: cannot get pending builds") result = multierror.Append(result, err) } for _, build := range pending { logger := logrus. WithField("build.id", build.ID). WithField("build.number", build.Number). WithField("build.repo_id", build.RepoID). WithField("build.status", build.Status). WithField("build.created", build.Created) // if a build is pending for longer than the maximum // pending time limit, the build is maybe cancelled. if isExceeded(build.Created, r.Pending, buffer) { logger.Traceln("reaper: cancel build: time limit exceeded") err = r.reapMaybe(ctx, build) if err != nil { logger.WithError(err). Errorln("reaper: cannot cancel build") result = multierror.Append(result, err) } } else { logger.Traceln("reaper: ignore build: time limit not exceeded") } } running, err := r.Builds.Running(ctx) if err != nil { logrus.WithError(err). Errorf("reaper: cannot get running builds") result = multierror.Append(result, err) } for _, build := range running { logger := logrus. WithField("build.id", build.ID). WithField("build.number", build.Number). WithField("build.repo_id", build.RepoID). WithField("build.status", build.Status). WithField("build.created", build.Created) // if a build is running for longer than the maximum // running time limit, the build is maybe cancelled. if isExceeded(build.Started, r.Running, buffer) { logger.Traceln("reaper: cancel build: time limit exceeded") err = r.reapMaybe(ctx, build) if err != nil { logger.WithError(err). Errorln("reaper: cannot cancel build") result = multierror.Append(result, err) } } else { logger.Traceln("reaper: ignore build: time limit not exceeded") } } return result } func (r *Reaper) reapMaybe(ctx context.Context, build *core.Build) error { repo, err := r.Repos.Find(ctx, build.RepoID) if err != nil { return err } // if the build status is pending we can immediately // cancel the build and all build stages. if build.Status == core.StatusPending { // TODO trace log entry return r.Canceler.Cancel(ctx, repo, build) } stages, err := r.Stages.List(ctx, build.ID) if err != nil { return err } var started int64 for _, stage := range stages { if stage.IsDone() { continue } if stage.Started > started { started = stage.Started } } // if the build stages are all pending we can immediately // cancel the build. if started == 0 { // TODO trace log entry return r.Canceler.Cancel(ctx, repo, build) } // if the build stage has exceeded the timeout by a reasonable // margin cancel the build and all build stages, else ignore. if isExceeded(started, time.Duration(repo.Timeout)*time.Minute, buffer) { // TODO trace log entry return r.Canceler.Cancel(ctx, repo, build) } // TODO trace log entry return nil }