Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the error message when source resolver is not resolving #1152

Merged
merged 8 commits into from Mar 10, 2023
Merged

Improve the error message when source resolver is not resolving #1152

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e467c48
Improve the error message when source resolver is not resolving
tomkennedy513 Feb 15, 2023
4b81993
Merge branch 'main' into source-resolver-status
yaelharel Feb 22, 2023
c28aacf
address feedback
Mar 7, 2023
d93c3be
Fix unit tests
Mar 8, 2023
deb92ff
WIP - revert most changes - one test is failing in image_test.go
Mar 9, 2023
7c4d5cc
Fix image_test.go
Mar 9, 2023
4b0451f
Merge branch 'main' into source-resolver-status
yaelharel Mar 10, 2023
e89de9a
Merge branch 'main' into source-resolver-status
yaelharel Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions pkg/apis/build/v1alpha2/image_lifecycle.go
View file
Open in desktop
Expand Up @@ -10,8 +10,9 @@ import (
)

const (
BuilderNotFound = "BuilderNotFound"
BuilderNotReady = "BuilderNotReady"
BuilderNotFound = "BuilderNotFound"
BuilderNotReady = "BuilderNotReady"
SourceResolverNotReady = "SourceResolverNotReady"
)

func (im *Image) BuilderNotFound() corev1alpha1.Conditions {
Expand Down
1 change: 1 addition & 0 deletions pkg/apis/build/v1alpha2/image_types.go
View file
Open in desktop
Expand Up @@ -136,3 +136,4 @@ func (i *Image) NamespacedName() types.NamespacedName {
}

const ConditionBuilderReady corev1alpha1.ConditionType = "BuilderReady"
const ConditionSourceResolverReady corev1alpha1.ConditionType = "SourceResolverReady"
104 changes: 92 additions & 12 deletions pkg/reconciler/image/image_test.go
View file
Open in desktop
Expand Up @@ -764,6 +764,62 @@ func testImageReconciler(t *testing.T, when spec.G, it spec.S) {
unresolvedSourceResolver(imageWithBuilder),
},
WantErr: false,
//no builds are created
WantCreates: nil,
})
})

it("does not schedule a build if the source resolver is in failed state", func() {
sr := unresolvedSourceResolver(imageWithBuilder)
sr.Status = buildapi.SourceResolverStatus{
Status: corev1alpha1.Status{
Conditions: corev1alpha1.Conditions{
{
Type: corev1alpha1.ConditionReady,
Status: corev1.ConditionFalse,
Message: "something is failing",
},
},
},
}
rt.Test(rtesting.TableRow{
Key: key,
Objects: []runtime.Object{
imageWithBuilder,
builder,
sr,
},
WantErr: false,
WantStatusUpdates: []clientgotesting.UpdateActionImpl{
{
Object: &buildapi.Image{
ObjectMeta: imageWithBuilder.ObjectMeta,
Spec: imageWithBuilder.Spec,
Status: buildapi.ImageStatus{
Status: corev1alpha1.Status{
ObservedGeneration: originalGeneration,
Conditions: corev1alpha1.Conditions{
{
Type: corev1alpha1.ConditionReady,
Status: corev1.ConditionUnknown,
Message: "SourceResolver image-name-source is not ready",
},
{
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionFalse,
Reason: buildapi.SourceResolverNotReady,
Message: "SourceResolver image-name-source is not ready: something is failing",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

},
},
},
},
},
},
},
})
})

Expand Down Expand Up @@ -800,6 +856,10 @@ func testImageReconciler(t *testing.T, when spec.G, it spec.S) {
Reason: buildapi.BuilderNotReady,
Message: "Builder builder-name is not ready: something went wrong",
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
},
},
},
Expand Down Expand Up @@ -2210,6 +2270,10 @@ func testImageReconciler(t *testing.T, when spec.G, it spec.S) {
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
},
},
LatestBuildRef: "image-name-build-1",
Expand Down Expand Up @@ -2247,16 +2311,7 @@ func testImageReconciler(t *testing.T, when spec.G, it spec.S) {
Status: buildapi.ImageStatus{
Status: corev1alpha1.Status{
ObservedGeneration: originalGeneration,
Conditions: corev1alpha1.Conditions{
{
Type: corev1alpha1.ConditionReady,
Status: corev1.ConditionUnknown,
},
{
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
},
Conditions: conditionReadyUnknown(),
},
LatestBuildRef: "image-name-build-1",
LatestImage: "some/image@sha256:build-1",
Expand Down Expand Up @@ -2304,6 +2359,10 @@ func testImageReconciler(t *testing.T, when spec.G, it spec.S) {
Reason: buildapi.BuilderNotReady,
Message: "Builder builder-name is not ready",
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
},
},
LatestBuildRef: "image-name-build-1",
Expand Down Expand Up @@ -2387,6 +2446,10 @@ func testImageReconciler(t *testing.T, when spec.G, it spec.S) {
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
},
},
LatestBuildRef: "image-name-build-1",
Expand Down Expand Up @@ -2596,13 +2659,18 @@ func limit(limit int64) *int64 {
func conditionReadyUnknown() corev1alpha1.Conditions {
return corev1alpha1.Conditions{
{
Type: corev1alpha1.ConditionReady,
Status: corev1.ConditionUnknown,
Type: corev1alpha1.ConditionReady,
Status: corev1.ConditionUnknown,
Message: "SourceResolver image-name-source is not ready",
},
{
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionUnknown,
},
}
}

Expand All @@ -2617,6 +2685,10 @@ func conditionBuildExecuting(buildName string) corev1alpha1.Conditions {
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
}
}

Expand All @@ -2630,6 +2702,10 @@ func conditionReady() corev1alpha1.Conditions {
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
}
}

Expand All @@ -2643,5 +2719,9 @@ func conditionNotReady() corev1alpha1.Conditions {
Type: buildapi.ConditionBuilderReady,
Status: corev1.ConditionTrue,
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
},
}
}
51 changes: 49 additions & 2 deletions pkg/reconciler/image/reconcile_build.go
View file
Open in desktop
Expand Up @@ -55,7 +55,7 @@ func (c *Reconciler) reconcileBuild(ctx context.Context, image *buildapi.Image,
case corev1.ConditionFalse:
return buildapi.ImageStatus{
Status: corev1alpha1.Status{
Conditions: noScheduledBuild(result.ConditionStatus, builder, latestBuild),
Conditions: noScheduledBuild(result.ConditionStatus, builder, latestBuild, sourceResolver),
},
LatestBuildRef: latestBuild.BuildRef(),
LatestBuildReason: latestBuild.BuildReason(),
Expand All @@ -70,15 +70,21 @@ func (c *Reconciler) reconcileBuild(ctx context.Context, image *buildapi.Image,
}
}

func noScheduledBuild(buildNeeded corev1.ConditionStatus, builder buildapi.BuilderResource, build *buildapi.Build) corev1alpha1.Conditions {
func noScheduledBuild(buildNeeded corev1.ConditionStatus, builder buildapi.BuilderResource, build *buildapi.Build, sourceResolver *buildapi.SourceResolver) corev1alpha1.Conditions {
if buildNeeded == corev1.ConditionUnknown {
message := ""
if !sourceResolver.Ready() {
message = fmt.Sprintf("SourceResolver %s is not ready", sourceResolver.GetName())
}
return corev1alpha1.Conditions{
{
Type: corev1alpha1.ConditionReady,
Status: corev1.ConditionUnknown,
Message: message,
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
},
builderCondition(builder),
sourceResolverCondition(sourceResolver),
}
}

Expand All @@ -90,6 +96,7 @@ func noScheduledBuild(buildNeeded corev1.ConditionStatus, builder buildapi.Build
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
},
builderCondition(builder),
sourceResolverCondition(sourceResolver),
}

}
Expand Down Expand Up @@ -135,6 +142,41 @@ func builderError(builder buildapi.BuilderResource) string {
return errorMessage
}

func sourceResolverCondition(sourceResolver *buildapi.SourceResolver) corev1alpha1.Condition {
switch unknownStatusIfNil(sourceResolver.Status.GetCondition(corev1alpha1.ConditionReady)) {
case corev1.ConditionFalse:
return corev1alpha1.Condition{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionFalse,
Reason: buildapi.SourceResolverNotReady,
Message: sourceResolverError(sourceResolver),
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
}
case corev1.ConditionTrue:
return corev1alpha1.Condition{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
}
default:
return corev1alpha1.Condition{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionUnknown,
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
}
}
}

func sourceResolverError(sourceResolver *buildapi.SourceResolver) string {
errorMessage := fmt.Sprintf("SourceResolver %s is not ready", sourceResolver.GetName())

if message := emptyMessageIfNil(sourceResolver.Status.GetCondition(corev1alpha1.ConditionReady)); message != "" {
errorMessage = fmt.Sprintf("%s: %s", errorMessage, message)
}

return errorMessage
}

func scheduledBuildCondition(build *buildapi.Build) corev1alpha1.Conditions {
return corev1alpha1.Conditions{
{
Expand All @@ -148,6 +190,11 @@ func scheduledBuildCondition(build *buildapi.Build) corev1alpha1.Conditions {
Status: corev1.ConditionTrue,
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
},
{
Type: buildapi.ConditionSourceResolverReady,
Status: corev1.ConditionTrue,
LastTransitionTime: corev1alpha1.VolatileTime{Inner: metav1.Now()},
},
}
}

Expand Down