Add small snippet of the error log in status

We detect if there is an error and add a small snippet into the checks.
Due of git provider API limitation, this will only show last five lines
of the first error task

Signed-off-by: Chmouel Boudjnah <[email protected]>

Author: chmouel

config/302-pac-configmap.yaml

@@ -33,6 +33,17 @@ data:
   # PipelineRun on the Tekton dashboard
   tekton-dashboard-url: ""
 
+  # Enable or disable the feature to show a log snippet of the failed task when there is
+  # an error in a Pipeline
+  #
+  # It will show the last 3 lines of the first container of the first task
+  # that has error in the pipeline.
+  #
+  # you may want to disable this if you think your pipeline may leak some value
+  error-log-snippet: "true"
+
+  # alpha feature: disabled by default
+  #
   # Enable or disable the inspection of container logs to detect error message
   # and expose them as annotations on Pull Request. Only Github apps is supported
   #

docs/content/docs/guide/statuses.md

@@ -10,6 +10,15 @@ When the pipeline finishes, the status will be added in the GitHub Check tabs
 with a short recap of how long each task of your pipeline took and the output of
 `tkn pr describe`.
 
+## Log error snippet
+
+When we detect an error  in one of the task of the Pipeline we will show a small
+snippet of the last 3 lines in the task breakdown.
+
+This will only show the output of the first task that failed (due of the limitation of the API not allowing to have many characters).
+
+![log snippet](/images/snippet-failure-message.png)
+
 ### Annotations (alpha feature)
 
 If you set `error-detection-from-container-logs` to `true` in the

docs/content/docs/install/settings.md

@@ -72,29 +72,39 @@ There is a few things you can configure through the config map
   for your repository and create a Repository CR.
 
   This feature is disabled by default and is only supported with GitHub App.
-  
+
   ****NOTE****: If you have a GitHub App already setup then verify if `Repository` event is subscribed.
 
 * `auto-configure-repo-namespace-template`
 
   If `auto-configure-new-github-repo` is enabled then you can provide a template for generating the namespace for your new repository.
   By default, the namespace will be generated using this format `{{repo_name}}-pipelines`.
-  
+
   You can override the default using the following variables
-  
+
   * `{{repo_owner}}`: The repository owner.
   * `{{repo_name}}`: The repository name.
-  
+
   for example. if the template is defined as `{{repo_owner}}-{{repo_name}}-ci`, then the namespace generated for repository
   `https://github.com/owner/repo` will be `owner-repo-ci`
 
+* `error-log-snippet`
+
+  Enable or disable the feature to show a log snippet of the failed task when there is
+  an error in a Pipeline
+
+  It will show the last 3 lines of the first container of the first task
+  that has error in the pipeline.
+
+  ***NOTE***: You may want to disable this if you think your pipeline may leak some value
+
 ## Pipelines-As-Code Info
 
   There are a settings exposed through a config map which any authenticated user can access to know about
   Pipeline as Code.
 
 * `version`
-  
+
   The version of Pipelines As Code installed.
 
 * `controller-url`

docs/static/images/snippet-failure-message.png

@@ -61,8 +61,11 @@ type RepositoryRunStatus struct {
 }
 
 type TaskInfos struct {
-	Reason     string
-	LogSnippet string
+	Name           string
+	Message        string
+	LogSnippet     string
+	Reason         string
+	CompletionTime *metav1.Time
 }
 
 // RepositorySpec is the spec of a repo

pkg/apis/pipelinesascode/v1alpha1/types.go

@@ -3,56 +3,24 @@ package status
 import (
 	"context"
 	"regexp"
-	"strings"
 
 	"github.com/google/go-github/v47/github"
 	pacv1alpha1 "github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/v1alpha1"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/kubeinteraction"
+	kstatus "github.com/openshift-pipelines/pipelines-as-code/pkg/kubeinteraction/status"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params"
 	sortrepostatus "github.com/openshift-pipelines/pipelines-as-code/pkg/sort"
 	tektonv1beta1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-var reasonMessageReplacementRegexp = regexp.MustCompile(`\(image: .*`)
-
 // snatched from prow
 // https://github.com/kubernetes/test-infra/blob/3c8cbed65c421670a7d37239b8ffceb91e0eb16b/prow/spyglass/lenses/buildlog/lens.go#L95
 var (
 	ErorrRE                                       = regexp.MustCompile(`timed out|ERROR:|(FAIL|Failure \[)\b|panic\b|^E\d{4} \d\d:\d\d:\d\d\.\d\d\d]`)
 	defaultNumLinesOfLogsInContainersToGrabForErr = int64(10)
 )
 
-// CollectTaskInfos collects all tasks information we are interested in.
-// TODO: move to a better package than cli since used by watcher too
-func CollectTaskInfos(ctx context.Context, cs *params.Run, pr tektonv1beta1.PipelineRun, numLines int64) map[string]pacv1alpha1.TaskInfos {
-	failureReasons := map[string]pacv1alpha1.TaskInfos{}
-	kinteract, _ := kubeinteraction.NewKubernetesInteraction(cs)
-	for _, task := range pr.Status.TaskRuns {
-		if task.Status != nil && len(task.Status.Conditions) > 0 && task.Status.Conditions[0].Reason == tektonv1beta1.PipelineRunReasonFailed.String() {
-			ti := pacv1alpha1.TaskInfos{
-				Reason: reasonMessageReplacementRegexp.ReplaceAllString(task.Status.Conditions[0].Message, ""),
-			}
-
-			if kinteract != nil {
-				for _, step := range task.Status.Steps {
-					if step.Terminated != nil && step.Terminated.ExitCode != 0 {
-						log, err := kinteract.GetPodLogs(ctx, pr.GetNamespace(), task.Status.PodName, step.ContainerName, numLines)
-						if err != nil {
-							cs.Clients.Log.Errorf("cannot get pod logs: %w", err)
-							continue
-						}
-						// see if a pattern match from errRe
-						ti.LogSnippet = strings.TrimSpace(log)
-					}
-				}
-			}
-			failureReasons[task.PipelineTaskName] = ti
-		}
-	}
-	return failureReasons
-}
-
 // RepositoryRunStatusRemoveSameSHA remove an existing status with the same
 // SHA. This would come from repo pipelinerun_status. We don't want the doublons
 // and we rather use the ones from the live PR on cluster.
@@ -68,7 +36,8 @@ func RepositoryRunStatusRemoveSameSHA(rs []pacv1alpha1.RepositoryRunStatus, live
 }
 
 func convertPrStatusToRepositoryStatus(ctx context.Context, cs *params.Run, pr tektonv1beta1.PipelineRun, logurl string) pacv1alpha1.RepositoryRunStatus {
-	failurereasons := CollectTaskInfos(ctx, cs, pr, defaultNumLinesOfLogsInContainersToGrabForErr)
+	kinteract, _ := kubeinteraction.NewKubernetesInteraction(cs)
+	failurereasons := kstatus.CollectFailedTasksLogSnippet(ctx, cs, kinteract, &pr, defaultNumLinesOfLogsInContainersToGrabForErr)
 	prSHA := pr.GetLabels()["pipelinesascode.tekton.dev/sha"]
 	return pacv1alpha1.RepositoryRunStatus{
 		Status:             pr.Status.Status,

pkg/cli/status/status.go

@@ -166,6 +166,11 @@ func TestDescribe(t *testing.T) {
 								Reason:     tektonv1beta1.PipelineRunReasonFailed.String(),
 								LogSnippet: "Error error miss robinson",
 							},
+
+							"task2": {
+								Message: "I was sleeping and I forgot to wake up",
+								Reason:  tektonv1beta1.PipelineRunReasonTimedOut.String(),
+							},
 						},
 						PipelineRunName: "pipelinerun1",
 						LogURL:          github.String("https://everywhere.anwywhere"),

pkg/cmd/tknpac/describe/describe_test.go

@@ -24,8 +24,8 @@
 
 {{ $.ColorScheme.Underline "Failures:" }}
 {{ range $taskName, $task := $status.CollectedTaskInfos }}
-{{- $.ColorScheme.Red "•" }} {{ $taskName }}:	{{ $task.Reason }}
-{{ formatError $.ColorScheme $task.LogSnippet }}
+{{ $.ColorScheme.Bold "•" }} {{ $taskName }}:{{if ne $task.Reason "Failed"}} {{$.ColorScheme.Dimmed $task.Reason}}{{end}}
+{{ if eq $task.LogSnippet ""}}  {{ $task.Message }}{{ else }}{{ formatError $.ColorScheme $task.LogSnippet }}{{end}}
 {{ end }}
 {{- end }}
 {{- if (gt (len .Statuses) 1) }}

pkg/cmd/tknpac/describe/templates/describe.tmpl

@@ -12,6 +12,10 @@ StartTime:      16 minutes ago
 Duration:       1 minute
 
 Failures:
-• task1:   Failed
+
+• task1:
   Error error miss robinson
 
+• task2: PipelineRunTimeout
+  I was sleeping and I forgot to wake up
+

pkg/cmd/tknpac/describe/testdata/TestDescribe-collect_failures.golden

@@ -21,6 +21,7 @@ type Interface interface {
 	CreateBasicAuthSecret(context.Context, *zap.SugaredLogger, *info.Event, string, string) error
 	DeleteBasicAuthSecret(context.Context, *zap.SugaredLogger, string, string) error
 	GetSecret(context.Context, GetSecretOpt) (string, error)
+	GetPodLogs(context.Context, string, string, string, int64) (string, error)
 }
 
 type Interaction struct {