Addressing comments from Dale

Signed-off-by: David Elie-Dit-Cosaque <[email protected]>

Author: edcdavid

docs/policygenerator-reference.yaml

@@ -279,9 +279,9 @@ policies:
               # An example modification to the manifest
               annotations:
                 friends-character: Chandler Bing
-        # The OpenAPI schema used to merge patches (useful for non Kubernetes CRs that containt list of items)
+        # The OpenAPI schema used to merge patches (useful for non-Kubernetes CRs that contain lists of items)
         openapi:
-          # The path to the OpenAPI schema to use when applying patches defined in patches 
+          # The path to the OpenAPI schema to use when applying patches defined from the `patches` array. 
           path: ""
     # Optional. (See policyDefaults.categories for description.)
     categories:

docs/policygenerator.md

@@ -75,50 +75,46 @@ DIRECTORY TREE              PACKAGE                 DESCRIPTION
     ├── typohelper.go       internal                Helpers for identifying manifest typos
     ├── utils.go            internal                Helper/utility functions
 ```
-## Openapi schema support 
-policy-genenerator-plugin supports openapi schemas as defined in  https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/openapi by Kustomize. The goal of this feature is to support patching non kubernetest CR objects that contain list of objects.
-The openapi object in this project has the same format of the openapi object in the kustomize project. The Path indicates the relative path of the schema json file relative to the kustomization.yaml file
-``` yaml
+
+## OpenAPI schema support
+The Policy Generator supports OpenAPI schemas as defined in
+https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/openapi by Kustomize. The goal of this feature is
+to support patching non-Kubernetes custom resource objects that contain list of objects. The OpenAPI object in this
+project has the same format of the OpenAPI object in the Kustomize project. The path indicates the relative path of the
+schema JSON file relative to the `kustomization.yaml` file:
+```yaml
 openapi:
-   path: schema.json
+  path: schema.json
 ```
-The openapi object is part of the manifest object in the plugin file:
-``` yaml
+The OpenAPI object is included with the manifest object in the plugin file:
+```yaml
 apiVersion: policy.open-cluster-management.io/v1
 kind: PolicyGenerator
-...
+. . .
 policies:
-- name: myapp
-  manifests:
-    - path: input-kustomize/
-      patches:
-      openapi:
-        path: schema.json
+  - name: myapp
+    manifests:
+      - path: input-kustomize/
+        patches: []
+        openapi:
+          path: schema.json
 ```
 ### How to create a Kustomize schema manually
-Ideally the openapi schema should be provided by the developper of the Custom Resource (CR).  
-To retrieve a schema from a running kubernetes cluster manually, do the following:
-
-``` default
+Ideally the OpenAPI schema is provided by the developper of the Custom Resource (CR). To retrieve a schema from a
+running Kubernetes cluster manually, do the following:
+```shell
 kustomize openapi fetch
 ```
-
 Then cut and paste the subset containing the resources that need to be patched.
-
-Next, identify the list objects in the schema and select a key from the fields
-of the object that would be use to index the list, for instance a name. After
-the definition of the list, add the following text:
-
-``` default
-              "x-kubernetes-patch-merge-key": "name",
-              "x-kubernetes-patch-strategy": "merge"
+Next, identify the list objects in the schema and select a key from the fields of the object that would be use to index
+the list, for instance a name. After the definition of the list, add the following text:
+```yaml
+"x-kubernetes-patch-merge-key": "name",
+"x-kubernetes-patch-strategy": "merge"
 ```
-
-`x-kubernetes-patch-merge-key` indicates the field in the object that is used to
-uniquely identify it in the list in this case the `name` field
-`x-kubernetes-patch-strategy` indicates the patch strategy. Merge would merge
-fields, replace would replace the object identified by the key with patch
-content.  
+`x-kubernetes-patch-merge-key` indicates the field in the object that is used to uniquely identify it in the list in
+this case the `name` field. `x-kubernetes-patch-strategy` indicates the patch strategy. Merge would merge fields,
+replace would replace the object identified by the key with patch content.  
 `Note:` The "key" selected in this step is used in patches to uniquely identify a list object.
-  
-An example of schema for the ptp-operator PtpConfig CR is shown at [link](internal/testdata/OpenAPI/newptpconfig-schema.json)
+An example of schema is shown at
+[link](internal/testdata/OpenAPI/openapi-schema.json)openapi-schema.json)

examples/policyGenerator-kustomize.yaml

@@ -17,4 +17,4 @@ policies:
       - metadata:
           name: "myname"
       openapi:
-        path: schema.json
+        path: schema.json

internal/patches.go

@@ -21,13 +21,22 @@ const (
 	kustomizeDir        = "kustomize"
 )
 
+type KustomizeJSON struct {
+	types.Filepath `json:"openapi,omitempty" yaml:"openapi,omitempty"`
+	Patches        []Patch  `json:"patches" yaml:"patches"`
+	Resources      []string `json:"resources" yaml:"resources"`
+}
+
+type Patch struct {
+	Path string `yaml:"path,omitempty" json:"path,omitempty"`
+}
 type manifestPatcher struct {
 	// The manifests to patch.
 	manifests []map[string]interface{}
 	// The Kustomize patches to apply on the manifests. Note that modifications are made
 	// to the input maps. If this is an issue, provide a deep copy of the patches.
 	patches []map[string]interface{}
-	openAPI types.OpenAPI
+	openAPI types.Filepath
 }
 
 // validateManifestInfo verifies that the apiVersion, kind, metadata.name fields from a manifest
@@ -181,12 +190,12 @@ func (m *manifestPatcher) ApplyPatches() ([]map[string]interface{}, error) {
 
 	err := InitializeInMemoryKustomizeDir(fSys, m.openAPI.Path)
 	if err != nil {
-		return nil, fmt.Errorf("failed to initialize Kustomize dir, err: %w", err)
+		return nil, fmt.Errorf("failed to initialize Kustomize dir: %w", err)
 	}
 
-	kustomizationYAMLFile := types.KustomizeJSON{}
+	kustomizationYAMLFile := KustomizeJSON{}
 	if m.openAPI.Path != "" {
-		kustomizationYAMLFile.OpenAPI.Path = localSchemaFileName
+		kustomizationYAMLFile.Filepath.Path = localSchemaFileName
 	}
 
 	options := []struct {
@@ -219,7 +228,7 @@ func (m *manifestPatcher) ApplyPatches() ([]map[string]interface{}, error) {
 				kustomizationYAMLFile.Resources = append(kustomizationYAMLFile.Resources, manifestFileName)
 			} else {
 				kustomizationYAMLFile.Patches = append(kustomizationYAMLFile.Patches,
-					types.Patch{Path: manifestFileName})
+					Patch{Path: manifestFileName})
 			}
 		}
 	}

internal/patches_test.go

@@ -50,7 +50,7 @@ func TestValidate(t *testing.T) {
 		},
 	}
 
-	openAPIConfig := types.OpenAPI{Path: ""}
+	openAPIConfig := types.Filepath{Path: ""}
 
 	patcher := manifestPatcher{manifests: manifests, patches: patches, openAPI: openAPIConfig}
 	err := patcher.Validate()