Merge pull request #331 from shiftstack/sync-main-martin

OCPBUGS-43892: manual rebase on upstream release-0.11

Author: openshift-merge-bot[bot]

.github/dependabot.yml

@@ -0,0 +1,53 @@
+# Please see the documentation for all configuration options: https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+
+# github-actions
+- directory: "/"
+  package-ecosystem: "github-actions"
+  open-pull-requests-limit: 5
+  schedule:
+    interval: "weekly"
+    day: "monday"
+  groups:
+    all-github-actions:
+      patterns: [ "*" ]
+  commit-message:
+    prefix: ":seedling: chore(deps): bump"
+    include: scope
+  labels:
+    - "area/dependency"
+    - "ok-to-test"
+
+# Go directories
+- directories:
+    - "/"
+    - "/hack/tools"
+    - "/orc"
+  package-ecosystem: "gomod"
+  open-pull-requests-limit: 5
+  schedule:
+    interval: "weekly"
+    day: "monday"
+  ## group all dependencies with a k8s.io prefix into a single PR.
+  groups:
+    all-go-mod-patch-and-minor:
+      patterns: [ "*" ]
+      update-types: [ "patch", "minor" ]
+  commit-message:
+    prefix: ":seedling: chore(deps): bump"
+    include: scope
+  ignore:
+    # Ignore controller-runtime as its upgraded manually.
+    - dependency-name: "sigs.k8s.io/controller-runtime"
+      update-types: [ "version-update:semver-major", "version-update:semver-minor" ]
+    # Ignore k8s and its transitives modules as they are upgraded manually together with controller-runtime.
+    - dependency-name: "k8s.io/*"
+      update-types: [ "version-update:semver-major", "version-update:semver-minor" ]
+    - dependency-name: "github.com/prometheus/*"
+      update-types: [ "version-update:semver-major", "version-update:semver-minor" ]
+    - dependency-name: "sigs.k8s.io/cluster-api-provider-openstack"
+  labels:
+    - "area/dependency"
+    - "ok-to-test"

.github/workflows/pr-dependabot.yaml

@@ -0,0 +1,49 @@
+name: PR dependabot code generation and go modules fix
+
+# This action runs on other PRs opened by dependabot. It updates modules and generated code on PRs opened by dependabot.
+on:
+  pull_request:
+    branches:
+      - dependabot/**
+  push:
+    branches:
+      - dependabot/**
+  workflow_dispatch:
+
+permissions:
+  contents: write # Allow to update the PR.
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # tag=v4.2.2
+    - name: Calculate go version
+      id: vars
+      run: echo "go_version=$(make go-version)" >> $GITHUB_OUTPUT
+    - name: Set up Go
+      uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # tag=v5.1.0
+      with:
+        go-version: ${{ steps.vars.outputs.go_version }}
+    - uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # tag=v4.1.2
+      name: Restore go cache
+      with:
+        path: |
+          ~/.cache/go-build
+          ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+    - name: Update all modules
+      run: make modules
+    - name: Update generated code
+      run: make generate
+    - uses: EndBug/add-and-commit@a94899bca583c204427a224a7af87c02f9b325d5 # tag=v9.1.4
+      name: Commit changes
+      with:
+        author_name: dependabot[bot]
+        author_email: 49699333+dependabot[bot]@users.noreply.github.com
+        default_author: github_actor
+        message: 'Update generated code'

.gitignore

@@ -146,7 +146,7 @@ kubernetes.tar.gz
 # generated files in any directory
 # TODO(thockin): uncomment this when we stop committing the generated files.
 #zz_generated.*
-zz_generated.openapi.go
+#zz_generated.openapi.go
 
 # make-related metadata
 /.make/
@@ -183,8 +183,8 @@ docs/book/book/
 
 # Don't ignore anything in vendor directories
 !/vendor/**
+!/orc/vendor/**
 !/hack/tools/vendor/**
-
-# Ignore go workspaces
-go.work
-go.work.sum
+# TODO Drop the codegen vendoring after 0.11
+!/orc/hack/codegen/vendor/**
+!/hack/codegen/vendor/**

.golangci.yml

@@ -5,13 +5,12 @@ linters:
   - asciicheck
   - bidichk
   - bodyclose
+  - copyloopvar
   - cyclop
-#  - depguard
   - dogsled
   - dupword
   - durationcheck
   - errcheck
-  - exportloopref
   - forbidigo
   - gci
   - goconst
@@ -56,7 +55,11 @@ linters-settings:
     # TODO(sbuerin) fix remaining findings and set to 20 afterwards
     max-complexity: 30
   gci:
-    local-prefixes: sigs.k8s.io/cluster-api-provider-openstack
+    sections:
+    - standard
+    - default
+    - prefix(github.com/k-orc/openstack-resource-controller)
+    - prefix(sigs.k8s.io/cluster-api-provider-openstack)
   gocritic:
     enabled-tags:
       - diagnostic
@@ -96,8 +99,8 @@ linters-settings:
       - pkg: sigs.k8s.io/controller-runtime
         alias: ctrl
       # CAPO
-      - pkg: sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha5
-        alias: infrav1alpha5
+      - pkg: sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha1
+        alias: infrav1alpha1
       - pkg: sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha6
         alias: infrav1alpha6
       - pkg: sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha7
@@ -127,14 +130,13 @@ linters-settings:
         alias: controlplanev1alpha4
       - pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1
         alias: controlplanev1
+      # ORC
+      - pkg: github.com/k-orc/openstack-resource-controller/api/v1alpha1
+        alias: orcv1alpha1
 
   nolintlint:
     # https://github.com/golangci/golangci-lint/issues/3228
     allow-unused: true
-  staticcheck:
-    go: "1.20"
-  stylecheck:
-    go: "1.20"
   nestif:
     # minimal complexity of if statements to report, 5 by default
     # TODO(sbuerin) fix remaining findings and set to 5 after:
@@ -176,12 +178,13 @@ issues:
     - stylecheck
     text: "ST1003: should not use underscores in Go names;"
     path: pkg/utils/conversioncommon/.*.go
+  exclude-files:
+  - "zz_generated.*\\.go$"
 
 run:
+  go: "1.22"
   timeout: 10m
   build-tags:
   - e2e
 
-  skip-files:
-    - "zz_generated.*\\.go$"
   allow-parallel-runners: true

Dockerfile

@@ -21,8 +21,11 @@ ARG goproxy=https://proxy.golang.org
 ENV GOPROXY=$goproxy
 
 # Copy the Go Modules manifests
+RUN mkdir orc
 COPY go.mod go.mod
 COPY go.sum go.sum
+COPY orc/go.mod orc/go.mod
+COPY orc/go.sum orc/go.sum
 
 # Cache deps before building and copying source so that we don't need to re-download as much
 # and so that source changes don't invalidate our downloaded layer

Makefile

@@ -41,18 +41,25 @@ KUBETEST_CONF_PATH ?= $(abspath $(E2E_DATA_DIR)/kubetest/conformance.yaml)
 KUBETEST_FAST_CONF_PATH ?= $(abspath $(E2E_DATA_DIR)/kubetest/conformance-fast.yaml)
 GO_INSTALL := ./scripts/go_install.sh
 
+# go-apidiff
+GO_APIDIFF_VER := v0.8.2
+GO_APIDIFF_BIN := go-apidiff
+GO_APIDIFF_PKG := github.com/joelanford/go-apidiff
+
 # Binaries.
 CONTROLLER_GEN := $(TOOLS_BIN_DIR)/controller-gen
 CONVERSION_GEN := $(TOOLS_BIN_DIR)/conversion-gen
 ENVSUBST := $(TOOLS_BIN_DIR)/envsubst
 GINKGO := $(TOOLS_BIN_DIR)/ginkgo
 GOJQ := $(TOOLS_BIN_DIR)/gojq
 GOLANGCI_LINT := $(TOOLS_BIN_DIR)/golangci-lint
+GOTESTSUM := $(TOOLS_BIN_DIR)/gotestsum
 KUSTOMIZE := $(TOOLS_BIN_DIR)/kustomize
 MOCKGEN := $(TOOLS_BIN_DIR)/mockgen
 RELEASE_NOTES := $(TOOLS_BIN_DIR)/release-notes
 SETUP_ENVTEST := $(TOOLS_BIN_DIR)/setup-envtest
 GEN_CRD_API_REFERENCE_DOCS := $(TOOLS_BIN_DIR)/gen-crd-api-reference-docs
+GO_APIDIFF := $(TOOLS_BIN_DIR)/$(GO_APIDIFF_BIN)-$(GO_APIDIFF_VER)
 
 # Kubebuilder
 export KUBEBUILDER_ENVTEST_KUBERNETES_VERSION ?= 1.28.0
@@ -140,8 +147,16 @@ kubebuilder_assets: $(SETUP_ENVTEST)
 
 .PHONY: test
 TEST_PATHS ?= ./...
-test: kubebuilder_assets
-	KUBEBUILDER_ASSETS="$(KUBEBUILDER_ASSETS)" go test -v $(TEST_PATHS) $(TEST_ARGS)
+test: test-capo test-orc
+
+.PHONY: test-capo
+test-capo: $(ARTIFACTS) $(GOTESTSUM) kubebuilder_assets
+	KUBEBUILDER_ASSETS="$(KUBEBUILDER_ASSETS)" $(GOTESTSUM) --junitfile $(ARTIFACTS)/junit.test.xml --junitfile-hide-empty-pkg --jsonfile $(ARTIFACTS)/test-output.log -- \
+			   -v $(TEST_PATHS) $(TEST_ARGS)
+
+.PHONY: test-orc
+test-orc:
+	$(MAKE) -C $(REPO_ROOT)/orc test
 
 E2E_TEMPLATES_DIR=test/e2e/data/infrastructure-openstack
 E2E_KUSTOMIZE_DIR=test/e2e/data/kustomize
@@ -151,7 +166,6 @@ E2E_NO_ARTIFACT_TEMPLATES_DIR=test/e2e/data/infrastructure-openstack-no-artifact
 .PHONY: e2e-templates
 e2e-templates: ## Generate cluster templates for e2e tests
 e2e-templates: $(addprefix $(E2E_NO_ARTIFACT_TEMPLATES_DIR)/, \
-		 cluster-template-v1alpha6.yaml \
 		 cluster-template-v1alpha7.yaml \
 		 cluster-template-md-remediation.yaml \
 		 cluster-template-kcp-remediation.yaml \
@@ -209,6 +223,11 @@ test-conformance: $(GINKGO) e2e-prerequisites ## Run clusterctl based conformanc
 test-conformance-fast: ## Run clusterctl based conformance test on workload cluster (requires Docker) using a subset of the conformance suite in parallel.
 	$(MAKE) test-conformance CONFORMANCE_E2E_ARGS="-kubetest.config-file=$(KUBETEST_FAST_CONF_PATH) -kubetest.ginkgo-nodes=5 $(E2E_ARGS)"
 
+APIDIFF_OLD_COMMIT ?= $(shell git rev-parse origin/main)
+
+.PHONY: apidiff
+apidiff: $(GO_APIDIFF) ## Check for API differences.
+	$(GO_APIDIFF) $(APIDIFF_OLD_COMMIT)
 
 ## --------------------------------------
 ##@ Binaries
@@ -225,17 +244,25 @@ managers:
 manager-openstack-infrastructure: ## Build manager binary.
 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "${LDFLAGS} -extldflags '-static'" -o $(BIN_DIR)/manager .
 
+.PHONY: $(GO_APIDIFF_BIN)
+$(GO_APIDIFF_BIN): $(GO_APIDIFF)
+
+$(GO_APIDIFF): # Build go-apidiff.
+	GOBIN=$(abspath $(TOOLS_BIN_DIR)) $(GO_INSTALL) $(GO_APIDIFF_PKG) $(GO_APIDIFF_BIN) $(GO_APIDIFF_VER)
+
 ## --------------------------------------
 ##@ Linting
 ## --------------------------------------
 
 .PHONY: lint
 lint: $(GOLANGCI_LINT) ## Lint codebase
 	$(GOLANGCI_LINT) run -v --fast=false
+	$(MAKE) -C $(REPO_ROOT)/orc lint
 
 .PHONY: lint-update
 lint-update: $(GOLANGCI_LINT) ## Lint codebase
 	$(GOLANGCI_LINT) run -v --fast=false --fix
+	$(MAKE) -C $(REPO_ROOT)/orc lint-fix
 
 lint-fast: $(GOLANGCI_LINT) ## Run only faster linters to detect possible issues
 	$(GOLANGCI_LINT) run -v --fast=true
@@ -246,11 +273,13 @@ lint-fast: $(GOLANGCI_LINT) ## Run only faster linters to detect possible issues
 
 .PHONY: modules
 modules: ## Runs go mod to ensure proper vendoring.
+	$(MAKE) -C $(REPO_ROOT)/orc modules
 	go mod tidy
 	cd $(TOOLS_DIR); go mod tidy
+	cd $(REPO_ROOT)/hack/codegen; go work sync; go mod tidy
 
 .PHONY: generate
-generate: templates generate-controller-gen generate-conversion-gen generate-go generate-manifests generate-api-docs ## Generate all generated code
+generate: templates generate-orc generate-controller-gen generate-codegen generate-conversion-gen generate-go generate-manifests generate-api-docs ## Generate all generated code
 
 .PHONY: generate-go
 generate-go: $(MOCKGEN)
@@ -262,18 +291,22 @@ generate-controller-gen: $(CONTROLLER_GEN)
 		paths=./api/... \
 		object:headerFile=./hack/boilerplate/boilerplate.generatego.txt
 
+.PHONY: generate-codegen
+generate-codegen: generate-controller-gen
+	./hack/update-codegen.sh
+
+.PHONY: generate-orc
+generate-orc:
+	$(MAKE) -C $(REPO_ROOT)/orc generate
+
 .PHONY: generate-conversion-gen
-capo_module := sigs.k8s.io/cluster-api-provider-openstack
 generate-conversion-gen: $(CONVERSION_GEN)
 	$(CONVERSION_GEN) \
-		--input-dirs=$(capo_module)/api/v1alpha5 \
-		--input-dirs=$(capo_module)/api/v1alpha6 \
-		--input-dirs=$(capo_module)/api/v1alpha7 \
-		--extra-dirs=$(capo_module)/pkg/utils/optional \
-		--extra-dirs=$(capo_module)/pkg/utils/conversioncommon \
-		--output-file-base=zz_generated.conversion \
-		--trim-path-prefix=$(capo_module)/ \
-		--go-header-file=./hack/boilerplate/boilerplate.generatego.txt
+		--extra-peer-dirs=./pkg/utils/optional \
+		--extra-peer-dirs=./pkg/utils/conversioncommon \
+		--output-file=zz_generated.conversion.go \
+		--go-header-file=./hack/boilerplate/boilerplate.generatego.txt \
+		./api/v1alpha6 ./api/v1alpha7
 
 .PHONY: generate-manifests
 generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
@@ -288,6 +321,7 @@ generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc.
 	$(CONTROLLER_GEN) \
 		paths=./ \
 		paths=./controllers/... \
+		paths=./internal/controllers/... \
 		output:rbac:dir=$(RBAC_ROOT) \
 		rbac:roleName=manager-role
 
@@ -506,25 +540,30 @@ clean-release: ## Remove the release folder
 	rm -rf $(RELEASE_DIR)
 
 .PHONY: verify
-verify: verify-boilerplate verify-modules verify-gen
+verify: verify-boilerplate verify-modules verify-gen verify-orc
 
 .PHONY: verify-boilerplate
 verify-boilerplate:
 	./hack/verify-boilerplate.sh
 
 .PHONY: verify-modules
 verify-modules: modules
-	@if !(git diff --quiet HEAD -- go.sum go.mod hack/tools/go.mod hack/tools/go.sum); then \
+	@if !(git diff --quiet HEAD -- go.* hack/tools/go.* hack/codegen/go.*); then \
 		git diff; \
 		echo "go module files are out of date"; exit 1; \
 	fi
 
+.PHONY: verify-gen
 verify-gen: generate
 	@if !(git diff --quiet HEAD); then \
 		git diff; \
 		echo "generated files are out of date, run make generate"; exit 1; \
 	fi
 
+.PHONY: verify-orc
+verify-orc:
+	$(MAKE) -C $(REPO_ROOT)/orc verify-generated
+
 .PHONY: vendor verify-vendoring
 vendor:
 	go mod vendor