Skip to content

Move wehbooks out of api directory to seperate directory #2296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 7, 2025
Merged

Move wehbooks out of api directory to seperate directory #2296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ COPY controllers/ controllers/
COPY cloud/ cloud/
COPY pkg/ pkg/
COPY util/ util/
COPY internal/ internal/

# Build
ARG TARGETOS
Expand Down
2 changes: 1 addition & 1 deletion cloud/scope/powervs_machine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ func (m *PowerVSMachineScope) CreateVPCLoadBalancerPoolMember() (*vpcv1.LoadBala
ID: loadBalancer.ID,
})
if err != nil {
return nil, fmt.Errorf("failed to fetch VPC load balancer details with ID: %s error: %v", *loadBalancer.ID, err)
return nil, fmt.Errorf("failed to fetch VPC load balancer details with ID: %s error: %v", *lbID, err)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Uncovered a bug while testing so fixed it here as its a small change. Unrelated to this PR

This line was causing a panic when we fail to fetch a loadbalancer with the ID as loadBalancer will be nil when.

}
if *loadBalancer.ProvisioningStatus != string(infrav1beta2.VPCLoadBalancerStateActive) {
m.V(3).Info("Unable to update pool for VPC load balancer as it is not in active state", "loadbalancer", *loadBalancer.Name, "state", *loadBalancer.ProvisioningStatus)
Expand Down
18 changes: 9 additions & 9 deletions cloud/scope/suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
ctrl "sigs.k8s.io/controller-runtime"

infrav1beta2 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
"sigs.k8s.io/cluster-api-provider-ibmcloud/internal/webhooks"
"sigs.k8s.io/cluster-api-provider-ibmcloud/test/helpers"
)

Expand Down Expand Up @@ -56,32 +57,31 @@ func setup() {
if err != nil {
panic(err)
}
if err := (&infrav1beta2.IBMPowerVSCluster{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSCluster{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSCluster webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSMachine{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSMachine{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSMachine webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSMachineTemplate webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSImage{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSImage{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSImage webhook: %v", err))
}
if err := (&infrav1beta2.IBMVPCCluster{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMVPCCluster{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMVPCCluster webhook: %v", err))
}
if err := (&infrav1beta2.IBMVPCMachine{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMVPCMachine{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMVPCMachine webhook: %v", err))
}
if err := (&infrav1beta2.IBMVPCMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMVPCMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMVPCMachineTemplate webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSClusterTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSClusterTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSClusterTemplate webhook: %v", err))
}
go func() {
fmt.Println("Starting the manager")
if err := testEnv.StartManager(ctx); err != nil {
panic(fmt.Sprintf("Failed to start the envtest manager: %v", err))
}
Expand Down
18 changes: 9 additions & 9 deletions controllers/suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (

// +kubebuilder:scaffold:imports
infrav1beta2 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
"sigs.k8s.io/cluster-api-provider-ibmcloud/internal/webhooks"
"sigs.k8s.io/cluster-api-provider-ibmcloud/test/helpers"
capiv1beta1 "sigs.k8s.io/cluster-api/api/v1beta1"
)
Expand Down Expand Up @@ -57,32 +58,31 @@ func setup() {
if err != nil {
panic(err)
}
if err := (&infrav1beta2.IBMPowerVSCluster{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSCluster{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSCluster webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSMachine{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSMachine{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSMachine webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSMachineTemplate webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSImage{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSImage{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSImage webhook: %v", err))
}
if err := (&infrav1beta2.IBMVPCCluster{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMVPCCluster{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMVPCCluster webhook: %v", err))
}
if err := (&infrav1beta2.IBMVPCMachine{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMVPCMachine{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMVPCMachine webhook: %v", err))
}
if err := (&infrav1beta2.IBMVPCMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMVPCMachineTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMVPCMachineTemplate webhook: %v", err))
}
if err := (&infrav1beta2.IBMPowerVSClusterTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
if err := (&webhooks.IBMPowerVSClusterTemplate{}).SetupWebhookWithManager(testEnv); err != nil {
panic(fmt.Sprintf("Unable to setup IBMPowerVSClusterTemplate webhook: %v", err))
}
go func() {
fmt.Println("Starting the manager")
if err := testEnv.StartManager(ctx); err != nil {
panic(fmt.Sprintf("Failed to start the envtest manager: %v", err))
}
Expand Down
16 changes: 9 additions & 7 deletions api/v1beta2/common.go → internal/webhooks/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,18 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta2
package webhooks

import (
"strconv"

"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/validation/field"

infrav1beta2 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
)

func defaultIBMPowerVSMachineSpec(spec *IBMPowerVSMachineSpec) {
func defaultIBMPowerVSMachineSpec(spec *infrav1beta2.IBMPowerVSMachineSpec) {
if spec.MemoryGiB == 0 {
spec.MemoryGiB = 2
}
Expand All @@ -34,18 +36,18 @@ func defaultIBMPowerVSMachineSpec(spec *IBMPowerVSMachineSpec) {
spec.SystemType = "s922"
}
if spec.ProcessorType == "" {
spec.ProcessorType = PowerVSProcessorTypeShared
spec.ProcessorType = infrav1beta2.PowerVSProcessorTypeShared
}
}

func validateIBMPowerVSResourceReference(res IBMPowerVSResourceReference, resType string) (bool, *field.Error) {
func validateIBMPowerVSResourceReference(res infrav1beta2.IBMPowerVSResourceReference, resType string) (bool, *field.Error) {
if res.ID != nil && res.Name != nil {
return false, field.Invalid(field.NewPath("spec", resType), res, "Only one of "+resType+" - ID or Name may be specified")
}
return true, nil
}

func validateIBMPowerVSNetworkReference(res IBMPowerVSResourceReference) (bool, *field.Error) {
func validateIBMPowerVSNetworkReference(res infrav1beta2.IBMPowerVSResourceReference) (bool, *field.Error) {
if (res.ID != nil && res.Name != nil) || (res.ID != nil && res.RegEx != nil) || (res.Name != nil && res.RegEx != nil) {
return false, field.Invalid(field.NewPath("spec", "Network"), res, "Only one of Network - ID, Name or RegEx can be specified")
}
Expand Down Expand Up @@ -74,13 +76,13 @@ func validateIBMPowerVSProcessorValues(resValue intstr.IntOrString) bool {
return true
}

func defaultIBMVPCMachineSpec(spec *IBMVPCMachineSpec) {
func defaultIBMVPCMachineSpec(spec *infrav1beta2.IBMVPCMachineSpec) {
if spec.Profile == "" {
spec.Profile = "bx2-2x8"
}
}

func validateBootVolume(spec IBMVPCMachineSpec) field.ErrorList {
func validateBootVolume(spec infrav1beta2.IBMVPCMachineSpec) field.ErrorList {
var allErrs field.ErrorList

if spec.BootVolume == nil {
Expand Down
28 changes: 15 additions & 13 deletions api/v1beta2/common_test.go → internal/webhooks/common_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

package v1beta2
package webhooks

import (
"testing"

"k8s.io/apimachinery/pkg/util/intstr"

infrav1beta2 "sigs.k8s.io/cluster-api-provider-ibmcloud/api/v1beta2"
)

func TestValidateIBMPowerVSMemoryValues(t *testing.T) {
Expand Down Expand Up @@ -113,48 +115,48 @@ func TestValidateIBMPowerVSProcessorValues(t *testing.T) {
func Test_validateBootVolume(t *testing.T) {
tests := []struct {
name string
spec IBMVPCMachineSpec
spec infrav1beta2.IBMVPCMachineSpec
wantError bool
}{
{
name: "Nil bootvolume",
spec: IBMVPCMachineSpec{
spec: infrav1beta2.IBMVPCMachineSpec{
BootVolume: nil,
},
wantError: false,
},
{
name: "valid sizeGiB",
spec: IBMVPCMachineSpec{
BootVolume: &VPCVolume{SizeGiB: 20},
spec: infrav1beta2.IBMVPCMachineSpec{
BootVolume: &infrav1beta2.VPCVolume{SizeGiB: 20},
},
wantError: false,
},
{
name: "Invalid sizeGiB",
spec: IBMVPCMachineSpec{
BootVolume: &VPCVolume{SizeGiB: 1},
spec: infrav1beta2.IBMVPCMachineSpec{
BootVolume: &infrav1beta2.VPCVolume{SizeGiB: 1},
},
wantError: true,
},
{
name: "Valid Iops",
spec: IBMVPCMachineSpec{
BootVolume: &VPCVolume{Iops: 1000, Profile: "custom"},
spec: infrav1beta2.IBMVPCMachineSpec{
BootVolume: &infrav1beta2.VPCVolume{Iops: 1000, Profile: "custom"},
},
wantError: true,
},
{
name: "Invalid Iops",
spec: IBMVPCMachineSpec{
BootVolume: &VPCVolume{Iops: 1234, Profile: "general-purpose"},
spec: infrav1beta2.IBMVPCMachineSpec{
BootVolume: &infrav1beta2.VPCVolume{Iops: 1234, Profile: "general-purpose"},
},
wantError: true,
},
{
name: "Missing Iops for custom profile",
spec: IBMVPCMachineSpec{
BootVolume: &VPCVolume{Profile: "general-purpose"},
spec: infrav1beta2.IBMVPCMachineSpec{
BootVolume: &infrav1beta2.VPCVolume{Profile: "general-purpose"},
},
wantError: true,
},
Expand Down
18 changes: 18 additions & 0 deletions internal/webhooks/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
Copyright 2025 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// Package webhooks contains external webhook implementations for some of our API types.
package webhooks
Loading