From fc2ffce43afbf8b63ae2c17e8b9098e7bdbe45a9 Mon Sep 17 00:00:00 2001 From: Armel Soro Date: Thu, 18 Jul 2024 00:08:12 +0200 Subject: [PATCH] Stop testing binding-related code since the Service Binding Operator has been deprecated [1] Also add warning notes to the corresponding command reference pages. This section used to cause a bunch of flaky tests, even if it hasn't seen any changes over the past months/years. [1] https://redhat-developer.github.io/service-binding-operator/userguide/intro.html --- .github/workflows/ci.yaml | 4 +++- Makefile | 8 ++++++++ docs/website/docs/command-reference/add-binding.md | 7 +++++++ docs/website/docs/command-reference/describe-binding.md | 7 +++++++ docs/website/docs/command-reference/list-binding.md | 6 ++++++ docs/website/docs/command-reference/list.md | 2 +- docs/website/docs/command-reference/remove-binding.md | 7 +++++++ scripts/openshiftci-presubmit-all-tests.sh | 6 ++++-- 8 files changed, 43 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 7baa75590..453267374 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -124,7 +124,9 @@ jobs: fail-fast: false matrix: k8s_version: [v1.28.0, v1.27.3, v1.26.6] - service_binding: ["false", "true"] + service_binding: + - "false" + # - "true" # Service Binding Operator deprecated as of Feb 2024 name: "K8s Tests (${{ matrix.k8s_version }}/ServiceBinding=${{ matrix.service_binding }})" runs-on: ubuntu-latest needs: build_odo diff --git a/Makefile b/Makefile index 466bb9ace..bc112f78e 100644 --- a/Makefile +++ b/Makefile @@ -225,6 +225,14 @@ test-integration-cluster-no-service-binding: test-integration-cluster-service-binding: $(RUN_GINKGO) $(GINKGO_FLAGS) --junit-report="test-integration.xml" --label-filter="servicebinding" tests/integration +.PHONY: test-integration-openshift-no-service-binding +test-integration-openshift-no-service-binding: + $(RUN_GINKGO) $(GINKGO_FLAGS) --junit-report="test-integration.xml" --label-filter="!unauth && !nocluster && !podman && !servicebinding && !skiponopenshift" tests/integration + +.PHONY: test-integration-openshift-service-binding +test-integration-openshift-service-binding: + $(RUN_GINKGO) $(GINKGO_FLAGS) --junit-report="test-integration.xml" --label-filter="!unauth && !nocluster && !podman && servicebinding && !skiponopenshift" tests/integration + .PHONY: test-integration-openshift-unauth test-integration-openshift-unauth: $(RUN_GINKGO) $(GINKGO_FLAGS) --junit-report="test-integration-unauth.xml" --label-filter="unauth" tests/integration diff --git a/docs/website/docs/command-reference/add-binding.md b/docs/website/docs/command-reference/add-binding.md index f0270416d..84bee1765 100644 --- a/docs/website/docs/command-reference/add-binding.md +++ b/docs/website/docs/command-reference/add-binding.md @@ -2,6 +2,13 @@ title: odo add binding --- +:::warning + +As of February 2024, the [Service Binding Operator](https://github.com/redhat-developer/service-binding-operator/), which this command relies on, has been deprecated. See [Deprecation Notice](https://redhat-developer.github.io/service-binding-operator/userguide/intro.html). +`odo add binding` may therefore not work as expected. + +::: + The `odo add binding` command adds a link between an Operator-backed service and a component. odo uses the [Service Binding Operator](https://github.com/redhat-developer/service-binding-operator/) to create this link. Running this command from a directory containing a Devfile will modify the Devfile, and once pushed (using `odo dev`) to the cluster, it creates an instance of the `ServiceBinding` resource. diff --git a/docs/website/docs/command-reference/describe-binding.md b/docs/website/docs/command-reference/describe-binding.md index 2d6dd32a1..bf9e855c6 100644 --- a/docs/website/docs/command-reference/describe-binding.md +++ b/docs/website/docs/command-reference/describe-binding.md @@ -2,6 +2,13 @@ title: odo describe binding --- +:::warning + +As of February 2024, the [Service Binding Operator](https://github.com/redhat-developer/service-binding-operator/), which this command relies on, has been deprecated. See [Deprecation Notice](https://redhat-developer.github.io/service-binding-operator/userguide/intro.html). +`odo describe binding` may therefore not work as expected. + +::: + `odo describe binding` command is useful for getting information about service bindings. This command supports the service bindings added with the command `odo add binding` and bindings added manually to the Devfile, using a `ServiceBinding` resource from one of these apiVersion: diff --git a/docs/website/docs/command-reference/list-binding.md b/docs/website/docs/command-reference/list-binding.md index 12caf2c30..c9d710e02 100644 --- a/docs/website/docs/command-reference/list-binding.md +++ b/docs/website/docs/command-reference/list-binding.md @@ -2,6 +2,12 @@ title: odo list binding --- +:::warning + +As of February 2024, the [Service Binding Operator](https://github.com/redhat-developer/service-binding-operator/), which this command relies on, has been deprecated. See [Deprecation Notice](https://redhat-developer.github.io/service-binding-operator/userguide/intro.html). +`odo list binding` may therefore not work as expected. + +::: You can use `odo list binding` to list all the Service Bindings declared in the current namespace and, if present, in the Devfile of the current directory. diff --git a/docs/website/docs/command-reference/list.md b/docs/website/docs/command-reference/list.md index 241b26831..9208c87ad 100644 --- a/docs/website/docs/command-reference/list.md +++ b/docs/website/docs/command-reference/list.md @@ -2,7 +2,7 @@ title: odo list --- -`odo list` command combines the `odo list binding` and `odo list component` commands. +`odo list` command combines the [`odo list binding`](./list-binding.md) and [`odo list component`](./list-component.md) commands. ## Running the command diff --git a/docs/website/docs/command-reference/remove-binding.md b/docs/website/docs/command-reference/remove-binding.md index 1a1546c6a..3db30baf9 100644 --- a/docs/website/docs/command-reference/remove-binding.md +++ b/docs/website/docs/command-reference/remove-binding.md @@ -2,6 +2,13 @@ title: odo remove binding --- +:::warning + +As of February 2024, the [Service Binding Operator](https://github.com/redhat-developer/service-binding-operator/), which this command relies on, has been deprecated. See [Deprecation Notice](https://redhat-developer.github.io/service-binding-operator/userguide/intro.html). +`odo remove binding` may therefore not work as expected. + +::: + ## Description The `odo remove binding` command removes the link created between the component and a service via Service Binding. diff --git a/scripts/openshiftci-presubmit-all-tests.sh b/scripts/openshiftci-presubmit-all-tests.sh index c51fd8251..fecc54b83 100755 --- a/scripts/openshiftci-presubmit-all-tests.sh +++ b/scripts/openshiftci-presubmit-all-tests.sh @@ -37,14 +37,16 @@ oc whoami source ./scripts/openshiftci-config.sh # Integration tests -make test-integration-openshift || error=true +# Service Binding Operator deprecated as of Feb 2024 +make test-integration-openshift-no-service-binding || error=true # Login again (in case the token expires for some reason) oc login -u developer -p password@123 --insecure-skip-tls-verify || true oc whoami # E2e tests -make test-e2e || error=true +# Service Binding Operator deprecated as of Feb 2024 +make test-e2e-no-service-binding || error=true # Fail the build if there is any error while test execution if [ $error ]; then