[release-1.26] feat(tests): add cleanup target for e2e.ocp test artifacts closes #1164

Makefile.core.mk

@@ -210,6 +210,10 @@ test.scorecard: operator-sdk ## Run the operator scorecard test.
 test.e2e.ocp: istioctl ## Run the end-to-end tests against an existing OCP cluster. While running on OCP in downstream you need to set ISTIOCTL_DOWNLOAD_URL to the URL where the istioctl productized binary.
 	GINKGO_FLAGS="$(GINKGO_FLAGS)" ${SOURCE_DIR}/tests/e2e/integ-suite-ocp.sh
 
+.PHONY: test.e2e.ocp.cleanup
+test.e2e.ocp.cleanup: verify-kubeconfig ## Clean up leftover artifacts from e2e.ocp tests
+	${SOURCE_DIR}/tests/e2e/cleanup-ocp.sh
+
 .PHONY: test.e2e.kind
 test.e2e.kind: istioctl ## Deploy a KinD cluster and run the end-to-end tests against it.
 	GINKGO_FLAGS="$(GINKGO_FLAGS)" ISTIOCTL="$(ISTIOCTL)" ${SOURCE_DIR}/tests/e2e/integ-suite-kind.sh

tests/e2e/cleanup-ocp.sh

@@ -0,0 +1,219 @@
+#!/bin/bash
+
+# Copyright Istio Authors
+#
+# 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.
+
+set -eux -o pipefail
+
+# Configuration variables
+NAMESPACE="${NAMESPACE:-sail-operator}"
+CONTROL_PLANE_NS="${CONTROL_PLANE_NS:-istio-system}"
+OPERATOR_NAME="${OPERATOR_NAME:-sailoperator}"
+LOCALBIN="${LOCALBIN:-${HOME}/bin}"
+OPERATOR_SDK="${OPERATOR_SDK:-${LOCALBIN}/operator-sdk}"
+COMMAND=""
+
+# Clean up leftover artifacts from e2e.ocp tests
+echo "Cleaning up leftover artifacts from e2e.ocp tests"
+
+# Check if KUBECONFIG is set
+if [ -z "${KUBECONFIG}" ]; then
+  echo "KUBECONFIG is not set. kubectl will not be able to connect to the cluster. Exiting."
+  exit 1
+fi
+
+# Detect whether to use kubectl or oc command
+detect_command() {
+  if command -v oc &>/dev/null && oc status &>/dev/null; then
+    COMMAND="oc"
+    echo "Using oc command for OpenShift cluster"
+  elif command -v kubectl &>/dev/null; then
+    COMMAND="kubectl"
+    echo "Using kubectl command"
+  else
+    echo "Neither oc nor kubectl found. Exiting."
+    exit 1
+  fi
+}
+
+# Detect if operator was installed via OLM
+detect_olm_installation() {
+  echo "Checking for OLM-based operator installation..."
+
+  # Check for Subscription resource
+  if ${COMMAND} get subscription "${OPERATOR_NAME}" -n "${NAMESPACE}" &>/dev/null; then
+    echo "Found OLM Subscription for ${OPERATOR_NAME} in namespace ${NAMESPACE}"
+    return 0
+  fi
+
+  # Check for ClusterServiceVersion with sailoperator pattern
+  if ${COMMAND} get csv -n "${NAMESPACE}" --no-headers 2>/dev/null | grep -q "${OPERATOR_NAME}"; then
+    echo "Found OLM ClusterServiceVersion for ${OPERATOR_NAME} in namespace ${NAMESPACE}"
+    return 0
+  fi
+
+  echo "No OLM installation detected"
+  return 1
+}
+
+# Verify and cleanup Istio custom resources following official undeploy process
+verify_and_cleanup_istio_resources() {
+  echo "=== Cleaning up Sail Operator custom resources ==="
+
+  echo "Checking for Istio resources..."
+  if ${COMMAND} get istios.sailoperator.io --no-headers 2>/dev/null | grep -q .; then
+    echo "Removing all Istio resources..."
+    ${COMMAND} delete istios.sailoperator.io --all --all-namespaces --wait=true --ignore-not-found
+  else
+    echo "No Istio resources found"
+  fi
+
+  echo "Checking for IstioCNI resources..."
+  if ${COMMAND} get istiocni.sailoperator.io --all-namespaces --no-headers 2>/dev/null | grep -q .; then
+    echo "Removing all IstioCNI resources..."
+    ${COMMAND} delete istiocni.sailoperator.io --all --all-namespaces --wait=true --ignore-not-found
+  else
+    echo "No IstioCNI resources found"
+  fi
+
+  echo "Checking for ZTunnel resources..."
+  if ${COMMAND} get ztunnel.sailoperator.io --all-namespaces --no-headers 2>/dev/null | grep -q .; then
+    echo "Removing all ZTunnel resources..."
+    ${COMMAND} delete ztunnel.sailoperator.io --all --all-namespaces --wait=true --ignore-not-found
+  else
+    echo "No ZTunnel resources found"
+  fi
+}
+
+# Verify and cleanup Sail operator deployment
+verify_and_cleanup_operator() {
+  echo "=== Cleaning up Sail Operator deployment ==="
+
+  echo "Checking for Sail operator in namespace: ${NAMESPACE}..."
+  if ${COMMAND} get namespace "${NAMESPACE}" &>/dev/null; then
+    echo "Found operator namespace: ${NAMESPACE}"
+
+    # Check for OLM installation first
+    if detect_olm_installation; then
+      echo "Operator was installed via OLM, using operator-sdk cleanup..."
+      cleanup_olm_operator
+    elif command -v helm &>/dev/null && helm list -n "${NAMESPACE}" | grep -q sail-operator; then
+      echo "Uninstalling Sail operator Helm release..."
+      helm uninstall sail-operator --namespace "${NAMESPACE}"
+    else
+      echo "No Helm release found for sail-operator"
+
+      # Check for operator deployment directly
+      if ${COMMAND} get deployment sail-operator -n "${NAMESPACE}" &>/dev/null; then
+        echo "Removing operator deployment directly..."
+        ${COMMAND} delete deployment sail-operator -n "${NAMESPACE}" --ignore-not-found
+      fi
+    fi
+  else
+    echo "Operator namespace ${NAMESPACE} not found"
+  fi
+}
+
+# Cleanup operator deployed via OLM
+cleanup_olm_operator() {
+  echo "=== Cleaning up OLM-based Sail operator deployment ==="
+
+  # Check if operator-sdk is available
+  if ! command -v "${OPERATOR_SDK}" &>/dev/null; then
+    # Fallback to system operator-sdk
+    if command -v operator-sdk &>/dev/null; then
+      OPERATOR_SDK="operator-sdk"
+      echo "Using system operator-sdk"
+    else
+      echo "Warning: operator-sdk not found. Skipping OLM cleanup."
+      echo "Please install operator-sdk or set OPERATOR_SDK environment variable."
+      return 1
+    fi
+  fi
+
+  echo "Using operator-sdk at: ${OPERATOR_SDK}"
+  echo "Cleaning up OLM deployment for operator: ${OPERATOR_NAME} in namespace: ${NAMESPACE}"
+
+  # Use operator-sdk cleanup command (same as undeploy-olm Makefile target)
+  if ${OPERATOR_SDK} cleanup "${OPERATOR_NAME}" --delete-all -n "${NAMESPACE}"; then
+    echo "OLM cleanup completed successfully"
+  else
+    echo "OLM cleanup failed, but continuing with remaining cleanup..."
+  fi
+}
+
+# Cleanup known namespaces
+cleanup_namespaces() {
+  echo "=== Cleaning up namespaces ==="
+
+  for ns in "${NAMESPACE}" "${CONTROL_PLANE_NS}" "istio-cni" "ztunnel"; do
+    if ${COMMAND} get namespace "${ns}" &>/dev/null; then
+      echo "Removing namespace: ${ns}..."
+      ${COMMAND} delete namespace "${ns}" --ignore-not-found --wait=true
+    else
+      echo "Namespace ${ns} not found (already cleaned up)"
+    fi
+  done
+}
+
+# Cleanup CRDs (existing logic)
+cleanup_crds() {
+  echo "=== Cleaning up CRDs ==="
+
+  echo "Removing Istio CRDs..."
+  ${COMMAND} get crds -o name | grep ".*\.istio" | xargs -r -n 1 ${COMMAND} delete || true
+
+  echo "Removing Sail Operator CRDs..."
+  ${COMMAND} get crds -o name | grep ".*\.sail" | xargs -r -n 1 ${COMMAND} delete || true
+}
+
+# Cleanup cluster-level resources (existing logic)
+cleanup_cluster_resources() {
+  echo "=== Cleaning up cluster-level resources ==="
+
+  echo "Removing cluster role bindings..."
+  ${COMMAND} delete clusterrolebinding metrics-reader-rolebinding --ignore-not-found
+
+  echo "Removing cluster roles..."
+  ${COMMAND} delete clusterrole metrics-reader --ignore-not-found
+}
+
+# Main cleanup flow following official documentation order
+main() {
+  echo "Starting enhanced cleanup process..."
+
+  # 1. Detect command to use
+  detect_command
+
+  # 2. Delete Sail operator custom resources (gives operator chance to cleanup via finalizers)
+  verify_and_cleanup_istio_resources
+
+  # 3. Remove operator deployment
+  verify_and_cleanup_operator
+
+  # 4. Clean up namespaces
+  cleanup_namespaces
+
+  # 5. Remove CRDs
+  cleanup_crds
+
+  # 6. Clean up cluster-level resources
+  cleanup_cluster_resources
+
+  echo "Cleanup completed successfully"
+}
+
+# Execute main function
+main
+