rename to outputexcerpt

Author: bparees

api/protobuf-spec/github_com_openshift_origin_pkg_build_apis_build_v1.proto

@@ -24587,9 +24587,9 @@
       },
       "description": "stages contains details about each stage that occurs during the build including start time, duration (in milliseconds), and the steps that occured within each stage."
      },
-     "logTail": {
+     "outputExcerpt": {
       "type": "string",
-      "description": "LogTail is the last few lines of the build log.  This value is only set for builds that failed."
+      "description": "OutputExcerpt is the last few lines of the build log.  This value is only set for builds that failed."
      }
     }
    },

api/swagger-spec/oapi-v1.json

@@ -82826,10 +82826,6 @@
       "type": "integer",
       "format": "int64"
      },
-     "logTail": {
-      "description": "LogTail is the last few lines of the build log.  This value is only set for builds that failed.",
-      "type": "string"
-     },
      "message": {
       "description": "message is a human-readable message indicating details about why the build has this status.",
       "type": "string"
@@ -82842,6 +82838,10 @@
       "description": "outputDockerImageReference contains a reference to the Docker image that will be built by this build. Its value is computed from Build.Spec.Output.To, and should include the registry address, so that it can be used to push and pull the image.",
       "type": "string"
      },
+     "outputExcerpt": {
+      "description": "OutputExcerpt is the last few lines of the build log.  This value is only set for builds that failed.",
+      "type": "string"
+     },
      "phase": {
       "description": "phase is the point in the build lifecycle. Possible values are \"New\", \"Pending\", \"Running\", \"Complete\", \"Failed\", \"Error\", and \"Cancelled\".",
       "type": "string"

api/swagger-spec/openshift-openapi-spec.json

@@ -305,8 +305,8 @@ type BuildStatus struct {
 	// occured within each stage.
 	Stages []StageInfo
 
-	// LogTail is the last few lines of the build log.  This value is only set for builds that failed.
-	LogTail *string
+	// OutputExcerpt is the last few lines of the build log.  This value is only set for builds that failed.
+	OutputExcerpt string
 }
 
 // StageInfo contains details about a build stage.

pkg/build/apis/build/types.go

@@ -204,7 +204,7 @@ var map_BuildStatus = map[string]string{
 	"config":                     "config is an ObjectReference to the BuildConfig this Build is based on.",
 	"output":                     "output describes the Docker image the build has produced.",
 	"stages":                     "stages contains details about each stage that occurs during the build including start time, duration (in milliseconds), and the steps that occured within each stage.",
-	"logTail":                    "LogTail is the last few lines of the build log.  This value is only set for builds that failed.",
+	"outputExcerpt":              "OutputExcerpt is the last few lines of the build log.  This value is only set for builds that failed.",
 }
 
 func (BuildStatus) SwaggerDoc() map[string]string {

pkg/build/apis/build/v1/generated.pb.go

@@ -214,8 +214,8 @@ type BuildStatus struct {
 	// occured within each stage.
 	Stages []StageInfo `json:"stages,omitempty" protobuf:"bytes,11,opt,name=stages"`
 
-	// LogTail is the last few lines of the build log.  This value is only set for builds that failed.
-	LogTail *string `json:"logTail,omitempty" protobuf:"bytes,12,opt,name=logTail"`
+	// OutputExcerpt is the last few lines of the build log.  This value is only set for builds that failed.
+	OutputExcerpt string `json:"outputExcerpt,omitempty" protobuf:"bytes,12,opt,name=outputExcerpt"`
 }
 
 // StageInfo contains details about a build stage.

pkg/build/apis/build/v1/generated.proto

@@ -811,7 +811,7 @@ func autoConvert_v1_BuildStatus_To_build_BuildStatus(in *BuildStatus, out *build
 		return err
 	}
 	out.Stages = *(*[]build.StageInfo)(unsafe.Pointer(&in.Stages))
-	out.LogTail = (*string)(unsafe.Pointer(in.LogTail))
+	out.OutputExcerpt = in.OutputExcerpt
 	return nil
 }
 
@@ -841,7 +841,7 @@ func autoConvert_build_BuildStatus_To_v1_BuildStatus(in *build.BuildStatus, out
 		return err
 	}
 	out.Stages = *(*[]StageInfo)(unsafe.Pointer(&in.Stages))
-	out.LogTail = (*string)(unsafe.Pointer(in.LogTail))
+	out.OutputExcerpt = in.OutputExcerpt
 	return nil
 }
 

pkg/build/apis/build/v1/swagger_doc.go

@@ -470,11 +470,6 @@ func DeepCopy_v1_BuildStatus(in interface{}, out interface{}, c *conversion.Clon
 				}
 			}
 		}
-		if in.LogTail != nil {
-			in, out := &in.LogTail, &out.LogTail
-			*out = new(string)
-			**out = **in
-		}
 		return nil
 	}
 }

pkg/build/apis/build/v1/types.go

@@ -471,11 +471,6 @@ func DeepCopy_build_BuildStatus(in interface{}, out interface{}, c *conversion.C
 				}
 			}
 		}
-		if in.LogTail != nil {
-			in, out := &in.LogTail, &out.LogTail
-			*out = new(string)
-			**out = **in
-		}
 		return nil
 	}
 }

pkg/build/apis/build/v1/zz_generated.conversion.go

@@ -259,17 +259,17 @@ func shouldIgnore(build *buildapi.Build) bool {
 	}
 
 	// If a build is in a terminal state, ignore it; unless it is in a succeeded or failed
-	// state and its completion time or logtail is not set, then we should at least attempt to set its
-	// completion time and logtail if possible because the build pod may have put the build in
-	// this state and it would have not set the completion timestamp or logtail data.
+	// state and its completion time or outputexcerpt is not set, then we should at least attempt to set its
+	// completion time and outputexcerpt if possible because the build pod may have put the build in
+	// this state and it would have not set the completion timestamp or outputexcerpt data.
 	if buildutil.IsBuildComplete(build) {
 		switch build.Status.Phase {
 		case buildapi.BuildPhaseComplete:
 			if build.Status.CompletionTimestamp == nil {
 				return false
 			}
 		case buildapi.BuildPhaseFailed:
-			if build.Status.CompletionTimestamp == nil || build.Status.LogTail == nil {
+			if build.Status.CompletionTimestamp == nil || len(build.Status.OutputExcerpt) == 0 {
 				return false
 			}
 		}
@@ -551,8 +551,8 @@ func (bc *BuildController) handleActiveBuild(build *buildapi.Build, pod *v1.Pod)
 // handleCompletedBuild will only be called on builds that are already in a terminal phase however, their completion timestamp
 // has not been set.
 func (bc *BuildController) handleCompletedBuild(build *buildapi.Build, pod *v1.Pod) (*buildUpdate, error) {
-	// No-op if the completion timestamp and logtail data(for failed builds only) has already been set
-	if build.Status.CompletionTimestamp != nil && (build.Status.LogTail != nil || build.Status.Phase != buildapi.BuildPhaseFailed) {
+	// No-op if the completion timestamp and outputexcerpt data(for failed builds only) has already been set
+	if build.Status.CompletionTimestamp != nil && (len(build.Status.OutputExcerpt) > 0 || build.Status.Phase != buildapi.BuildPhaseFailed) {
 		return nil, nil
 	}
 
@@ -849,13 +849,14 @@ func setBuildCompletionData(build *buildapi.Build, pod *v1.Pod, update *buildUpd
 			}
 			excerpt := parts[len(parts)-excerptLength:]
 			for i, line := range excerpt {
-				if len(line) > 100 {
-					excerpt[i] = line[0:97] + "..."
+				if len(line) > 120 {
+					middle := len(line) / 2
+					excess := (len(line) - 117) / 2
+					excerpt[i] = line[0:middle-excess] + "..." + line[middle+excess:]
 				}
 			}
 			msg = strings.Join(excerpt, "\n")
-
-			update.setLogTail(msg)
+			update.setOutputExcerpt(msg)
 		}
 	}
 

pkg/build/apis/build/v1/zz_generated.deepcopy.go

@@ -773,7 +773,9 @@ func TestSetBuildCompletionTimestampAndDuration(t *testing.T) {
 
 	for _, test := range tests {
 		update := &buildUpdate{}
-		setBuildCompletionTimestampAndDuration(test.build, test.podStartTime, update)
+		pod := &v1.Pod{}
+		pod.Status.StartTime = test.podStartTime
+		setBuildCompletionData(test.build, pod, update)
 		// Ensure that only the fields in the expected update are set
 		if test.expected.podNameAnnotation == nil && (test.expected.podNameAnnotation != update.podNameAnnotation) {
 			t.Errorf("%s: podNameAnnotation should not be set", test.name)

pkg/build/apis/build/zz_generated.deepcopy.go

@@ -26,7 +26,7 @@ type buildUpdate struct {
 	completionTime    *metav1.Time
 	duration          *time.Duration
 	outputRef         *string
-	logTail           *string
+	outputExcerpt     *string
 }
 
 func (u *buildUpdate) setPhase(phase buildapi.BuildPhase) {
@@ -61,8 +61,8 @@ func (u *buildUpdate) setPodNameAnnotation(podName string) {
 	u.podNameAnnotation = &podName
 }
 
-func (u *buildUpdate) setLogTail(message string) {
-	u.logTail = &message
+func (u *buildUpdate) setOutputExcerpt(message string) {
+	u.outputExcerpt = &message
 }
 
 func (u *buildUpdate) reset() {
@@ -74,7 +74,7 @@ func (u *buildUpdate) reset() {
 	u.completionTime = nil
 	u.duration = nil
 	u.outputRef = nil
-	u.logTail = nil
+	u.outputExcerpt = nil
 }
 
 func (u *buildUpdate) isEmpty() bool {
@@ -86,7 +86,7 @@ func (u *buildUpdate) isEmpty() bool {
 		u.completionTime == nil &&
 		u.duration == nil &&
 		u.outputRef == nil &&
-		u.logTail == nil
+		u.outputExcerpt == nil
 }
 
 func (u *buildUpdate) apply(build *buildapi.Build) {
@@ -114,8 +114,8 @@ func (u *buildUpdate) apply(build *buildapi.Build) {
 	if u.outputRef != nil {
 		build.Status.OutputDockerImageReference = *u.outputRef
 	}
-	if u.logTail != nil {
-		build.Status.LogTail = u.logTail
+	if u.outputExcerpt != nil {
+		build.Status.OutputExcerpt = *u.outputExcerpt
 	}
 }
 
@@ -147,8 +147,8 @@ func (u *buildUpdate) String() string {
 	if u.podNameAnnotation != nil {
 		updates = append(updates, fmt.Sprintf("podName: %q", *u.podNameAnnotation))
 	}
-	if u.logTail != nil {
-		updates = append(updates, fmt.Sprintf("logTail: %q", *u.logTail))
+	if u.outputExcerpt != nil {
+		updates = append(updates, fmt.Sprintf("outputExcerpt: %q", *u.outputExcerpt))
 	}
 	return fmt.Sprintf("buildUpdate(%s)", strings.Join(updates, ", "))
 }

pkg/build/controller/build/build_controller.go

@@ -170,8 +170,8 @@ func (d *BuildDescriber) Describe(namespace, name string, settings kprinters.Des
 
 		describeCommonSpec(build.Spec.CommonSpec, out)
 		describeBuildTriggerCauses(build.Spec.TriggeredBy, out)
-		if build.Status.LogTail != nil {
-			formatString(out, "Log Tail", *build.Status.LogTail)
+		if len(build.Status.OutputExcerpt) != 0 {
+			formatString(out, "Log Tail", build.Status.OutputExcerpt)
 		}
 		if settings.ShowEvents {
 			kinternalprinters.DescribeEvents(events, kinternalprinters.NewPrefixWriter(out))

pkg/build/controller/build/build_controller_test.go

@@ -3084,9 +3084,9 @@ func GetOpenAPIDefinitions(ref openapi.ReferenceCallback) map[string]openapi.Ope
 								},
 							},
 						},
-						"logTail": {
+						"outputExcerpt": {
 							SchemaProps: spec.SchemaProps{
-								Description: "LogTail is the last few lines of the build log.  This value is only set for builds that failed.",
+								Description: "OutputExcerpt is the last few lines of the build log.  This value is only set for builds that failed.",
 								Type:        []string{"string"},
 								Format:      "",
 							},

pkg/build/controller/build/buildupdate.go

@@ -60,7 +60,7 @@ var _ = g.Describe("[builds][Slow] update failure status", func() {
 
 			exutil.CheckForBuildEvent(oc.KubeClient().Core(), br.Build, buildapi.BuildFailedEventReason, buildapi.BuildFailedEventMessage)
 
-			// wait for the build to be updated w/ completiontimestamp which should also mean the logtail
+			// wait for the build to be updated w/ completiontimestamp which should also mean the outputexcerpt
 			// is set if one is going to be set.
 			err = wait.Poll(time.Second, 30*time.Second, func() (bool, error) {
 				// note this is the same build variable used in the test scope
@@ -74,8 +74,7 @@ var _ = g.Describe("[builds][Slow] update failure status", func() {
 				return false, nil
 			})
 			o.Expect(err).NotTo(o.HaveOccurred())
-			o.Expect(build.Status.LogTail).NotTo(o.BeNil(), "LogTail should be set to something for failed builds")
-			o.Expect(len(*build.Status.LogTail)).NotTo(o.Equal(0), "LogTail should be set to something for failed builds")
+			o.Expect(len(build.Status.OutputExcerpt)).NotTo(o.Equal(0), "OutputExcerpt should be set to something for failed builds")
 		})
 	})