add failure reasons

Author: Victor

pkg/build/api/types.go

@@ -286,6 +286,46 @@ const (
 	// secret for pushing the output image.
 	// The build will stay in the pending state until the secret is created, or the build times out.
 	StatusReasonMissingPushSecret StatusReason = "MissingPushSecret"
+
+	// StatusReasonPostCommitHookFailed indicates the post-commit hook failed.
+	StatusReasonPostCommitHookFailed StatusReason = "PostCommitHookFailed"
+
+	// StatusReasonPushImageToRegistryFailed indicates that an image failed to be
+	// pushed to the registry.
+	StatusReasonPushImageToRegistryFailed StatusReason = "PushImageToRegistryFailed"
+
+	// StatusReasonPullBuilderImageFailed indicates that we failed to pull the
+	// builder image.
+	StatusReasonPullBuilderImageFailed StatusReason = "PullBuilderImageFailed"
+
+	// StatusReasonFetchSourceFailed indicates that fetching the source of the
+	// build has failed.
+	StatusReasonFetchSourceFailed StatusReason = "FetchSourceFailed"
+
+	// StatusReasonCancelledBuild indicates that the build was cancelled by the
+	// user.
+	StatusReasonCancelledBuild StatusReason = "CancelledBuild"
+
+	// StatusReasonDockerBuildFailed indicates that the docker build strategy has
+	// failed.
+	StatusReasonDockerBuildFailed StatusReason = "DockerBuildFailed"
+)
+
+// NOTE: These messages might change.
+const (
+	StatusMessageCannotCreateBuildPodSpec  = "Failed to create pod spec"
+	StatusMessageCannotCreateBuildPod      = "Failed creating build pod"
+	StatusMessageInvalidOutputRef          = "Output image could not be resolved"
+	StatusMessageCancelBuildFailed         = "Failed to cancel build"
+	StatusMessageBuildPodDeleted           = "The pod for this build was deleted before the build completed"
+	StatusMessageExceededRetryTimeout      = "Build did not complete and retrying timed out"
+	StatusMessageMissingPushSecret         = "Missing push secret"
+	StatusMessagePostCommitHookFailed      = "Build failed because of post commit hook"
+	StatusMessagePushImageToRegistryFailed = "Failed to push the image to the registry"
+	StatusMessagePullBuilderImageFailed    = "Failed pulling builder image"
+	StatusMessageFetchSourceFailed         = "Failed to fetch the input source"
+	StatusMessageCancelledBuild            = "The build was cancelled by the user"
+	StatusMessageDockerBuildFailed         = "Docker build strategy has failed"
 )
 
 // BuildSource is the input used for the build.

pkg/build/builder/common.go

@@ -10,6 +10,8 @@ import (
 	"github.com/docker/distribution/reference"
 	"github.com/fsouza/go-dockerclient"
 
+	kclient "k8s.io/kubernetes/pkg/client/unversioned"
+
 	"github.com/openshift/origin/pkg/build/api"
 	"github.com/openshift/origin/pkg/client"
 	"github.com/openshift/origin/pkg/generate/git"
@@ -20,7 +22,14 @@ import (
 // client facing libraries should not be using glog
 var glog = utilglog.ToFile(os.Stderr, 2)
 
-const OriginalSourceURLAnnotationKey = "openshift.io/original-source-url"
+const (
+	OriginalSourceURLAnnotationKey = "openshift.io/original-source-url"
+
+	// containerNamePrefix prefixes the name of containers launched by a build.
+	// We cannot reuse the prefix "k8s" because we don't want the containers to
+	// be managed by a kubelet.
+	containerNamePrefix = "openshift"
+)
 
 // KeyValue can be used to build ordered lists of key-value pairs.
 type KeyValue struct {
@@ -66,35 +75,6 @@ func buildInfo(build *api.Build) []KeyValue {
 	return kv
 }
 
-func updateBuildRevision(c client.BuildInterface, build *api.Build, sourceInfo *git.SourceInfo) {
-	if build.Spec.Revision != nil {
-		return
-	}
-	build.Spec.Revision = &api.SourceRevision{
-		Git: &api.GitSourceRevision{
-			Commit:  sourceInfo.CommitID,
-			Message: sourceInfo.Message,
-			Author: api.SourceControlUser{
-				Name:  sourceInfo.AuthorName,
-				Email: sourceInfo.AuthorEmail,
-			},
-			Committer: api.SourceControlUser{
-				Name:  sourceInfo.CommitterName,
-				Email: sourceInfo.CommitterEmail,
-			},
-		},
-	}
-
-	// Reset ResourceVersion to avoid a conflict with other updates to the build
-	build.ResourceVersion = ""
-
-	glog.V(4).Infof("Setting build revision to %#v", build.Spec.Revision.Git)
-	_, err := c.UpdateDetails(build)
-	if err != nil {
-		glog.V(0).Infof("error: An error occurred saving build revision: %v", err)
-	}
-}
-
 // randomBuildTag generates a random tag used for building images in such a way
 // that the built image can be referred to unambiguously even in the face of
 // concurrent builds with the same name in the same namespace.
@@ -108,11 +88,6 @@ func randomBuildTag(namespace, name string) string {
 	return fmt.Sprintf("%s:%s", repo, randomTag)
 }
 
-// containerNamePrefix prefixes the name of containers launched by a build. We
-// cannot reuse the prefix "k8s" because we don't want the containers to be
-// managed by a kubelet.
-const containerNamePrefix = "openshift"
-
 // containerName creates names for Docker containers launched by a build. It is
 // meant to resemble Kubernetes' pkg/kubelet/dockertools.BuildDockerName.
 func containerName(strategyName, buildName, namespace, containerPurpose string) string {
@@ -180,3 +155,47 @@ func execPostCommitHook(client DockerClient, postCommitSpec api.BuildPostCommitS
 		Stderr:       true,
 	})
 }
+
+func updateBuildRevision(build *api.Build, sourceInfo *git.SourceInfo) *api.SourceRevision {
+	if build.Spec.Revision != nil {
+		return build.Spec.Revision
+	}
+	return &api.SourceRevision{
+		Git: &api.GitSourceRevision{
+			Commit:  sourceInfo.CommitID,
+			Message: sourceInfo.Message,
+			Author: api.SourceControlUser{
+				Name:  sourceInfo.AuthorName,
+				Email: sourceInfo.AuthorEmail,
+			},
+			Committer: api.SourceControlUser{
+				Name:  sourceInfo.CommitterName,
+				Email: sourceInfo.CommitterEmail,
+			},
+		},
+	}
+}
+
+func retryBuildStatusUpdate(build *api.Build, client client.BuildInterface, sourceRev *api.SourceRevision) error {
+	return kclient.RetryOnConflict(kclient.DefaultBackoff, func() error {
+		// before updating, make sure we are using the latest version of the build
+		latestBuild, err := client.Get(build.Name)
+		if err != nil {
+			// usually this means we failed to get resources due to the missing
+			// privilleges
+			return err
+		}
+		if sourceRev != nil {
+			latestBuild.Spec.Revision = sourceRev
+			latestBuild.ResourceVersion = ""
+		}
+
+		latestBuild.Status.Reason = build.Status.Reason
+		latestBuild.Status.Message = build.Status.Message
+
+		if _, err := client.UpdateDetails(latestBuild); err != nil {
+			return err
+		}
+		return nil
+	})
+}

pkg/build/builder/docker.go

@@ -12,7 +12,9 @@ import (
 	dockercmd "github.com/docker/docker/builder/dockerfile/command"
 	"github.com/docker/docker/builder/dockerfile/parser"
 	docker "github.com/fsouza/go-dockerclient"
+
 	kapi "k8s.io/kubernetes/pkg/api"
+	utilruntime "k8s.io/kubernetes/pkg/util/runtime"
 
 	s2iapi "github.com/openshift/source-to-image/pkg/api"
 	"github.com/openshift/source-to-image/pkg/tar"
@@ -69,12 +71,22 @@ func (d *DockerBuilder) Build() error {
 	}
 	sourceInfo, err := fetchSource(d.dockerClient, buildDir, d.build, d.urlTimeout, os.Stdin, d.gitClient)
 	if err != nil {
+		d.build.Status.Reason = api.StatusReasonFetchSourceFailed
+		d.build.Status.Message = api.StatusMessageFetchSourceFailed
+		if updateErr := retryBuildStatusUpdate(d.build, d.client, nil); updateErr != nil {
+			utilruntime.HandleError(fmt.Errorf("error: An error occured while updating the build status: %v", updateErr))
+		}
 		return err
 	}
+
 	if sourceInfo != nil {
-		updateBuildRevision(d.client, d.build, sourceInfo)
+		glog.V(4).Infof("Setting build revision with details %#v", sourceInfo)
+		revision := updateBuildRevision(d.build, sourceInfo)
+		if updateErr := retryBuildStatusUpdate(d.build, d.client, revision); updateErr != nil {
+			utilruntime.HandleError(fmt.Errorf("error: An error occured while updating the build status: %v", updateErr))
+		}
 	}
-	if err := d.addBuildParameters(buildDir); err != nil {
+	if err = d.addBuildParameters(buildDir); err != nil {
 		return err
 	}
 
@@ -91,14 +103,14 @@ func (d *DockerBuilder) Build() error {
 	dockerfilePath := d.getDockerfilePath(buildDir)
 	imageNames := getDockerfileFrom(dockerfilePath)
 	if len(imageNames) == 0 {
-		return fmt.Errorf("no from image in dockerfile.")
+		return fmt.Errorf("no FROM image in Dockerfile")
 	}
 	for _, imageName := range imageNames {
 		if imageName == "scratch" {
 			glog.V(4).Infof("\nSkipping image \"scratch\"")
 			continue
 		}
-		var imageExists bool = true
+		imageExists := true
 		_, err = d.dockerClient.InspectImage(imageName)
 		if err != nil {
 			if err != docker.ErrNoSuchImage {
@@ -113,18 +125,33 @@ func (d *DockerBuilder) Build() error {
 				dockercfg.PullAuthType,
 			)
 			glog.V(0).Infof("\nPulling image %s ...", imageName)
-			if err := pullImage(d.dockerClient, imageName, pullAuthConfig); err != nil {
+			if err = pullImage(d.dockerClient, imageName, pullAuthConfig); err != nil {
+				d.build.Status.Reason = api.StatusReasonPullBuilderImageFailed
+				d.build.Status.Message = api.StatusMessagePullBuilderImageFailed
+				if updateErr := retryBuildStatusUpdate(d.build, d.client, nil); updateErr != nil {
+					utilruntime.HandleError(fmt.Errorf("error: An error occured while updating the build status: %v", updateErr))
+				}
 				return fmt.Errorf("failed to pull image: %v", err)
 			}
 		}
 	}
 
-	if err := d.dockerBuild(buildDir, buildTag, d.build.Spec.Source.Secrets); err != nil {
+	if err = d.dockerBuild(buildDir, buildTag, d.build.Spec.Source.Secrets); err != nil {
+		d.build.Status.Reason = api.StatusReasonDockerBuildFailed
+		d.build.Status.Message = api.StatusMessageDockerBuildFailed
+		if updateErr := retryBuildStatusUpdate(d.build, d.client, nil); updateErr != nil {
+			utilruntime.HandleError(fmt.Errorf("error: An error occured while updating the build status: %v", updateErr))
+		}
 		return err
 	}
 
 	cname := containerName("docker", d.build.Name, d.build.Namespace, "post-commit")
 	if err := execPostCommitHook(d.dockerClient, d.build.Spec.PostCommit, buildTag, cname); err != nil {
+		d.build.Status.Reason = api.StatusReasonPostCommitHookFailed
+		d.build.Status.Message = api.StatusMessagePostCommitHookFailed
+		if updateErr := retryBuildStatusUpdate(d.build, d.client, nil); updateErr != nil {
+			utilruntime.HandleError(fmt.Errorf("error: An error occured while updating the build status: %v", updateErr))
+		}
 		return err
 	}
 
@@ -149,6 +176,11 @@ func (d *DockerBuilder) Build() error {
 		}
 		glog.V(0).Infof("\nPushing image %s ...", pushTag)
 		if err := pushImage(d.dockerClient, pushTag, pushAuthConfig); err != nil {
+			d.build.Status.Reason = api.StatusReasonPushImageToRegistryFailed
+			d.build.Status.Message = api.StatusMessagePushImageToRegistryFailed
+			if updateErr := retryBuildStatusUpdate(d.build, d.client, nil); updateErr != nil {
+				utilruntime.HandleError(fmt.Errorf("error: An error occured while updating the build status: %v", updateErr))
+			}
 			return reportPushFailure(err, authPresent, pushAuthConfig)
 		}
 		glog.V(0).Infof("Push successful")