Merge pull request #1906 from p0lyn0mial/jsonpatch-formatting

API-1835: manifestclient: format jsonpatch payloads

pkg/manifestclient/write_roundtripper.go

@@ -175,6 +175,18 @@ func (mrt *writeTrackingRoundTripper) roundTrip(req *http.Request) ([]byte, erro
 		}
 		generatedName = bodyObj.(*unstructured.Unstructured).GetGenerateName()
 		kindType = bodyObj.GetObjectKind().GroupVersionKind()
+	} else if (action == ActionPatch || action == ActionPatchStatus) && patchType == string(types.JSONPatchType) {
+		// the following code gives nice formatting for
+		// JSON patches that will be stored in files.
+		var jsonPatchOperations []map[string]interface{}
+		err = json.Unmarshal(bodyOutputBytes, &jsonPatchOperations)
+		if err != nil {
+			return nil, fmt.Errorf("unable to decode JSONPatch body: %w", err)
+		}
+		bodyOutputBytes, err = yaml.Marshal(jsonPatchOperations)
+		if err != nil {
+			return nil, fmt.Errorf("unable to encode JSONPatch body: %w", err)
+		}
 	}
 
 	fieldManagerName := ""

pkg/manifestclienttest/client_write_test.go

@@ -171,12 +171,13 @@ func TestSimpleWritesChecks(t *testing.T) {
 				}
 
 				ctx := manifestclient.WithControllerInstanceNameFromContext(context.TODO(), "fooController")
+				jsonPatchPayload := []byte(`[{"op":"test","path":"/foo/path","value":"bar"},{"op":"remove","path":"/foo/path/2"}]`)
 
 				resultingObj, err := configClient.ConfigV1().FeatureGates().Patch(
 					ctx,
 					"instance-name",
 					types.JSONPatchType,
-					[]byte("json-patch"),
+					jsonPatchPayload,
 					metav1.PatchOptions{})
 				if err != nil {
 					t.Fatal(err)
@@ -189,7 +190,7 @@ func TestSimpleWritesChecks(t *testing.T) {
 					ctx,
 					"instance-name",
 					types.JSONPatchType,
-					[]byte("json-patch"),
+					jsonPatchPayload,
 					metav1.PatchOptions{},
 					"status")
 				if err != nil {
@@ -210,7 +211,7 @@ func TestSimpleWritesChecks(t *testing.T) {
 					ctx,
 					"instance-name",
 					types.JSONPatchType,
-					[]byte("json-patch"),
+					jsonPatchPayload,
 					metav1.PatchOptions{},
 				)
 				if err != nil {

pkg/manifestclienttest/testdata/mutation-tests/PATCH-crd-in-dataset/Patch/cluster-scoped-resources/config.openshift.io/featuregates/943a-body-instance-name.yaml

@@ -0,0 +1,5 @@
+- op: test
+  path: /foo/path
+  value: bar
+- op: remove
+  path: /foo/path/2

pkg/manifestclienttest/testdata/mutation-tests/PATCH-crd-in-dataset/PatchStatus/cluster-scoped-resources/config.openshift.io/featuregates/943a-body-instance-name.yaml

@@ -0,0 +1,5 @@
+- op: test
+  path: /foo/path
+  value: bar
+- op: remove
+  path: /foo/path/2