Create the required mariadb database and account for watcher

.gitignore

@@ -36,3 +36,4 @@ CI_TOOLS_REPO
 
 # CI generated files
 ci/olm.yaml
+tests/kuttl/test-suites/default/output/*

Makefile

@@ -144,7 +144,8 @@ PROC_CMD = --procs ${PROCS}
 
 .PHONY: test
 test: manifests generate fmt vet envtest ginkgo ## Run tests.
-	@echo "TODO add test execution"
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" $(GINKGO) --trace --cover --coverpkg=../../pkg/watcher,../../controllers,../../api/v1beta1 --coverprofile cover.out --covermode=atomic ${PROC_CMD} $(GINKGO_ARGS) ./tests/...
+
 
 ##@ Build
 
@@ -238,6 +239,7 @@ ginkgo: $(GINKGO) ## Download ginkgo locally if necessary.
 $(GINKGO): $(LOCALBIN)
 	test -s $(LOCALBIN)/ginkgo || GOBIN=$(LOCALBIN) go install github.com/onsi/ginkgo/v2/ginkgo
 
+
 .PHONY: operator-sdk
 OPERATOR_SDK ?= $(LOCALBIN)/operator-sdk
 operator-sdk: ## Download operator-sdk locally if necessary.
@@ -394,3 +396,35 @@ watcher_cleanup: export CATALOG_IMG=${CATALOG_IMAGE}
 watcher_cleanup: ## Cleaning watcher operator via olm
 	bash ci/olm.sh
 	oc delete -f ci/olm.yaml
+
+KUTTL_SUITE ?= default
+KUTTL_NAMESPACE ?= watcher-kuttl-$(KUTTL_SUITE)
+KUTTL_SUITE_DIR ?= tests/kuttl/test-suites/$(KUTTL_SUITE)
+
+.PHONY: kuttl-test-prep
+kuttl-test-prep:
+	oc apply -k $(KUTTL_SUITE_DIR)/deps/ --timeout=120s
+	oc wait -n $(KUTTL_NAMESPACE) openstackcontrolplane openstack --for condition=Ready --timeout=300s
+
+.PHONY: kuttl-test-run
+kuttl-test-run:
+	oc kuttl test --v 1 --start-kind=false --config $(KUTTL_SUITE_DIR)/config.yaml
+
+.PHONY: kuttl-test
+kuttl-test: kuttl-test-prep kuttl-test-run
+
+.PHONY: kuttl-test-cleanup
+kuttl-test-cleanup:
+	# only cleanup if the $(KUTTL_NAMESPACE) exists
+	$(eval namespace_exists=$(shell oc get namespace $(KUTTL_NAMESPACE) --ignore-not-found -o name))
+	# We need to order the deletion. Simply deleting the namespace will
+	# result in errors in mariadb- and keystone-operator and then
+	# finalizer removal get stuck blocking the namespace deletion.
+	if [ "${namespace_exists}" != "" ]; then \
+		oc delete --wait=true --all=true -n $(KUTTL_NAMESPACE) --timeout=120s Watcher; \
+		oc delete --wait=true --all=true -n $(KUTTL_NAMESPACE) --timeout=120s OpenStackControlPlane; \
+		oc delete --wait=true namespace $(KUTTL_NAMESPACE); \
+		oc get pv |grep "Released.*crc-csi-hostpath-provisioner"|awk '{print $$1}'|xargs -I {} oc delete pv {} ;\
+	else \
+		echo "Namespce already cleaned up. Nothing to do"; \
+	fi

api/bases/watcher.openstack.org_watchers.yaml

@@ -35,13 +35,88 @@ spec:
           spec:
             description: WatcherSpec defines the desired state of Watcher
             properties:
-              foo:
-                description: Foo is an example field of Watcher. Edit watcher_types.go
-                  to remove/update
+              databaseAccount:
+                default: watcher
+                description: DatabaseAccount - MariaDBAccount CR name used for watcher
+                  DB, defaults to watcher
                 type: string
+              databaseInstance:
+                description: MariaDB instance name Required to use the mariadb-operator
+                  instance to create the DB and user
+                type: string
+              passwordSelectors:
+                default:
+                  service: WatcherPassword
+                description: PasswordSelectors - Selectors to identify the ServiceUser
+                  password from the Secret
+                properties:
+                  service:
+                    default: WatcherPassword
+                    description: Service - Selector to get the watcher service user
+                      password from the Secret
+                    type: string
+                type: object
+              secret:
+                default: osp-secret
+                description: Secret containing all passwords / keys needed
+                type: string
+            required:
+            - databaseInstance
             type: object
           status:
             description: WatcherStatus defines the observed state of Watcher
+            properties:
+              conditions:
+                description: Conditions
+                items:
+                  description: Condition defines an observation of a API resource
+                    operational state.
+                  properties:
+                    lastTransitionTime:
+                      description: 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: A human readable message indicating details about
+                        the transition.
+                      type: string
+                    reason:
+                      description: The reason for the condition's last transition
+                        in CamelCase.
+                      type: string
+                    severity:
+                      description: Severity provides a classification of Reason code,
+                        so the current situation is immediately understandable and
+                        could act accordingly. It is meant for situations where Status=False
+                        and it should be indicated if it is just informational, warning
+                        (next reconciliation might fix it) or an error (e.g. DB create
+                        issue and no actions to automatically resolve the issue can/should
+                        be done). For conditions where Status=Unknown or Status=True
+                        the Severity should be SeverityNone.
+                      type: string
+                    status:
+                      description: Status of the condition, one of True, False, Unknown.
+                      type: string
+                    type:
+                      description: Type of condition in CamelCase.
+                      type: string
+                  required:
+                  - lastTransitionTime
+                  - status
+                  - type
+                  type: object
+                type: array
+              observedGeneration:
+                description: ObservedGeneration - the most recent generation observed
+                  for this service. If the observed generation is less than the spec
+                  generation, then the controller has not processed the latest changes
+                  injected by the opentack-operator in the top-level CR (e.g. the
+                  ContainerImage)
+                format: int64
+                type: integer
             type: object
         type: object
     served: true

api/v1beta1/common_types.go

@@ -0,0 +1,51 @@
+/*
+Copyright 2024.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+// WatcherTemplate defines a spec based reusable for all the CRDs
+type WatcherTemplate struct {
+	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
+	// Important: Run "make" to regenerate code after modifying this file
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=osp-secret
+	// Secret containing all passwords / keys needed
+	Secret string `json:"secret"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default={service: WatcherPassword,}
+	// PasswordSelectors - Selectors to identify the ServiceUser password from the Secret
+	PasswordSelectors PasswordSelector `json:"passwordSelectors"`
+
+	// +kubebuilder:validation:Required
+	// MariaDB instance name
+	// Required to use the mariadb-operator instance to create the DB and user
+	DatabaseInstance string `json:"databaseInstance"`
+
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=watcher
+	// DatabaseAccount - MariaDBAccount CR name used for watcher DB, defaults to watcher
+	DatabaseAccount string `json:"databaseAccount"`
+}
+
+// PasswordSelector to identify the DB and AdminUser password from the Secret
+type PasswordSelector struct {
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default="WatcherPassword"
+	// Service - Selector to get the watcher service user password from the Secret
+	Service string `json:"service"`
+}

api/v1beta1/watcher_types.go

@@ -17,25 +17,28 @@ limitations under the License.
 package v1beta1
 
 import (
+	"github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // WatcherSpec defines the desired state of Watcher
 type WatcherSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 
-	// Foo is an example field of Watcher. Edit watcher_types.go to remove/update
-	Foo string `json:"foo,omitempty"`
+	WatcherTemplate `json:",inline"`
 }
 
 // WatcherStatus defines the observed state of Watcher
 type WatcherStatus struct {
-	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
-	// Important: Run "make" to regenerate code after modifying this file
+	// Conditions
+	Conditions condition.Conditions `json:"conditions,omitempty" optional:"true"`
+
+	// ObservedGeneration - the most recent generation observed for this
+	// service. If the observed generation is less than the spec generation,
+	// then the controller has not processed the latest changes injected by
+	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }
 
 //+kubebuilder:object:root=true
@@ -62,3 +65,7 @@ type WatcherList struct {
 func init() {
 	SchemeBuilder.Register(&Watcher{}, &WatcherList{})
 }
+
+// SetupDefaults - initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)
+func SetupDefaults() {
+}