Fix CRD Generation (#303)

Author: chatton

deploy/crds/arbitrary_statefulset_configuration/mongodb.com_v1_custom_volume_cr.yaml

@@ -19,6 +19,8 @@ spec:
           db: admin
         - name: userAdminAnyDatabase
           db: admin
+      scramCredentialsSecretName: my-scram
+
   statefulSet:
     spec:
       template:

deploy/crds/mongodb.com_mongodbcommunity_crd.yaml

@@ -42,6 +42,11 @@ spec:
         spec:
           description: MongoDBCommunitySpec defines the desired state of MongoDB
           properties:
+            additionalMongodConfig:
+              description: 'AdditionalMongodConfig is additional configuration that
+                can be passed to each data-bearing mongod at runtime. Uses the same
+                structure as the mongod configuration file: https://docs.mongodb.com/manual/reference/configuration-options/'
+              type: object
             featureCompatibilityVersion:
               description: FeatureCompatibilityVersion configures the feature compatibility
                 version that will be set for the deployment
@@ -205,6 +210,11 @@ spec:
             statefulSet:
               description: StatefulSetConfiguration holds the optional custom StatefulSet
                 that should be merged into the operator created one.
+              properties:
+                spec:
+                  type: object
+              required:
+              - spec
               type: object
             type:
               description: Type defines which type of MongoDB deployment the resource
@@ -259,8 +269,8 @@ spec:
                     description: ScramCredentialsSecretName appended by string "scram-credentials"
                       is the name of the secret object created by the mongoDB operator
                       for storing SCRAM credentials
-                    type: string
                     pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
+                    type: string
                 required:
                 - name
                 - passwordSecretRef

pkg/apis/mongodb/v1/mongodb_types.go

@@ -75,6 +75,7 @@ type MongoDBCommunitySpec struct {
 	// each data-bearing mongod at runtime. Uses the same structure as the mongod
 	// configuration file: https://docs.mongodb.com/manual/reference/configuration-options/
 	// +kubebuilder:validation:Type=object
+	// +optional
 	AdditionalMongodConfig MongodConfiguration `json:"additionalMongodConfig,omitempty"`
 }
 
@@ -175,8 +176,30 @@ type AuthenticationRestriction struct {
 // StatefulSetConfiguration holds the optional custom StatefulSet
 // that should be merged into the operator created one.
 type StatefulSetConfiguration struct {
-	// The StatefulSet override options for underlying StatefulSet
-	Spec appsv1.StatefulSetSpec `json:"spec"` // TODO: this pollutes the crd generation
+	SpecWrapper StatefulSetSpecWrapper `json:"spec"`
+}
+
+// StatefulSetSpecWrapper is a wrapper around StatefulSetSpec with a custom implementation
+// of MarshalJSON and UnmarshalJSON which delegate to the underlying Spec to avoid CRD pollution.
+
+type StatefulSetSpecWrapper struct {
+	Spec appsv1.StatefulSetSpec `json:"-"`
+}
+
+// MarshalJSON defers JSON encoding to the wrapped map
+func (m *StatefulSetSpecWrapper) MarshalJSON() ([]byte, error) {
+	return json.Marshal(m.Spec)
+}
+
+// UnmarshalJSON will decode the data into the wrapped map
+func (m *StatefulSetSpecWrapper) UnmarshalJSON(data []byte) error {
+	return json.Unmarshal(data, &m.Spec)
+}
+
+func (m *StatefulSetSpecWrapper) DeepCopy() *StatefulSetSpecWrapper {
+	return &StatefulSetSpecWrapper{
+		Spec: m.Spec,
+	}
 }
 
 // MongodConfiguration holds the optional mongod configuration
@@ -224,7 +247,7 @@ type MongoDBUser struct {
 	Roles []Role `json:"roles"`
 
 	// ScramCredentialsSecretName appended by string "scram-credentials" is the name of the secret object created by the mongoDB operator for storing SCRAM credentials
-	// +kubebuilder:validation:Pattern="^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
+	// +kubebuilder:validation:Pattern=^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
 	ScramCredentialsSecretName string `json:"scramCredentialsSecretName"`
 }
 

pkg/apis/mongodb/v1/zz_generated.deepcopy.go

@@ -799,7 +799,7 @@ func buildStatefulSetModificationFunction(mdb mdbv1.MongoDBCommunity) statefulse
 				buildScramPodSpecModification(mdb),
 			),
 		),
-		statefulset.WithCustomSpecs(mdb.Spec.StatefulSetConfiguration.Spec),
+		statefulset.WithCustomSpecs(mdb.Spec.StatefulSetConfiguration.SpecWrapper.Spec),
 	)
 }
 

pkg/controller/mongodb/replica_set_controller.go

@@ -154,6 +154,9 @@ func NewTestMongoDB(name string, namespace string) (mdbv1.MongoDBCommunity, mdbv
 					Modes: []mdbv1.AuthMode{"SCRAM"},
 				},
 			},
+			AdditionalMongodConfig: mdbv1.MongodConfiguration{
+				Object: map[string]interface{}{},
+			},
 			Users: []mdbv1.MongoDBUser{
 				{
 					Name: fmt.Sprintf("%s-user", name),

test/e2e/e2eutil.go

@@ -31,7 +31,7 @@ func TestStatefulSetArbitraryConfig(t *testing.T) {
 	}
 
 	overrideSpec := v1.StatefulSetConfiguration{}
-	overrideSpec.Spec.Template.Spec.Containers = []corev1.Container{
+	overrideSpec.SpecWrapper.Spec.Template.Spec.Containers = []corev1.Container{
 		{Name: "mongodb-agent", ReadinessProbe: &corev1.Probe{TimeoutSeconds: 100}}}
 
 	mdb.Spec.StatefulSetConfiguration = overrideSpec

test/e2e/statefulset_arbitrary_config/statefulset_arbitrary_config_test.go

@@ -42,7 +42,7 @@ func TestStatefulSetArbitraryConfig(t *testing.T) {
 	t.Run("AutomationConfig has the correct version", mongodbtests.AutomationConfigVersionHasTheExpectedVersion(&mdb, 1))
 
 	overrideSpec := v1.StatefulSetConfiguration{}
-	overrideSpec.Spec.Template.Spec.Containers = []corev1.Container{
+	overrideSpec.SpecWrapper.Spec.Template.Spec.Containers = []corev1.Container{
 		{Name: "mongodb-agent", ReadinessProbe: &corev1.Probe{TimeoutSeconds: 100}}}
 
 	err = e2eutil.UpdateMongoDBResource(&mdb, func(mdb *v1.MongoDBCommunity) { mdb.Spec.StatefulSetConfiguration = overrideSpec })