List dead job-processes as failed

Previously listed as `stopped` but this only occurs when a bpm
job-process dies, or is unexpectedly killed.

[finishes #152414698]

Signed-off-by: James Myers <jmyers@pivotal.io>

Author: aramprice

src/bpm/commands/start.go

@@ -17,7 +17,7 @@ package commands
 
 import (
 	"bpm/config"
-	"bpm/runc/lifecycle"
+	"bpm/models"
 	"fmt"
 
 	"github.com/spf13/cobra"
@@ -83,10 +83,10 @@ func start(cmd *cobra.Command, _ []string) error {
 	}
 
 	switch state {
-	case lifecycle.ContainerStateRunning:
+	case models.ProcessStateRunning:
 		logger.Info("process-already-running")
 		return nil
-	case lifecycle.ContainerStateStopped:
+	case models.ProcessStateFailed:
 		logger.Info("removing-stopped-process")
 		if err := runcLifecycle.RemoveProcess(bpmCfg); err != nil {
 			logger.Error("failed-to-cleanup", err)

src/bpm/main_test.go

@@ -781,7 +781,7 @@ var _ = Describe("bpm", func() {
 				session, err = gexec.Start(command, GinkgoWriter, GinkgoWriter)
 				Expect(err).ShouldNot(HaveOccurred())
 				Eventually(session).Should(gexec.Exit(0))
-				Expect(session.Out).Should(gbytes.Say("stopped"))
+				Expect(session.Out).Should(gbytes.Say("failed"))
 			})
 
 			It("`bpm start` cleans up the associated container and artifacts and starts it", func() {
@@ -816,7 +816,7 @@ var _ = Describe("bpm", func() {
 					Expect(err).ShouldNot(HaveOccurred())
 					Eventually(session).Should(gexec.Exit(0))
 
-					Expect(session.Out).Should(gbytes.Say("stopped"))
+					Expect(session.Out).Should(gbytes.Say("failed"))
 				})
 			})
 		})

src/bpm/models/models.go

@@ -15,6 +15,11 @@
 
 package models
 
+const (
+	ProcessStateRunning = "running"
+	ProcessStateFailed  = "failed"
+)
+
 type Process struct {
 	Name   string
 	Pid    int

src/bpm/presenters/presenters.go

@@ -25,16 +25,22 @@ import (
 	"text/tabwriter"
 )
 
-func PrintJobs(jobs []models.Process, stdout io.Writer) error {
+func PrintJobs(processes []*models.Process, stdout io.Writer) error {
 	tw := tabwriter.NewWriter(stdout, 0, 0, 1, ' ', 0)
 
 	printRow(tw, "Name", "Pid", "Status")
-	for _, job := range jobs {
-		name, err := config.Decode(job.Name)
+	for _, process := range processes {
+		name, err := config.Decode(process.Name)
 		if err != nil {
 			return err
 		}
-		printRow(tw, name, strconv.Itoa(job.Pid), job.Status)
+
+		pid := "-"
+		if process.Pid > 0 {
+			pid = strconv.Itoa(process.Pid)
+		}
+
+		printRow(tw, name, pid, process.Status)
 	}
 
 	return tw.Flush()

src/bpm/presenters/presenters_suite_test.go

@@ -0,0 +1,28 @@
+// Copyright (C) 2017-Present Pivotal Software, Inc. All rights reserved.
+//
+// This program and the accompanying materials are made available under
+// the terms of the 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 presenters_test
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"testing"
+)
+
+func TestPresenters(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Presenters Suite")
+}

src/bpm/presenters/presenters_test.go

@@ -0,0 +1,54 @@
+// Copyright (C) 2017-Present Pivotal Software, Inc. All rights reserved.
+//
+// This program and the accompanying materials are made available under
+// the terms of the 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 presenters_test
+
+import (
+	"bpm/config"
+	"bpm/models"
+	"bpm/presenters"
+	"fmt"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"github.com/onsi/gomega/gbytes"
+)
+
+var _ = Describe("Presenters", func() {
+	Describe("PresentJobs", func() {
+		var (
+			processes []*models.Process
+			output    *gbytes.Buffer
+		)
+
+		BeforeEach(func() {
+			processes = []*models.Process{
+				{Name: config.Encode("job-process-2"), Pid: 23456, Status: "created"},
+				{Name: config.Encode("job-process-1"), Pid: 34567, Status: "running"},
+				{Name: config.Encode("job-process-3"), Pid: 0, Status: "failed"},
+			}
+
+			output = gbytes.NewBuffer()
+		})
+
+		It("prints the jobs in a table", func() {
+			Expect(presenters.PrintJobs(processes, output)).To(Succeed())
+			Expect(output).Should(gbytes.Say("Name\\s+Pid\\s+Status"))
+			Expect(output).Should(gbytes.Say(fmt.Sprintf("%s\\s+%d\\s+%s", "job-process-2", 23456, "created")))
+			Expect(output).Should(gbytes.Say(fmt.Sprintf("%s\\s+%d\\s+%s", "job-process-1", 34567, "running")))
+			Expect(output).Should(gbytes.Say(fmt.Sprintf("%s\\s+%s\\s+%s", "job-process-3", "-", "failed")))
+		})
+	})
+})

src/bpm/runc/lifecycle/lifecycle.go

@@ -165,31 +165,30 @@ func (j *RuncLifecycle) GetProcess(cfg *config.BPMConfig) (*models.Process, erro
 		return nil, nil
 	}
 
-	return &models.Process{
-		Name:   container.ID,
-		Pid:    container.Pid,
-		Status: container.Status,
-	}, nil
+	return newProcessFromContainerState(
+		container.ID,
+		container.Status,
+		container.Pid,
+	), nil
 }
 
 func (j *RuncLifecycle) OpenShell(cfg *config.BPMConfig, stdin io.Reader, stdout, stderr io.Writer) error {
 	return j.runcClient.Exec(cfg.ContainerID(true), "/bin/bash", stdin, stdout, stderr)
 }
 
-func (j *RuncLifecycle) ListProcesses() ([]models.Process, error) {
+func (j *RuncLifecycle) ListProcesses() ([]*models.Process, error) {
 	containers, err := j.runcClient.ListContainers()
 	if err != nil {
 		return nil, err
 	}
 
-	var processes []models.Process
+	var processes []*models.Process
 	for _, c := range containers {
-		process := models.Process{
-			Name:   c.ID,
-			Pid:    c.InitProcessPid,
-			Status: c.Status,
-		}
-		processes = append(processes, process)
+		processes = append(processes, newProcessFromContainerState(
+			c.ID,
+			c.Status,
+			c.InitProcessPid,
+		))
 	}
 
 	return processes, nil
@@ -205,7 +204,7 @@ func (j *RuncLifecycle) StopProcess(logger lager.Logger, cfg *config.BPMConfig,
 	if err != nil {
 		logger.Error("failed-to-fetch-state", err)
 	} else {
-		if state.Status == "stopped" {
+		if state.Status == ContainerStateStopped {
 			return nil
 		}
 	}
@@ -221,7 +220,7 @@ func (j *RuncLifecycle) StopProcess(logger lager.Logger, cfg *config.BPMConfig,
 			if err != nil {
 				logger.Error("failed-to-fetch-state", err)
 			} else {
-				if state.Status == "stopped" {
+				if state.Status == ContainerStateStopped {
 					return nil
 				}
 			}
@@ -246,6 +245,18 @@ func (j *RuncLifecycle) RemoveProcess(cfg *config.BPMConfig) error {
 	return j.runcClient.DestroyBundle(cfg.BundlePath())
 }
 
+func newProcessFromContainerState(id, status string, pid int) *models.Process {
+	if status == ContainerStateStopped {
+		status = "failed"
+	}
+
+	return &models.Process{
+		Name:   id,
+		Pid:    pid,
+		Status: status,
+	}
+}
+
 type commandRunner struct{}
 
 func NewCommandRunner() CommandRunner          { return &commandRunner{} }

src/bpm/runc/lifecycle/lifecycle_test.go

@@ -518,10 +518,10 @@ var _ = Describe("RuncJobLifecycle", func() {
 			bpmJobs, err := runcLifecycle.ListProcesses()
 			Expect(err).NotTo(HaveOccurred())
 
-			Expect(bpmJobs).To(ConsistOf([]models.Process{
+			Expect(bpmJobs).To(ConsistOf([]*models.Process{
 				{Name: "job-process-2", Pid: 23456, Status: "created"},
 				{Name: "job-process-1", Pid: 34567, Status: "running"},
-				{Name: "job-process-3", Pid: 0, Status: "stopped"},
+				{Name: "job-process-3", Pid: 0, Status: "failed"},
 			}))
 		})
 
@@ -542,18 +542,33 @@ var _ = Describe("RuncJobLifecycle", func() {
 		})
 
 		It("fetches the container state and translates it into a job", func() {
-			job, err := runcLifecycle.GetProcess(bpmCfg)
+			process, err := runcLifecycle.GetProcess(bpmCfg)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(fakeRuncClient.ContainerStateCallCount()).To(Equal(1))
 			Expect(fakeRuncClient.ContainerStateArgsForCall(0)).To(Equal(expectedContainerID))
-			Expect(job).NotTo(BeNil())
-			Expect(*job).To(Equal(models.Process{
+			Expect(process).To(Equal(&models.Process{
 				Name:   expectedContainerID,
 				Pid:    1234,
 				Status: "running",
 			}))
 		})
 
+		Context("when the container state is stopped", func() {
+			BeforeEach(func() {
+				fakeRuncClient.ContainerStateReturns(&specs.State{ID: expectedContainerID, Pid: 0, Status: "stopped"}, nil)
+			})
+
+			It("fetches the container state and translates it into a job", func() {
+				process, err := runcLifecycle.GetProcess(bpmCfg)
+				Expect(err).NotTo(HaveOccurred())
+				Expect(process).To(Equal(&models.Process{
+					Name:   expectedContainerID,
+					Pid:    0,
+					Status: "failed",
+				}))
+			})
+		})
+
 		Context("when the process name is the same as the job name", func() {
 			BeforeEach(func() {
 				bpmCfg = config.NewBPMConfig(expectedSystemRoot, expectedJobName, expectedJobName)
@@ -574,10 +589,10 @@ var _ = Describe("RuncJobLifecycle", func() {
 			})
 
 			It("returns nil,nil", func() {
-				job, err := runcLifecycle.GetProcess(bpmCfg)
+				process, err := runcLifecycle.GetProcess(bpmCfg)
 				Expect(err).NotTo(HaveOccurred())
 
-				Expect(job).To(BeNil())
+				Expect(process).To(BeNil())
 			})
 		})