feat: centralize addition of flags to remove inconsistencies

Signed-off-by: Dustin Scott <[email protected]>
nukleros · Jul 3, 2024 · 403fc85 · 403fc85
1 parent 7e76115
commit 403fc85
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 14 deletions.
diff --git a/internal/plugins/config/v1/api.go b/internal/plugins/config/v1/api.go
@@ -13,6 +13,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/model/resource"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
+	"github.com/nukleros/operator-builder/internal/plugins/workload"
 	workloadconfig "github.com/nukleros/operator-builder/internal/workload/v1/config"
 	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
@@ -26,8 +27,7 @@ type createAPISubcommand struct {
 var _ plugin.CreateAPISubcommand = &createAPISubcommand{}
 
 func (p *createAPISubcommand) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&p.workloadConfigPath, "workload-config", "", "path to workload config file")
-	fs.BoolVar(&p.enableOlm, "enable-olm", false, "enable support for OpenShift Lifecycle Manager")
+	workload.AddFlags(fs, &p.workloadConfigPath, &p.enableOlm)
 }
 
 func (p *createAPISubcommand) InjectConfig(c config.Config) error {

diff --git a/internal/plugins/config/v1/init.go b/internal/plugins/config/v1/init.go
@@ -12,6 +12,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
+	"github.com/nukleros/operator-builder/internal/plugins/workload"
 	workloadconfig "github.com/nukleros/operator-builder/internal/workload/v1/config"
 )
 
@@ -24,9 +25,9 @@ type initSubcommand struct {
 var _ plugin.InitSubcommand = &initSubcommand{}
 
 func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&p.workloadConfigPath, "workload-config", "", "path to workload config file")
+	workload.AddFlags(fs, &p.workloadConfigPath, &p.enableOlm)
+
 	fs.StringVar(&p.controllerImage, "controller-image", "controller:latest", "controller image")
-	fs.BoolVar(&p.enableOlm, "enable-olm", false, "enable support for Operator Lifecycle Manager (OLM)")
 }
 
 func (p *initSubcommand) InjectConfig(c config.Config) error {

diff --git a/internal/plugins/license/license.go b/internal/plugins/license/license.go
@@ -0,0 +1,12 @@
+// Copyright 2024 Nukleros
+// SPDX-License-Identifier: MIT
+
+package license
+
+import "github.com/spf13/pflag"
+
+// AddFlags adds a consistent set of license flags across plugin versions and commands.
+func AddFlags(fs *pflag.FlagSet, projectLicensePath, sourceHeaderPath *string) {
+	fs.StringVar(projectLicensePath, "project-license", "", "path to project license file")
+	fs.StringVar(sourceHeaderPath, "source-header-license", "", "path to file with source code header license text")
+}
diff --git a/internal/plugins/license/v1/init.go b/internal/plugins/license/v1/init.go
@@ -13,6 +13,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
 	"github.com/nukleros/operator-builder/internal/license"
+	licenseplugin "github.com/nukleros/operator-builder/internal/plugins/license"
 )
 
 var _ plugin.InitSubcommand = &initSubcommand{}
@@ -37,8 +38,7 @@ func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *
 }
 
 func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&p.projectLicensePath, "project-license", "", "path to project license file")
-	fs.StringVar(&p.sourceHeaderPath, "source-header-license", "", "path to file with source code header license text")
+	licenseplugin.AddFlags(fs, &p.projectLicensePath, &p.sourceHeaderPath)
 }
 
 func (p *initSubcommand) InjectConfig(c config.Config) {

diff --git a/internal/plugins/license/v2/edit.go b/internal/plugins/license/v2/edit.go
@@ -12,6 +12,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 
 	"github.com/nukleros/operator-builder/internal/license"
+	licenseplugin "github.com/nukleros/operator-builder/internal/plugins/license"
 )
 
 var _ plugin.EditSubcommand = &editSubcommand{}
@@ -38,8 +39,7 @@ Features supported:
 }
 
 func (p *editSubcommand) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&p.projectLicensePath, "project-license", "", "path to project license file")
-	fs.StringVar(&p.sourceHeaderPath, "source-header-license", "", "path to file with source code header license text")
+	licenseplugin.AddFlags(fs, &p.projectLicensePath, &p.sourceHeaderPath)
 }
 
 func (p *editSubcommand) InjectConfig(c config.Config) error {

diff --git a/internal/plugins/license/v2/init.go b/internal/plugins/license/v2/init.go
@@ -13,6 +13,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 
 	"github.com/nukleros/operator-builder/internal/license"
+	licenseplugin "github.com/nukleros/operator-builder/internal/plugins/license"
 )
 
 var _ plugin.InitSubcommand = &initSubcommand{}
@@ -37,8 +38,7 @@ func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *
 }
 
 func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&p.projectLicensePath, "project-license", "", "path to project license file")
-	fs.StringVar(&p.sourceHeaderPath, "source-header-license", "", "path to file with source code header license text")
+	licenseplugin.AddFlags(fs, &p.projectLicensePath, &p.sourceHeaderPath)
 }
 
 func (p *initSubcommand) InjectConfig(c config.Config) {

diff --git a/internal/plugins/workload/v2/api.go b/internal/plugins/workload/v2/api.go
@@ -20,6 +20,7 @@ import (
 	goplugin "sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang"
 
 	"github.com/nukleros/operator-builder/internal/controllergen"
+	"github.com/nukleros/operator-builder/internal/plugins/workload"
 	"github.com/nukleros/operator-builder/internal/plugins/workload/v2/scaffolds"
 	"github.com/nukleros/operator-builder/internal/utils"
 	"github.com/nukleros/operator-builder/internal/workload/v1/commands/subcommand"
@@ -59,8 +60,7 @@ func (p *createAPISubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdM
 }
 
 func (p *createAPISubcommand) BindFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&p.workloadConfigPath, "workload-config", "", "path to workload config file")
-	fs.BoolVar(&p.enableOlm, "enable-olm", false, "enable support for OpenShift Lifecycle Manager")
+	workload.AddFlags(fs, &p.workloadConfigPath, &p.enableOlm)
 
 	fs.BoolVar(&p.generateDeepCopy, "generate-deep-copy", true,
 		"if true, generate deep copy methods after scaffolding (equivalent of 'make generate')")

diff --git a/internal/plugins/workload/v2/init.go b/internal/plugins/workload/v2/init.go
@@ -18,6 +18,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang"
 
+	"github.com/nukleros/operator-builder/internal/plugins/workload"
 	"github.com/nukleros/operator-builder/internal/plugins/workload/v2/scaffolds"
 	"github.com/nukleros/operator-builder/internal/utils"
 	"github.com/nukleros/operator-builder/internal/workload/v1/commands/subcommand"
@@ -67,9 +68,8 @@ func (p *initSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *
 }
 
 func (p *initSubcommand) BindFlags(fs *pflag.FlagSet) {
+	workload.AddFlags(fs, &p.workloadConfigPath, &p.enableOlm)
 	fs.StringVar(&p.controllerImage, "controller-image", "controller:latest", "controller image")
-	fs.StringVar(&p.workloadConfigPath, "workload-config", "", "path to workload config file")
-	fs.BoolVar(&p.enableOlm, "enable-olm", false, "enable support for OpenShift Lifecycle Manager")
 
 	fs.BoolVar(&p.skipGoVersionCheck, "skip-go-version-check",
 		false, "if specified, skip checking the Go version")

diff --git a/internal/plugins/workload/workload.go b/internal/plugins/workload/workload.go
@@ -0,0 +1,12 @@
+// Copyright 2024 Nukleros
+// SPDX-License-Identifier: MIT
+
+package workload
+
+import "github.com/spf13/pflag"
+
+// AddFlags adds a consistent set of workload flags across plugin versions and commands.
+func AddFlags(fs *pflag.FlagSet, workloadConfigPath *string, enableOlm *bool) {
+	fs.StringVar(workloadConfigPath, "workload-config", "", "path to workload config file")
+	fs.BoolVar(enableOlm, "enable-olm", false, "enable support for OpenShift Lifecycle Manager")
+}