func (a DrainAction) Run(drainType DrainType, newSpecs ...boshas.V1ApplySpec) (int, error) {
a.logger.Debug(drainActionLogTag, "Running drain action with drain type %s", drainType)
currentSpec, err := a.specService.Get()
if err != nil {
return 0, bosherr.WrapError(err, "Getting current spec")
}
if len(currentSpec.JobSpec.Template) == 0 {
if drainType == DrainTypeStatus {
return 0, bosherr.Error("Check Status on Drain action requires job spec")
}
return 0, nil
}
a.logger.Debug(drainActionLogTag, "Unmonitoring")
err = a.jobSupervisor.Unmonitor()
if err != nil {
return 0, bosherr.WrapError(err, "Unmonitoring services")
}
drainScript := a.drainScriptProvider.NewScript(currentSpec.JobSpec.Template)
var newSpec *boshas.V1ApplySpec
var params boshdrain.ScriptParams
if len(newSpecs) > 0 {
newSpec = &newSpecs[0]
}
switch drainType {
case DrainTypeUpdate:
if newSpec == nil {
return 0, bosherr.Error("Drain update requires new spec")
}
params = boshdrain.NewUpdateParams(currentSpec, *newSpec)
case DrainTypeShutdown:
err = a.notifier.NotifyShutdown()
if err != nil {
return 0, bosherr.WrapError(err, "Notifying shutdown")
}
params = boshdrain.NewShutdownParams(currentSpec, newSpec)
case DrainTypeStatus:
params = boshdrain.NewStatusParams(currentSpec, newSpec)
}
if !drainScript.Exists() {
if drainType == DrainTypeStatus {
return 0, bosherr.Error("Check Status on Drain action requires a valid drain script")
}
return 0, nil
}
value, err := drainScript.Run(params)
if err != nil {
return 0, bosherr.WrapError(err, "Running Drain Script")
}
return value, nil
}
func init() {
Describe("DrainAction", func() {
var (
notifier *fakenotif.FakeNotifier
specService *fakeas.FakeV1Service
drainScriptProvider *fakedrain.FakeScriptProvider
jobSupervisor *fakejobsuper.FakeJobSupervisor
action DrainAction
logger boshlog.Logger
)
BeforeEach(func() {
logger = boshlog.NewLogger(boshlog.LevelNone)
notifier = fakenotif.NewFakeNotifier()
specService = fakeas.NewFakeV1Service()
drainScriptProvider = fakedrain.NewFakeScriptProvider()
jobSupervisor = fakejobsuper.NewFakeJobSupervisor()
action = NewDrain(notifier, specService, drainScriptProvider, jobSupervisor, logger)
})
BeforeEach(func() {
drainScriptProvider.NewScriptScript.ExistsBool = true
})
It("is asynchronous", func() {
Expect(action.IsAsynchronous()).To(BeTrue())
})
It("is not persistent", func() {
Expect(action.IsPersistent()).To(BeFalse())
})
Context("when drain update is requested", func() {
act := func() (int, error) { return action.Run(DrainTypeUpdate, boshas.V1ApplySpec{}) }
Context("when current agent has a job spec template", func() {
var currentSpec boshas.V1ApplySpec
BeforeEach(func() {
currentSpec = boshas.V1ApplySpec{}
currentSpec.JobSpec.Template = "foo"
specService.Spec = currentSpec
})
It("unmonitors services so that drain scripts can kill processes on their own", func() {
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(jobSupervisor.Unmonitored).To(BeTrue())
})
Context("when unmonitoring services succeeds", func() {
It("does not notify of job shutdown", func() {
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(notifier.NotifiedShutdown).To(BeFalse())
})
Context("when new apply spec is provided", func() {
newSpec := boshas.V1ApplySpec{
PackageSpecs: map[string]boshas.PackageSpec{
"foo": boshas.PackageSpec{
Name: "foo",
Sha1: "foo-sha1-new",
},
},
}
Context("when drain script exists", func() {
It("runs drain script with job_shutdown param", func() {
value, err := action.Run(DrainTypeUpdate, newSpec)
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(drainScriptProvider.NewScriptTemplateName).To(Equal("foo"))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeTrue())
params := drainScriptProvider.NewScriptScript.RunParams
Expect(params).To(Equal(boshdrain.NewUpdateParams(currentSpec, newSpec)))
})
Context("when drain script runs and errs", func() {
It("returns error", func() {
drainScriptProvider.NewScriptScript.RunError = errors.New("fake-drain-run-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-drain-run-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when drain script does not exist", func() {
It("returns 0", func() {
drainScriptProvider.NewScriptScript.ExistsBool = false
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(0))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeFalse())
})
})
})
Context("when apply spec is not provided", func() {
It("returns error", func() {
value, err := action.Run(DrainTypeUpdate)
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("Drain update requires new spec"))
Expect(value).To(Equal(0))
})
})
})
Context("when unmonitoring services fails", func() {
It("returns error", func() {
jobSupervisor.UnmonitorErr = errors.New("fake-unmonitor-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-unmonitor-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when current agent spec does not have a job spec template", func() {
It("returns 0 and does not run drain script", func() {
specService.Spec = boshas.V1ApplySpec{}
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(0))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeFalse())
})
})
})
Context("when drain shutdown is requested", func() {
act := func() (int, error) { return action.Run(DrainTypeShutdown) }
Context("when current agent has a job spec template", func() {
var currentSpec boshas.V1ApplySpec
BeforeEach(func() {
currentSpec = boshas.V1ApplySpec{}
currentSpec.JobSpec.Template = "foo"
specService.Spec = currentSpec
})
It("unmonitors services so that drain scripts can kill processes on their own", func() {
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(jobSupervisor.Unmonitored).To(BeTrue())
})
Context("when unmonitoring services succeeds", func() {
It("notifies that job is about to shutdown", func() {
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(notifier.NotifiedShutdown).To(BeTrue())
})
Context("when job shutdown notification succeeds", func() {
Context("when drain script exists", func() {
It("runs drain script with job_shutdown param passing no apply spec", func() {
value, err := action.Run(DrainTypeShutdown)
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(drainScriptProvider.NewScriptTemplateName).To(Equal("foo"))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeTrue())
params := drainScriptProvider.NewScriptScript.RunParams
Expect(params).To(Equal(boshdrain.NewShutdownParams(currentSpec, nil)))
})
It("runs drain script with job_shutdown param passing in first apply spec", func() {
newSpec := boshas.V1ApplySpec{}
newSpec.JobSpec.Template = "fake-updated-template"
value, err := action.Run(DrainTypeShutdown, newSpec)
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(drainScriptProvider.NewScriptTemplateName).To(Equal("foo"))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeTrue())
params := drainScriptProvider.NewScriptScript.RunParams
Expect(params).To(Equal(boshdrain.NewShutdownParams(currentSpec, &newSpec)))
})
Context("when drain script runs and errs", func() {
It("returns error", func() {
drainScriptProvider.NewScriptScript.RunError = errors.New("fake-drain-run-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-drain-run-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when drain script does not exist", func() {
It("returns 0", func() {
drainScriptProvider.NewScriptScript.ExistsBool = false
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(0))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeFalse())
})
})
})
Context("when job shutdown notification fails", func() {
It("returns error if job shutdown notifications errs", func() {
notifier.NotifyShutdownErr = errors.New("fake-shutdown-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-shutdown-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when unmonitoring services fails", func() {
It("returns error", func() {
jobSupervisor.UnmonitorErr = errors.New("fake-unmonitor-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-unmonitor-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when current agent spec does not have a job spec template", func() {
It("returns 0 and does not run drain script", func() {
specService.Spec = boshas.V1ApplySpec{}
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(0))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeFalse())
})
})
})
Context("when drain status is requested", func() {
act := func() (int, error) { return action.Run(DrainTypeStatus) }
Context("when current agent has a job spec template", func() {
var currentSpec boshas.V1ApplySpec
BeforeEach(func() {
currentSpec = boshas.V1ApplySpec{}
currentSpec.JobSpec.Template = "foo"
specService.Spec = currentSpec
})
It("unmonitors services so that drain scripts can kill processes on their own", func() {
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(jobSupervisor.Unmonitored).To(BeTrue())
})
It("does not notify of job shutdown", func() {
value, err := act()
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(notifier.NotifiedShutdown).To(BeFalse())
})
Context("when unmonitoring services succeeds", func() {
Context("when drain script exists", func() {
It("runs drain script with job_check_status param passing no apply spec", func() {
value, err := action.Run(DrainTypeStatus)
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(drainScriptProvider.NewScriptTemplateName).To(Equal("foo"))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeTrue())
params := drainScriptProvider.NewScriptScript.RunParams
Expect(params).To(Equal(boshdrain.NewStatusParams(currentSpec, nil)))
})
It("runs drain script with job_check_status param passing in first apply spec", func() {
newSpec := boshas.V1ApplySpec{}
newSpec.JobSpec.Template = "fake-updated-template"
value, err := action.Run(DrainTypeStatus, newSpec)
Expect(err).ToNot(HaveOccurred())
Expect(value).To(Equal(1))
Expect(drainScriptProvider.NewScriptTemplateName).To(Equal("foo"))
Expect(drainScriptProvider.NewScriptScript.DidRun).To(BeTrue())
params := drainScriptProvider.NewScriptScript.RunParams
Expect(params).To(Equal(boshdrain.NewStatusParams(currentSpec, &newSpec)))
})
Context("when drain script runs and errs", func() {
It("returns error if drain script errs", func() {
drainScriptProvider.NewScriptScript.RunError = errors.New("fake-drain-run-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-drain-run-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when drain script does not exist", func() {
It("returns error because drain status must be called after starting draining", func() {
drainScriptProvider.NewScriptScript.ExistsBool = false
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("Check Status on Drain action requires a valid drain script"))
Expect(value).To(Equal(0))
})
})
})
Context("when unmonitoring services fails", func() {
It("returns error if unmonitoring services errs", func() {
jobSupervisor.UnmonitorErr = errors.New("fake-unmonitor-error")
value, err := act()
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("fake-unmonitor-error"))
Expect(value).To(Equal(0))
})
})
})
Context("when current agent spec does not have a job spec template", func() {
It("returns error because drain status should only be called after starting draining", func() {
specService.Spec = boshas.V1ApplySpec{}
value, err := action.Run(DrainTypeStatus)
Expect(err).To(HaveOccurred())
Expect(err.Error()).To(ContainSubstring("Check Status on Drain action requires job spec"))
Expect(value).To(Equal(0))
})
})
})
})
}