fix: Fixes #18, added ability to use parent resource name in child re…

…source

Signed-off-by: Dustin Scott <dustin.scott18@gmail.com>

docs/markers.md

@@ -36,14 +36,21 @@ field for your workload.
 | [replace](#replace-optional)         | string                         | false    |
 | [description](#description-optional) | string                         | false    |
 
-### Name (required)
+### Name (required if Parent is unspecified)
 
 The name you want to use for the field in the custom resource that
 Operator Builder will create.  If you're not sure what that means, it will
 become clear shortly.
 
 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.
+
+ex. +operator-builder:field:parent=metadata.name
+
 ### Type (required)
 
 The other required field is the `type` field which specifies the data type for

internal/workload/v1/kinds/workload.go

@@ -364,14 +364,16 @@ func (ws *WorkloadSpec) processMarkerResults(markerResults []*inspect.YAMLResult
 		}
 
 		// add the field to the api specification
-		if err := ws.APISpecFields.AddField(
-			marker.GetName(),
-			marker.GetFieldType(),
-			comments,
-			sampleVal,
-			defaultFound,
-		); err != nil {
-			return err
+		if marker.GetName() != "" {
+			if err := ws.APISpecFields.AddField(
+				marker.GetName(),
+				marker.GetFieldType(),
+				comments,
+				sampleVal,
+				defaultFound,
+			); err != nil {
+				return err
+			}
 		}
 
 		marker.SetForCollection(ws.ForCollection)

internal/workload/v1/markers/collection_field_marker.go

@@ -11,6 +11,7 @@ import (
 
 const (
 	CollectionFieldMarkerPrefix = "+operator-builder:collection:field"
+	CollectionFieldPrefix       = "collection"
 	CollectionFieldSpecPrefix   = "collection.Spec"
 )
 
@@ -24,7 +25,7 @@ type CollectionFieldMarker FieldMarker
 //nolint:gocritic //needed to implement string interface
 func (cfm CollectionFieldMarker) String() string {
 	return fmt.Sprintf("CollectionFieldMarker{Name: %s Type: %v Description: %q Default: %v}",
-		cfm.Name,
+		cfm.GetName(),
 		cfm.Type,
 		cfm.GetDescription(),
 		cfm.Default,
@@ -47,7 +48,11 @@ func defineCollectionFieldMarker(registry *marker.Registry) error {
 // FieldMarkerProcessor interface methods.
 //
 func (cfm *CollectionFieldMarker) GetName() string {
-	return cfm.Name
+	if cfm.Name == nil {
+		return ""
+	}
+
+	return *cfm.Name
 }
 
 func (cfm *CollectionFieldMarker) GetDefault() interface{} {
@@ -74,6 +79,10 @@ func (cfm *CollectionFieldMarker) GetReplaceText() string {
 	return *cfm.Replace
 }
 
+func (cfm *CollectionFieldMarker) GetPrefix() string {
+	return CollectionFieldPrefix
+}
+
 func (cfm *CollectionFieldMarker) GetSpecPrefix() string {
 	return CollectionFieldSpecPrefix
 }
@@ -86,6 +95,14 @@ func (cfm *CollectionFieldMarker) GetOriginalValue() interface{} {
 	return cfm.originalValue
 }
 
+func (cfm *CollectionFieldMarker) GetParent() string {
+	if cfm.Parent == nil {
+		return ""
+	}
+
+	return *cfm.Parent
+}
+
 func (cfm *CollectionFieldMarker) IsCollectionFieldMarker() bool {
 	return true
 }

internal/workload/v1/markers/collection_field_marker_internal_test.go

@@ -15,9 +15,10 @@ func TestCollectionFieldMarker_String(t *testing.T) {
 	t.Parallel()
 
 	testString := "cfm test"
+	testName := "test"
 
 	type fields struct {
-		Name        string
+		Name        *string
 		Type        FieldType
 		Description *string
 		Default     interface{}
@@ -31,7 +32,7 @@ func TestCollectionFieldMarker_String(t *testing.T) {
 		{
 			name: "ensure collection field string output matches expected",
 			fields: fields{
-				Name:        "test",
+				Name:        &testName,
 				Type:        FieldString,
 				Description: &testString,
 				Default:     "test",
@@ -41,7 +42,7 @@ func TestCollectionFieldMarker_String(t *testing.T) {
 		{
 			name: "ensure collection field with nil values output matches expected",
 			fields: fields{
-				Name:        "test",
+				Name:        &testName,
 				Type:        FieldString,
 				Description: nil,
 				Default:     "test",
@@ -143,11 +144,14 @@ func TestCollectionFieldMarker_GetDefault(t *testing.T) {
 	}
 }
 
-func TestCollectionFieldMarker_GetDescription(t *testing.T) {
+func TestCollectionFieldMarker_GetName(t *testing.T) {
 	t.Parallel()
 
+	name := "test"
+	emptyName := ""
+
 	type fields struct {
-		Name string
+		Name *string
 	}
 
 	tests := []struct {
@@ -158,14 +162,14 @@ func TestCollectionFieldMarker_GetDescription(t *testing.T) {
 		{
 			name: "ensure collection field name returns as expected",
 			fields: fields{
-				Name: "test",
+				Name: &name,
 			},
 			want: "test",
 		},
 		{
 			name: "ensure collection field name with empty value returns as expected",
 			fields: fields{
-				Name: "",
+				Name: &emptyName,
 			},
 			want: "",
 		},
@@ -185,7 +189,7 @@ func TestCollectionFieldMarker_GetDescription(t *testing.T) {
 	}
 }
 
-func TestCollectionFieldMarker_GetName(t *testing.T) {
+func TestCollectionFieldMarker_GetDescription(t *testing.T) {
 	t.Parallel()
 
 	cfmDescription := "test collection description"

internal/workload/v1/markers/field_marker.go

@@ -17,6 +17,7 @@ var (
 
 const (
 	FieldMarkerPrefix = "+operator-builder:field"
+	FieldPrefix       = "parent"
 	FieldSpecPrefix   = "parent.Spec"
 )
 
@@ -25,11 +26,12 @@ const (
 // and matches the constants defined by the fieldMarker constant above.
 type FieldMarker struct {
 	// inputs from the marker itself
-	Name        string
+	Name        *string
 	Type        FieldType
 	Description *string
 	Default     interface{} `marker:",optional"`
 	Replace     *string
+	Parent      *string
 
 	// other values which we use to pass information
 	forCollection bool
@@ -40,7 +42,7 @@ type FieldMarker struct {
 //nolint:gocritic //needed to implement string interface
 func (fm FieldMarker) String() string {
 	return fmt.Sprintf("FieldMarker{Name: %s Type: %v Description: %q Default: %v}",
-		fm.Name,
+		fm.GetName(),
 		fm.Type,
 		fm.GetDescription(),
 		fm.Default,
@@ -63,7 +65,11 @@ func defineFieldMarker(registry *marker.Registry) error {
 // FieldMarker Processor interface methods.
 //
 func (fm *FieldMarker) GetName() string {
-	return fm.Name
+	if fm.Name == nil {
+		return ""
+	}
+
+	return *fm.Name
 }
 
 func (fm *FieldMarker) GetDefault() interface{} {
@@ -90,6 +96,10 @@ func (fm *FieldMarker) GetReplaceText() string {
 	return *fm.Replace
 }
 
+func (fm *FieldMarker) GetPrefix() string {
+	return FieldPrefix
+}
+
 func (fm *FieldMarker) GetSpecPrefix() string {
 	return FieldSpecPrefix
 }
@@ -98,6 +108,14 @@ func (fm *FieldMarker) GetOriginalValue() interface{} {
 	return fm.originalValue
 }
 
+func (fm *FieldMarker) GetParent() string {
+	if fm.Parent == nil {
+		return ""
+	}
+
+	return *fm.Parent
+}
+
 func (fm *FieldMarker) GetSourceCodeVariable() string {
 	return fm.sourceCodeVar
 }

internal/workload/v1/markers/field_marker_internal_test.go

@@ -14,10 +14,11 @@ import (
 func TestFieldMarker_String(t *testing.T) {
 	t.Parallel()
 
+	testName := "test"
 	testString := "fm test"
 
 	type fields struct {
-		Name        string
+		Name        *string
 		Type        FieldType
 		Description *string
 		Default     interface{}
@@ -31,7 +32,7 @@ func TestFieldMarker_String(t *testing.T) {
 		{
 			name: "ensure field string output matches expected",
 			fields: fields{
-				Name:        "test",
+				Name:        &testName,
 				Type:        FieldString,
 				Description: &testString,
 				Default:     "test",
@@ -41,7 +42,7 @@ func TestFieldMarker_String(t *testing.T) {
 		{
 			name: "ensure field with nil values output matches expected",
 			fields: fields{
-				Name:        "test",
+				Name:        &testName,
 				Type:        FieldString,
 				Description: nil,
 				Default:     "test",
@@ -143,11 +144,14 @@ func TestFieldMarker_GetDefault(t *testing.T) {
 	}
 }
 
-func TestFieldMarker_GetDescription(t *testing.T) {
+func TestFieldMarker_GetName(t *testing.T) {
 	t.Parallel()
 
+	name := "test"
+	emptyName := ""
+
 	type fields struct {
-		Name string
+		Name *string
 	}
 
 	tests := []struct {
@@ -158,14 +162,14 @@ func TestFieldMarker_GetDescription(t *testing.T) {
 		{
 			name: "ensure field name returns as expected",
 			fields: fields{
-				Name: "test",
+				Name: &name,
 			},
 			want: "test",
 		},
 		{
 			name: "ensure field name with empty value returns as expected",
 			fields: fields{
-				Name: "",
+				Name: &emptyName,
 			},
 			want: "",
 		},
@@ -185,7 +189,7 @@ func TestFieldMarker_GetDescription(t *testing.T) {
 	}
 }
 
-func TestFieldMarker_GetName(t *testing.T) {
+func TestFieldMarker_GetDescription(t *testing.T) {
 	t.Parallel()
 
 	fmDescription := "test description"