Skip to content
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

pkg/karmadactl/addons/init: unit test enable and disable addon operations #5771

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

pkg/karmadactl/addons/init: unit test enable and disable addon operations #5771

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
5 changes: 3 additions & 2 deletions pkg/karmadactl/addons/init/disable_option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package init

import (
"errors"
"fmt"

"k8s.io/client-go/kubernetes"
Expand Down Expand Up @@ -53,13 +54,13 @@ func (o *CommandAddonsDisableOption) Complete() error {

// Validate Check that there are enough conditions to run the disable.
func (o *CommandAddonsDisableOption) Validate(args []string) error {
err := validAddonNames(args)
err := validateAddonNames(args)
if err != nil {
return err
}

if slices.Contains(args, EstimatorResourceName) && o.Cluster == "" {
return fmt.Errorf("member cluster and config is needed when disable karmada-scheduler-estimator,use `--cluster=member --member-kubeconfig /root/.kube/config --member-context member1` to disable karmada-scheduler-estimator")
return errors.New("member cluster and config is needed when disable karmada-scheduler-estimator,use `--cluster=member --member-kubeconfig /root/.kube/config --member-context member1` to disable karmada-scheduler-estimator")
}
return nil
}
Expand Down
153 changes: 153 additions & 0 deletions pkg/karmadactl/addons/init/disable_option_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
/*
Copyright 2024 The Karmada 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 init

import (
"fmt"
"strings"
"testing"
)

func TestValidateDisableAddon(t *testing.T) {
clusterName, namespace := "test-cluster", "test"
tests := []struct {
name string
disableOpts *CommandAddonsDisableOption
validateArgs []string
prep func() error
wantErr bool
errMsg string
}{
{
name: "Validate_EmptyAddonNames_AddonNamesMustBeNotNull",
disableOpts: &CommandAddonsDisableOption{},
validateArgs: nil,
prep: func() error { return nil },
wantErr: true,
errMsg: "addonNames must be not be null",
},
{
name: "Validate_WithoutMemberClusterForKarmadaSchedulerEstimatorAddon_MemberClusterIsNeeded",
disableOpts: &CommandAddonsDisableOption{
GlobalCommandOptions: GlobalCommandOptions{
Namespace: namespace,
},
},
validateArgs: []string{EstimatorResourceName},
prep: func() error {
Addons["karmada-scheduler-estimator"] = &Addon{Name: EstimatorResourceName}
return nil
},
wantErr: true,
errMsg: "member cluster and config is needed when disable karmada-scheduler-estimator",
},
{
name: "Validate_WithMemberClusterForKarmadaSchedulerEstimatorAddon_Validated",
disableOpts: &CommandAddonsDisableOption{
GlobalCommandOptions: GlobalCommandOptions{
Namespace: namespace,
Cluster: clusterName,
},
},
validateArgs: []string{EstimatorResourceName},
prep: func() error {
Addons["karmada-scheduler-estimator"] = &Addon{Name: EstimatorResourceName}
return nil
},
wantErr: false,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
if err := test.prep(); err != nil {
t.Fatalf("failed to prep for validating disable addon, got an error: %v", err)
}
err := test.disableOpts.Validate(test.validateArgs)
if err == nil && test.wantErr {
t.Fatal("expected an error, but got none")
}
if err != nil && !test.wantErr {
t.Errorf("unexpected error, got: %v", err)
}
if err != nil && test.wantErr && !strings.Contains(err.Error(), test.errMsg) {
t.Errorf("expected error message %s to be in %s", test.errMsg, err.Error())
}
})
}
}

func TestRunDisableAddon(t *testing.T) {
tests := []struct {
name string
disableOpts *CommandAddonsDisableOption
validateArgs []string
prep func() error
wantErr bool
errMsg string
}{
{
name: "Run_DisableKarmadaDeschedulerAddon_FailedToDisableWithNetworkIssue",
disableOpts: &CommandAddonsDisableOption{
Force: true,
},
validateArgs: []string{DeschedulerResourceName},
prep: func() error {
Addons["karmada-descheduler"] = &Addon{
Name: string(DeschedulerResourceName),
Disable: func(*CommandAddonsDisableOption) error {
return fmt.Errorf("got network issue while disabling %s addon", DeschedulerResourceName)
},
}
return nil
},
wantErr: true,
errMsg: fmt.Sprintf("got network issue while disabling %s addon", DeschedulerResourceName),
},
{
name: "Run_DisableKarmadaDeschedulerAddon_Disabled",
disableOpts: &CommandAddonsDisableOption{
Force: true,
},
validateArgs: []string{DeschedulerResourceName},
prep: func() error {
Addons["karmada-descheduler"] = &Addon{
Name: string(DeschedulerResourceName),
Disable: func(*CommandAddonsDisableOption) error { return nil },
}
return nil
},
wantErr: false,
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
if err := test.prep(); err != nil {
t.Fatalf("failed to prep before disabling addon, got an error: %v", err)
}
err := test.disableOpts.Run(test.validateArgs)
if err == nil && test.wantErr {
t.Fatal("expected an error, but got none")
}
if err != nil && !test.wantErr {
t.Errorf("unexpected error, got: %v", err)
}
if err != nil && test.wantErr && !strings.Contains(err.Error(), test.errMsg) {
t.Errorf("expected error message %s to be in %s", test.errMsg, err.Error())
}
})
}
}
29 changes: 20 additions & 9 deletions pkg/karmadactl/addons/init/enable_option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ package init

import (
"context"
"errors"
"fmt"

apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"k8s.io/klog/v2"
"k8s.io/utils/strings/slices"

Expand Down Expand Up @@ -140,9 +142,17 @@ func (o *CommandAddonsEnableOption) Complete() error {
return nil
}

var validateMemberConfig = func(memberContext, memberKubeConfig string) (*rest.Config, error) {
return apiclient.RestConfig(memberContext, memberKubeConfig)
}

var memberKubeClientBuilder = func(memberCfg *rest.Config) kubernetes.Interface {
return kubernetes.NewForConfigOrDie(memberCfg)
}

// Validate Check that there are enough conditions to run addon enable.
func (o *CommandAddonsEnableOption) Validate(args []string) error {
err := validAddonNames(args)
err := validateAddonNames(args)
if err != nil {
return err
}
Expand All @@ -153,26 +163,27 @@ func (o *CommandAddonsEnableOption) Validate(args []string) error {
if apierrors.IsNotFound(err) {
return fmt.Errorf("secrets `kubeconfig` is not found in namespace %s, please execute karmadactl init to deploy karmada first", o.Namespace)
}
return err
}

if o.Cluster == "" {
if slices.Contains(args, EstimatorResourceName) {
return fmt.Errorf("member cluster is needed when enable karmada-scheduler-estimator,use `--cluster=member --member-kubeconfig /root/.kube/config --member-context member1` to enable karmada-scheduler-estimator")
return errors.New("member cluster is needed when enable karmada-scheduler-estimator,use `--cluster=member --member-kubeconfig /root/.kube/config --member-context member1` to enable karmada-scheduler-estimator")
}
} else {
if !slices.Contains(args, EstimatorResourceName) && !slices.Contains(args, "all") {
return fmt.Errorf("cluster is needed only when enable karmada-scheduler-estimator or enable all")
return errors.New("cluster is needed only when enable karmada-scheduler-estimator or enable all")
}
if o.MemberKubeConfig == "" {
return fmt.Errorf("member config is needed when enable karmada-scheduler-estimator,use `--cluster=member --member-kubeconfig /root/.kube/member.config --member-context member1` to enable karmada-scheduler-estimator")
return errors.New("member config is needed when enable karmada-scheduler-estimator,use `--cluster=member --member-kubeconfig /root/.kube/member.config --member-context member1` to enable karmada-scheduler-estimator")
}

// Check member kubeconfig and context is valid
memberConfig, err := apiclient.RestConfig(o.MemberContext, o.MemberKubeConfig)
memberConfig, err := validateMemberConfig(o.MemberContext, o.MemberKubeConfig)
if err != nil {
return fmt.Errorf("failed to get member cluster config. error: %v", err)
}
memberKubeClient := kubernetes.NewForConfigOrDie(memberConfig)
memberKubeClient := memberKubeClientBuilder(memberConfig)
_, err = memberKubeClient.CoreV1().Nodes().List(context.TODO(), metav1.ListOptions{})
if err != nil {
return fmt.Errorf("failed to get nodes from cluster %s with member-kubeconfig and member-context. error: %v, Please check the Role or ClusterRole of the serviceAccount in your member-kubeconfig", o.Cluster, err)
Expand Down Expand Up @@ -213,10 +224,10 @@ func (o *CommandAddonsEnableOption) Run(args []string) error {
return nil
}

// validAddonNames valid whether addon names is supported now
func validAddonNames(addonNames []string) error {
// validateAddonNames validate whether addon names is supported now
func validateAddonNames(addonNames []string) error {
if len(addonNames) == 0 {
return fmt.Errorf("addonNames must be not be null")
return errors.New("addonNames must be not be null")
}
for _, addonName := range addonNames {
if addonName == "all" {
Expand Down
Loading
Loading