Controller gen #5543

zbb88888 · 2025-08-01T09:46:12Z

Pull Request

Make sure you have followed Kube-OVN Code Style.

What type of this PR

Examples of user facing changes:

Features

Which issue(s) this PR fixes

Fixes #(issue-number)

Signed-off-by: zbb88888 <[email protected]>

gemini-code-assist

Summary of Changes

Hello @zbb88888, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've introduced changes primarily focused on improving the generation of Custom Resource Definitions (CRDs) for Kube-OVN. This involves adding a new script to automate CRD generation using controller-gen and making necessary adjustments to Go struct tags to ensure proper JSON serialization for the generated CRDs.

Highlights

CRD Generation Script: I've added a new shell script, hack/update-codegen-crd.sh, which automates the process of generating CRDs using controller-gen. This script ensures that the latest CRDs are always up-to-date with the Go API definitions.
Gitignore Update: I've updated the .gitignore file to include yamls/crds, preventing generated CRD files from being committed to the repository directly, as they will now be generated on demand.
API Struct Tagging: I've added json tags to embedded structs within ProviderNetworkCondition, NatOutgoingPolicyRuleStatus, and BigInt types. This ensures that controller-gen correctly processes these fields when generating CRDs, improving their serialization and deserialization.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a script to generate CRDs using controller-gen and updates several type definitions with JSON tags to support this. The changes are generally good, but I have a few suggestions to improve the new script's robustness and flexibility. I've also identified a potential issue with the JSON tag on the BigInt type which could lead to an incorrect CRD schema, and I've proposed a fix.

gemini-code-assist · 2025-08-01T09:48:11Z

pkg/internal/big_int.go


 type BigInt struct {
-	big.Int
+	big.Int `json:"bigInt"`


Adding a json tag to the embedded big.Int field might cause issues with CRD generation. The BigInt type has custom MarshalJSON and UnmarshalJSON methods that serialize it to a JSON string. However, controller-gen might interpret this json:"bigInt" tag to mean that the serialized form is an object with a bigInt field, leading to an incorrect OpenAPI schema for the CRD. This will cause schema validation failures for clients.

The recommended way to handle types with custom JSON marshalling is to use // +kubebuilder:validation:Type=string on the fields of type BigInt within your CRD structs (e.g., in IPPoolStatus). This tells controller-gen to treat it as a string in the schema, which matches the behavior of your custom marshaller.

Please remove this tag and apply the +kubebuilder marker on the relevant fields in the CRD definitions.

Suggested change

big.Int `json:"bigInt"`

big.Int

root@debian:~/f/kube-ovn controller-gen ✔ 3m ⍉
▶ bash ./hack/update-codegen-crd.sh

export GOPROXY=https://goproxy.cn

GOPROXY=https://goproxy.cn

CONTROLLER_TOOLS_VERSION=v0.17.3

go install sigs.k8s.io/controller-tools/cmd/[email protected]

go mod tidy

controller-gen crd:allowDangerousTypes=true paths=./pkg/apis/kubeovn/v1 output:crd:artifacts:config=./yamls/crds
/root/f/kube-ovn/pkg/internal/big_int.go:9:2: encountered struct field "" without JSON tag in type "BigInt"
github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
github.com/kubeovn/kube-ovn/pkg/apis/kubeovn/v1:-: conflicting types in allOf branches in schema: object vs string
Error: not all generators ran successfully

hack/update-codegen-crd.sh

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Signed-off-by: zbb88888 <[email protected]>

coveralls · 2025-08-01T10:32:23Z

Pull Request Test Coverage Report for Build 19527788804

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

66 of 123 (53.66%) changed or added relevant lines in 9 files are covered.
2 unchanged lines in 1 file lost coverage.
Overall coverage increased (+0.08%) to 21.99%

Changes Missing Coverage	Changed/Added Lines	%
pkg/webhook/subnet.go	2	0.0%
pkg/controller/pod.go	3	0.0%
pkg/controller/exporter.go	5	0.0%
pkg/controller/subnet.go	47	0.0%

Files with Coverage Reduction	New Missed Lines	%
pkg/controller/subnet.go	2	6.9%

Totals
Change from base Build 19453678196:	0.08%
Covered Lines:	11187
Relevant Lines:	50873

💛 - Coveralls

github-actions · 2025-10-01T00:00:44Z

PRs go stale after 60d of inactivity. Please comment or re-open the PR if you are still working on this PR.

Signed-off-by: zbb88888 <[email protected]>

zbb88888 · 2025-11-19T03:15:30Z

#5919

Signed-off-by: zbb88888 <[email protected]>

问题根源： controller-gen 分支引入 BigInt 类型替换 int64 用于 IP 地址计数，但 MarshalJSON 实现返回裸数字而非带引号的字符串，与 CRD schema (+kubebuilder:validation:Type=string) 不匹配，导致 K8s API server 在 patch/create 操作时拒绝请求。修复内容： 1. BigInt.MarshalJSON: 输出带引号的 JSON 字符串 ("123" 而非 123) 2. BigInt.UnmarshalJSON: 兼容处理带引号和裸数字格式（向后兼容） 3. BigInt.DeepCopyInto: 修复错误实现 (FillBytes -> Int.Set) 测试覆盖： - pkg/types/big_int_test.go: 完整的 BigInt 单元测试 * JSON 序列化/反序列化（包含边界情况） * 算术运算 (Add/Sub) * 比较操作 (Cmp/Equal/EqualInt64) * DeepCopy 语义正确性 * 结构体嵌入场景 - pkg/apis/kubeovn/v1/subnet_bigint_test.go: SubnetStatus 集成测试 * 验证 Subnet CRD 对象的 JSON 序列化符合 K8s API 规范 * 模拟 patch 操作确保字段类型正确（string 而非 number）影响范围：修复 E2E 测试失败： [group:subnet] should support subnet add nat outgoing policy rules 所有 BigInt 类型字段现在正确序列化为符合 CRD schema 的 JSON 字符串，确保与 K8s API server 的兼容性。 Signed-off-by: zbb88888 <[email protected]>

验证 BigInt 类型在真实 Kubernetes API Server 交互中的正确性：测试覆盖： 1. 创建 Subnet 后 BigInt 字段正确填充 2. JSON 序列化格式验证（字符串而非数字） 3. K8s API patch 操作成功（验证不会因类型不匹配被拒绝） 4. 状态字段直接更新（关键：通过 API 更新 BigInt 字段） 5. 大数值往返序列化（/16 subnet = 65533 IPs）关键验证点： - 确保 BigInt.MarshalJSON 返回 "253" 而非 253 - 确保符合 CRD schema type:string 要求 - 防止 API server 因类型校验失败拒绝 patch 补充单元测试未覆盖的 K8s API 层面交互。 Signed-off-by: zbb88888 <[email protected]>

修复 golangci-lint 错误： test/e2e/kube-ovn/subnet/subnet_bigint_e2e_test.go:123:3: declared and not used: currentSubnet (typecheck) 变量 currentSubnet 仅用于验证 subnet 存在，实际不需要使用其返回值。直接移除该变量声明，测试逻辑不受影响。 Signed-off-by: zbb88888 <[email protected]>

修复4个 lint 问题： 1. goimports: 调整 import 顺序，将标准库、k8s 包和本地包分组 pkg/apis/kubeovn/v1/subnet_bigint_test.go 2. gofumpt: 函数参数格式化 checkStringField := func(name, expected string) 3. revive: 移除 min 函数定义，使用 Go 1.21+ 内置 min 函数 (Go 1.21 及以上版本内置了 min/max 函数) 4. staticcheck QF1008: 简化 DeepCopyInto 选择器 n.Set(&b.Int) 替代 n.Int.Set(&b.Int) (嵌入字段可以直接访问方法) 所有单元测试通过验证。 Signed-off-by: zbb88888 <[email protected]>

- 修复 golangci-lint modernize 检查 - 在 subnet_bigint_test.go 中替换 3 处 interface{} - 在 subnet_bigint_e2e_test.go 中替换 4 处 interface{} - 保持测试逻辑不变 Signed-off-by: zbb88888 <[email protected]>

Signed-off-by: zbb88888 <[email protected]>

zbb88888 added 2 commits August 1, 2025 17:43

support crd gen

df5d028

Signed-off-by: zbb88888 <[email protected]>

ignore temp crds for now

bb2f640

Signed-off-by: zbb88888 <[email protected]>

gemini-code-assist bot reviewed Aug 1, 2025

View reviewed changes

zbb88888 and others added 2 commits August 1, 2025 17:52

Update hack/update-codegen-crd.sh

41ddcf7

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

fix as gemini, but err

817a16f

Signed-off-by: zbb88888 <[email protected]>

github-actions bot added the no-pr-activity label Oct 1, 2025

github-actions bot closed this Oct 8, 2025

zbb88888 reopened this Oct 9, 2025

github-actions bot removed the no-pr-activity label Oct 10, 2025

zbb88888 added 3 commits November 18, 2025 22:49

fix big int json and upgrade controller-gen version

19e90d7

Signed-off-by: zbb88888 <[email protected]>

subnet status use big int

93ddef5

Signed-off-by: zbb88888 <[email protected]>

Merge branch 'master' into controller-gen

899d4df

zbb88888 added 2 commits November 19, 2025 11:41

fix(subnet): correct IP availability check by using big.Int addition

dfb5f71

fix lint

b6d2b5a

Signed-off-by: zbb88888 <[email protected]>

zbb88888 marked this pull request as ready for review November 19, 2025 05:03

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. go Pull requests that update Go code labels Nov 19, 2025

zbb88888 added 4 commits November 19, 2025 23:46

fix e2e

388d650

Signed-off-by: zbb88888 <[email protected]>

fix ut

6f10d09

Signed-off-by: zbb88888 <[email protected]>

fix lint

18683f2

Signed-off-by: zbb88888 <[email protected]>

dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Nov 20, 2025

dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Nov 20, 2025

zbb88888 added 5 commits November 20, 2025 11:51

fix: 使用 any 替换 interface{} (Go 1.18+)

6b78d85

- 修复 golangci-lint modernize 检查 - 在 subnet_bigint_test.go 中替换 3 处 interface{} - 在 subnet_bigint_e2e_test.go 中替换 4 处 interface{} - 保持测试逻辑不变 Signed-off-by: zbb88888 <[email protected]>

fix: 使用 any 替换 interface{} (Go 1.18+)

5bc4386

- 修复 golangci-lint modernize 检查 - 在 subnet_bigint_test.go 中替换 3 处 interface{} - 在 subnet_bigint_e2e_test.go 中替换 4 处 interface{} - 保持测试逻辑不变 Signed-off-by: zbb88888 <[email protected]>

ignore pinger

d8754a7

Signed-off-by: zbb88888 <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Controller gen #5543

Controller gen #5543

Uh oh!

zbb88888 commented Aug 1, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Aug 1, 2025

Uh oh!

zbb88888 Aug 1, 2025

Uh oh!

Uh oh!

Uh oh!

coveralls commented Aug 1, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Oct 1, 2025

Uh oh!

zbb88888 commented Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Controller gen #5543

Are you sure you want to change the base?

Controller gen #5543

Uh oh!

Conversation

zbb88888 commented Aug 1, 2025

Pull Request

What type of this PR

Which issue(s) this PR fixes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

zbb88888 Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coveralls commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 19527788804

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Uh oh!

github-actions bot commented Oct 1, 2025

Uh oh!

zbb88888 commented Nov 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coveralls commented Aug 1, 2025 •

edited

Loading