feat: add support for arbitrary field markers (#57)

* feat: add support for arbitrary field markers Arbitrary field markers allow custom resource fields to be added that do not map directly to child resource values. Arbitrary fields may be referenced by resource markers or leveraged in custom mutation logic. Signed-off-by: Rich Lander <lander2k2@protonmail.com> * fix: fix lint errors Signed-off-by: Rich Lander <lander2k2@protonmail.com> * fix: fix operator-builder imports Signed-off-by: Rich Lander <lander2k2@protonmail.com> * test: update tests for field marker Signed-off-by: Rich Lander <lander2k2@protonmail.com> * test: update repo in CI config Signed-off-by: Rich Lander <lander2k2@protonmail.com> Signed-off-by: Rich Lander <lander2k2@protonmail.com>
nukleros · Oct 12, 2022 · 4388aa9 · 4388aa9
1 parent 5db1fac
commit 4388aa9
Show file tree

Hide file tree

Showing 77 changed files with 266 additions and 162 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -6,7 +6,7 @@ linters-settings:
     lines: 100
     statements: 50
   gci:
-    local-prefixes: github.com/vmware-tanzu-labs/operator-builder
+    local-prefixes: github.com/nukleros/operator-builder
   goconst:
     min-len: 2
     min-occurrences: 2
@@ -26,7 +26,7 @@ linters-settings:
   gocyclo:
     min-complexity: 15
   goimports:
-    local-prefixes: github.com/vmware-tanzu-labs/operator-builder
+    local-prefixes: github.com/nukleros/operator-builder
   golint:
     min-confidence: 0
   gomnd:
@@ -43,10 +43,10 @@ linters-settings:
     settings:
       printf:
         funcs:
-          - (github.com/vmware-tanzu-labs/operator-builder/pkg/logutils.Log).Infof
-          - (github.com/vmware-tanzu-labs/operator-builder/logutils.Log).Warnf
-          - (github.com/vmware-tanzu-labs/operator-builder/pkg/logutils.Log).Errorf
-          - (github.com/vmware-tanzu-labs/operator-builder/pkg/logutils.Log).Fatalf
+          - (github.com/nukleros/operator-builder/pkg/logutils.Log).Infof
+          - (github.com/nukleros/operator-builder/logutils.Log).Warnf
+          - (github.com/nukleros/operator-builder/pkg/logutils.Log).Errorf
+          - (github.com/nukleros/operator-builder/pkg/logutils.Log).Fatalf
   lll:
     line-length: 140
   maligned:

diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-[![Go Reference](https://pkg.go.dev/badge/github.com/vmware-tanzu-labs/operator-builder.svg)](https://pkg.go.dev/github.com/vmware-tanzu-labs/operator-builder)
-[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/vmware-tanzu-labs/operator-builder)](https://golang.org/)
-[![Go Report Card](https://goreportcard.com/badge/github.com/vmware-tanzu-labs/operator-builder)](https://goreportcard.com/report/github.com/vmware-tanzu-labs/operator-builder)
-[![GitHub](https://img.shields.io/github/license/vmware-tanzu-labs/operator-builder)](https://github.com/vmware-tanzu-labs/operator-builder/blob/main/LICENSE)[![GitHub release (latest by date)](https://img.shields.io/github/v/release/vmware-tanzu-labs/operator-builder)](https://github.com/vmware-tanzu-labs/operator-builder/releases)
-[![Hombrew](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/vmware-tanzu-labs/homebrew-tap/master/Info/operator-builder.json&query=$.versions.stable&label=homebrew)](https://github.com/vmware-tanzu-labs/operator-builder/releases)
+[![Go Reference](https://pkg.go.dev/badge/github.com/nukleros/operator-builder.svg)](https://pkg.go.dev/github.com/nukleros/operator-builder)
+[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/nukleros/operator-builder)](https://golang.org/)
+[![Go Report Card](https://goreportcard.com/badge/github.com/nukleros/operator-builder)](https://goreportcard.com/report/github.com/nukleros/operator-builder)
+[![GitHub](https://img.shields.io/github/license/nukleros/operator-builder)](https://github.com/nukleros/operator-builder/blob/main/LICENSE)[![GitHub release (latest by date)](https://img.shields.io/github/v/release/nukleros/operator-builder)](https://github.com/nukleros/operator-builder/releases)
+[![Hombrew](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/nukleros/homebrew-tap/master/Info/operator-builder.json&query=$.versions.stable&label=homebrew)](https://github.com/nukleros/operator-builder/releases)
 <!---[![Get it from the Snap Store](https://badgen.net/snapcraft/v/operator-builder)](https://snapcraft.io/operator-builder)-->
-![Github Downloads (by Release)](https://img.shields.io/github/downloads/vmware-tanzu-labs/operator-builder/total.svg)
+![Github Downloads (by Release)](https://img.shields.io/github/downloads/nukleros/operator-builder/total.svg)
 
 # Operator Builder
 

diff --git a/cmd/operator-builder/main.go b/cmd/operator-builder/main.go
@@ -7,7 +7,7 @@ package main
 import (
 	log "github.com/sirupsen/logrus"
 
-	"github.com/vmware-tanzu-labs/operator-builder/pkg/cli"
+	"github.com/nukleros/operator-builder/pkg/cli"
 )
 
 func main() {

diff --git a/docs/markers.md b/docs/markers.md
@@ -34,6 +34,7 @@ field for your workload.
 | [type](#type-required)               | string{string, int, bool}      | true     |
 | [default](#default-optional)         | [type](#supported-field-types) | false    |
 | [replace](#replace-optional)         | string                         | false    |
+| [arbitrary](#arbitrary-optional)     | bool                           | false    |
 | [description](#description-optional) | string                         | false    |
 
 ### Name (required if Parent is unspecified)
@@ -46,15 +47,15 @@ ex. +operator-builder:field:name=myName
 
 ### Parent (required if Name is unspecified)
 
-The parent field in which you wish to substitute.  Currently, only `metadata.name` is supported.  This 
-will allow you to use the parent name as a value in the child resource.
+The parent field in which you wish to substitute.  Currently, only `metadata.name` is supported.
+This will allow you to use the parent name as a value in the child resource.
 
 ex. +operator-builder:field:parent=metadata.name
 
 ### Type (required)
 
 The other required field is the `type` field which specifies the data type for
-the value.  
+the value.
 
 [#supported-field-types]() The supported data types are:
 
@@ -128,6 +129,69 @@ data:
     justtesting: myoption
 ```
 
+### Arbitrary (optional)
+
+If you wish to create a field for a custom resource that does not directly map
+to a value in a child resource, mark a field as arbitrary.
+
+Here is an example of how to mark a field as arbitrary:
+
+```yaml
+---
+# +operator-builder:field:name=nginx.installType,arbitrary,default="deployment",type=string,description=`
+# +kubebuilder:validation:Enum=deployment;daemonset
+# Method of install nginx ingress controller.  One of: deployment | daemonset.`
+apiVersion: v1
+kind: Namespace
+metadata:
+  # +operator-builder:field:name=namespace,default="nukleros-ingress-system",type=string,description=`
+  # Namespace to use for ingress support services.`
+  name: nukleros-ingress-system
+```
+
+On the first line you can see the `nginx.installType` custom resource field is
+marked as arbitrary with the `arbitrary` marker field.  Where you place this
+marker is unimportant but it is recommended you put all arbitrary fields at the
+beginning of one chosen manifest for ease of maintenance.
+
+This will result in a custom resource sample that looks as follows:
+
+```yaml
+apiVersion: platform.addons.nukleros.io/v1alpha1
+kind: IngressComponent
+metadata:
+  name: ingresscomponent-sample
+spec:
+  #collection:
+    #name: "supportservices-sample"
+    #namespace: ""
+  nginx:
+    installType: "deployment"            # <---- arbitary field
+    image: "nginx/nginx-ingress"
+    version: "2.3.0"
+    replicas: 2
+  namespace: "nukleros-ingress-system"
+```
+
+This arbitrary field will not map to any child resource value.  However it can
+be leveraged by some custom mutation code or by a resource marker such as this:
+
+```yaml
+---
+# +operator-builder:resource:field=nginx.installType,value="deployment",include
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: nginx-ingress
+  namespace: nukleros-ingress-system # +operator-builder:field:name=namespace,default="nukleros-ingress-system",type=string
+...
+```
+
+The marker on line one indicates the deployment resource only be created if
+`nginx.installType` has a value of `deployment` (as shown in the custom resource
+sample above).  In this example, we are providing an option to install the Nginx
+Ingress Controller as a deployment _or_ a daemonset.
+
 ### Description (optional)
 
 An optional description can be provided which will be used in the source code as
@@ -213,6 +277,12 @@ resource.
 Defined as `+operator-builder:resource` this marker can be used to control a specific
 resource with arguments in the marker.
 
+Note: a resource marker must reference a field defined by a field marker.  If
+you include a resource marker with a unique field name that is not also defined
+by a field marker you will get an error.  You may use an [arbitrary field](#arbitrary-optional)
+on a field marker if you don't wish to associate the field with a value in a
+child resource.
+
 | Field                                               | Type                           | Required |
 | --------------------------------------------------- | ------------------------------ | -------- |
 | [field](#field--collectionfield-required)           | string                         | true     |

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/vmware-tanzu-labs/operator-builder
+module github.com/nukleros/operator-builder
 
 go 1.17
 

diff --git a/internal/markers/inspect/inspector.go b/internal/markers/inspect/inspector.go
@@ -5,8 +5,8 @@
 package inspect
 
 import (
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/marker"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/parser"
+	"github.com/nukleros/operator-builder/internal/markers/marker"
+	"github.com/nukleros/operator-builder/internal/markers/parser"
 )
 
 type Inspector struct {

diff --git a/internal/markers/inspect/yaml.go b/internal/markers/inspect/yaml.go
@@ -12,7 +12,7 @@ import (
 
 	"gopkg.in/yaml.v3"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/parser"
+	"github.com/nukleros/operator-builder/internal/markers/parser"
 )
 
 type YAMLResult struct {

diff --git a/internal/markers/lexer/lexer_test.go b/internal/markers/lexer/lexer_test.go
@@ -10,7 +10,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/lexer"
+	"github.com/nukleros/operator-builder/internal/markers/lexer"
 )
 
 func GetTestLexer(buf string) *lexer.Lexer {

diff --git a/internal/markers/marker/argument.go b/internal/markers/marker/argument.go
@@ -10,7 +10,7 @@ import (
 	"reflect"
 	"strings"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/parser"
+	"github.com/nukleros/operator-builder/internal/markers/parser"
 )
 
 var (

diff --git a/internal/markers/marker/registry.go b/internal/markers/marker/registry.go
@@ -4,7 +4,7 @@
 
 package marker
 
-import "github.com/vmware-tanzu-labs/operator-builder/internal/markers/parser"
+import "github.com/nukleros/operator-builder/internal/markers/parser"
 
 type Registry struct {
 	registry map[string]*Definition

diff --git a/internal/markers/parser/consumed.go b/internal/markers/parser/consumed.go
@@ -4,7 +4,7 @@
 
 package parser
 
-import "github.com/vmware-tanzu-labs/operator-builder/internal/markers/lexer"
+import "github.com/nukleros/operator-builder/internal/markers/lexer"
 
 func (p *Parser) consumed(lxt lexer.LexemeType) bool {
 	if p.peek().Type == lxt {

diff --git a/internal/markers/parser/parser.go b/internal/markers/parser/parser.go
@@ -7,7 +7,7 @@ package parser
 import (
 	"bytes"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/lexer"
+	"github.com/nukleros/operator-builder/internal/markers/lexer"
 )
 
 type stateFn func(*Parser) stateFn

diff --git a/internal/markers/parser/peek.go b/internal/markers/parser/peek.go
@@ -4,7 +4,7 @@
 
 package parser
 
-import "github.com/vmware-tanzu-labs/operator-builder/internal/markers/lexer"
+import "github.com/nukleros/operator-builder/internal/markers/lexer"
 
 func (p *Parser) peek() lexer.Lexeme {
 	if p.peekCount > 0 {

diff --git a/internal/markers/parser/state.go b/internal/markers/parser/state.go
@@ -8,7 +8,7 @@ import (
 	"errors"
 	"strconv"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/markers/lexer"
+	"github.com/nukleros/operator-builder/internal/markers/lexer"
 )
 
 func startParse(p *Parser) stateFn {

diff --git a/internal/plugins/config/v1/api.go b/internal/plugins/config/v1/api.go
@@ -13,8 +13,8 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/model/resource"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	workloadconfig "github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/config"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/kinds"
+	workloadconfig "github.com/nukleros/operator-builder/internal/workload/v1/config"
+	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
 
 type createAPISubcommand struct {

diff --git a/internal/plugins/config/v1/init.go b/internal/plugins/config/v1/init.go
@@ -12,7 +12,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	workloadconfig "github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/config"
+	workloadconfig "github.com/nukleros/operator-builder/internal/workload/v1/config"
 )
 
 type initSubcommand struct {

diff --git a/internal/plugins/config/v1/plugin.go b/internal/plugins/config/v1/plugin.go
@@ -9,7 +9,7 @@ import (
 	cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins"
+	"github.com/nukleros/operator-builder/internal/plugins"
 )
 
 const pluginName = "config." + plugins.DefaultNameQualifier

diff --git a/internal/plugins/license/v1/init.go b/internal/plugins/license/v1/init.go
@@ -12,7 +12,7 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/license"
+	"github.com/nukleros/operator-builder/internal/license"
 )
 
 var _ plugin.InitSubcommand = &initSubcommand{}

diff --git a/internal/plugins/license/v1/plugin.go b/internal/plugins/license/v1/plugin.go
@@ -9,7 +9,7 @@ import (
 	cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins"
+	"github.com/nukleros/operator-builder/internal/plugins"
 )
 
 const pluginName = "license." + plugins.DefaultNameQualifier

diff --git a/internal/plugins/workload/v1/api.go b/internal/plugins/workload/v1/api.go
@@ -13,10 +13,10 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/model/resource"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/commands/subcommand"
-	workloadconfig "github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/config"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/kinds"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds"
+	"github.com/nukleros/operator-builder/internal/workload/v1/commands/subcommand"
+	workloadconfig "github.com/nukleros/operator-builder/internal/workload/v1/config"
+	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
 
 type createAPISubcommand struct {

diff --git a/internal/plugins/workload/v1/init.go b/internal/plugins/workload/v1/init.go
@@ -12,10 +12,10 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/commands/subcommand"
-	workloadconfig "github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/config"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/kinds"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds"
+	"github.com/nukleros/operator-builder/internal/workload/v1/commands/subcommand"
+	workloadconfig "github.com/nukleros/operator-builder/internal/workload/v1/config"
+	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
 
 type initSubcommand struct {

diff --git a/internal/plugins/workload/v1/plugin.go b/internal/plugins/workload/v1/plugin.go
@@ -9,7 +9,7 @@ import (
 	cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins"
+	"github.com/nukleros/operator-builder/internal/plugins"
 )
 
 const pluginName = "workload." + plugins.DefaultNameQualifier

diff --git a/internal/plugins/workload/v1/scaffolds/api.go b/internal/plugins/workload/v1/scaffolds/api.go
@@ -16,17 +16,17 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/model/resource"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugins"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/api"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/api/resources"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/cli"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/config/crd"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/config/samples"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/controller"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/int/dependencies"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/int/mutate"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/test/e2e"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/kinds"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/api"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/api/resources"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/cli"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/config/crd"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/config/samples"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/controller"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/int/dependencies"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/int/mutate"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/test/e2e"
+	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
 
 const boilerplatePath = "hack/boilerplate.go.txt"

diff --git a/internal/plugins/workload/v1/scaffolds/init.go b/internal/plugins/workload/v1/scaffolds/init.go
@@ -13,10 +13,10 @@ import (
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugins"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/cli"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/plugins/workload/v1/scaffolds/templates/test/e2e"
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/kinds"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/cli"
+	"github.com/nukleros/operator-builder/internal/plugins/workload/v1/scaffolds/templates/test/e2e"
+	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
 
 var _ plugins.Scaffolder = &initScaffolder{}

diff --git a/internal/plugins/workload/v1/scaffolds/templates/api/resources/constants.go b/internal/plugins/workload/v1/scaffolds/templates/api/resources/constants.go
@@ -9,7 +9,7 @@ import (
 
 	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
 
-	"github.com/vmware-tanzu-labs/operator-builder/internal/workload/v1/kinds"
+	"github.com/nukleros/operator-builder/internal/workload/v1/kinds"
 )
 
 var _ machinery.Template = &Constants{}