Merge pull request #13 from stakater/e2e

e2e tests. need to configure env in pipelines in order to run e2e

Author: Juansasa

.gitignore

@@ -21,7 +21,6 @@ go.work
 
 # editor and IDE paraphernalia
 .idea
-.vscode
 *.swp
 *.swo
 *~

.golangci.yml

@@ -16,6 +16,10 @@ issues:
       linters:
         - dupl
         - lll
+    - path: "test/*"
+      linters:
+        - dupl
+        - lll
 linters:
   disable-all: true
   enable:
@@ -37,4 +41,4 @@ linters:
     - typecheck
     - unconvert
     - unparam
-    - unused
+    - unused

.vscode/launch.json

@@ -0,0 +1,45 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Go Tests",
+            "type": "go",
+            "request": "launch",
+            "mode": "test",
+            "program": "${fileDirname}", // Specifies that tests in the current directory's package should be run
+            "args": ["-test.v", "--ginkgo.vv", "--ginkgo.focus", "${selectedText}"], // Verbose test output
+            "preLaunchTask": "", // This should match the label of your pre-test task
+            "env": {
+              "GOFLAGS": "-count=1", // Avoid test caching
+            },
+          },
+          {
+            "name": "Debug E2E Tests",
+            "type": "go",
+            "request": "launch",
+            "mode": "test",
+            "program": "${fileDirname}", // Specifies that tests in the current directory's package should be run
+            "args": ["-test.v", "--ginkgo.vv", "--ginkgo.focus", "${selectedText}"], // Verbose test output
+            "preLaunchTask": "", // This should match the label of your pre-test task
+            "env": {
+              "GOFLAGS": "-count=1", // Avoid test caching
+              "HOSTED_CLUSTER_NAME": "c7ked5y6v",
+              "HOSTED_CLUSTER_NAMESPACE": "hypershift-c7ked5y6v",
+              "SPOKE_ROUTE_NAMESPACE": "openshift-monitoring",
+              "HUB_NAMESPACE": "c7ked5y6v",
+              "ROUTE_NAME": "e2e-example-route",
+              "ROUTE_LABELS": "app=example,env=prod",
+              "PROBE_JOB_NAME": "e2e-uptime-probe-job",
+              "PROBE_INTERVAL": "30s",
+              "PROBE_TIMEOUT": "10s",
+              "PROBE_MODULE": "http_2xx",
+              "PROBER_URL": "e2e-blackbox-exporter.openshift-monitoring.svc.cluster.local:9115",
+              "PROBER_SCHEME": "http",
+              "PROBER_PATH": "/probe"
+            },
+          },
+    ]
+}

Makefile

@@ -3,7 +3,7 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-VERSION ?= 0.0.1
+VERSION ?= 0.0.2
 OPERATOR_NAME ?= uptimeguardian
 CATALOG_DIR_PATH ?= catalog
 DOCKER_REPO_BASE ?= ghcr.io/stakater
@@ -115,7 +115,7 @@ vet: ## Run go vet against code.
 
 .PHONY: test
 test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -v -ginkgo.v -coverprofile cover.out
 
 # Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors.
 .PHONY: test-e2e  # Run the e2e tests against a Kind k8s instance that is spun up.

README.md

@@ -1,28 +1,38 @@
-# uptimeguardian
-// TODO(user): Add simple overview of use/purpose
+# Uptime Guardian Operator
+UptimeGuardian is an OpenShift operator which runs in the Hub cluster and watches `Routes` in the Spoke clusters and creates corresponding Prometheus `Probes` in the Hub cluster.
 
 ## Description
-// TODO(user): An in-depth paragraph about your project and overview of use
+UptimeGuardian is designed to operate in a hub-spoke architecture, where it is installed on the hub (mothershift) cluster. The operator performs the following key functions:
+
+1. Watches `HostedCluster` Custom Resources (CRs) in the hub cluster to discover and maintain connections with spoke (childshift) clusters
+2. Establishes secure connections to the spoke clusters using the credentials and configuration from the `HostedCluster` CRs
+3. Monitors `Routes` in the spoke clusters based on configured label selectors
+4. Creates and manages corresponding Prometheus `Probe` resources in the hub cluster
+
+To use UptimeGuardian, you need to:
+1. Install the operator in your hub cluster
+2. Create an `UptimeProbe` CR in the hub cluster with configuration including:
+   - Label selectors to identify which Routes to monitor in the spoke clusters
+   - Target namespace where the Prometheus Probes will be created in the hub cluster
+   - Any additional monitoring configuration like intervals, timeouts, etc.
+
+The operator automatically handles the synchronization between spoke cluster Routes and hub cluster Probes, ensuring your routes are continuously monitored for availability.
 
 ## Getting Started
 
 ### Prerequisites
-- go version v1.21.0+
-- docker version 17.03+.
-- kubectl version v1.11.3+.
-- Access to a Kubernetes v1.11.3+ cluster.
+- go version v1.23.0+
+- docker version 20.10+.
+- kubectl version v1.23.0+.
+- Access to a OpenShift cluster v4.14+
 
 ### To Deploy on the cluster
 **Build and push your image to the location specified by `IMG`:**
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/uptimeguardian:tag
+make docker-build docker-push IMG=ghcr.io/stakater/uptimeguardian:tag
 ```
 
-**NOTE:** This image ought to be published in the personal registry you specified.
-And it is required to have access to pull the image from the working environment.
-Make sure you have the proper permission to the registry if the above commands don’t work.
-
 **Install the CRDs into the cluster:**
 
 ```sh
@@ -32,7 +42,7 @@ make install
 **Deploy the Manager to the cluster with the image specified by `IMG`:**
 
 ```sh
-make deploy IMG=<some-registry>/uptimeguardian:tag
+make deploy IMG=ghcr.io/stakater/uptimeguardian:tag
 ```
 
 > **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
@@ -66,31 +76,40 @@ make uninstall
 make undeploy
 ```
 
-## Project Distribution
+### Development
 
-Following are the steps to build the installer and distribute this project to users.
+**Running the operator locally:**
 
-1. Build the installer for the image built and published in the registry:
+Ensure you are connected to the Hub cluster and your kubeconfig is set to use the Hub cluster context.
+Install the CRDs as mentioned in the [To Deploy on the cluster](#to-deploy-on-the-cluster) section and run the operator locally.
 
 ```sh
-make build-installer IMG=<some-registry>/uptimeguardian:tag
+make run
 ```
 
-NOTE: The makefile target mentioned above generates an 'install.yaml'
-file in the dist directory. This file contains all the resources built
-with Kustomize, which are necessary to install this project without
-its dependencies.
+**Running E2E Tests:**
+Use the provided VSCode launch configuration to execute the end-to-end tests. The launch file contains the necessary configuration for running tests in your development environment. `Debug E2E Tests` is the launch configuration for running the end-to-end tests. It have environment variables which can be used to configure the test. To run the test in VSCode, you need to select the test name and then click on the `Debug E2E Tests` launch configuration.
 
-2. Using the installer
+If you want to run the test outside of VSCode, you can run the following command (make sure you have all the environment variables set mentioned in the launch configuration `launch.json`):
 
-Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
+```sh
+make test-e2e
+```
+
+**Running Unit Tests:**
+Apart from using the VSCode launch configuration (by selecting the any unit test name as regex and then clicking on the `Debug Unit Tests` launch configuration), you can also run the unit tests using the following command:
 
 ```sh
-kubectl apply -f https://raw.githubusercontent.com/<org>/uptimeguardian/<tag or branch>/dist/install.yaml
+make test
 ```
 
-## Contributing
-// TODO(user): Add detailed information on how you would like others to contribute to this project
+## Contributing to UptimeGuardian!
+
+Before submitting a pull request:
+1. Ensure all tests pass locally
+2. Add tests / e2e tests for any new features
+3. Update documentation as needed
+4. Follow the existing code style and conventions
 
 **NOTE:** Run `make help` for more information on all potential `make` targets
 

catalog.Dockerfile

@@ -2,8 +2,7 @@
 # /bin/opm (with a serve subcommand) and /bin/grpc_health_probe
 FROM quay.io/operator-framework/opm:v1.50.0
 
-# Configure the entrypoint and command
-ENTRYPOINT ["/bin/opm"]
+# Configure the command
 CMD ["serve", "/configs", "--cache-dir=/tmp/cache"]
 
 # Copy declarative config root into image at /configs and pre-populate serve cache

catalog/channels.yaml

@@ -3,3 +3,6 @@ package: uptimeguardian
 name: preview
 entries:
   - name: uptimeguardian.v0.0.1
+  - name: uptimeguardian.v0.0.2
+    skips:
+      - uptimeguardian.v0.0.1

config/rbac/role.yaml

@@ -20,6 +20,18 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - monitoring.coreos.com
+  resources:
+  - probes
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
 - apiGroups:
   - networking.stakater.com
   resources:

config/samples/networking_v1alpha1_uptimeprobe.yaml

@@ -6,4 +6,15 @@ metadata:
     app.kubernetes.io/managed-by: kustomize
   name: uptimeprobe-sample
 spec:
-  # TODO(user): Add fields here
+  labelSelector:
+    matchLabels:
+      app.kubernetes.io/name: thanos-query
+  probeConfig:
+    module: http_2xx
+    jobName: default-uptime-probe-job
+    interval: 30s
+    scrapeTimeout: 10s
+    proberUrl: blackbox-exporter.openshift-monitoring.svc.cluster.local:9115
+    proberScheme: http
+    proberPath: /probe
+    targetNamespace: test-1

generate-catalog-index.sh

@@ -17,19 +17,16 @@ echo " catalog build start"
 SHOULD_RELEASE="false"
 for item in $CHANNEL_BUNDLES; do
   # Setup bundle from entries
-  if [ -n "$GIT_TAG" ]; then
+  latest="${OPERATOR_NAME}.v${VERSION}"
+  if [ -n "$GIT_TAG" ] && [ "$latest" == "$item" ]; then
       bundle="${item//${OPERATOR_NAME}./${OPERATOR_NAME}-bundle:}${GIT_TAG}"
-      release="${OPERATOR_NAME}-bundle:v${VERSION}${GIT_TAG}"
   else
       bundle="${item//${OPERATOR_NAME}./${OPERATOR_NAME}-bundle:}"
-      release="${OPERATOR_NAME}-bundle:v${VERSION}"
   fi
 
   # Check if next release is defined in any channel
-  if [ "${bundle}" == "${release}" ]; then
+  if [ "$latest" == "$item" ]; then
       SHOULD_RELEASE="true"
-  else
-      SHOULD_RELEASE="false"
   fi
 
   opm render "$DOCKER_REPO/$bundle" --output=yaml >> "$CATALOG_DIR_PATH"/bundles.yaml
@@ -45,8 +42,5 @@ done
       echo "  >> release is not defined in ${CATALOG_DIR_PATH}/channels.yaml, will not create catalog index"
   fi
 
-rm -rf "$CATALOG_DIR_PATH"/bundles.yaml
+#rm -rf "$CATALOG_DIR_PATH"/bundles.yaml
 echo " catalog build done!"
-
-## Delete entries
-#yq eval 'del(select(.schema == "olm.bundle"))' -i catalog/index.yaml