Update the project for kubebuilder go/v4 layout

Change the layout to follow the Standard Go Project Layout, as described in https://book.kubebuilder.io/migration/v3vsv4. This allows newer releases of kubebuilder to be used with this repo. Signed-off-by: Dean Roehrich <[email protected]>
DataWorkflowServices · Oct 20, 2023 · a15f556 · a15f556
1 parent 5d24804
commit a15f556
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 13 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-# Copyright 2020, 2021, 2022 Hewlett Packard Enterprise Development LP
+# Copyright 2020-2023 Hewlett Packard Enterprise Development LP
 # Other additional copyright holders may be indicated within.
 #
 # The entirety of this work is licensed under the Apache License,
@@ -24,16 +24,17 @@ COPY go.mod go.mod
 COPY go.sum go.sum
 
 # Copy the go source
-COPY main.go main.go
+COPY cmd/ cmd/
 COPY api/ api/
+COPY internal/ internal/
 COPY controllers/ controllers/
 COPY mount-daemon/ mount-daemon/
 COPY utils/ utils/
 COPY vendor/ vendor/
 COPY github/cluster-api/util/conversion/ github/cluster-api/util/conversion/
 
 # Build
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o manager cmd/main.go
 
 FROM builder as testing
 WORKDIR /workspace

diff --git a/Makefile b/Makefile
@@ -135,10 +135,10 @@ build-daemon: manifests generate fmt vet ## Build standalone clientMount daemon
 	GOOS=linux GOARCH=amd64 go build -ldflags="-X '$(PACKAGE).version=$(RPM_VERSION)'" -o bin/clientmountd mount-daemon/main.go
 
 build: manifests generate fmt vet ## Build manager binary.
-	go build -o bin/manager main.go
+	go build -o bin/manager cmd/main.go
 
 run: manifests generate fmt vet ## Run a controller from your host.
-	go run ./main.go
+	go run cmd/main.go
 
 docker-build: VERSION ?= $(shell cat .version)
 docker-build: .version manifests generate fmt vet ## Build docker image with the manager.

diff --git a/PROJECT b/PROJECT
@@ -4,7 +4,7 @@
 # More info: https://book.kubebuilder.io/reference/project-config.html
 domain: github.io
 layout:
-- go.kubebuilder.io/v3
+- go.kubebuilder.io/v4
 plugins:
   manifests.sdk.operatorframework.io/v2: {}
   scorecard.sdk.operatorframework.io/v2: {}

diff --git a/main.go → cmd/main.go b/main.go → cmd/main.go
diff --git a/controllers/workflow_controller.go b/controllers/workflow_controller.go
@@ -38,7 +38,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
 	dwsv1alpha2 "github.com/DataWorkflowServices/dws/api/v1alpha2"
-	"github.com/DataWorkflowServices/dws/controllers/metrics"
+	"github.com/DataWorkflowServices/dws/internal/controller/metrics"
 	"github.com/DataWorkflowServices/dws/utils/updater"
 )
 

diff --git a/controllers/conversion_test.go → internal/controller/conversion_test.go b/controllers/conversion_test.go → internal/controller/conversion_test.go
@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-package controllers
+package controller
 
 import (
 	"context"

diff --git a/controllers/metrics/metrics.go → internal/controller/metrics/metrics.go b/controllers/metrics/metrics.go → internal/controller/metrics/metrics.go
diff --git a/controllers/suite_test.go → internal/controller/suite_test.go b/controllers/suite_test.go → internal/controller/suite_test.go
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package controllers
+package controller
 
 import (
 	"context"
@@ -37,6 +37,7 @@ import (
 
 	dwsv1alpha1 "github.com/DataWorkflowServices/dws/api/v1alpha1"
 	dwsv1alpha2 "github.com/DataWorkflowServices/dws/api/v1alpha2"
+	"github.com/DataWorkflowServices/dws/controllers"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -82,9 +83,9 @@ var _ = BeforeSuite(func() {
 
 	testEnv = &envtest.Environment{
 		WebhookInstallOptions: envtest.WebhookInstallOptions{
-			Paths: []string{filepath.Join("..", "config", "webhook")},
+			Paths: []string{filepath.Join("..", "..", "config", "webhook")},
 		},
-		CRDDirectoryPaths: []string{filepath.Join("..", "config", "crd", "bases")},
+		CRDDirectoryPaths: []string{filepath.Join("..", "..", "config", "crd", "bases")},
 
 		CRDInstallOptions: envtest.CRDInstallOptions{
 			// This adds the conversion webhook configuration to
@@ -147,7 +148,7 @@ var _ = BeforeSuite(func() {
 
 	// start reconcilers
 
-	err = (&WorkflowReconciler{
+	err = (&controllers.WorkflowReconciler{
 		Client: k8sManager.GetClient(),
 		Log:    ctrl.Log.WithName("controllers").WithName("Workflow"),
 		Scheme: testEnv.Scheme,

diff --git a/controllers/workflow_controller_test.go → ...al/controller/workflow_controller_test.go b/controllers/workflow_controller_test.go → ...al/controller/workflow_controller_test.go
@@ -17,7 +17,7 @@
  * limitations under the License.
  */
 
-package controllers
+package controller
 
 import (
 	"context"