Move "printer column" options under the same generator config struct (#82)

Issue N/A

Initially we used to have one config field ("is_printable") under
`ackconfig.FieldConfig` to instruct the code generator to generate
kubebuilder marker comments in order to include the field in `kubectl get` 
response.

Time passed and we are in a situation where want to tune more the way
we print these fields and extend the `kubebuilder:printcolumns` comment
markers to include options like `priority`, `order` and default columns.

This patch reworks the field configuration structure and prepare the
laying ground for future print config fields.

This patch will simplify the realization of the following issues:
* aws-controllers-k8s/community#821
* aws-controllers-k8s/community#822
* aws-controllers-k8s/community#823

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Author: a-hilaly

pkg/generate/codedeploy_test.go

@@ -113,12 +113,12 @@ func TestCodeDeploy_Deployment(t *testing.T) {
 
 	// We marked the fields, "ApplicationName", "DeploymentGroupName",
 	// "DeploymentConfigName and "Description" as printer columns in the
-	// generator.yaml. Let's make sure that they are always returned in sorted
-	// order.
+	// generator.yaml and trimmed the "Name" suffix. Let's make sure that
+	// they are always returned in sorted order.
 	expPrinterColNames := []string{
-		"ApplicationName",
-		"DeploymentConfigName",
-		"DeploymentGroupName",
+		"Application",
+		"DeploymentConfig",
+		"DeploymentGroup",
 		"Description",
 	}
 	gotPrinterCols := crd.AdditionalPrinterColumns()

pkg/generate/config/field.go

@@ -116,6 +116,16 @@ type CompareFieldConfig struct {
 	NilEqualsZeroValue bool `json:"nil_equals_zero_value"`
 }
 
+// PrintFieldConfig instructs the code generator how to handle kubebuilder:printcolumn
+// comment marker generation. If this struct is not nil, the field will be added to the
+// columns of `kubectl get` response.
+type PrintFieldConfig struct {
+	// Name instructs the code generator to override the column name used to
+	// include the field in `kubectl get` response. This field is generally used
+	// to override very long and redundant columns names.
+	Name string `json:"name"`
+}
+
 // FieldConfig contains instructions to the code generator about how
 // to interpret the value of an Attribute and how to map it to a CRD's Spec or
 // Status field
@@ -131,14 +141,6 @@ type FieldConfig struct {
 	// IsReadOnly indicates the field's value can not be set by a Kubernetes
 	// user; in other words, the field should go in the CR's Status struct
 	IsReadOnly bool `json:"is_read_only"`
-	// IsPrintable determines whether the field should be included in the
-	// AdditionalPrinterColumns list to be included in the `kubectl get`
-	// response.
-	IsPrintable bool `json:"is_printable"`
-	// PrintName instructs the code generator to override the column name used
-	// to include the field in `kubectl get` response. If `IsPrintable` is false
-	// this field is ignored.
-	PrintName string `json:"print_name"`
 	// Required indicates whether this field is a required member or not.
 	// This field is used to configure '+kubebuilder:validation:Required' on API object's members.
 	IsRequired *bool `json:"is_required,omitempty"`
@@ -168,4 +170,8 @@ type FieldConfig struct {
 	// Compare instructs the code generator how to produce code that compares
 	// the value of the field in two resources
 	Compare *CompareFieldConfig `json:"compare,omitempty"`
+	// Print instructs the code generator how to generate comment markers that
+	// influence hows field are printed in `kubectl get` response. If this field
+	// is not nil, it will be added to the columns of `kubectl get`.
+	Print *PrintFieldConfig `json:"print,omitempty"`
 }

pkg/generate/testdata/models/apis/codedeploy/0000-00-00/generator.yaml

@@ -7,10 +7,13 @@ resources:
     # below, we're testing printer columns end up sorted properly in the CRD
     fields:
       DeploymentGroupName:
-        is_printable: true
+        print:
+          name: DeploymentGroup
       ApplicationName:
-        is_printable: true
+        print:
+          name: Application
       DeploymentConfigName:
-        is_printable: true
+        print:
+          name: DeploymentConfig
       Description:
-        is_printable: true
+        print: {}

pkg/model/crd.go

@@ -176,7 +176,7 @@ func (r *CRD) AddSpecField(
 	fConfigs := r.cfg.ResourceFields(r.Names.Original)
 	fConfig := fConfigs[memberNames.Original]
 	f := NewField(r, fPath, memberNames, shapeRef, fConfig)
-	if fConfig != nil && fConfig.IsPrintable {
+	if fConfig != nil && fConfig.Print != nil {
 		r.addSpecPrintableColumn(f)
 	}
 	r.SpecFields[memberNames.Original] = f
@@ -193,7 +193,7 @@ func (r *CRD) AddStatusField(
 	fConfigs := r.cfg.ResourceFields(r.Names.Original)
 	fConfig := fConfigs[memberNames.Original]
 	f := NewField(r, fPath, memberNames, shapeRef, fConfig)
-	if fConfig != nil && fConfig.IsPrintable {
+	if fConfig != nil && fConfig.Print != nil {
 		r.addStatusPrintableColumn(f)
 	}
 	r.StatusFields[memberNames.Original] = f

pkg/model/printer_column.go

@@ -110,8 +110,8 @@ func (r *CRD) addPrintableColumn(
 	}
 
 	name := field.Names.Camel
-	if field.FieldConfig.PrintName != "" {
-		name = field.FieldConfig.PrintName
+	if field.FieldConfig.Print.Name != "" {
+		name = field.FieldConfig.Print.Name
 	}
 
 	column := &PrinterColumn{