Add Reason and Message into terminationMessage

We should get a detail information in order to indicate the reason of why entrypointer failed
Sometimes, it would be DeadlineExecced or others and we want to represent it on TaskStep.
It is a PRE-PR to implement the issue tektoncd#1690

Signed-off-by: jtcheng <jtcheng0616@gmail.com>

Author: chengjingtao

cmd/entrypoint/runner.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"os"
 	"os/exec"
 
@@ -15,13 +16,13 @@ type realRunner struct{}
 
 var _ entrypoint.Runner = (*realRunner)(nil)
 
-func (*realRunner) Run(args ...string) error {
+func (*realRunner) Run(ctx context.Context, args ...string) error {
 	if len(args) == 0 {
 		return nil
 	}
 	name, args := args[0], args[1:]
 
-	cmd := exec.Command(name, args...)
+	cmd := exec.CommandContext(ctx, name, args...)
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 

pkg/entrypoint/entrypointer.go

@@ -17,6 +17,7 @@ limitations under the License.
 package entrypoint
 
 import (
+	"context"
 	"fmt"
 	"io/ioutil"
 	"os"
@@ -68,7 +69,7 @@ type Waiter interface {
 
 // Runner encapsulates running commands.
 type Runner interface {
-	Run(args ...string) error
+	Run(ctx context.Context, args ...string) error
 }
 
 // PostWriter encapsulates writing a file when complete.
@@ -113,7 +114,8 @@ func (e Entrypointer) Go() error {
 		Value: time.Now().Format(time.RFC3339),
 	})
 
-	err := e.Runner.Run(e.Args...)
+	err := e.Runner.Run(context.TODO(), e.Args...)
+	output = append(output, e.fmtErrOutPut(err)...)
 
 	// Write the post file *no matter what*
 	e.WritePostFile(e.PostFile, err)
@@ -129,6 +131,26 @@ func (e Entrypointer) Go() error {
 	return err
 }
 
+// fmtErrOutPut will format error to PipelineResourceResult
+func (e Entrypointer) fmtErrOutPut(err error) []v1alpha1.PipelineResourceResult {
+	if err == nil {
+		return []v1alpha1.PipelineResourceResult{}
+	}
+	// TODO: will add logic to format reason according error type sooner, example: DeadlineExceeded
+	// For more details, refer to:  https://github.com/tektoncd/pipeline/issues/1690
+
+	return []v1alpha1.PipelineResourceResult{
+		{
+			Key:   "Reason",
+			Value: err.Error(),
+		},
+		{
+			Key:   "Message",
+			Value: err.Error(),
+		},
+	}
+}
+
 func (e Entrypointer) readResultsFromDisk() error {
 	output := []v1alpha1.PipelineResourceResult{}
 	for _, resultFile := range e.Results {

pkg/entrypoint/entrypointer_test.go

@@ -17,6 +17,7 @@ limitations under the License.
 package entrypoint
 
 import (
+	"context"
 	"encoding/json"
 	"errors"
 	"io/ioutil"
@@ -93,6 +94,43 @@ func TestEntrypointerFailures(t *testing.T) {
 			if c.postFile == "" && fpw.wrote != nil {
 				t.Errorf("Wrote post file when not required")
 			}
+
+			if c.waiter == nil {
+				fileContents, err := ioutil.ReadFile("termination")
+				if err == nil {
+					var entries []v1alpha1.PipelineResourceResult
+					if err := json.Unmarshal([]byte(fileContents), &entries); err == nil {
+						index := make(map[string]v1alpha1.PipelineResourceResult, len(entries))
+						for _, item := range entries {
+							index[item.Key] = item
+						}
+						if _, ok := index["StartedAt"]; !ok {
+							t.Error("Didn't find the StartedAt entry")
+						}
+						if reason, ok := index["Reason"]; ok {
+							if reason.Value != "runner failed" {
+								t.Error("Reason should be runner failed")
+							}
+						} else {
+							t.Error("Didn't find the Reason entry")
+						}
+
+						if message, ok := index["Message"]; ok {
+							if message.Value != "runner failed" {
+								t.Error("Message should be runner failed")
+							}
+						} else {
+							t.Error("Didn't find the Message entry ")
+						}
+					}
+				} else if !os.IsNotExist(err) {
+					t.Error("Wanted termination file written, got nil")
+				}
+				if err := os.Remove("termination"); err != nil {
+					t.Errorf("Could not remove termination path: %s", err)
+				}
+			}
+
 		})
 	}
 }
@@ -213,7 +251,7 @@ func (f *fakeWaiter) Wait(file string, _ bool) error {
 
 type fakeRunner struct{ args *[]string }
 
-func (f *fakeRunner) Run(args ...string) error {
+func (f *fakeRunner) Run(ctx context.Context, args ...string) error {
 	f.args = &args
 	return nil
 }
@@ -231,7 +269,7 @@ func (f *fakeErrorWaiter) Wait(file string, expectContent bool) error {
 
 type fakeErrorRunner struct{ args *[]string }
 
-func (f *fakeErrorRunner) Run(args ...string) error {
+func (f *fakeErrorRunner) Run(ctx context.Context, args ...string) error {
 	f.args = &args
 	return errors.New("runner failed")
 }

test/taskrun_test.go

@@ -95,6 +95,7 @@ func TestTaskRunFailure(t *testing.T) {
 			Terminated: &corev1.ContainerStateTerminated{
 				ExitCode: 1,
 				Reason:   "Error",
+				Message:  `[{"key":"Message","value":"exit status 1","resourceRef":{}},{"key":"Reason","value":"exit status 1","resourceRef":{}}]`,
 			},
 		},
 		Name:          "unnamed-1",

test/v1alpha1/taskrun_test.go

@@ -86,6 +86,7 @@ func TestTaskRunFailure(t *testing.T) {
 			Terminated: &corev1.ContainerStateTerminated{
 				ExitCode: 1,
 				Reason:   "Error",
+				Message:  `[{"key":"Message","value":"exit status 1","resourceRef":{}},{"key":"Reason","value":"exit status 1","resourceRef":{}}]`,
 			},
 		},
 		Name:          "unnamed-1",