Skip to content

Commit c6138e2

Browse files
authored
feat(client): use openapi v3 to generate client (#6056)
* feat(client): use openapi v3 to generate client Signed-off-by: liubo02 <liubo02@pingcap.com> * fix tidy Signed-off-by: liubo02 <liubo02@pingcap.com> --------- Signed-off-by: liubo02 <liubo02@pingcap.com>
1 parent 469992a commit c6138e2

File tree

6 files changed

+700
-14
lines changed

6 files changed

+700
-14
lines changed

go.mod

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ require (
1313
github.com/evanphx/json-patch v4.12.0+incompatible
1414
github.com/go-logr/logr v1.4.2
1515
github.com/go-sql-driver/mysql v1.8.1
16+
github.com/google/gnostic-models v0.6.8
1617
github.com/mitchellh/mapstructure v1.5.0
1718
github.com/olekukonko/tablewriter v0.0.5
1819
github.com/onsi/ginkgo/v2 v2.19.0
@@ -28,6 +29,9 @@ require (
2829
github.com/stretchr/testify v1.9.0
2930
go.uber.org/mock v0.4.0
3031
go.uber.org/zap v1.27.0
32+
google.golang.org/protobuf v1.34.2
33+
gopkg.in/yaml.v2 v2.4.0
34+
gopkg.in/yaml.v3 v3.0.1
3135
k8s.io/api v0.31.0
3236
k8s.io/apimachinery v0.31.0
3337
k8s.io/cli-runtime v0.31.0
@@ -81,7 +85,6 @@ require (
8185
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
8286
github.com/golang/protobuf v1.5.4 // indirect
8387
github.com/google/btree v1.0.1 // indirect
84-
github.com/google/gnostic-models v0.6.8 // indirect
8588
github.com/google/go-cmp v0.6.0 // indirect
8689
github.com/google/gofuzz v1.2.0 // indirect
8790
github.com/google/pprof v0.0.0-20240525223248-4bfdf5a9a2af // indirect
@@ -129,11 +132,8 @@ require (
129132
gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
130133
google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
131134
google.golang.org/grpc v1.65.0 // indirect
132-
google.golang.org/protobuf v1.34.2 // indirect
133135
gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
134136
gopkg.in/inf.v0 v0.9.1 // indirect
135-
gopkg.in/yaml.v2 v2.4.0 // indirect
136-
gopkg.in/yaml.v3 v3.0.1 // indirect
137137
k8s.io/apiextensions-apiserver v0.31.0 // indirect
138138
k8s.io/component-base v0.31.0 // indirect
139139
sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect

pkg/client/client.go

Lines changed: 71 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,22 @@ import (
2020
"fmt"
2121
"reflect"
2222

23+
openapi_v3 "github.com/google/gnostic-models/openapiv3"
24+
"google.golang.org/protobuf/proto"
2325
"k8s.io/apimachinery/pkg/api/equality"
2426
"k8s.io/apimachinery/pkg/api/errors"
2527
"k8s.io/apimachinery/pkg/runtime/schema"
2628
"k8s.io/apimachinery/pkg/runtime/serializer/json"
2729
"k8s.io/apimachinery/pkg/types"
2830
"k8s.io/apimachinery/pkg/util/managedfields"
2931
"k8s.io/client-go/discovery"
32+
"k8s.io/client-go/openapi"
3033
"k8s.io/client-go/rest"
31-
"k8s.io/kube-openapi/pkg/util/proto"
3234
"sigs.k8s.io/controller-runtime/pkg/client"
3335
"sigs.k8s.io/structured-merge-diff/v4/typed"
3436

3537
"github.com/pingcap/tidb-operator/pkg/scheme"
38+
forkedproto "github.com/pingcap/tidb-operator/third_party/kube-openapi/pkg/util/proto"
3639
)
3740

3841
const (
@@ -163,25 +166,44 @@ type GVKParser interface {
163166
Type(gvk schema.GroupVersionKind) *typed.ParseableType
164167
}
165168

166-
func New(cfg *rest.Config, opts client.Options) (Client, error) {
167-
dc, err := discovery.NewDiscoveryClientForConfig(cfg)
168-
if err != nil {
169-
return nil, err
169+
type gvkParser struct {
170+
parsers map[schema.GroupVersion]GVKParser
171+
}
172+
173+
func (p *gvkParser) Type(gvk schema.GroupVersionKind) *typed.ParseableType {
174+
parser, ok := p.parsers[gvk.GroupVersion()]
175+
if !ok {
176+
return nil
170177
}
178+
return parser.Type(gvk)
179+
}
171180

172-
doc, err := dc.OpenAPISchema()
181+
func gvToAPIPath(gv schema.GroupVersion) string {
182+
var resourcePath string
183+
if gv.Group == "" {
184+
resourcePath = fmt.Sprintf("api/%s", gv.Version)
185+
} else {
186+
resourcePath = fmt.Sprintf("apis/%s/%s", gv.Group, gv.Version)
187+
}
188+
return resourcePath
189+
}
190+
191+
func New(cfg *rest.Config, opts client.Options) (Client, error) {
192+
dc, err := discovery.NewDiscoveryClientForConfig(cfg)
173193
if err != nil {
174-
return nil, err
194+
return nil, fmt.Errorf("cannot new discovery client: %w", err)
175195
}
176196

177-
models, err := proto.NewOpenAPIData(doc)
197+
oc := dc.OpenAPIV3()
198+
paths, err := oc.Paths()
178199
if err != nil {
179200
return nil, err
180201
}
202+
gvs := scheme.GroupVersions
181203

182-
parser, err := managedfields.NewGVKParser(models, false)
204+
parser, err := NewGVKParser(gvs, paths)
183205
if err != nil {
184-
return nil, err
206+
return nil, fmt.Errorf("cannot new gvk parser: %w", err)
185207
}
186208

187209
c, err := client.NewWithWatch(cfg, opts)
@@ -195,6 +217,45 @@ func New(cfg *rest.Config, opts client.Options) (Client, error) {
195217
}, nil
196218
}
197219

220+
func NewGVKParser(gvs []schema.GroupVersion, paths map[string]openapi.GroupVersion) (GVKParser, error) {
221+
parser := &gvkParser{
222+
parsers: map[schema.GroupVersion]GVKParser{},
223+
}
224+
for _, gv := range gvs {
225+
path := gvToAPIPath(gv)
226+
gvc, ok := paths[path]
227+
if !ok {
228+
return nil, fmt.Errorf("cannot find openapi doc of gv %v", gv.String())
229+
}
230+
if err := parser.addGroupVersion(gv, gvc); err != nil {
231+
return nil, err
232+
}
233+
}
234+
235+
return parser, nil
236+
}
237+
238+
func (p *gvkParser) addGroupVersion(gv schema.GroupVersion, gvc openapi.GroupVersion) error {
239+
bs, err := gvc.Schema(openapi.ContentTypeOpenAPIV3PB)
240+
if err != nil {
241+
return err
242+
}
243+
var doc openapi_v3.Document
244+
if err2 := proto.Unmarshal(bs, &doc); err2 != nil {
245+
return err2
246+
}
247+
models, err := forkedproto.NewOpenAPIV3Data(&doc)
248+
if err != nil {
249+
return err
250+
}
251+
parser, err := managedfields.NewGVKParser(models, false)
252+
if err != nil {
253+
return err
254+
}
255+
p.parsers[gv] = parser
256+
return nil
257+
}
258+
198259
func newObject(x client.Object) client.Object {
199260
if x == nil {
200261
return nil

pkg/scheme/scheme.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@
1515
package scheme
1616

1717
import (
18+
corev1 "k8s.io/api/core/v1"
19+
storagev1 "k8s.io/api/storage/v1"
20+
storagev1beta1 "k8s.io/api/storage/v1beta1"
1821
"k8s.io/apimachinery/pkg/runtime"
22+
"k8s.io/apimachinery/pkg/runtime/schema"
1923
"k8s.io/apimachinery/pkg/runtime/serializer"
2024
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
2125
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
@@ -34,3 +38,10 @@ func init() {
3438
utilruntime.Must(clientgoscheme.AddToScheme(Scheme))
3539
utilruntime.Must(v1alpha1.Install(Scheme))
3640
}
41+
42+
var GroupVersions = []schema.GroupVersion{
43+
corev1.SchemeGroupVersion,
44+
storagev1.SchemeGroupVersion,
45+
v1alpha1.SchemeGroupVersion,
46+
storagev1beta1.SchemeGroupVersion,
47+
}

third_party/kube-openapi/LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)