scripts: address review round 4 -- operator_dir as CLI arg, raw_copy, new patches

- Move operator_dir from YAML config to --operator-dir CLI argument
- Remove REPO_ROOT and __file__-based path deduction (KISS)
- Rename backup_paths to raw_copy, reduce to purely custom dirs
  (pkg/, version/, config/metalk8s/, salt/)
- Generate patch files for CRD types and controllers (previously
  raw-copied from backup, now scaffold + patch)
- Remove Dockerfile modification (scaffold FROM golang is kept as-is)
- Fail on missing raw_copy paths instead of warning
- Use Path.is_dir() instead of endswith("/") convention
- Remove zz_generated filtering (no longer needed)
- Neutralize scaffold-generated controller tests via patches
  (incompatible with our delegation pattern, never used)
- Add --forward flag to patch command to avoid false "reversed patch"

Author: ezekiel-alexrod

BUMPING.md

@@ -141,8 +141,8 @@ Target versions are pinned in `scripts/upgrade-operator-sdk/<name>/config.yaml`:
 
 ```yaml
 operator_sdk_version: v1.42.1    # target operator-sdk release
-go_toolchain: go1.25.8           # pin Go toolchain (for GOTOOLCHAIN)
-k8s_libs: v0.33.9                # pin k8s.io libs version
+go_toolchain: go1.24.13          # pin Go toolchain (for GOTOOLCHAIN)
+k8s_libs: v0.33.10               # pin k8s.io libs version
 ```
 
 After scaffolding, the script detects the latest available versions (operator-sdk
@@ -159,22 +159,24 @@ This is CI-friendly: zero interactive input during reconciliation.
 
 ### Running the upgrade
 
-The script processes one operator at a time. Run it once per operator:
+The script processes one operator at a time:
 
 ```bash
-python3 scripts/upgrade-operator-sdk/upgrade.py operator
-python3 scripts/upgrade-operator-sdk/upgrade.py storage-operator
-```
+python3 scripts/upgrade-operator-sdk/upgrade.py \
+    --operator-dir operator \
+    scripts/upgrade-operator-sdk/operator
 
-The argument is the name of the config directory next to the script
-(i.e. `scripts/upgrade-operator-sdk/<name>/`). A full path can also be
-given for configs stored elsewhere.
+python3 scripts/upgrade-operator-sdk/upgrade.py \
+    --operator-dir storage-operator \
+    scripts/upgrade-operator-sdk/storage-operator
+```
 
 Options:
 
 ```
+--operator-dir    Path to the operator project directory (required)
 --skip-backup     Reuse an existing .bak directory (no new backup)
---clean-tools     Delete .tmp/bin/ after the upgrade
+--clean-tools     Remove tool cache after upgrade
 --yes, -y         Skip the confirmation prompt
 ```
 
@@ -185,17 +187,23 @@ Each operator has a config directory at `scripts/upgrade-operator-sdk/<name>/` c
 
 - **Versions**: `operator_sdk_version`, `go_toolchain` (optional pin), `k8s_libs` (optional pin)
 - **Scaffold**: `repo`, `domain`, `apis` (with `group`, `version`, `kind`, `namespaced`). The operator name is derived from the config directory name.
-- **Paths**: `operator_dir`, `backup_paths`
+- **Raw copy**: `raw_copy` -- directories or files copied as-is from backup (purely custom code with no scaffold equivalent: `pkg/`, `version/`, `config/metalk8s/`, `salt/`, individual test/helper files)
 - **Post-processing**: `image_placeholder`, `extra_commands`
 
 ### Patch files
 
-MetalK8s-specific customizations to scaffold-generated files (`Dockerfile`, `Makefile`)
-are stored as GNU unified diff files in the `patches/` subdirectory next to `config.yaml`. The script
-applies them with `patch -p1` after scaffolding. If a patch does not apply cleanly,
-look for `.rej` files and resolve manually.
+All customizations to scaffold-generated files are stored as GNU unified diff
+files in the `patches/` subdirectory. This includes:
+
+- **Dockerfile** and **Makefile** customizations
+- **CRD type definitions** (`*_types.go`)
+- **Controller implementations** (`*_controller.go`)
+- **Scaffold test stubs** (`*_controller_test.go`) -- neutralized when incompatible with the delegation pattern
+
+The script applies them with `patch -p1` after scaffolding. If a patch does not
+apply cleanly, look for `.rej` files and resolve manually.
 
-Patch files use `__PLACEHOLDER__` tokens for values from the YAML config:
+Patch files use `__PLACEHOLDER__` tokens for runtime values:
 
 | Placeholder       | Replaced with                   | Source     |
 | ----------------- | ------------------------------- | ---------- |

scripts/upgrade-operator-sdk/operator/config.yaml

@@ -1,11 +1,10 @@
 repo: github.com/scality/metalk8s/operator
 domain: metalk8s.scality.com
-operator_dir: operator
 
 operator_sdk_version: v1.42.1
 
-# Optional: pin versions. If absent or empty, the script detects the
-# latest patch from the scaffold's go.mod and offers to update this file.
+# Optional: pin versions. If absent, the script detects the latest
+# patch from the scaffold's go.mod and auto-pins them here.
 go_toolchain: go1.24.13
 k8s_libs: v0.33.10
 
@@ -17,13 +16,16 @@ apis:
     kind: VirtualIPPool
     namespaced: true
 
-backup_paths:
-  - pkg/
-  - version/
-  - config/metalk8s/
-  - api/
-  - hack/
-  - internal/controller/
+# Directories/files copied as-is from backup (purely custom, no scaffold equivalent).
+raw_copy:
+  - pkg
+  - version
+  - config/metalk8s
+  - api/v1alpha1/conditions.go
+  - api/v1alpha1/conditions_test.go
+  - api/v1alpha1/clusterconfig_types_test.go
+  - api/v1alpha1/virtualippool_types_test.go
+  - api/v1alpha1/v1alpha1_suite_test.go
 
 image_placeholder: '{{ build_image_name("metalk8s-operator") }}'
 

scripts/upgrade-operator-sdk/operator/patches/clusterconfig_controller.patch

@@ -0,0 +1,73 @@
+--- a/internal/controller/clusterconfig_controller.go
++++ b/internal/controller/clusterconfig_controller.go
+@@ -1,5 +1,5 @@
+ /*
+-Copyright 2026.
++Copyright 2022.
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+@@ -17,14 +17,10 @@
+ package controller
+ 
+ import (
+-	"context"
+-
++	"github.com/scality/metalk8s/operator/pkg/controller/clusterconfig"
+ 	"k8s.io/apimachinery/pkg/runtime"
+ 	ctrl "sigs.k8s.io/controller-runtime"
+ 	"sigs.k8s.io/controller-runtime/pkg/client"
+-	logf "sigs.k8s.io/controller-runtime/pkg/log"
+-
+-	metalk8sscalitycomv1alpha1 "github.com/scality/metalk8s/operator/api/v1alpha1"
+ )
+ 
+ // ClusterConfigReconciler reconciles a ClusterConfig object
+@@ -33,9 +29,13 @@
+ 	Scheme *runtime.Scheme
+ }
+ 
+-// +kubebuilder:rbac:groups=metalk8s.scality.com,resources=clusterconfigs,verbs=get;list;watch;create;update;patch;delete
+-// +kubebuilder:rbac:groups=metalk8s.scality.com,resources=clusterconfigs/status,verbs=get;update;patch
+-// +kubebuilder:rbac:groups=metalk8s.scality.com,resources=clusterconfigs/finalizers,verbs=update
++//+kubebuilder:rbac:groups=metalk8s.scality.com,resources=clusterconfigs,verbs=get;list;watch;create;update;patch;delete
++//+kubebuilder:rbac:groups=metalk8s.scality.com,resources=clusterconfigs/status,verbs=get;update;patch
++//+kubebuilder:rbac:groups=metalk8s.scality.com,resources=clusterconfigs/finalizers,verbs=update
++
++//+kubebuilder:rbac:groups="",resources=namespaces,verbs=get;list;watch;create;update;patch;delete
++//+kubebuilder:rbac:groups="",resources=events,verbs=create;patch
++//+kubebuilder:rbac:groups=metalk8s.scality.com,resources=virtualippools,verbs=get;list;watch;create;update;patch;delete
+ 
+ // Reconcile is part of the main kubernetes reconciliation loop which aims to
+ // move the current state of the cluster closer to the desired state.
+@@ -45,19 +45,18 @@
+ // the user.
+ //
+ // For more details, check Reconcile and its Result here:
+-// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.21.0/pkg/reconcile
+-func (r *ClusterConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+-	_ = logf.FromContext(ctx)
+-
+-	// TODO(user): your logic here
+-
+-	return ctrl.Result{}, nil
+-}
++// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.12.1/pkg/reconcile
++//func (r *ClusterConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
++//	_ = log.FromContext(ctx)
++//
++//	return ctrl.Result{}, nil
++//}
+ 
+ // SetupWithManager sets up the controller with the Manager.
+ func (r *ClusterConfigReconciler) SetupWithManager(mgr ctrl.Manager) error {
+-	return ctrl.NewControllerManagedBy(mgr).
+-		For(&metalk8sscalitycomv1alpha1.ClusterConfig{}).
+-		Named("clusterconfig").
+-		Complete(r)
++	return clusterconfig.Add(mgr)
++
++	//return ctrl.NewControllerManagedBy(mgr).
++	//	For(&metalk8sscalitycomv1alpha1.ClusterConfig{}).
++	//	Complete(r)
+ }

scripts/upgrade-operator-sdk/operator/patches/clusterconfig_controller_test.patch

@@ -0,0 +1,87 @@
+--- a/internal/controller/clusterconfig_controller_test.go
++++ b/internal/controller/clusterconfig_controller_test.go
+@@ -1,84 +1 @@
+-/*
+-Copyright 2026.
+-
+-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.
+-*/
+-
+ package controller
+-
+-import (
+-	"context"
+-
+-	. "github.com/onsi/ginkgo/v2"
+-	. "github.com/onsi/gomega"
+-	"k8s.io/apimachinery/pkg/api/errors"
+-	"k8s.io/apimachinery/pkg/types"
+-	"sigs.k8s.io/controller-runtime/pkg/reconcile"
+-
+-	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+-
+-	metalk8sscalitycomv1alpha1 "github.com/scality/metalk8s/operator/api/v1alpha1"
+-)
+-
+-var _ = Describe("ClusterConfig Controller", func() {
+-	Context("When reconciling a resource", func() {
+-		const resourceName = "test-resource"
+-
+-		ctx := context.Background()
+-
+-		typeNamespacedName := types.NamespacedName{
+-			Name:      resourceName,
+-			Namespace: "default", // TODO(user):Modify as needed
+-		}
+-		clusterconfig := &metalk8sscalitycomv1alpha1.ClusterConfig{}
+-
+-		BeforeEach(func() {
+-			By("creating the custom resource for the Kind ClusterConfig")
+-			err := k8sClient.Get(ctx, typeNamespacedName, clusterconfig)
+-			if err != nil && errors.IsNotFound(err) {
+-				resource := &metalk8sscalitycomv1alpha1.ClusterConfig{
+-					ObjectMeta: metav1.ObjectMeta{
+-						Name:      resourceName,
+-						Namespace: "default",
+-					},
+-					// TODO(user): Specify other spec details if needed.
+-				}
+-				Expect(k8sClient.Create(ctx, resource)).To(Succeed())
+-			}
+-		})
+-
+-		AfterEach(func() {
+-			// TODO(user): Cleanup logic after each test, like removing the resource instance.
+-			resource := &metalk8sscalitycomv1alpha1.ClusterConfig{}
+-			err := k8sClient.Get(ctx, typeNamespacedName, resource)
+-			Expect(err).NotTo(HaveOccurred())
+-
+-			By("Cleanup the specific resource instance ClusterConfig")
+-			Expect(k8sClient.Delete(ctx, resource)).To(Succeed())
+-		})
+-		It("should successfully reconcile the resource", func() {
+-			By("Reconciling the created resource")
+-			controllerReconciler := &ClusterConfigReconciler{
+-				Client: k8sClient,
+-				Scheme: k8sClient.Scheme(),
+-			}
+-
+-			_, err := controllerReconciler.Reconcile(ctx, reconcile.Request{
+-				NamespacedName: typeNamespacedName,
+-			})
+-			Expect(err).NotTo(HaveOccurred())
+-			// TODO(user): Add more specific assertions depending on your controller's reconciliation logic.
+-			// Example: If you expect a certain status condition after reconciliation, verify it here.
+-		})
+-	})
+-})