Skip to content

test(writer): Added unit test for cert_writer_test.go#5649

Open
yuvraj-kolkar17 wants to merge 5 commits intofluid-cloudnative:masterfrom
yuvraj-kolkar17:test/webhook-certwriter-test
Open

test(writer): Added unit test for cert_writer_test.go#5649
yuvraj-kolkar17 wants to merge 5 commits intofluid-cloudnative:masterfrom
yuvraj-kolkar17:test/webhook-certwriter-test

Conversation

@yuvraj-kolkar17
Copy link
Contributor

PR Description

Ⅰ. Describe what this PR does

This PR adds comprehensive unit tests for certwriter.go using Ginkgo/Gomega testing framework, providing full code coverage for certificate validation and management logic.

Ⅱ. Does this pull request fix one issue?

part of #5407

Ⅲ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.

Added Unit Tests for CertWriter Package:

  1. handleCommon function tests (7 test cases):

    • Input validation (empty dnsName, nil certReadWriter)
    • Certificate creation when certificates don't exist
    • Handling race conditions (AlreadyExists error)
    • Certificate regeneration when invalid
    • Error handling during overwrite
    • Returning existing valid certificates without changes
  2. createIfNotExists function tests (5 test cases):

    • Returning existing certificates
    • Creating new certificates when not found
    • Handling race conditions with AlreadyExists
    • Propagating read errors
    • Propagating write errors
  3. validCert function tests (10 test cases):

    • Nil artifacts and missing field validation
    • Invalid key-cert pair detection
    • Invalid CA certificate PEM handling
    • Invalid certificate PEM format handling
    • Valid certificate verification
    • Expiring certificates detection (within 6 months)
    • DNS name mismatch validation

Total: 22 comprehensive test cases

Ⅳ. Describe how to verify it

Run the tests:

cd pkg/utils/webhook/writer
ginkgo -v --cover --coverprofile=coverage.out

Expected Results:

  • All 22 tests pass successfully
  • High code coverage (80%+ for certwriter.go)
  • Clear BDD-style test output with detailed descriptions
test results

Ⅴ. Special notes for reviews

Signed-off-by: Yuvraj Kolkar <kolkaryuvraj2@gmail.com>
@fluid-e2e-bot
Copy link

fluid-e2e-bot bot commented Jan 31, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign ronggu for approval by writing /assign @ronggu in a comment. For more information see:The Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @yuvraj-kolkar17, I'm Gemini Code Assist1! 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!

This pull request significantly enhances the robustness and reliability of the certificate management logic by introducing a comprehensive suite of unit tests. These tests validate various aspects of certificate handling, including creation, validation, and error scenarios, ensuring that the system correctly manages webhook certificates under diverse conditions.

Highlights

  • Comprehensive Unit Tests for certwriter.go: Added a new test file certwriter_test.go containing 22 unit test cases using the Ginkgo/Gomega framework to ensure full code coverage for certificate validation and management logic.
  • handleCommon Function Testing: Seven test cases were added for the handleCommon function, covering input validation (empty DNS name, nil reader/writer), certificate creation when not found, handling race conditions with AlreadyExists errors, regeneration of invalid certificates, error handling during overwrite operations, and correctly returning existing valid certificates.
  • createIfNotExists Function Testing: Five test cases were introduced for the createIfNotExists function, verifying its behavior when certificates already exist, when new certificates need to be created, handling race conditions during creation, and propagating various read and write errors.
  • validCert Function Testing: Ten test cases were implemented for the validCert function, covering scenarios such as nil or incomplete certificate artifacts, malformed certificates (invalid key-cert pairs, invalid CA PEM, invalid cert PEM format), successful validation of valid certificates, detection of certificates expiring within 6 months, and validation of DNS name mismatches.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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.

Footnotes

  1. 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.

@fluid-e2e-bot
Copy link

fluid-e2e-bot bot commented Jan 31, 2026

Hi @yuvraj-kolkar17. Thanks for your PR.

I'm waiting for a fluid-cloudnative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a comprehensive set of unit tests for certwriter.go, significantly improving code coverage and confidence in the certificate management logic. The tests are well-structured using Ginkgo/Gomega and cover a wide range of scenarios, including input validation, certificate creation, race conditions, and validation logic. I've included one suggestion to refactor some of the test helper functions to reduce code duplication. Overall, this is a great addition to the project.

@codecov
Copy link

codecov bot commented Jan 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.48%. Comparing base (ef245fc) to head (68860a7).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5649      +/-   ##
==========================================
+ Coverage   59.23%   59.48%   +0.25%     
==========================================
  Files         444      444              
  Lines       30540    30540              
==========================================
+ Hits        18089    18167      +78     
+ Misses      10952    10869      -83     
- Partials     1499     1504       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Yuvraj Kolkar <kolkaryuvraj2@gmail.com>
@yuvraj-kolkar17
Copy link
Contributor Author

/gemini review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a comprehensive suite of unit tests for certwriter.go, significantly improving code coverage and confidence in the certificate management logic. The tests are well-structured using Ginkgo and cover a wide range of scenarios, including input validation, certificate creation, race conditions, and validation logic. I've provided a few suggestions to enhance the maintainability and style of the new test code, primarily focusing on reducing code duplication in test helpers and improving the flexibility of the mock implementation.

Signed-off-by: Yuvraj Kolkar <kolkaryuvraj2@gmail.com>
Signed-off-by: Yuvraj Kolkar <kolkaryuvraj2@gmail.com>
Signed-off-by: Yuvraj Kolkar <kolkaryuvraj2@gmail.com>
@sonarqubecloud
Copy link

@yuvraj-kolkar17
Copy link
Contributor Author

/cc @cheyang @RongGu @TrafalgarZZZ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant