From 487f26737e2d1e27765ff2907b25bf4661d985a5 Mon Sep 17 00:00:00 2001 From: jkhelil Date: Thu, 12 Aug 2021 16:08:56 +0200 Subject: [PATCH] add shipwright build status --- api/v1alpha1/shipwrightbuild_types.go | 17 ++++- api/v1alpha1/shipwrightbuild_types_test.go | 62 ++++++++++++++++ api/v1alpha1/zz_generated.deepcopy.go | 10 ++- ...erator.shipwright.io_shipwrightbuilds.yaml | 74 ++++++++++++++++++- ...erator.shipwright.io_shipwrightbuilds.yaml | 74 ++++++++++++++++++- controllers/shipwrightbuild_controller.go | 46 ++++++++++-- .../shipwrightbuild_controller_test.go | 5 +- docs/shipwrightbuild.md | 0 hack/test-with-envtest.sh | 2 +- 9 files changed, 276 insertions(+), 14 deletions(-) create mode 100644 api/v1alpha1/shipwrightbuild_types_test.go create mode 100644 docs/shipwrightbuild.md diff --git a/api/v1alpha1/shipwrightbuild_types.go b/api/v1alpha1/shipwrightbuild_types.go index 8c7eb62e..f7910f14 100644 --- a/api/v1alpha1/shipwrightbuild_types.go +++ b/api/v1alpha1/shipwrightbuild_types.go @@ -14,8 +14,11 @@ type ShipwrightBuildSpec struct { TargetNamespace string `json:"targetNamespace,omitempty"` } -// ShipwrightBuildStatus defines the observed state of Shipwright-Build -type ShipwrightBuildStatus struct{} +// ShipwrightBuildStatus defines the observed state of ShipwrightBuild +type ShipwrightBuildStatus struct { + // Conditions holds the latest available observations of a resource's current state. + Conditions []metav1.Condition `json:"conditions,omitempty"` +} // +kubebuilder:object:root=true // +kubebuilder:resource:scope=Cluster @@ -44,3 +47,13 @@ type ShipwrightBuildList struct { func init() { SchemeBuilder.Register(&ShipwrightBuild{}, &ShipwrightBuildList{}) } + +// IsReady returns true the Ready condition status is True +func (status ShipwrightBuildStatus) IsReady() bool { + for _, condition := range status.Conditions { + if condition.Type == "Ready" && condition.Status == metav1.ConditionTrue { + return true + } + } + return false +} diff --git a/api/v1alpha1/shipwrightbuild_types_test.go b/api/v1alpha1/shipwrightbuild_types_test.go new file mode 100644 index 00000000..811e688a --- /dev/null +++ b/api/v1alpha1/shipwrightbuild_types_test.go @@ -0,0 +1,62 @@ +package v1alpha1 + +import ( + "testing" + + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +const ( + ConditionReady = "Ready" + ConditionNotReady = "NotReady" +) + +// TestIsReady tests IsReady condition status function +func TestIsReady(t *testing.T) { + testCases := map[string]struct { + status ShipwrightBuildStatus + expectedOutput bool + }{ + "ready": { + status: ShipwrightBuildStatus{ + Conditions: []metav1.Condition{ + metav1.Condition{ + Type: ConditionReady, + Status: metav1.ConditionTrue, + Reason: "Good", + }, + metav1.Condition{ + Type: ConditionNotReady, + Status: metav1.ConditionFalse, + Reason: "Good", + }, + }, + }, + expectedOutput: true, + }, + "notReady": { + status: ShipwrightBuildStatus{ + Conditions: []metav1.Condition{ + metav1.Condition{ + Type: ConditionReady, + Status: metav1.ConditionFalse, + Reason: "NotGood", + }, + metav1.Condition{ + Type: ConditionNotReady, + Status: metav1.ConditionFalse, + Reason: "Good", + }, + }, + }, + expectedOutput: false, + }, + } + + for tcName, tc := range testCases { + if output := tc.status.IsReady(); output != tc.expectedOutput { + t.Errorf("%s Got %t while expecting %t", tcName, output, tc.expectedOutput) + } + } + +} diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go index d41abef5..612c48eb 100644 --- a/api/v1alpha1/zz_generated.deepcopy.go +++ b/api/v1alpha1/zz_generated.deepcopy.go @@ -9,6 +9,7 @@ package v1alpha1 import ( + "k8s.io/apimachinery/pkg/apis/meta/v1" runtime "k8s.io/apimachinery/pkg/runtime" ) @@ -18,7 +19,7 @@ func (in *ShipwrightBuild) DeepCopyInto(out *ShipwrightBuild) { out.TypeMeta = in.TypeMeta in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) out.Spec = in.Spec - out.Status = in.Status + in.Status.DeepCopyInto(&out.Status) } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightBuild. @@ -89,6 +90,13 @@ func (in *ShipwrightBuildSpec) DeepCopy() *ShipwrightBuildSpec { // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *ShipwrightBuildStatus) DeepCopyInto(out *ShipwrightBuildStatus) { *out = *in + if in.Conditions != nil { + in, out := &in.Conditions, &out.Conditions + *out = make([]v1.Condition, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } } // DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightBuildStatus. diff --git a/bundle/manifests/operator.shipwright.io_shipwrightbuilds.yaml b/bundle/manifests/operator.shipwright.io_shipwrightbuilds.yaml index d173e513..3fd7c186 100644 --- a/bundle/manifests/operator.shipwright.io_shipwrightbuilds.yaml +++ b/bundle/manifests/operator.shipwright.io_shipwrightbuilds.yaml @@ -42,7 +42,79 @@ spec: type: string type: object status: - description: ShipwrightBuildStatus defines the observed state of Shipwright-Build + description: ShipwrightBuildStatus defines the observed state of ShipwrightBuild + properties: + conditions: + description: Conditions holds the latest available observations of + a resource's current state. + items: + description: "Condition contains details for one aspect of the current + state of this API Resource. --- This struct is intended for direct + use as an array at the field path .status.conditions. For example, + type FooStatus struct{ // Represents the observations of a + foo's current state. // Known .status.conditions.type are: + \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type + \ // +patchStrategy=merge // +listType=map // +listMapKey=type + \ Conditions []metav1.Condition `json:\"conditions,omitempty\" + patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` + \n // other fields }" + properties: + lastTransitionTime: + description: lastTransitionTime is the last time the condition + transitioned from one status to another. This should be when + the underlying condition changed. If that is not known, then + using the time when the API field changed is acceptable. + format: date-time + type: string + message: + description: message is a human readable message indicating + details about the transition. This may be an empty string. + maxLength: 32768 + type: string + observedGeneration: + description: observedGeneration represents the .metadata.generation + that the condition was set based upon. For instance, if .metadata.generation + is currently 12, but the .status.conditions[x].observedGeneration + is 9, the condition is out of date with respect to the current + state of the instance. + format: int64 + minimum: 0 + type: integer + reason: + description: reason contains a programmatic identifier indicating + the reason for the condition's last transition. Producers + of specific condition types may define expected values and + meanings for this field, and whether the values are considered + a guaranteed API. The value should be a CamelCase string. + This field may not be empty. + maxLength: 1024 + minLength: 1 + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ + type: string + status: + description: status of the condition, one of True, False, Unknown. + enum: + - "True" + - "False" + - Unknown + type: string + type: + description: type of condition in CamelCase or in foo.example.com/CamelCase. + --- Many .condition.type values are consistent across resources + like Available, but because arbitrary conditions can be useful + (see .node.status.conditions), the ability to deconflict is + important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) + maxLength: 316 + pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ + type: string + required: + - lastTransitionTime + - message + - reason + - status + - type + type: object + type: array type: object type: object served: true diff --git a/config/crd/bases/operator.shipwright.io_shipwrightbuilds.yaml b/config/crd/bases/operator.shipwright.io_shipwrightbuilds.yaml index 6b127988..e8eae83d 100644 --- a/config/crd/bases/operator.shipwright.io_shipwrightbuilds.yaml +++ b/config/crd/bases/operator.shipwright.io_shipwrightbuilds.yaml @@ -44,7 +44,79 @@ spec: type: string type: object status: - description: ShipwrightBuildStatus defines the observed state of Shipwright-Build + description: ShipwrightBuildStatus defines the observed state of ShipwrightBuild + properties: + conditions: + description: Conditions holds the latest available observations of + a resource's current state. + items: + description: "Condition contains details for one aspect of the current + state of this API Resource. --- This struct is intended for direct + use as an array at the field path .status.conditions. For example, + type FooStatus struct{ // Represents the observations of a + foo's current state. // Known .status.conditions.type are: + \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type + \ // +patchStrategy=merge // +listType=map // +listMapKey=type + \ Conditions []metav1.Condition `json:\"conditions,omitempty\" + patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` + \n // other fields }" + properties: + lastTransitionTime: + description: lastTransitionTime is the last time the condition + transitioned from one status to another. This should be when + the underlying condition changed. If that is not known, then + using the time when the API field changed is acceptable. + format: date-time + type: string + message: + description: message is a human readable message indicating + details about the transition. This may be an empty string. + maxLength: 32768 + type: string + observedGeneration: + description: observedGeneration represents the .metadata.generation + that the condition was set based upon. For instance, if .metadata.generation + is currently 12, but the .status.conditions[x].observedGeneration + is 9, the condition is out of date with respect to the current + state of the instance. + format: int64 + minimum: 0 + type: integer + reason: + description: reason contains a programmatic identifier indicating + the reason for the condition's last transition. Producers + of specific condition types may define expected values and + meanings for this field, and whether the values are considered + a guaranteed API. The value should be a CamelCase string. + This field may not be empty. + maxLength: 1024 + minLength: 1 + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ + type: string + status: + description: status of the condition, one of True, False, Unknown. + enum: + - "True" + - "False" + - Unknown + type: string + type: + description: type of condition in CamelCase or in foo.example.com/CamelCase. + --- Many .condition.type values are consistent across resources + like Available, but because arbitrary conditions can be useful + (see .node.status.conditions), the ability to deconflict is + important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) + maxLength: 316 + pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ + type: string + required: + - lastTransitionTime + - message + - reason + - status + - type + type: object + type: array type: object type: object served: true diff --git a/controllers/shipwrightbuild_controller.go b/controllers/shipwrightbuild_controller.go index 369bc177..0892d08f 100644 --- a/controllers/shipwrightbuild_controller.go +++ b/controllers/shipwrightbuild_controller.go @@ -17,6 +17,7 @@ import ( corev1 "k8s.io/api/core/v1" crdclientv1 "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/typed/apiextensions/v1" "k8s.io/apimachinery/pkg/api/errors" + apimeta "k8s.io/apimachinery/pkg/api/meta" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/types" @@ -35,6 +36,9 @@ const ( FinalizerAnnotation = "finalizer.operator.shipwright.io" // defaultTargetNamespace fallback namespace when `.spec.namepace` is not informed. defaultTargetNamespace = "shipwright-build" + + // Ready object is providing service. + ConditionReady = "Ready" ) // ShipwrightBuildReconciler reconciles a ShipwrightBuild object @@ -150,9 +154,22 @@ func (r *ShipwrightBuildReconciler) Reconcile(ctx context.Context, req ctrl.Requ logger.Info("Resource is not found!") return NoRequeue() } - logger.Error(err, "Retrieving ShipwrightBuild object from cache") + logger.Error(err, "retrieving ShipwrightBuild object from cache") return RequeueOnError(err) } + init := b.Status.Conditions == nil + if init { + b.Status.Conditions = make([]metav1.Condition, 0) + apimeta.SetStatusCondition(&b.Status.Conditions, metav1.Condition{ + Type: ConditionReady, + Status: metav1.ConditionUnknown, // we just started trying to reconcile + Reason: "Init", + Message: "Initializing Shipwright Operator", + }) + if err := r.Client.Status().Update(ctx, b); err != nil { + return RequeueWithError(err) + } + } // selecting the target namespace based on the CRD information, when not informed using the // default namespace instead @@ -189,7 +206,7 @@ func (r *ShipwrightBuildReconciler) Reconcile(ctx context.Context, req ctrl.Requ Filter(manifestival.Not(manifestival.ByKind("Namespace"))). Transform(manifestival.InjectNamespace(targetNamespace)) if err != nil { - logger.Error(err, "Transforming manifests, injecting namespace") + logger.Error(err, "transforming manifests, injecting namespace") return RequeueWithError(err) } @@ -205,12 +222,12 @@ func (r *ShipwrightBuildReconciler) Reconcile(ctx context.Context, req ctrl.Requ logger.Info("Deleting manifests...") if err := manifest.Delete(); err != nil { - logger.Error(err, "Deleting manifest's resources") + logger.Error(err, "deleting manifest's resources") return RequeueWithError(err) } logger.Info("Removing finalizers...") if err := r.unsetFinalizer(ctx, b); err != nil { - logger.Error(err, "Removing the finalizer") + logger.Error(err, "removing the finalizer") return RequeueWithError(err) } logger.Info("All removed!") @@ -221,14 +238,31 @@ func (r *ShipwrightBuildReconciler) Reconcile(ctx context.Context, req ctrl.Requ // instance with required dependencies logger.Info("Applying manifest's resources...") if err := manifest.Apply(); err != nil { - logger.Error(err, "Rolling out manifest's resources") + logger.Error(err, "rolling out manifest's resources") + apimeta.SetStatusCondition(&b.Status.Conditions, metav1.Condition{ + Type: ConditionReady, + Status: metav1.ConditionFalse, + Reason: "Failed", + Message: fmt.Sprintf("Reconciling ShipwrightBuild failed: %v", err), + }) + r.Client.Status().Update(ctx, b) return RequeueWithError(err) } if err := r.setFinalizer(ctx, b); err != nil { logger.Info(fmt.Sprintf("%#v", b)) - logger.Error(err, "Setting the finalizer") + logger.Error(err, "setting the finalizer") return RequeueWithError(err) } + apimeta.SetStatusCondition(&b.Status.Conditions, metav1.Condition{ + Type: ConditionReady, + Status: metav1.ConditionTrue, + Reason: "Success", + Message: "Reconciled ShipwrightBuild successfully", + }) + if err := r.Client.Status().Update(ctx, b); err != nil { + logger.Error(err, "updating ShipwrightBuild status") + RequeueWithError(err) + } logger.Info("All done!") return NoRequeue() } diff --git a/controllers/shipwrightbuild_controller_test.go b/controllers/shipwrightbuild_controller_test.go index 21fa92a0..bd9e11fe 100644 --- a/controllers/shipwrightbuild_controller_test.go +++ b/controllers/shipwrightbuild_controller_test.go @@ -353,13 +353,14 @@ func testShipwrightBuildReconcilerReconcile(t *testing.T, targetNamespace string // Build Controller is created accordingly t.Run("rollout-manifests", func(t *testing.T) { ctx := context.TODO() - res, err := r.Reconcile(ctx, req) g.Expect(err).To(o.BeNil()) g.Expect(res.Requeue).To(o.BeFalse()) - err = c.Get(ctx, deploymentName, &appsv1.Deployment{}) g.Expect(err).To(o.BeNil()) + err = c.Get(ctx, namespacedName, b) + g.Expect(err).To(o.BeNil()) + g.Expect(b.Status.IsReady()).To(o.BeTrue()) }) // rolling back all changes, making sure the main deployment is also not found afterwards diff --git a/docs/shipwrightbuild.md b/docs/shipwrightbuild.md new file mode 100644 index 00000000..e69de29b diff --git a/hack/test-with-envtest.sh b/hack/test-with-envtest.sh index edaf8ded..17739325 100755 --- a/hack/test-with-envtest.sh +++ b/hack/test-with-envtest.sh @@ -11,4 +11,4 @@ source "${ENVTEST_ASSETS_DIR}/setup-envtest.sh" fetch_envtest_tools "${ENVTEST_ASSETS_DIR}" setup_envtest_env "${ENVTEST_ASSETS_DIR}" # Run tests sequentially - the controller integration tests cannot be run concurrently -go test ./... -coverprofile cover.out -p 1 -failfast -ginkgo.v -ginkgo.failFast +go test ./... -coverprofile cover.out -p 1 -failfast -test.v -test.failfast