Add Print Conditions

josvazg · josvazg · commit a87b89923649 · 2025-12-10T12:06:16.000+01:00
diff --git a/config/openapi2crd.yaml b/config/openapi2crd.yaml
@@ -49,6 +49,7 @@ spec:
         - reference_extensions
         - mutual_exclusive_major_versions
         - atlas_sdk_version
+        - print_conditions
 
   openapi:
     - name: v20250312
diff --git a/internal/generated/crds/crds.yaml b/internal/generated/crds/crds.yaml
@@ -25,7 +25,14 @@ spec:
     singular: group
   scope: Namespaced
   versions:
-  - name: v1
+  - additionalPrinterColumns:
+    - jsonPath: .status.conditions[?(@.type=="Ready")].status
+      name: Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="State")].status
+      name: State
+      type: string
+    name: v1
     schema:
       openAPIV3Schema:
         description: A group, managed by the MongoDB Kubernetes Atlas Operator.
@@ -235,7 +242,14 @@ spec:
     singular: cluster
   scope: Namespaced
   versions:
-  - name: v1
+  - additionalPrinterColumns:
+    - jsonPath: .status.conditions[?(@.type=="Ready")].status
+      name: Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="State")].status
+      name: State
+      type: string
+    name: v1
     schema:
       openAPIV3Schema:
         description: A cluster, managed by the MongoDB Kubernetes Atlas Operator.
@@ -1555,7 +1569,14 @@ spec:
     singular: flexcluster
   scope: Namespaced
   versions:
-  - name: v1
+  - additionalPrinterColumns:
+    - jsonPath: .status.conditions[?(@.type=="Ready")].status
+      name: Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="State")].status
+      name: State
+      type: string
+    name: v1
     schema:
       openAPIV3Schema:
         description: A flexcluster, managed by the MongoDB Kubernetes Atlas Operator.
@@ -1880,7 +1901,14 @@ spec:
     singular: databaseuser
   scope: Namespaced
   versions:
-  - name: v1
+  - additionalPrinterColumns:
+    - jsonPath: .status.conditions[?(@.type=="Ready")].status
+      name: Ready
+      type: string
+    - jsonPath: .status.conditions[?(@.type=="State")].status
+      name: State
+      type: string
+    name: v1
     schema:
       openAPIV3Schema:
         description: A databaseuser, managed by the MongoDB Kubernetes Atlas Operator.
diff --git a/internal/nextapi/generated/v1/zz_generated.deepcopy.go b/internal/nextapi/generated/v1/zz_generated.deepcopy.go
diff --git a/tools/openapi2crd/config.example.yaml b/tools/openapi2crd/config.example.yaml
@@ -36,6 +36,7 @@ spec:
         - reference_extensions
         - mutual_exclusive_major_versions
         - atlas_sdk_version
+        - print_conditions
 
   openapi:
     - name: v20250312
diff --git a/tools/openapi2crd/config.sample.yaml b/tools/openapi2crd/config.sample.yaml
@@ -36,6 +36,7 @@ spec:
         - reference_extensions
         - mutual_exclusive_major_versions
         - atlas_sdk_version
+        - print_conditions
 
   openapi:
     - name: v20250312
diff --git a/tools/openapi2crd/pkg/generator/generator.go b/tools/openapi2crd/pkg/generator/generator.go
@@ -21,12 +21,13 @@ import (
 	"log"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"sigs.k8s.io/yaml"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
 )
 
 type Generator struct {
diff --git a/tools/openapi2crd/pkg/generator/generator_test.go b/tools/openapi2crd/pkg/generator/generator_test.go
@@ -20,13 +20,14 @@ import (
 	"testing"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/config"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
 )
 
 func TestClearPropertiesWithoutExtensions(t *testing.T) {
diff --git a/tools/openapi2crd/pkg/plugins/catalog.go b/tools/openapi2crd/pkg/plugins/catalog.go
@@ -143,6 +143,7 @@ func NewCatalog() *Catalog {
 			"references":             &References{},
 			"connection_secret":      &ConnectionSecret{},
 			"mutual_exclusive_group": &MutualExclusiveGroup{},
+			"print_conditions":       &PrintConditions{},
 		},
 		property: map[string]PropertyPlugin{
 			"sensitive_properties":  &SensitiveProperties{},
diff --git a/tools/openapi2crd/pkg/plugins/catalog_test.go b/tools/openapi2crd/pkg/plugins/catalog_test.go
@@ -19,8 +19,9 @@ import (
 	"errors"
 	"testing"
 
-	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
 	"github.com/stretchr/testify/assert"
+
+	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
 )
 
 func TestBuildSets(t *testing.T) {
diff --git a/tools/openapi2crd/pkg/plugins/parameters.go b/tools/openapi2crd/pkg/plugins/parameters.go
@@ -19,8 +19,9 @@ import (
 	"fmt"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
 )
 
 // Parameters adds parameters from the OpenAPI spec to the CRD schema.
diff --git a/tools/openapi2crd/pkg/plugins/parameters_test.go b/tools/openapi2crd/pkg/plugins/parameters_test.go
@@ -21,11 +21,12 @@ import (
 	"testing"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 	"k8s.io/utils/ptr"
+
+	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
 )
 
 func TestParameterName(t *testing.T) {
diff --git a/tools/openapi2crd/pkg/plugins/plugin.go b/tools/openapi2crd/pkg/plugins/plugin.go
@@ -17,9 +17,10 @@ package plugins
 
 import (
 	"github.com/getkin/kin-openapi/openapi3"
+	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+
 	configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
 	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/converter"
-	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
 )
 
 type CRDProcessorRequest struct {
diff --git a/tools/openapi2crd/pkg/plugins/print_conditions.go b/tools/openapi2crd/pkg/plugins/print_conditions.go
@@ -0,0 +1,45 @@
+package plugins
+
+import (
+	"fmt"
+
+	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+)
+
+type PrintConditions struct{}
+
+func (p *PrintConditions) Name() string {
+	return "print_conditions"
+}
+
+func (p *PrintConditions) Process(req *MappingProcessorRequest) error {
+	index := findVersionIndex(req.CRD.Spec.Versions, req.CRD.APIVersion)
+	if index == -1 {
+		return fmt.Errorf("apiVersion %q not listed in spec", req.CRD.APIVersion)
+	}
+	req.CRD.Spec.Versions[index].AdditionalPrinterColumns = []apiextensions.CustomResourceColumnDefinition{
+		{
+			JSONPath: `.status.conditions[?(@.type=="Ready")].status`,
+			Name:     "Ready",
+			Type:     "string",
+		},
+		{
+			JSONPath: `.status.conditions[?(@.type=="State")].status`,
+			Name:     "State",
+			Type:     "string",
+		},
+	}
+	return nil
+}
+
+func findVersionIndex(versions []apiextensions.CustomResourceDefinitionVersion, version string) int {
+	if len(versions) == 1 && version == "" {
+		return 0
+	}
+	for i, v := range versions {
+		if v.Name == version {
+			return i
+		}
+	}
+	return -1
+}
diff --git a/tools/openapi2crd/pkg/plugins/print_conditions_test.go b/tools/openapi2crd/pkg/plugins/print_conditions_test.go
@@ -0,0 +1,138 @@
+package plugins_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/plugins"
+)
+
+func TestPrintConditions_Name(t *testing.T) {
+	p := &plugins.PrintConditions{}
+	assert.Equal(t, "print_conditions", p.Name())
+}
+
+func TestPrintConditions_Process(t *testing.T) {
+	tests := []struct {
+		title      string
+		apiVersion string
+		versions   []apiextensions.CustomResourceDefinitionVersion
+		wantErr    string
+		// validate allows us to inspect the CRD after processing to ensure side effects occurred
+		validate func(t *testing.T, crd *apiextensions.CustomResourceDefinition)
+	}{
+		{
+			title:      "version updated",
+			apiVersion: "v1",
+			versions: []apiextensions.CustomResourceDefinitionVersion{
+				{Name: "v1beta1", Served: true, Storage: false},
+				{Name: "v1", Served: true, Storage: true},
+			},
+			validate: func(t *testing.T, crd *apiextensions.CustomResourceDefinition) {
+				// Find the v1 version
+				var targetVersion apiextensions.CustomResourceDefinitionVersion
+				for _, v := range crd.Spec.Versions {
+					if v.Name == "v1" {
+						targetVersion = v
+						break
+					}
+				}
+
+				// Verify columns were added
+				require.NotEmpty(t, targetVersion.Name, "Should have found the target version")
+				require.Len(t, targetVersion.AdditionalPrinterColumns, 2)
+
+				assert.Equal(t, "Ready", targetVersion.AdditionalPrinterColumns[0].Name)
+				assert.Equal(t, `.status.conditions[?(@.type=="Ready")].status`, targetVersion.AdditionalPrinterColumns[0].JSONPath)
+
+				assert.Equal(t, "State", targetVersion.AdditionalPrinterColumns[1].Name)
+				assert.Equal(t, `.status.conditions[?(@.type=="State")].status`, targetVersion.AdditionalPrinterColumns[1].JSONPath)
+			},
+		},
+		{
+			title:      "missing version",
+			apiVersion: "v2",
+			versions: []apiextensions.CustomResourceDefinitionVersion{
+				{Name: "v1", Served: true, Storage: true},
+			},
+			wantErr: "apiVersion \"v2\" not listed in spec",
+			validate: func(t *testing.T, crd *apiextensions.CustomResourceDefinition) {
+				// Ensure no weird side effects happened to existing versions
+				assert.Empty(t, crd.Spec.Versions[0].AdditionalPrinterColumns)
+			},
+		},
+		{
+			title:      "replace columns",
+			apiVersion: "v1",
+			versions: []apiextensions.CustomResourceDefinitionVersion{
+				{
+					Name: "v1",
+					AdditionalPrinterColumns: []apiextensions.CustomResourceColumnDefinition{
+						{Name: "OldColumn", JSONPath: ".old"},
+					},
+				},
+			},
+			validate: func(t *testing.T, crd *apiextensions.CustomResourceDefinition) {
+				targetVersion := crd.Spec.Versions[0]
+				require.Len(t, targetVersion.AdditionalPrinterColumns, 2)
+				assert.Equal(t, "Ready", targetVersion.AdditionalPrinterColumns[0].Name)
+			},
+		},
+		{
+			title:      "unique version updated",
+			apiVersion: "",
+			versions: []apiextensions.CustomResourceDefinitionVersion{
+				{Name: "v1", Served: true, Storage: true},
+			},
+			validate: func(t *testing.T, crd *apiextensions.CustomResourceDefinition) {
+				// Find the v1 version
+				var targetVersion apiextensions.CustomResourceDefinitionVersion
+				for _, v := range crd.Spec.Versions {
+					if v.Name == "v1" {
+						targetVersion = v
+						break
+					}
+				}
+
+				// Verify columns were added
+				require.NotEmpty(t, targetVersion.Name, "Should have found the target version")
+				require.Len(t, targetVersion.AdditionalPrinterColumns, 2)
+
+				assert.Equal(t, "Ready", targetVersion.AdditionalPrinterColumns[0].Name)
+				assert.Equal(t, `.status.conditions[?(@.type=="Ready")].status`, targetVersion.AdditionalPrinterColumns[0].JSONPath)
+
+				assert.Equal(t, "State", targetVersion.AdditionalPrinterColumns[1].Name)
+				assert.Equal(t, `.status.conditions[?(@.type=="State")].status`, targetVersion.AdditionalPrinterColumns[1].JSONPath)
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.title, func(t *testing.T) {
+			p := &plugins.PrintConditions{}
+			crd := &apiextensions.CustomResourceDefinition{
+				Spec: apiextensions.CustomResourceDefinitionSpec{
+					Versions: tc.versions,
+				},
+			}
+			crd.APIVersion = tc.apiVersion
+			req := &plugins.MappingProcessorRequest{
+				CRD: crd,
+			}
+
+			err := p.Process(req)
+
+			if tc.wantErr != "" {
+				assert.EqualError(t, err, tc.wantErr)
+			} else {
+				assert.NoError(t, err)
+			}
+			if tc.validate != nil {
+				tc.validate(t, crd)
+			}
+		})
+	}
+}
diff --git a/tools/openapi2crd/pkg/plugins/read_write_properties_test.go b/tools/openapi2crd/pkg/plugins/read_write_properties_test.go
@@ -19,9 +19,10 @@ import (
 	"testing"
 
 	"github.com/getkin/kin-openapi/openapi3"
-	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
 	"github.com/stretchr/testify/assert"
 	"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions"
+
+	"github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"
 )
 
 func TestReadWritePropertyName(t *testing.T) {
diff --git a/tools/openapi2crd/pkg/plugins/reference_extensions.go b/tools/openapi2crd/pkg/plugins/reference_extensions.go
diff --git a/tools/openapi2crd/pkg/plugins/reference_extensions_test.go b/tools/openapi2crd/pkg/plugins/reference_extensions_test.go
diff --git a/tools/openapi2crd/pkg/plugins/references.go b/tools/openapi2crd/pkg/plugins/references.go
diff --git a/tools/openapi2crd/pkg/plugins/sensitive_properties.go b/tools/openapi2crd/pkg/plugins/sensitive_properties.go
diff --git a/tools/openapi2crd/pkg/plugins/sensitive_properties_test.go b/tools/openapi2crd/pkg/plugins/sensitive_properties_test.go

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,9 @@ import (`
`19`	`19`	`"errors"`
`20`	`20`	`"testing"`
`21`	`21`
`22`		`- configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"`
`23`	`22`	`"github.com/stretchr/testify/assert"`
	`23`	`+`
	`24`	`+ configv1alpha1 "github.com/mongodb/mongodb-atlas-kubernetes/tools/openapi2crd/pkg/apis/config/v1alpha1"`
`24`	`25`	`)`
`25`	`26`
`26`	`27`	`func TestBuildSets(t *testing.T) {`