Merge pull request #677 from shiftstack/orc-lint

Add ORC API linter to enforce ORC specific rules

Author: mandre

.golangci.yml

@@ -62,6 +62,7 @@ linters:
               - statusoptional
               - statussubresource
               - uniquemarkers
+              - noopenstackidref
           lintersConfig:
             conditions:
               isFirstField: Warn

Makefile

@@ -139,7 +139,7 @@ lint: golangci-kal ## Run golangci-kal linter
 	$(GOLANGCI_KAL) run
 
 .PHONY: lint-fix
-lint-fix: golangci-kal ## Run golangci-lint linter and perform fixes
+lint-fix: golangci-kal ## Run golangci-kal linter and perform fixes
 	$(GOLANGCI_KAL) run --fix
 
 ##@ Build
@@ -315,7 +315,6 @@ KUSTOMIZE_VERSION ?= v5.6.0
 CONTROLLER_TOOLS_VERSION ?= v0.17.1
 ENVTEST_VERSION ?= release-0.22
 GOLANGCI_LINT_VERSION ?= v2.7.2
-KAL_VERSION ?= v0.0.0-20260205134631-d65d24a9df89
 MOCKGEN_VERSION ?= v0.5.0
 KUTTL_VERSION ?= v0.24.0
 GOVULNCHECK_VERSION ?= v1.1.4
@@ -346,8 +345,8 @@ version:  $(GOLANGCI_LINT_VERSION)
 name: golangci-kube-api-linter
 destination: $(LOCALBIN)
 plugins:
-- module: 'sigs.k8s.io/kube-api-linter'
-  version: $(KAL_VERSION)
+- module: 'github.com/k-orc/openstack-resource-controller/v2/tools/orc-api-linter'
+  path: ./tools/orc-api-linter
 endef
 export custom-gcl
 
@@ -357,6 +356,7 @@ CUSTOM_GCL_FILE ?= $(shell pwd)/.custom-gcl.yml
 golangci-kal: $(GOLANGCI_KAL)
 $(GOLANGCI_KAL): $(LOCALBIN) $(GOLANGCI_LINT)
 	$(file >$(CUSTOM_GCL_FILE),$(custom-gcl))
+	cd tools/orc-api-linter && go mod tidy
 	$(GOLANGCI_LINT) custom
 
 .PHONY: mockgen

api/v1alpha1/port_types.go

@@ -59,7 +59,7 @@ type HostID struct {
 	// This is mutually exclusive with serverRef.
 	// +kubebuilder:validation:MaxLength=36
 	// +optional
-	ID string `json:"id,omitempty"`
+	ID string `json:"id,omitempty"` //nolint:kubeapilinter // intentionally allow raw ID
 
 	// serverRef is a reference to an ORC Server resource from which to
 	// retrieve the hostID for port binding. The hostID will be read from
@@ -167,7 +167,7 @@ type PortResourceSpec struct {
 	// +kubebuilder:validation:MaxItems:=64
 	// +listType=set
 	// +optional
-	SecurityGroupRefs []OpenStackName `json:"securityGroupRefs,omitempty"`
+	SecurityGroupRefs []OpenStackName `json:"securityGroupRefs,omitempty"` //nolint:kubeapilinter // https://github.com/k-orc/openstack-resource-controller/issues/438
 
 	// vnicType specifies the type of vNIC which this port should be
 	// attached to. This is used to determine which mechanism driver(s) to
@@ -209,7 +209,7 @@ type PortResourceSpec struct {
 	// binding host, not the value specified here.
 	// +optional
 	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="hostID is immutable"
-	HostID *HostID `json:"hostID,omitempty"`
+	HostID *HostID `json:"hostID,omitempty"` //nolint:kubeapilinter // HostID provides both raw ID and ServerRef options
 }
 
 type PortResourceStatus struct {