Merge pull request #13307 from coreydaley/add_build_substatus

Merged by openshift-bot

Author: OpenShift Bot

api/protobuf-spec/github_com_openshift_origin_pkg_build_api_v1.proto

@@ -24394,6 +24394,13 @@
      "output": {
       "$ref": "v1.BuildStatusOutput",
       "description": "output describes the Docker image the build has produced."
+     },
+     "stages": {
+      "type": "array",
+      "items": {
+       "$ref": "v1.StageInfo"
+      },
+      "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."
      }
     }
    },
@@ -24417,6 +24424,51 @@
      }
     }
    },
+   "v1.StageInfo": {
+    "id": "v1.StageInfo",
+    "description": "StageInfo contains details about a build stage.",
+    "properties": {
+     "name": {
+      "type": "string",
+      "description": "name is a unique identifier for each build stage that occurs."
+     },
+     "startTime": {
+      "type": "string",
+      "description": "startTime is a timestamp representing the server time when this Stage started. It is represented in RFC3339 form and is in UTC."
+     },
+     "durationMilliseconds": {
+      "type": "integer",
+      "format": "int64",
+      "description": "durationMilliseconds identifies how long the stage took to complete in milliseconds. Note: the duration of a stage can exceed the sum of the duration of the steps within the stage as not all actions are accounted for in explicit build steps."
+     },
+     "steps": {
+      "type": "array",
+      "items": {
+       "$ref": "v1.StepInfo"
+      },
+      "description": "steps contains details about each step that occurs during a build stage including start time and duration in milliseconds."
+     }
+    }
+   },
+   "v1.StepInfo": {
+    "id": "v1.StepInfo",
+    "description": "StepInfo contains details about a build step.",
+    "properties": {
+     "name": {
+      "type": "string",
+      "description": "name is a unique identifier for each build step."
+     },
+     "startTime": {
+      "type": "string",
+      "description": "startTime is a timestamp representing the server time when this Step started. it is represented in RFC3339 form and is in UTC."
+     },
+     "durationMilliseconds": {
+      "type": "integer",
+      "format": "int64",
+      "description": "durationMilliseconds identifies how long the step took to complete in milliseconds."
+     }
+    }
+   },
    "v1.BuildLog": {
     "id": "v1.BuildLog",
     "description": "BuildLog is the (unused) resource associated with the build log redirector",

api/swagger-spec/oapi-v1.json

@@ -68300,6 +68300,13 @@
       "description": "reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.",
       "type": "string"
      },
+     "stages": {
+      "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.",
+      "type": "array",
+      "items": {
+       "$ref": "#/definitions/v1.StageInfo"
+      }
+     },
      "startTimestamp": {
       "description": "startTimestamp is a timestamp representing the server time when this Build started running in a Pod. It is represented in RFC3339 form and is in UTC.",
       "$ref": "#/definitions/unversioned.Time"
@@ -76213,6 +76220,49 @@
      }
     }
    },
+   "v1.StageInfo": {
+    "description": "StageInfo contains details about a build stage.",
+    "properties": {
+     "durationMilliseconds": {
+      "description": "durationMilliseconds identifies how long the stage took to complete in milliseconds. Note: the duration of a stage can exceed the sum of the duration of the steps within the stage as not all actions are accounted for in explicit build steps.",
+      "type": "integer",
+      "format": "int64"
+     },
+     "name": {
+      "description": "name is a unique identifier for each build stage that occurs.",
+      "type": "string"
+     },
+     "startTime": {
+      "description": "startTime is a timestamp representing the server time when this Stage started. It is represented in RFC3339 form and is in UTC.",
+      "$ref": "#/definitions/unversioned.Time"
+     },
+     "steps": {
+      "description": "steps contains details about each step that occurs during a build stage including start time and duration in milliseconds.",
+      "type": "array",
+      "items": {
+       "$ref": "#/definitions/v1.StepInfo"
+      }
+     }
+    }
+   },
+   "v1.StepInfo": {
+    "description": "StepInfo contains details about a build step.",
+    "properties": {
+     "durationMilliseconds": {
+      "description": "durationMilliseconds identifies how long the step took to complete in milliseconds.",
+      "type": "integer",
+      "format": "int64"
+     },
+     "name": {
+      "description": "name is a unique identifier for each build step.",
+      "type": "string"
+     },
+     "startTime": {
+      "description": "startTime is a timestamp representing the server time when this Step started. it is represented in RFC3339 form and is in UTC.",
+      "$ref": "#/definitions/unversioned.Time"
+     }
+    }
+   },
    "v1.SubjectAccessReview": {
     "description": "SubjectAccessReview is an object for requesting information about whether a user or group can perform an action",
     "required": [

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

@@ -1,7 +1,12 @@
 package api
 
 import (
+	"time"
+
 	kapi "k8s.io/kubernetes/pkg/api"
+	"k8s.io/kubernetes/pkg/api/unversioned"
+
+	"github.com/golang/glog"
 )
 
 // BuildToPodLogOptions builds a PodLogOptions object out of a BuildLogOptions.
@@ -75,3 +80,52 @@ func HasTriggerType(triggerType BuildTriggerType, bc *BuildConfig) bool {
 	matches := FindTriggerPolicy(triggerType, bc)
 	return len(matches) > 0
 }
+
+// RecordStageAndStepInfo records details about each build stage and step
+func RecordStageAndStepInfo(stages []StageInfo, stageName StageName, stepName StepName, startTime unversioned.Time, endTime unversioned.Time) []StageInfo {
+	// If the stage already exists in the slice, update the DurationMilliseconds, and append the new step.
+	for stageKey, stageVal := range stages {
+		if stageVal.Name == stageName {
+			for _, step := range stages[stageKey].Steps {
+				if step.Name == stepName {
+					glog.Warningf("error recording build timing information, step %v already exists in stage %v", stepName, stageName)
+				}
+			}
+			stages[stageKey].DurationMilliseconds = endTime.Time.Sub(stages[stageKey].StartTime.Time).Nanoseconds() / int64(time.Millisecond)
+			if len(stages[stageKey].Steps) == 0 {
+				stages[stageKey].Steps = make([]StepInfo, 0)
+			}
+			stages[stageKey].Steps = append(stages[stageKey].Steps, StepInfo{
+				Name:                 stepName,
+				StartTime:            startTime,
+				DurationMilliseconds: endTime.Time.Sub(startTime.Time).Nanoseconds() / int64(time.Millisecond),
+			})
+			return stages
+		}
+	}
+
+	// If the stageName does not exist, add it to the slice along with the new step.
+	var steps []StepInfo
+	steps = append(steps, StepInfo{
+		Name:                 stepName,
+		StartTime:            startTime,
+		DurationMilliseconds: endTime.Time.Sub(startTime.Time).Nanoseconds() / int64(time.Millisecond),
+	})
+	stages = append(stages, StageInfo{
+		Name:                 stageName,
+		StartTime:            startTime,
+		DurationMilliseconds: endTime.Time.Sub(startTime.Time).Nanoseconds() / int64(time.Millisecond),
+		Steps:                steps,
+	})
+	return stages
+}
+
+// AppendStageAndStepInfo appends the step info from one stages slice into another.
+func AppendStageAndStepInfo(stages []StageInfo, stagesToMerge []StageInfo) []StageInfo {
+	for _, stage := range stagesToMerge {
+		for _, step := range stage.Steps {
+			stages = RecordStageAndStepInfo(stages, stage.Name, step.Name, step.StartTime, unversioned.NewTime(step.StartTime.Add(time.Duration(step.DurationMilliseconds)*time.Millisecond)))
+		}
+	}
+	return stages
+}

pkg/build/api/helpers.go

@@ -287,8 +287,96 @@ type BuildStatus struct {
 
 	// Output describes the Docker image the build has produced.
 	Output BuildStatusOutput
+
+	// 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.
+	Stages []StageInfo
+}
+
+// StageInfo contains details about a build stage.
+type StageInfo struct {
+	// Name is a unique identifier for each build stage that occurs.
+	Name StageName
+
+	// StartTime is a timestamp representing the server time when this Stage started.
+	// It is represented in RFC3339 form and is in UTC.
+	StartTime unversioned.Time
+
+	// DurationMilliseconds identifies how long the stage took
+	// to complete in milliseconds.
+	// Note: the duration of a stage can exceed the sum of the duration of the steps within
+	// the stage as not all actions are accounted for in explicit build steps.
+	DurationMilliseconds int64
+
+	// Steps contains details about each step that occurs during a build stage
+	// including start time and duration in milliseconds.
+	Steps []StepInfo
 }
 
+// StageName is the identifier for each build stage.
+type StageName string
+
+// Valid values for StageName
+const (
+	// StageFetchInputs fetches any inputs such as source code.
+	StageFetchInputs StageName = "FetchInputs"
+
+	// StagePullImages pulls any images that are needed such as
+	// base images or input images.
+	StagePullImages StageName = "PullImages"
+
+	// StageBuild performs the steps necessary to build the image.
+	StageBuild StageName = "Build"
+
+	// StagePostCommit executes any post commit steps.
+	StagePostCommit StageName = "PostCommit"
+
+	// StagePushImage pushes the image to the node.
+	StagePushImage StageName = "PushImage"
+)
+
+// StepInfo contains details about a build step.
+type StepInfo struct {
+	// Name is a unique identifier for each build step.
+	Name StepName
+
+	// StartTime is a timestamp representing the server time when this Step started.
+	// it is represented in RFC3339 form and is in UTC.
+	StartTime unversioned.Time
+
+	// DurationMilliseconds identifies how long the step took
+	// to complete in milliseconds.
+	DurationMilliseconds int64
+}
+
+// StepName is a unique identifier for each build step.
+type StepName string
+
+// Valid values for StepName
+const (
+	// StepExecPostCommitHook executes the buildconfigs post commit hook.
+	StepExecPostCommitHook StepName = "RunPostCommitHook"
+
+	// StepFetchGitSource fetches the source code for the build.
+	StepFetchGitSource StepName = "FetchGitSource"
+
+	// StepPullBaseImage pulls the base image for the build.
+	StepPullBaseImage StepName = "PullBaseImage"
+
+	// StepPullInputImage pulls the input image for the build.
+	StepPullInputImage StepName = "PullInputImage"
+
+	// StepPushImage pushed the image to the registry.
+	StepPushImage StepName = "PushImage"
+
+	// StepPushDockerImage pushes the docker image to the registry.
+	StepPushDockerImage StepName = "PushDockerImage"
+
+	//StepDockerBuild performs the docker build
+	StepDockerBuild StepName = "DockerBuild"
+)
+
 // BuildPhase represents the status of a build at a point in time.
 type BuildPhase string