Skip to content

Commit 40e2d53

Browse files
committed
implement review feedback
1 parent 94c9085 commit 40e2d53

File tree

6 files changed

+214
-136
lines changed

6 files changed

+214
-136
lines changed

Taskfile.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ includes:
66
flatten: true
77
vars:
88
NESTED_MODULES: api
9+
API_DIRS: '{{.ROOT_DIR}}/api/...'
910
CODE_DIRS: '{{.ROOT_DIR}}/pkg/... {{.ROOT_DIR}}/api/...'
1011
GENERATE_DOCS_INDEX: "true"

api/go.mod

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
module github.com/openmcp-project/controller-utils/api
22

33
go 1.24.2
4+
5+
require k8s.io/apiextensions-apiserver v0.33.2
6+
7+
require (
8+
github.com/fxamacker/cbor/v2 v2.7.0 // indirect
9+
github.com/go-logr/logr v1.4.2 // indirect
10+
github.com/gogo/protobuf v1.3.2 // indirect
11+
github.com/json-iterator/go v1.1.12 // indirect
12+
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
13+
github.com/modern-go/reflect2 v1.0.2 // indirect
14+
github.com/x448/float16 v0.8.4 // indirect
15+
golang.org/x/net v0.38.0 // indirect
16+
golang.org/x/text v0.23.0 // indirect
17+
gopkg.in/inf.v0 v0.9.1 // indirect
18+
k8s.io/apimachinery v0.33.2 // indirect
19+
k8s.io/klog/v2 v2.130.1 // indirect
20+
k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 // indirect
21+
sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 // indirect
22+
sigs.k8s.io/randfill v1.0.0 // indirect
23+
sigs.k8s.io/structured-merge-diff/v4 v4.6.0 // indirect
24+
sigs.k8s.io/yaml v1.4.0 // indirect
25+
)

api/go.sum

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
2+
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
3+
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
4+
github.com/fxamacker/cbor/v2 v2.7.0 h1:iM5WgngdRBanHcxugY4JySA0nk1wZorNOpTgCMedv5E=
5+
github.com/fxamacker/cbor/v2 v2.7.0/go.mod h1:pxXPTn3joSm21Gbwsv0w9OSA2y1HFR9qXEeXQVeNoDQ=
6+
github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY=
7+
github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
8+
github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
9+
github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
10+
github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
11+
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
12+
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
13+
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
14+
github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
15+
github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
16+
github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
17+
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
18+
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
19+
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
20+
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
21+
github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M=
22+
github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
23+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
24+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
25+
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
26+
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
27+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
28+
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
29+
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
30+
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
31+
github.com/x448/float16 v0.8.4 h1:qLwI1I70+NjRFUR3zs1JPUCgaCXSh3SW62uAKT1mSBM=
32+
github.com/x448/float16 v0.8.4/go.mod h1:14CWIYCyZA/cWjXOioeEpHeN/83MdbZDRQHoFcYsOfg=
33+
github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
34+
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
35+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
36+
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
37+
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
38+
golang.org/x/mod v0.2.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
39+
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
40+
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
41+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
42+
golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
43+
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
44+
golang.org/x/net v0.38.0 h1:vRMAPTMaeGqVhG5QyLJHqNDwecKTomGeqbnfZyKlBI8=
45+
golang.org/x/net v0.38.0/go.mod h1:ivrbrMbzFq5J41QOQh0siUuly180yBYtLp+CKbEaFx8=
46+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
47+
golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
48+
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
49+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
50+
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
51+
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
52+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
53+
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
54+
golang.org/x/text v0.23.0 h1:D71I7dUrlY+VX0gQShAThNGHFxZ13dGLBHQLVl1mJlY=
55+
golang.org/x/text v0.23.0/go.mod h1:/BLNzu4aZCJ1+kcD0DNRotWKage4q2rGVAg4o22unh4=
56+
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
57+
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
58+
golang.org/x/tools v0.0.0-20200619180055-7c47624df98f/go.mod h1:EkVYQZoAsY45+roYkvgYkIh4xh/qjgUK9TdY2XT94GE=
59+
golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
60+
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
61+
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
62+
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
63+
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
64+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
65+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
66+
gopkg.in/inf.v0 v0.9.1 h1:73M5CoZyi3ZLMOyDlQh031Cx6N9NDJ2Vvfl76EDAgDc=
67+
gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw=
68+
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
69+
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
70+
k8s.io/apiextensions-apiserver v0.33.2 h1:6gnkIbngnaUflR3XwE1mCefN3YS8yTD631JXQhsU6M8=
71+
k8s.io/apiextensions-apiserver v0.33.2/go.mod h1:IvVanieYsEHJImTKXGP6XCOjTwv2LUMos0YWc9O+QP8=
72+
k8s.io/apimachinery v0.33.2 h1:IHFVhqg59mb8PJWTLi8m1mAoepkUNYmptHsV+Z1m5jY=
73+
k8s.io/apimachinery v0.33.2/go.mod h1:BHW0YOu7n22fFv/JkYOEfkUYNRN0fj0BlvMFWA7b+SM=
74+
k8s.io/klog/v2 v2.130.1 h1:n9Xl7H1Xvksem4KFG4PYbdQCQxqc/tTUyrgXaOhHSzk=
75+
k8s.io/klog/v2 v2.130.1/go.mod h1:3Jpz1GvMt720eyJH1ckRHK1EDfpxISzJ7I9OYgaDtPE=
76+
k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738 h1:M3sRQVHv7vB20Xc2ybTt7ODCeFj6JSWYFzOFnYeS6Ro=
77+
k8s.io/utils v0.0.0-20241104100929-3ea5e8cea738/go.mod h1:OLgZIPagt7ERELqWJFomSt595RzquPNLL48iOWgYOg0=
78+
sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3 h1:/Rv+M11QRah1itp8VhT6HoVx1Ray9eB4DBr+K+/sCJ8=
79+
sigs.k8s.io/json v0.0.0-20241010143419-9aa6b5e7a4b3/go.mod h1:18nIHnGi6636UCz6m8i4DhaJ65T6EruyzmoQqI2BVDo=
80+
sigs.k8s.io/randfill v0.0.0-20250304075658-069ef1bbf016/go.mod h1:XeLlZ/jmk4i1HRopwe7/aU3H5n1zNUcX6TM94b3QxOY=
81+
sigs.k8s.io/randfill v1.0.0 h1:JfjMILfT8A6RbawdsK2JXGBR5AQVfd+9TbzrlneTyrU=
82+
sigs.k8s.io/randfill v1.0.0/go.mod h1:XeLlZ/jmk4i1HRopwe7/aU3H5n1zNUcX6TM94b3QxOY=
83+
sigs.k8s.io/structured-merge-diff/v4 v4.6.0 h1:IUA9nvMmnKWcj5jl84xn+T5MnlZKThmUW1TdblaLVAc=
84+
sigs.k8s.io/structured-merge-diff/v4 v4.6.0/go.mod h1:dDy58f92j70zLsuZVuUX5Wp9vtxXpaZnkPGWeqDfCps=
85+
sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=
86+
sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=

api/jsonpatch/types.go

Lines changed: 28 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1+
// +kubebuilder:object:generate=true
12
package jsonpatch
23

3-
import "encoding/json"
4+
import (
5+
"encoding/json"
6+
7+
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
8+
)
49

510
// JSONPatch represents a JSON patch operation.
611
// Technically, a single JSON patch (as defined by RFC 6902) is a list of patch operations.
@@ -23,7 +28,7 @@ type JSONPatch struct {
2328
// +kubebuilder:validation:Schemaless
2429
// +kubebuilder:pruning:PreserveUnknownFields
2530
// +optional
26-
Value *Any `json:"value,omitempty"`
31+
Value *apiextensionsv1.JSON `json:"value,omitempty"`
2732

2833
// From is the source location for move and copy operations.
2934
// +optional
@@ -52,13 +57,31 @@ const (
5257
)
5358

5459
// NewJSONPatch creates a new JSONPatch with the given values.
55-
func NewJSONPatch(op Operation, path string, value *Any, from *string) JSONPatch {
56-
return JSONPatch{
60+
// If value is non-nil, it is marshaled to JSON. Returns an error if the value cannot be marshaled.
61+
func NewJSONPatch(op Operation, path string, value any, from *string) (JSONPatch, error) {
62+
res := JSONPatch{
5763
Operation: op,
5864
Path: path,
59-
Value: value,
6065
From: from,
6166
}
67+
var err error
68+
if value != nil {
69+
var valueJSON []byte
70+
valueJSON, err = json.Marshal(value)
71+
res.Value = &apiextensionsv1.JSON{
72+
Raw: valueJSON,
73+
}
74+
}
75+
return res, err
76+
}
77+
78+
// NewJSONPatchOrPanic works like NewJSONPatch, but instead of returning an error, it panics if the patch cannot be created.
79+
func NewJSONPatchOrPanic(op Operation, path string, value any, from *string) JSONPatch {
80+
patch, err := NewJSONPatch(op, path, value, from)
81+
if err != nil {
82+
panic(err)
83+
}
84+
return patch
6285
}
6386

6487
// NewJSONPatches combines multiple JSONPatch instances into a single JSONPatches instance.
@@ -70,113 +93,3 @@ func NewJSONPatches(patches ...JSONPatch) JSONPatches {
7093
}
7194
return result
7295
}
73-
74-
func NewAny(value any) *Any {
75-
return &Any{Value: value}
76-
}
77-
78-
type Any struct {
79-
Value any `json:"-"`
80-
}
81-
82-
var _ json.Marshaler = &Any{}
83-
var _ json.Unmarshaler = &Any{}
84-
85-
func (a *Any) MarshalJSON() ([]byte, error) {
86-
if a == nil {
87-
return []byte("null"), nil
88-
}
89-
return json.Marshal(a.Value)
90-
}
91-
92-
func (a *Any) UnmarshalJSON(data []byte) error {
93-
if data == nil || string(data) == "null" {
94-
a.Value = nil
95-
return nil
96-
}
97-
return json.Unmarshal(data, &a.Value)
98-
}
99-
100-
func (in *JSONPatch) DeepCopy() *JSONPatch {
101-
if in == nil {
102-
return nil
103-
}
104-
out := &JSONPatch{}
105-
in.DeepCopyInto(out)
106-
return out
107-
}
108-
109-
func (in *JSONPatch) DeepCopyInto(out *JSONPatch) {
110-
if out == nil {
111-
return
112-
}
113-
out.Operation = in.Operation
114-
out.Path = in.Path
115-
if in.Value != nil {
116-
valueCopy := *in.Value
117-
out.Value = &valueCopy
118-
} else {
119-
out.Value = nil
120-
}
121-
if in.From != nil {
122-
fromCopy := *in.From
123-
out.From = &fromCopy
124-
} else {
125-
out.From = nil
126-
}
127-
}
128-
129-
func (in *JSONPatches) DeepCopy() *JSONPatches {
130-
if in == nil {
131-
return nil
132-
}
133-
out := &JSONPatches{}
134-
for _, item := range *in {
135-
outItem := item.DeepCopy()
136-
*out = append(*out, *outItem)
137-
}
138-
return out
139-
}
140-
141-
func (in *JSONPatches) DeepCopyInto(out *JSONPatches) {
142-
if out == nil {
143-
return
144-
}
145-
*out = make(JSONPatches, len(*in))
146-
for i, item := range *in {
147-
outItem := item.DeepCopy()
148-
(*out)[i] = *outItem
149-
}
150-
}
151-
152-
func (in *Any) DeepCopy() *Any {
153-
if in == nil {
154-
return nil
155-
}
156-
out := &Any{}
157-
in.DeepCopyInto(out)
158-
return out
159-
}
160-
161-
func (in *Any) DeepCopyInto(out *Any) {
162-
if out == nil {
163-
return
164-
}
165-
if in.Value == nil {
166-
out.Value = nil
167-
return
168-
}
169-
// Use json.Marshal and json.Unmarshal to deep copy the value.
170-
data, err := json.Marshal(in.Value)
171-
if err != nil {
172-
panic("failed to marshal Any value: " + err.Error())
173-
}
174-
if err := json.Unmarshal(data, &out.Value); err != nil {
175-
panic("failed to unmarshal Any value: " + err.Error())
176-
}
177-
}
178-
179-
// Ptr is a convenience function to create a pointer to the given value.
180-
func Ptr[T any](val T) *T {
181-
return &val
182-
}

api/jsonpatch/zz_generated.deepcopy.go

Lines changed: 55 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)