Skip to content

Conversation

eofff
Copy link
Contributor

@eofff eofff commented Oct 10, 2025

Description

Why do we need it, and what problem does it solve?

What is the expected result?

Checklist

  • The code is covered by unit tests.
  • e2e tests passed.
  • Documentation updated according to the changes.
  • Changes were tested in the Kubernetes cluster manually.

Changelog entries

section:
type:
summary:

Copy link
Contributor

sourcery-ai bot commented Oct 10, 2025

Reviewer's Guide

This PR introduces a StorageClassMatchValidator for both VirtualDisk and VirtualImage webhooks, adding logic to fetch the default storage class and ensure that PVC-based resources created via object references share matching storage classes, and it integrates this validator into the respective webhook controllers.

Sequence diagram for storage class validation when creating VirtualDisk from VirtualImage

sequenceDiagram
    participant VDWebhook
    participant StorageClassMatchValidator
    participant K8sClient
    participant VirtualImage
    VDWebhook->>StorageClassMatchValidator: ValidateCreate(ctx, vd)
    StorageClassMatchValidator->>K8sClient: Fetch VirtualImage by ObjectRef
    K8sClient-->>StorageClassMatchValidator: VirtualImage object
    StorageClassMatchValidator->>StorageClassMatchValidator: Compare storage classes (VD vs VI)
    StorageClassMatchValidator-->>VDWebhook: Return error if mismatch
Loading

Class diagram for StorageClassMatchValidator and integration with webhook validators

classDiagram
    class StorageClassMatchValidator {
        +client: Client
        +scService: VirtualDiskStorageClassService | VirtualImageStorageClassService
        +ValidateCreate(ctx, obj): (Warnings, error)
        +ValidateUpdate(ctx, oldObj, newObj): (Warnings, error)
        +Validate(ctx, obj): (Warnings, error)
    }
    class VirtualDiskValidator {
        +validators: []Validator
    }
    class VirtualImageValidator {
        +logger: Logger
        +client: Client
        +scService: VirtualImageStorageClassService
        +storageClassMatchValidator: StorageClassMatchValidator
    }
    StorageClassMatchValidator <|-- VirtualDiskValidator : used by
    StorageClassMatchValidator <|-- VirtualImageValidator : used by
    VirtualDiskValidator o-- StorageClassMatchValidator
    VirtualImageValidator o-- StorageClassMatchValidator
Loading

File-Level Changes

Change Details Files
Add StorageClassMatchValidator implementations for VirtualDisk and VirtualImage
  • Create storage_class_match_validator.go under vd/internal/validator
  • Create storage_class_match_validator.go under vi/internal/validator
  • Implement ValidateCreate, ValidateUpdate, and shared Validate logic
  • Fetch related object, retrieve default storage class, and compare storage class names
images/virtualization-artifact/pkg/controller/vd/internal/validator/storage_class_match_validator.go
images/virtualization-artifact/pkg/controller/vi/internal/validator/storage_class_match_validator.go
Register StorageClassMatchValidator in VirtualDisk webhook
  • Add validator.NewStorageClassMatchValidator to the validator list in NewValidator
images/virtualization-artifact/pkg/controller/vd/vd_webhook.go
Invoke StorageClassMatchValidator in VirtualImage webhook
  • Add storageClassMatchValidator field to Validator struct
  • Initialize storageClassMatchValidator in NewValidator
  • Call ValidateCreate on storageClassMatchValidator after existing checks
  • Import the new validator package
images/virtualization-artifact/pkg/controller/vi/vi_webhook.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

add
Signed-off-by: Valeriy Khorunzhin <[email protected]>
@eofff eofff force-pushed the feat/api/validate-sc-for-vi-from-vd-and-vd-from-vi branch from 178252d to 1d83ca0 Compare October 10, 2025 13:39
@eofff eofff added the e2e/run Run e2e test on cluster of PR author label Oct 10, 2025
@deckhouse-BOaTswain
Copy link
Contributor

Workflow has started.
Follow the progress here: Workflow Run

@eofff eofff removed the e2e/run Run e2e test on cluster of PR author label Oct 10, 2025
Signed-off-by: Valeriy Khorunzhin <[email protected]>
@eofff eofff added the e2e/run Run e2e test on cluster of PR author label Oct 10, 2025
@deckhouse-BOaTswain
Copy link
Contributor

deckhouse-BOaTswain commented Oct 10, 2025

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

@deckhouse-BOaTswain deckhouse-BOaTswain removed the e2e/run Run e2e test on cluster of PR author label Oct 10, 2025
@Isteb4k Isteb4k added this to the v1.1.1 milestone Oct 14, 2025
@nevermarine nevermarine modified the milestones: v1.1.1, v1.2.0 Oct 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants