Switch to eviction condition, improve tests, imports, auth

Instead of duplicated and mostly inconsistent eviction status as a status field,
use conditions to display and check for the eviction status.
More conditions are anticapted to provide insights about current state
of eviction.
refactored GetServiceClientAuth into GetServiceClient to support
not-password-polluted environents.
Remove httpmock requirement, httptest should be enough.
Improve tests by explicitly checking every iteration of a
reconciliation. This can be used as a template for other tests to
increase coverage.

Author: notandy

api/v1/eviction_types.go

@@ -21,9 +21,6 @@ import (
 	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.
-
 // EvictionSpec defines the desired state of Eviction
 type EvictionSpec struct {
 	// +kubebuilder:validation:Required
@@ -40,11 +37,22 @@ type EvictionSpec struct {
 	Reason string `json:"reason"`
 }
 
+const (
+	// ConditionTypeEviction is the type of condition for eviction status
+	ConditionTypeEviction = "Eviction"
+
+	// ConditionReasonRunning means the eviction is currently running
+	ConditionReasonRunning string = "Running"
+
+	// ConditionReasonFailed means the eviction has failed
+	ConditionReasonFailed string = "Failed"
+
+	// ConditionReasonSuceeded means the eviction has succeeded
+	ConditionReasonSuceeded string = "Succeeded"
+)
+
 // EvictionStatus defines the observed state of Eviction
 type EvictionStatus struct {
-	// +kubebuilder:validation:Enum=Pending;Running;Failed;Succeeded
-	// +kubebuilder:default=Pending
-	EvictionState string `json:"evictionState"`
 	// +kubebuilder:validation:Optional
 	HypervisorServiceId string `json:"hypervisorServiceId"`
 	// +kubebuilder:validation:Optional
@@ -62,7 +70,7 @@ type EvictionStatus struct {
 // +kubebuilder:resource:scope=Cluster,shortName=evi
 // +kubebuilder:printcolumn:JSONPath=".spec.hypervisor",name="Hypervisor",type="string"
 // +kubebuilder:printcolumn:JSONPath=".spec.reason",name="Reason",type="string"
-// +kubebuilder:printcolumn:JSONPath=".status.evictionState",name="State",type="string"
+// +kubebuilder:printcolumn:JSONPath=".status.conditions[?(@.type==\"Eviction\")].reason",name="State",type="string"
 // +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name="Created",type="date"
 
 // Eviction is the Schema for the evictions API

charts/openstack-hypervisor-operator/crds/eviction-crd.yaml

@@ -22,7 +22,7 @@ spec:
     - jsonPath: .spec.reason
       name: Reason
       type: string
-    - jsonPath: .status.evictionState
+    - jsonPath: .status.conditions[?(@.type=="Eviction")].reason
       name: State
       type: string
     - jsonPath: .metadata.creationTimestamp
@@ -128,14 +128,6 @@ spec:
                   - type
                   type: object
                 type: array
-              evictionState:
-                default: Pending
-                enum:
-                - Pending
-                - Running
-                - Failed
-                - Succeeded
-                type: string
               hypervisorServiceId:
                 type: string
               outstandingInstances:
@@ -146,8 +138,6 @@ spec:
                 default: 0
                 format: int64
                 type: integer
-            required:
-            - evictionState
             type: object
         type: object
     served: true

config/crd/bases/kvm.cloud.sap_evictions.yaml

@@ -23,7 +23,7 @@ spec:
     - jsonPath: .spec.reason
       name: Reason
       type: string
-    - jsonPath: .status.evictionState
+    - jsonPath: .status.conditions[?(@.type=="Eviction")].reason
       name: State
       type: string
     - jsonPath: .metadata.creationTimestamp
@@ -129,14 +129,6 @@ spec:
                   - type
                   type: object
                 type: array
-              evictionState:
-                default: Pending
-                enum:
-                - Pending
-                - Running
-                - Failed
-                - Succeeded
-                type: string
               hypervisorServiceId:
                 type: string
               outstandingInstances:
@@ -147,8 +139,6 @@ spec:
                 default: 0
                 format: int64
                 type: integer
-            required:
-            - evictionState
             type: object
         type: object
     served: true

go.mod

@@ -9,7 +9,6 @@ require (
 	github.com/go-openapi/swag v0.23.1
 	github.com/gophercloud/gophercloud/v2 v2.7.0
 	github.com/gophercloud/utils/v2 v2.0.0-20250711132455-9770683b100a
-	github.com/jarcoal/httpmock v1.4.0
 	github.com/onsi/ginkgo/v2 v2.23.4
 	github.com/onsi/gomega v1.37.0
 	k8s.io/api v0.33.3

go.sum

@@ -74,8 +74,6 @@ github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1 h1:VNqngBF40hVlDloBruUehVYC3Ar
 github.com/grpc-ecosystem/grpc-gateway/v2 v2.25.1/go.mod h1:RBRO7fro65R6tjKzYgLAFo0t1QEXY1Dp+i/bvpRiqiQ=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
-github.com/jarcoal/httpmock v1.4.0 h1:BvhqnH0JAYbNudL2GMJKgOHe2CtKlzJ/5rWKyp+hc2k=
-github.com/jarcoal/httpmock v1.4.0/go.mod h1:ftW1xULwo+j0R0JJkJIIi7UKigZUXCLLanykgjwBXL0=
 github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY=
 github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y=
 github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
@@ -92,8 +90,6 @@ github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0
 github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
 github.com/mailru/easyjson v0.9.0 h1:PrnmzHw7262yW8sTBwxi1PdJA3Iw/EKBa8psRf7d9a4=
 github.com/mailru/easyjson v0.9.0/go.mod h1:1+xMtQp2MRNVL/V1bOzuP3aP8VNwRW55fQUto+XFtTU=
-github.com/maxatome/go-testdeep v1.14.0 h1:rRlLv1+kI8eOI3OaBXZwb3O7xY3exRzdW5QyX48g9wI=
-github.com/maxatome/go-testdeep v1.14.0/go.mod h1:lPZc/HAcJMP92l7yI6TRz1aZN5URwUBUAfUNvrclaNM=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

internal/controller/aggregates_controller.go

@@ -30,9 +30,10 @@ import (
 	k8sclient "sigs.k8s.io/controller-runtime/pkg/client"
 	logger "sigs.k8s.io/controller-runtime/pkg/log"
 
-	"github.com/cobaltcore-dev/openstack-hypervisor-operator/internal/openstack"
 	"github.com/gophercloud/gophercloud/v2"
 	"github.com/gophercloud/gophercloud/v2/openstack/compute/v2/aggregates"
+
+	"github.com/cobaltcore-dev/openstack-hypervisor-operator/internal/openstack"
 )
 
 const (
@@ -109,7 +110,7 @@ func (r *AggregatesController) SetupWithManager(mgr ctrl.Manager) error {
 	_ = logger.FromContext(ctx)
 
 	var err error
-	if r.computeClient, err = openstack.GetServiceClient(ctx, "compute"); err != nil {
+	if r.computeClient, err = openstack.GetServiceClient(ctx, "compute", nil); err != nil {
 		return err
 	}
 	r.computeClient.Microversion = "2.40" // gophercloud only supports numeric ids

internal/controller/decomission_controller.go

@@ -17,11 +17,16 @@ limitations under the License.
 
 package controller
 
+import "C"
 import (
 	"context"
 	"fmt"
 	"net/http"
 
+	"github.com/gophercloud/gophercloud/v2"
+	"github.com/gophercloud/gophercloud/v2/openstack/compute/v2/hypervisors"
+	"github.com/gophercloud/gophercloud/v2/openstack/compute/v2/services"
+	"github.com/gophercloud/gophercloud/v2/openstack/placement/v1/resourceproviders"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/labels"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -32,10 +37,6 @@ import (
 
 	kvmv1 "github.com/cobaltcore-dev/openstack-hypervisor-operator/api/v1"
 	"github.com/cobaltcore-dev/openstack-hypervisor-operator/internal/openstack"
-	"github.com/gophercloud/gophercloud/v2"
-	"github.com/gophercloud/gophercloud/v2/openstack/compute/v2/hypervisors"
-	"github.com/gophercloud/gophercloud/v2/openstack/compute/v2/services"
-	"github.com/gophercloud/gophercloud/v2/openstack/placement/v1/resourceproviders"
 )
 
 const (
@@ -159,13 +160,13 @@ func (r *NodeDecommissionReconciler) SetupWithManager(mgr ctrl.Manager) error {
 	ctx := context.Background()
 
 	var err error
-	if r.computeClient, err = openstack.GetServiceClient(ctx, "compute"); err != nil {
+	if r.computeClient, err = openstack.GetServiceClient(ctx, "compute", nil); err != nil {
 		return err
 	}
 
 	r.computeClient.Microversion = "2.93"
 
-	r.placementClient, err = openstack.GetServiceClient(ctx, "placement")
+	r.placementClient, err = openstack.GetServiceClient(ctx, "placement", nil)
 	if err != nil {
 		return err
 	}

internal/controller/decomission_controller_test.go

@@ -20,6 +20,7 @@ package controller
 import (
 	"context"
 
+	"github.com/gophercloud/gophercloud/v2/testhelper"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	corev1 "k8s.io/api/core/v1"
@@ -77,7 +78,10 @@ var _ = Describe("Decommission Controller", func() {
 		})
 
 		It("should successfully reconcile the resource", func() {
-			By("Reconciling the created resource")
+			By("ConditionType the created resource")
+			testhelper.SetupHTTP()
+			defer testhelper.TeardownHTTP()
+
 			_, err := reconcileNodeLoop(1)
 			Expect(err).NotTo(HaveOccurred())
 		})