From f3186364eb622b443aad3481676a2865e3818309 Mon Sep 17 00:00:00 2001 From: Sascha Schwarze Date: Mon, 19 Feb 2024 17:32:34 +0100 Subject: [PATCH] Add logic to convert the status of a Build and BuildRun from Beta to Alpha Co-authored-by: Enrique Encalada --- pkg/apis/build/v1beta1/build_conversion.go | 6 + pkg/apis/build/v1beta1/buildrun_conversion.go | 65 ++++++++ pkg/webhook/conversion/converter_test.go | 157 ++++++++++++++++++ 3 files changed, 228 insertions(+) diff --git a/pkg/apis/build/v1beta1/build_conversion.go b/pkg/apis/build/v1beta1/build_conversion.go index c0199aae74..c39d652d23 100644 --- a/pkg/apis/build/v1beta1/build_conversion.go +++ b/pkg/apis/build/v1beta1/build_conversion.go @@ -38,6 +38,12 @@ func (src *Build) ConvertTo(ctx context.Context, obj *unstructured.Unstructured) src.Spec.ConvertTo(&alphaBuild.Spec) + alphaBuild.Status = v1alpha1.BuildStatus{ + Registered: src.Status.Registered, + Reason: (*v1alpha1.BuildReason)(src.Status.Reason), + Message: src.Status.Message, + } + // convert annotation-controlled features if src.Spec.Retention != nil && src.Spec.Retention.AtBuildDeletion != nil { // We must create a new Map as otherwise the addition is not kept diff --git a/pkg/apis/build/v1beta1/buildrun_conversion.go b/pkg/apis/build/v1beta1/buildrun_conversion.go index aa7405470d..ddcdf6aa9a 100644 --- a/pkg/apis/build/v1beta1/buildrun_conversion.go +++ b/pkg/apis/build/v1beta1/buildrun_conversion.go @@ -108,6 +108,71 @@ func (src *BuildRun) ConvertTo(ctx context.Context, obj *unstructured.Unstructur }) } + // BuildRun Status + var sourceStatus []v1alpha1.SourceResult + if src.Status.Source != nil && src.Status.Source.Git != nil { + // Note: v1alpha contains a Name field under the SourceResult + // object, which we dont set here. + sourceStatus = append(sourceStatus, v1alpha1.SourceResult{ + Name: "default", + Git: (*v1alpha1.GitSourceResult)(src.Status.Source.Git), + Timestamp: src.Status.Source.Timestamp, + }) + } + + if src.Status.Source != nil && src.Status.Source.OciArtifact != nil { + // Note: v1alpha contains a Name field under the SourceResult + // object, which we dont set here. + sourceStatus = append(sourceStatus, v1alpha1.SourceResult{ + Name: "default", + Bundle: (*v1alpha1.BundleSourceResult)(src.Status.Source.OciArtifact), + Timestamp: src.Status.Source.Timestamp, + }) + } + + var conditions []v1alpha1.Condition + for _, c := range src.Status.Conditions { + ct := v1alpha1.Condition{ + Type: v1alpha1.Type(c.Type), + Status: c.Status, + LastTransitionTime: c.LastTransitionTime, + Reason: c.Reason, + Message: c.Message, + } + conditions = append(conditions, ct) + } + + alphaBuildRun.Status = v1alpha1.BuildRunStatus{ + Sources: sourceStatus, + Output: (*v1alpha1.Output)(src.Status.Output), + Conditions: conditions, + LatestTaskRunRef: src.Status.TaskRunName, + StartTime: src.Status.StartTime, + CompletionTime: src.Status.CompletionTime, + } + + if src.Status.FailureDetails != nil { + alphaBuildRun.Status.FailureDetails = &v1alpha1.FailureDetails{ + Reason: src.Status.FailureDetails.Reason, + Message: src.Status.FailureDetails.Message, + } + } + + if src.Status.FailureDetails != nil && src.Status.FailureDetails.Location != nil { + alphaBuildRun.Status.FailureDetails.Location = &v1alpha1.FailedAt{ + Pod: src.Status.FailureDetails.Location.Pod, + Container: src.Status.FailureDetails.Location.Container, + } + //nolint:staticcheck // SA1019 we want to give users some time to adopt to failureDetails + alphaBuildRun.Status.FailedAt = alphaBuildRun.Status.FailureDetails.Location + } + + aux := &v1alpha1.BuildSpec{} + if src.Status.BuildSpec != nil { + src.Status.BuildSpec.ConvertTo(aux) + alphaBuildRun.Status.BuildSpec = aux + } + mapito, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&alphaBuildRun) if err != nil { ctxlog.Error(ctx, err, "failed structuring the newObject") diff --git a/pkg/webhook/conversion/converter_test.go b/pkg/webhook/conversion/converter_test.go index 616fd96253..3ec33d8184 100644 --- a/pkg/webhook/conversion/converter_test.go +++ b/pkg/webhook/conversion/converter_test.go @@ -82,6 +82,10 @@ request: strategy: name: %s kind: %s + status: + message: "all validations succeeded" + reason: Succeeded + registered: "True" ` o := fmt.Sprintf(buildTemplate, apiVersion, desiredAPIVersion, strategyName, strategyKind) @@ -122,6 +126,11 @@ request: Kind: (*v1alpha1.BuildStrategyKind)(&strategyKind), }, }, + Status: v1alpha1.BuildStatus{ + Message: pointer.String("all validations succeeded"), + Reason: v1alpha1.BuildReasonPtr(v1alpha1.SucceedStatus), + Registered: v1alpha1.ConditionStatusPtr(corev1.ConditionTrue), + }, } // Use ComparableTo and assert the whole object @@ -1029,6 +1038,154 @@ request: // Use ComparableTo and assert the whole object Expect(buildRun).To(BeComparableTo(desiredBuildRun)) }) + + It("converts for status", func() { + // Create the yaml in v1beta1 + buildTemplate := `kind: ConversionReview +apiVersion: %s +request: + uid: 0000-0000-0000-0000 + desiredAPIVersion: %s + objects: + - apiVersion: shipwright.io/v1beta1 + kind: BuildRun + metadata: + name: buildkit-run + spec: + build: + name: a_build + source: + type: Local + local: + name: foobar_local + timeout: 1m + status: + buildSpec: + output: + image: somewhere + pushSecret: some-secret + paramValues: + - name: dockerfile + value: Dockerfile + source: + git: + url: https://github.com/shipwright-io/sample-go + type: Git + strategy: + kind: ClusterBuildStrategy + name: buildkit + timeout: 10m0s + completionTime: "2023-10-17T07:35:10Z" + conditions: + - lastTransitionTime: "2023-10-17T07:35:10Z" + message: All Steps have completed executing + reason: Succeeded + status: "True" + type: Succeeded + output: + digest: sha256:9befa6f5f7142a5bf92174b54bb6e0a1dd04e5252aa9dc8f6962f6da966f68a8 + source: + git: + commitAuthor: somebody + commitSha: 6a45e68454ca0f319b1a82c65bea09a10fa9eec6 + startTime: "2023-10-17T07:31:55Z" + taskRunName: buildkit-run-n5sxr +` + o := fmt.Sprintf(buildTemplate, apiVersion, + desiredAPIVersion) + + // Invoke the /convert webhook endpoint + conversionReview, err := getConversionReview(o) + Expect(err).To(BeNil()) + Expect(conversionReview.Response.Result.Status).To(Equal(v1.StatusSuccess)) + + convertedObj, err := ToUnstructured(conversionReview) + Expect(err).To(BeNil()) + + buildRun, err := toV1Alpha1BuildRunObject(convertedObj) + Expect(err).To(BeNil()) + + // Prepare our desired v1alpha1 BuildRun + completionTime, err := time.Parse(time.RFC3339, "2023-10-17T07:35:10Z") + Expect(err).To(BeNil()) + startTime, err := time.Parse(time.RFC3339, "2023-10-17T07:31:55Z") + Expect(err).To(BeNil()) + buildStrategyKind := v1alpha1.BuildStrategyKind(v1alpha1.ClusterBuildStrategyKind) + desiredBuildRun := v1alpha1.BuildRun{ + ObjectMeta: v1.ObjectMeta{ + Name: "buildkit-run", + }, + TypeMeta: v1.TypeMeta{ + APIVersion: "shipwright.io/v1alpha1", + Kind: "BuildRun", + }, + Spec: v1alpha1.BuildRunSpec{ + BuildRef: &v1alpha1.BuildRef{ + Name: "a_build", + }, + Sources: []v1alpha1.BuildSource{ + { + Name: "foobar_local", + Type: v1alpha1.LocalCopy, + Timeout: &v1.Duration{ + Duration: 1 * time.Minute, + }, + }, + }, + ServiceAccount: &v1alpha1.ServiceAccount{}, + }, + Status: v1alpha1.BuildRunStatus{ + BuildSpec: &v1alpha1.BuildSpec{ + Source: v1alpha1.Source{ + URL: pointer.String("https://github.com/shipwright-io/sample-go"), + }, + Dockerfile: pointer.String("Dockerfile"), + Output: v1alpha1.Image{ + Image: "somewhere", + Credentials: &corev1.LocalObjectReference{ + Name: "some-secret", + }, + }, + Strategy: v1alpha1.Strategy{ + Kind: &buildStrategyKind, + Name: "buildkit", + }, + Timeout: &v1.Duration{ + Duration: 10 * time.Minute, + }, + }, + CompletionTime: &v1.Time{ + Time: completionTime, + }, + Conditions: v1alpha1.Conditions{{ + LastTransitionTime: v1.Time{ + Time: completionTime, + }, + Message: "All Steps have completed executing", + Reason: "Succeeded", + Status: corev1.ConditionTrue, + Type: v1alpha1.Succeeded, + }}, + LatestTaskRunRef: pointer.String("buildkit-run-n5sxr"), + Output: &v1alpha1.Output{ + Digest: "sha256:9befa6f5f7142a5bf92174b54bb6e0a1dd04e5252aa9dc8f6962f6da966f68a8", + }, + Sources: []v1alpha1.SourceResult{{ + Name: "default", + Git: &v1alpha1.GitSourceResult{ + CommitAuthor: "somebody", + CommitSha: "6a45e68454ca0f319b1a82c65bea09a10fa9eec6", + }, + }}, + StartTime: &v1.Time{ + Time: startTime, + }, + }, + } + + // Use ComparableTo and assert the whole object + Expect(buildRun).To(BeComparableTo(desiredBuildRun)) + }) }) Context("for a BuildRun CR from v1alpha1 to v1beta1", func() { var desiredAPIVersion = "shipwright.io/v1beta1"