15660492627

Committed 15 Jun 2025 06:44AM UTC coverage: 59.438% (-0.05%) from 59.486%

Build # 15660492627

Build Type

Pull #3140

github

Committed by

andyzhangx

Commit Message

test: fix golint errors

Pull Request Pull Request #3140: [release-1.30] test: fix golint errors

Run Details

6 of 6 new or added lines in 2 files covered. (100.0%)

3 existing lines in 1 file now uncovered.

3725 of 6267 relevant lines covered (59.44%)

5.34 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

65.73

/pkg/azuredisk/azuredisk.go

/*
Copyright 2017 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 azuredisk

import (
        "context"
        "encoding/json"
        "errors"
        "fmt"
        "reflect"
        "strconv"
        "strings"
        "time"

        "github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/compute/armcompute/v5"
        "github.com/container-storage-interface/spec/lib/go/csi"
        "go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"

        "google.golang.org/grpc"
        "google.golang.org/grpc/codes"
        "google.golang.org/grpc/status"

        corev1 "k8s.io/api/core/v1"
        metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
        "k8s.io/apimachinery/pkg/types"
        k8stypes "k8s.io/apimachinery/pkg/types"
        "k8s.io/apimachinery/pkg/util/wait"
        "k8s.io/client-go/kubernetes"
        clientset "k8s.io/client-go/kubernetes"
        "k8s.io/klog/v2"
        "k8s.io/kubernetes/pkg/volume/util/hostutil"
        "k8s.io/mount-utils"
        "k8s.io/utils/pointer"

        consts "sigs.k8s.io/azuredisk-csi-driver/pkg/azureconstants"
        "sigs.k8s.io/azuredisk-csi-driver/pkg/azureutils"
        csicommon "sigs.k8s.io/azuredisk-csi-driver/pkg/csi-common"
        "sigs.k8s.io/azuredisk-csi-driver/pkg/mounter"
        "sigs.k8s.io/azuredisk-csi-driver/pkg/optimization"
        volumehelper "sigs.k8s.io/azuredisk-csi-driver/pkg/util"
        "sigs.k8s.io/cloud-provider-azure/pkg/azclient"
        azcache "sigs.k8s.io/cloud-provider-azure/pkg/cache"
        azurecloudconsts "sigs.k8s.io/cloud-provider-azure/pkg/consts"
        azure "sigs.k8s.io/cloud-provider-azure/pkg/provider"
)

var (
        // taintRemovalInitialDelay is the initial delay for node taint removal
        taintRemovalInitialDelay = 1 * time.Second
        // taintRemovalBackoff is the exponential backoff configuration for node taint removal
        taintRemovalBackoff = wait.Backoff{
                Duration: 500 * time.Millisecond,
                Factor:   2,
                Steps:    10, // Max delay = 0.5 * 2^9 = ~4 minutes
        }
)

// CSIDriver defines the interface for a CSI driver.
type CSIDriver interface {
        csi.ControllerServer
        csi.NodeServer
        csi.IdentityServer

        Run(ctx context.Context) error
}

type hostUtil interface {
        PathIsDevice(string) (bool, error)
}

// DriverCore contains fields common to both the V1 and V2 driver, and implements all interfaces of CSI drivers
type DriverCore struct {
        csicommon.CSIDriver
        perfOptimizationEnabled      bool
        cloudConfigSecretName        string
        cloudConfigSecretNamespace   string
        customUserAgent              string
        userAgentSuffix              string
        cloud                        *azure.Cloud
        clientFactory                azclient.ClientFactory
        diskController               *ManagedDiskController
        mounter                      *mount.SafeFormatAndMount
        deviceHelper                 optimization.Interface
        nodeInfo                     *optimization.NodeInfo
        ioHandler                    azureutils.IOHandler
        hostUtil                     hostUtil
        useCSIProxyGAInterface       bool
        enableDiskOnlineResize       bool
        allowEmptyCloudConfig        bool
        enableListVolumes            bool
        enableListSnapshots          bool
        supportZone                  bool
        getNodeInfoFromLabels        bool
        enableDiskCapacityCheck      bool
        disableUpdateCache           bool
        enableTrafficManager         bool
        trafficManagerPort           int64
        vmssCacheTTLInSeconds        int64
        volStatsCacheExpireInMinutes int64
        attachDetachInitialDelayInMs int64
        getDiskTimeoutInSeconds      int64
        vmType                       string
        enableWindowsHostProcess     bool
        getNodeIDFromIMDS            bool
        enableOtelTracing            bool
        shouldWaitForSnapshotReady   bool
        checkDiskLUNCollision        bool
        checkDiskCountForBatching    bool
        forceDetachBackoff           bool
        waitForDetach                bool
        endpoint                     string
        disableAVSetNodes            bool
        removeNotReadyTaint          bool
        kubeClient                   kubernetes.Interface
        // a timed cache storing volume stats <volumeID, volumeStats>
        volStatsCache           azcache.Resource
        maxConcurrentFormat     int64
        concurrentFormatTimeout int64
}

// Driver is the v1 implementation of the Azure Disk CSI Driver.
type Driver struct {
        DriverCore
        volumeLocks *volumehelper.VolumeLocks
        // a timed cache for throttling
        throttlingCache azcache.Resource
        // a timed cache for disk lun collision check throttling
        checkDiskLunThrottlingCache azcache.Resource
}

// newDriverV1 Creates a NewCSIDriver object. Assumes vendor version is equal to driver version &
// does not support optional driver plugin info manifest field. Refer to CSI spec for more details.
func newDriverV1(options *DriverOptions) *Driver {
        driver := Driver{}
        driver.Name = options.DriverName
        driver.Version = driverVersion
        driver.NodeID = options.NodeID
        driver.VolumeAttachLimit = options.VolumeAttachLimit
        driver.ReservedDataDiskSlotNum = options.ReservedDataDiskSlotNum
        driver.perfOptimizationEnabled = options.EnablePerfOptimization
        driver.cloudConfigSecretName = options.CloudConfigSecretName
        driver.cloudConfigSecretNamespace = options.CloudConfigSecretNamespace
        driver.customUserAgent = options.CustomUserAgent
        driver.userAgentSuffix = options.UserAgentSuffix
        driver.useCSIProxyGAInterface = options.UseCSIProxyGAInterface
        driver.enableDiskOnlineResize = options.EnableDiskOnlineResize
        driver.allowEmptyCloudConfig = options.AllowEmptyCloudConfig
        driver.enableListVolumes = options.EnableListVolumes
        driver.enableListSnapshots = options.EnableListVolumes
        driver.supportZone = options.SupportZone
        driver.getNodeInfoFromLabels = options.GetNodeInfoFromLabels
        driver.enableDiskCapacityCheck = options.EnableDiskCapacityCheck
        driver.disableUpdateCache = options.DisableUpdateCache
        driver.attachDetachInitialDelayInMs = options.AttachDetachInitialDelayInMs
        driver.enableTrafficManager = options.EnableTrafficManager
        driver.trafficManagerPort = options.TrafficManagerPort
        driver.vmssCacheTTLInSeconds = options.VMSSCacheTTLInSeconds
        driver.volStatsCacheExpireInMinutes = options.VolStatsCacheExpireInMinutes
        driver.getDiskTimeoutInSeconds = options.GetDiskTimeoutInSeconds
        driver.vmType = options.VMType
        driver.enableWindowsHostProcess = options.EnableWindowsHostProcess
        driver.getNodeIDFromIMDS = options.GetNodeIDFromIMDS
        driver.enableOtelTracing = options.EnableOtelTracing
        driver.shouldWaitForSnapshotReady = options.WaitForSnapshotReady
        driver.checkDiskLUNCollision = options.CheckDiskLUNCollision
        driver.checkDiskCountForBatching = options.CheckDiskCountForBatching
        driver.forceDetachBackoff = options.ForceDetachBackoff
        driver.waitForDetach = options.WaitForDetach
        driver.endpoint = options.Endpoint
        driver.disableAVSetNodes = options.DisableAVSetNodes
        driver.removeNotReadyTaint = options.RemoveNotReadyTaint
        driver.maxConcurrentFormat = options.MaxConcurrentFormat
        driver.concurrentFormatTimeout = options.ConcurrentFormatTimeout
        driver.volumeLocks = volumehelper.NewVolumeLocks()
        driver.ioHandler = azureutils.NewOSIOHandler()
        driver.hostUtil = hostutil.NewHostUtil()

        if driver.NodeID == "" {
                // nodeid is not needed in controller component
                klog.Warning("nodeid is empty")
        }
        topologyKey = fmt.Sprintf("topology.%s/zone", driver.Name)

        getter := func(_ string) (interface{}, error) { return nil, nil }
        var err error
        if driver.throttlingCache, err = azcache.NewTimedCache(5*time.Minute, getter, false); err != nil {
                klog.Fatalf("%v", err)
        }
        if driver.checkDiskLunThrottlingCache, err = azcache.NewTimedCache(30*time.Minute, getter, false); err != nil {
                klog.Fatalf("%v", err)
        }

        if options.VolStatsCacheExpireInMinutes <= 0 {
                options.VolStatsCacheExpireInMinutes = 10 // default expire in 10 minutes
        }
        if driver.volStatsCache, err = azcache.NewTimedCache(time.Duration(options.VolStatsCacheExpireInMinutes)*time.Minute, getter, false); err != nil {
                klog.Fatalf("%v", err)
        }

        userAgent := GetUserAgent(driver.Name, driver.customUserAgent, driver.userAgentSuffix)
        klog.V(2).Infof("driver userAgent: %s", userAgent)

        kubeClient, err := azureutils.GetKubeClient(options.Kubeconfig)
        if err != nil {
                klog.Warningf("get kubeconfig(%s) failed with error: %v", options.Kubeconfig, err)
        }
        driver.kubeClient = kubeClient

        cloud, err := azureutils.GetCloudProviderFromClient(context.Background(), kubeClient, driver.cloudConfigSecretName, driver.cloudConfigSecretNamespace,
                userAgent, driver.allowEmptyCloudConfig, driver.enableTrafficManager, driver.trafficManagerPort)
        if err != nil {
                klog.Fatalf("failed to get Azure Cloud Provider, error: %v", err)
        }
        driver.cloud = cloud

        if driver.cloud != nil {
                driver.clientFactory = driver.cloud.ComputeClientFactory
                if driver.vmType != "" {
                        klog.V(2).Infof("override VMType(%s) in cloud config as %s", driver.cloud.VMType, driver.vmType)
                        driver.cloud.VMType = driver.vmType
                }

                if driver.NodeID == "" {
                        // Disable UseInstanceMetadata for controller to mitigate a timeout issue using IMDS
                        // https://github.com/kubernetes-sigs/azuredisk-csi-driver/issues/168
                        klog.V(2).Infof("disable UseInstanceMetadata for controller")
                        driver.cloud.Config.UseInstanceMetadata = false

                        if driver.cloud.VMType == azurecloudconsts.VMTypeStandard && driver.cloud.DisableAvailabilitySetNodes {
                                klog.V(2).Infof("set DisableAvailabilitySetNodes as false since VMType is %s", driver.cloud.VMType)
                                driver.cloud.DisableAvailabilitySetNodes = false
                        }

                        if driver.cloud.VMType == azurecloudconsts.VMTypeVMSS && !driver.cloud.DisableAvailabilitySetNodes && driver.disableAVSetNodes {
                                klog.V(2).Infof("DisableAvailabilitySetNodes for controller since current VMType is vmss")
                                driver.cloud.DisableAvailabilitySetNodes = true
                        }
                        klog.V(2).Infof("cloud: %s, location: %s, rg: %s, VMType: %s, PrimaryScaleSetName: %s, PrimaryAvailabilitySetName: %s, DisableAvailabilitySetNodes: %v", driver.cloud.Cloud, driver.cloud.Location, driver.cloud.ResourceGroup, driver.cloud.VMType, driver.cloud.PrimaryScaleSetName, driver.cloud.PrimaryAvailabilitySetName, driver.cloud.DisableAvailabilitySetNodes)
                }

                if driver.vmssCacheTTLInSeconds > 0 {
                        klog.V(2).Infof("reset vmssCacheTTLInSeconds as %d", driver.vmssCacheTTLInSeconds)
                        driver.cloud.VMCacheTTLInSeconds = int(driver.vmssCacheTTLInSeconds)
                        driver.cloud.VmssCacheTTLInSeconds = int(driver.vmssCacheTTLInSeconds)
                }

                driver.diskController = NewManagedDiskController(driver.cloud)
                driver.diskController.DisableUpdateCache = driver.disableUpdateCache
                driver.diskController.AttachDetachInitialDelayInMs = int(driver.attachDetachInitialDelayInMs)
                driver.diskController.ForceDetachBackoff = driver.forceDetachBackoff
                driver.diskController.WaitForDetach = driver.waitForDetach
                driver.diskController.CheckDiskCountForBatching = driver.checkDiskCountForBatching
        }

        driver.deviceHelper = optimization.NewSafeDeviceHelper()

        if driver.getPerfOptimizationEnabled() {
                driver.nodeInfo, err = optimization.NewNodeInfo(context.TODO(), driver.getCloud(), driver.NodeID)
                if err != nil {
                        klog.Warningf("Failed to get node info. Error: %v", err)
                }
        }

        driver.mounter, err = mounter.NewSafeMounter(driver.enableWindowsHostProcess, driver.useCSIProxyGAInterface, int(driver.maxConcurrentFormat), time.Duration(driver.concurrentFormatTimeout)*time.Second)
        if err != nil {
                klog.Fatalf("Failed to get safe mounter. Error: %v", err)
        }

        controllerCap := []csi.ControllerServiceCapability_RPC_Type{
                csi.ControllerServiceCapability_RPC_CREATE_DELETE_VOLUME,
                csi.ControllerServiceCapability_RPC_PUBLISH_UNPUBLISH_VOLUME,
                csi.ControllerServiceCapability_RPC_CREATE_DELETE_SNAPSHOT,
                csi.ControllerServiceCapability_RPC_CLONE_VOLUME,
                csi.ControllerServiceCapability_RPC_EXPAND_VOLUME,
                csi.ControllerServiceCapability_RPC_SINGLE_NODE_MULTI_WRITER,
                csi.ControllerServiceCapability_RPC_MODIFY_VOLUME,
        }
        if driver.enableListVolumes {
                controllerCap = append(controllerCap, csi.ControllerServiceCapability_RPC_LIST_VOLUMES, csi.ControllerServiceCapability_RPC_LIST_VOLUMES_PUBLISHED_NODES)
        }
        if driver.enableListSnapshots {
                controllerCap = append(controllerCap, csi.ControllerServiceCapability_RPC_LIST_SNAPSHOTS)
        }

        driver.AddControllerServiceCapabilities(controllerCap)
        driver.AddVolumeCapabilityAccessModes(
                []csi.VolumeCapability_AccessMode_Mode{
                        csi.VolumeCapability_AccessMode_SINGLE_NODE_WRITER,
                        csi.VolumeCapability_AccessMode_SINGLE_NODE_READER_ONLY,
                        csi.VolumeCapability_AccessMode_SINGLE_NODE_SINGLE_WRITER,
                        csi.VolumeCapability_AccessMode_SINGLE_NODE_MULTI_WRITER,
                })
        driver.AddNodeServiceCapabilities([]csi.NodeServiceCapability_RPC_Type{
                csi.NodeServiceCapability_RPC_STAGE_UNSTAGE_VOLUME,
                csi.NodeServiceCapability_RPC_EXPAND_VOLUME,
                csi.NodeServiceCapability_RPC_GET_VOLUME_STATS,
                csi.NodeServiceCapability_RPC_SINGLE_NODE_MULTI_WRITER,
        })

        if kubeClient != nil && driver.removeNotReadyTaint && driver.NodeID != "" {
                // Remove taint from node to indicate driver startup success
                // This is done at the last possible moment to prevent race conditions or false positive removals
                time.AfterFunc(taintRemovalInitialDelay, func() {
                        removeTaintInBackground(kubeClient, driver.NodeID, driver.Name, taintRemovalBackoff, removeNotReadyTaint)
                })
        }
        return &driver
}

// Run driver initialization
func (d *Driver) Run(ctx context.Context) error {
        versionMeta, err := GetVersionYAML(d.Name)
        if err != nil {
                klog.Fatalf("%v", err)
        }
        klog.Infof("\nDRIVER INFORMATION:\n-------------------\n%s\n\nStreaming logs below:", versionMeta)

        grpcInterceptor := grpc.UnaryInterceptor(csicommon.LogGRPC)
        opts := []grpc.ServerOption{
                grpcInterceptor,
        }
        if d.enableOtelTracing {
                exporter, err := InitOtelTracing()
                if err != nil {
                        klog.Fatalf("Failed to initialize otel tracing: %v", err)
                }
                // Exporter will flush traces on shutdown
                defer func() {
                        if err := exporter.Shutdown(context.Background()); err != nil {
                                klog.Errorf("Could not shutdown otel exporter: %v", err)
                        }
                }()
                opts = append(opts, grpc.StatsHandler(otelgrpc.NewServerHandler()))
        }

        s := grpc.NewServer(opts...)
        csi.RegisterIdentityServer(s, d)
        csi.RegisterControllerServer(s, d)
        csi.RegisterNodeServer(s, d)

        go func() {
                //graceful shutdown
                <-ctx.Done()
                s.GracefulStop()
        }()
        // Driver d act as IdentityServer, ControllerServer and NodeServer
        listener, err := csicommon.Listen(ctx, d.endpoint)
        if err != nil {
                klog.Fatalf("failed to listen to endpoint, error: %v", err)
        }
        err = s.Serve(listener)
        if errors.Is(err, grpc.ErrServerStopped) {
                klog.Infof("gRPC server stopped serving")
                return nil
        }
        return err
}

func (d *Driver) isGetDiskThrottled() bool {
        cache, err := d.throttlingCache.Get(consts.GetDiskThrottlingKey, azcache.CacheReadTypeDefault)
        if err != nil {
                klog.Warningf("throttlingCache(%s) return with error: %s", consts.GetDiskThrottlingKey, err)
                return false
        }
        return cache != nil
}

func (d *Driver) isCheckDiskLunThrottled() bool {
        cache, err := d.checkDiskLunThrottlingCache.Get(consts.CheckDiskLunThrottlingKey, azcache.CacheReadTypeDefault)
        if err != nil {
                klog.Warningf("throttlingCache(%s) return with error: %s", consts.CheckDiskLunThrottlingKey, err)
                return false
        }
        return cache != nil
}

func (d *Driver) checkDiskExists(ctx context.Context, diskURI string) (*armcompute.Disk, error) {
        diskName, err := azureutils.GetDiskName(diskURI)
        if err != nil {
                return nil, err
        }

        resourceGroup, err := azureutils.GetResourceGroupFromURI(diskURI)
        if err != nil {
                return nil, err
        }

        if d.isGetDiskThrottled() {
                klog.Warningf("skip checkDiskExists(%s) since it's still in throttling", diskURI)
                return nil, nil
        }
        subsID := azureutils.GetSubscriptionIDFromURI(diskURI)
        diskClient, err := d.diskController.clientFactory.GetDiskClientForSub(subsID)
        if err != nil {
                return nil, err
        }

        newCtx, cancel := context.WithTimeout(ctx, time.Duration(d.getDiskTimeoutInSeconds)*time.Second)
        defer cancel()

        disk, err := diskClient.Get(newCtx, resourceGroup, diskName)
        if err != nil {
                return nil, err
        }
        return disk, nil
}

func (d *Driver) checkDiskCapacity(ctx context.Context, subsID, resourceGroup, diskName string, requestGiB int) (bool, error) {
        if d.isGetDiskThrottled() {
                klog.Warningf("skip checkDiskCapacity(%s, %s) since it's still in throttling", resourceGroup, diskName)
                return true, nil
        }
        diskClient, err := d.clientFactory.GetDiskClientForSub(subsID)
        if err != nil {
                return false, err
        }
        disk, err := diskClient.Get(ctx, resourceGroup, diskName)
        // Because we can not judge the reason of the error. Maybe the disk does not exist.
        // So here we do not handle the error.
        if err == nil {
                if !reflect.DeepEqual(disk, armcompute.Disk{}) && disk.Properties.DiskSizeGB != nil && int(*disk.Properties.DiskSizeGB) != requestGiB {
                        return false, status.Errorf(codes.AlreadyExists, "the request volume already exists, but its capacity(%v) is different from (%v)", *disk.Properties.DiskSizeGB, requestGiB)
                }
        }
        return true, nil
}

func (d *Driver) getVolumeLocks() *volumehelper.VolumeLocks {
        return d.volumeLocks
}

// setControllerCapabilities sets the controller capabilities field. It is intended for use with unit tests.
func (d *DriverCore) setControllerCapabilities(caps []*csi.ControllerServiceCapability) {
        d.Cap = caps
}

// setNodeCapabilities sets the node capabilities field. It is intended for use with unit tests.
func (d *DriverCore) setNodeCapabilities(nodeCaps []*csi.NodeServiceCapability) {
        d.NSCap = nodeCaps
}

// setName sets the Name field. It is intended for use with unit tests.
func (d *DriverCore) setName(name string) {
        d.Name = name
}

// setName sets the NodeId field. It is intended for use with unit tests.
func (d *DriverCore) setNodeID(nodeID string) {
        d.NodeID = nodeID
}

// setName sets the Version field. It is intended for use with unit tests.
func (d *DriverCore) setVersion(version string) {
        d.Version = version
}

// getCloud returns the value of the cloud field. It is intended for use with unit tests.
func (d *DriverCore) getCloud() *azure.Cloud {
        return d.cloud
}

// setCloud sets the cloud field. It is intended for use with unit tests.
func (d *DriverCore) setCloud(cloud *azure.Cloud) {
        d.cloud = cloud
}

// getMounter returns the value of the mounter field. It is intended for use with unit tests.
func (d *DriverCore) getMounter() *mount.SafeFormatAndMount {
        return d.mounter
}

// setMounter sets the mounter field. It is intended for use with unit tests.
func (d *DriverCore) setMounter(mounter *mount.SafeFormatAndMount) {
        d.mounter = mounter
}

// getPerfOptimizationEnabled returns the value of the perfOptimizationEnabled field. It is intended for use with unit tests.
func (d *DriverCore) getPerfOptimizationEnabled() bool {
        return d.perfOptimizationEnabled
}

// setPerfOptimizationEnabled sets the value of the perfOptimizationEnabled field. It is intended for use with unit tests.
func (d *DriverCore) setPerfOptimizationEnabled(enabled bool) {
        d.perfOptimizationEnabled = enabled
}

// getDeviceHelper returns the value of the deviceHelper field. It is intended for use with unit tests.
func (d *DriverCore) getDeviceHelper() optimization.Interface {
        return d.deviceHelper
}

// getNodeInfo returns the value of the nodeInfo field. It is intended for use with unit tests.
func (d *DriverCore) getNodeInfo() *optimization.NodeInfo {
        return d.nodeInfo
}

func (d *DriverCore) getHostUtil() hostUtil {
        return d.hostUtil
}

// getSnapshotCompletionPercent returns the completion percent of snapshot
func (d *DriverCore) getSnapshotCompletionPercent(ctx context.Context, subsID, resourceGroup, snapshotName string) (float32, error) {
        snapshotClient, err := d.clientFactory.GetSnapshotClientForSub(subsID)
        if err != nil {
                return 0.0, err
        }
        copySnapshot, err := snapshotClient.Get(ctx, resourceGroup, snapshotName)
        if err != nil {
                return 0.0, err
        }

        if copySnapshot.Properties == nil || copySnapshot.Properties.CompletionPercent == nil {
                // If CompletionPercent is nil, it means the snapshot is complete
                klog.V(2).Infof("snapshot(%s) under rg(%s) has no SnapshotProperties or CompletionPercent is nil", snapshotName, resourceGroup)
                return 100.0, nil
        }

        return *copySnapshot.Properties.CompletionPercent, nil
}

// waitForSnapshotReady wait for completionPercent of snapshot is 100.0
func (d *DriverCore) waitForSnapshotReady(ctx context.Context, subsID, resourceGroup, snapshotName string, intervel, timeout time.Duration) error {
        completionPercent, err := d.getSnapshotCompletionPercent(ctx, subsID, resourceGroup, snapshotName)
        if err != nil {
                return err
        }

        if completionPercent >= float32(100.0) {
                klog.V(2).Infof("snapshot(%s) under rg(%s) complete", snapshotName, resourceGroup)
                return nil
        }

        timeTick := time.Tick(intervel)
        timeAfter := time.After(timeout)
        for {
                select {
                case <-timeTick:
                        completionPercent, err = d.getSnapshotCompletionPercent(ctx, subsID, resourceGroup, snapshotName)
                        if err != nil {
                                return err
                        }

                        if completionPercent >= float32(100.0) {
                                klog.V(2).Infof("snapshot(%s) under rg(%s) complete", snapshotName, resourceGroup)
                                return nil
                        }
                        klog.V(2).Infof("snapshot(%s) under rg(%s) completionPercent: %f", snapshotName, resourceGroup, completionPercent)
                case <-timeAfter:
                        return fmt.Errorf("timeout waiting for snapshot(%s) under rg(%s)", snapshotName, resourceGroup)
                }
        }
}

// getUsedLunsFromVolumeAttachments returns a list of used luns from VolumeAttachments
func (d *DriverCore) getUsedLunsFromVolumeAttachments(ctx context.Context, nodeName string) ([]int, error) {
        kubeClient := d.cloud.KubeClient
        if kubeClient == nil || kubeClient.StorageV1() == nil || kubeClient.StorageV1().VolumeAttachments() == nil {
                return nil, fmt.Errorf("kubeClient or kubeClient.StorageV1() or kubeClient.StorageV1().VolumeAttachments() is nil")
        }

        volumeAttachments, err := kubeClient.StorageV1().VolumeAttachments().List(ctx, metav1.ListOptions{
                TimeoutSeconds: pointer.Int64Ptr(2)})
        if err != nil {
                return nil, err
        }

        usedLuns := make([]int, 0)
        if volumeAttachments == nil {
                klog.V(2).Infof("volumeAttachments is nil")
                return usedLuns, nil
        }

        klog.V(2).Infof("volumeAttachments count: %d, nodeName: %s", len(volumeAttachments.Items), nodeName)
        for _, va := range volumeAttachments.Items {
                klog.V(6).Infof("attacher: %s, nodeName: %s, Status: %v, PV: %s, attachmentMetadata: %v", va.Spec.Attacher, va.Spec.NodeName,
                        va.Status.Attached, pointer.StringDeref(va.Spec.Source.PersistentVolumeName, ""), va.Status.AttachmentMetadata)
                if va.Spec.Attacher == d.Name && strings.EqualFold(va.Spec.NodeName, nodeName) && va.Status.Attached {
                        if k, ok := va.Status.AttachmentMetadata[consts.LUN]; ok {
                                lun, err := strconv.Atoi(k)
                                if err != nil {
                                        klog.Warningf("VolumeAttachment(%s) lun(%s) is not a valid integer", va.Name, k)
                                        continue
                                }
                                usedLuns = append(usedLuns, lun)
                        }
                }
        }
        return usedLuns, nil
}

// getUsedLunsFromNode returns a list of sorted used luns from Node
func (d *DriverCore) getUsedLunsFromNode(nodeName types.NodeName) ([]int, error) {
        disks, _, err := d.diskController.GetNodeDataDisks(nodeName, azcache.CacheReadTypeDefault)
        if err != nil {
                klog.Errorf("error of getting data disks for node %s: %v", nodeName, err)
                return nil, err
        }

        usedLuns := make([]int, 0)
        // get all disks attached to the node
        for _, disk := range disks {
                if disk.Lun == nil {
                        klog.Warningf("disk(%s) lun is nil", *disk.Name)
                        continue
                }
                usedLuns = append(usedLuns, int(*disk.Lun))
        }
        return usedLuns, nil
}

// getNodeInfoFromLabels get zone, instanceType from node labels
func getNodeInfoFromLabels(ctx context.Context, nodeName string, kubeClient clientset.Interface) (string, string, error) {
        if kubeClient == nil || kubeClient.CoreV1() == nil {
                return "", "", fmt.Errorf("kubeClient is nil")
        }

        node, err := kubeClient.CoreV1().Nodes().Get(ctx, nodeName, metav1.GetOptions{})
        if err != nil {
                return "", "", fmt.Errorf("get node(%s) failed with %v", nodeName, err)
        }

        if len(node.Labels) == 0 {
                return "", "", fmt.Errorf("node(%s) label is empty", nodeName)
        }
        return node.Labels[consts.WellKnownTopologyKey], node.Labels[consts.InstanceTypeKey], nil
}

// getDefaultDiskIOPSReadWrite according to requestGiB
//
//        ref: https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#ultra-disk-iops
func getDefaultDiskIOPSReadWrite(requestGiB int) int {
        iops := azurecloudconsts.DefaultDiskIOPSReadWrite
        if requestGiB > iops {
                iops = requestGiB
        }
        if iops > 160000 {
                iops = 160000
        }
        return iops
}

// getDefaultDiskMBPSReadWrite according to requestGiB
//
//        ref: https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#ultra-disk-throughput
func getDefaultDiskMBPSReadWrite(requestGiB int) int {
        bandwidth := azurecloudconsts.DefaultDiskMBpsReadWrite
        iops := getDefaultDiskIOPSReadWrite(requestGiB)
        if iops/256 > bandwidth {
                bandwidth = int(volumehelper.RoundUpSize(int64(iops), 256))
        }
        if bandwidth > iops/4 {
                bandwidth = int(volumehelper.RoundUpSize(int64(iops), 4))
        }
        if bandwidth > 4000 {
                bandwidth = 4000
        }
        return bandwidth
}

// getVMSSInstanceName get instance name from vmss compute name, e.g. "aks-agentpool-20657377-vmss_2" -> "aks-agentpool-20657377-vmss000002"
func getVMSSInstanceName(computeName string) (string, error) {
        names := strings.Split(computeName, "_")
        if len(names) != 2 {
                return "", fmt.Errorf("invalid vmss compute name: %s", computeName)
        }

        instanceID, err := strconv.Atoi(names[1])
        if err != nil {
                return "", fmt.Errorf("parsing vmss compute name(%s) failed with %v", computeName, err)
        }
        return fmt.Sprintf("%s%06s", names[0], strconv.FormatInt(int64(instanceID), 36)), nil
}

// Struct for JSON patch operations
type JSONPatch struct {
        OP    string      `json:"op,omitempty"`
        Path  string      `json:"path,omitempty"`
        Value interface{} `json:"value"`
}

// removeTaintInBackground is a goroutine that retries removeNotReadyTaint with exponential backoff
func removeTaintInBackground(k8sClient kubernetes.Interface, nodeName, driverName string, backoff wait.Backoff, removalFunc func(kubernetes.Interface, string, string) error) {
        backoffErr := wait.ExponentialBackoff(backoff, func() (bool, error) {
                err := removalFunc(k8sClient, nodeName, driverName)
                if err != nil {
                        klog.ErrorS(err, "Unexpected failure when attempting to remove node taint(s)")
                        return false, nil
                }
                return true, nil
        })

        if backoffErr != nil {
                klog.ErrorS(backoffErr, "Retries exhausted, giving up attempting to remove node taint(s)")
        }
}

// removeNotReadyTaint removes the taint disk.csi.azure.com/agent-not-ready from the local node
// This taint can be optionally applied by users to prevent startup race conditions such as
// https://github.com/kubernetes/kubernetes/issues/95911
func removeNotReadyTaint(clientset kubernetes.Interface, nodeName, driverName string) error {
        ctx := context.Background()
        node, err := clientset.CoreV1().Nodes().Get(ctx, nodeName, metav1.GetOptions{})
        if err != nil {
                return err
        }

        if err := checkAllocatable(ctx, clientset, nodeName, driverName); err != nil {
                return err
        }

        taintKeyToRemove := driverName + consts.AgentNotReadyNodeTaintKeySuffix
        klog.V(2).Infof("removing taint with key %s from local node %s", taintKeyToRemove, nodeName)
        var taintsToKeep []corev1.Taint
        for _, taint := range node.Spec.Taints {
                klog.V(5).Infof("checking taint key %s, value %s, effect %s", taint.Key, taint.Value, taint.Effect)
                if taint.Key != taintKeyToRemove {
                        taintsToKeep = append(taintsToKeep, taint)
                } else {
                        klog.V(2).Infof("queued taint for removal with key %s, effect %s", taint.Key, taint.Effect)
                }
        }

        if len(taintsToKeep) == len(node.Spec.Taints) {
                klog.V(2).Infof("No taints to remove on node, skipping taint removal")
                return nil
        }

        patchRemoveTaints := []JSONPatch{
                {
                        OP:    "test",
                        Path:  "/spec/taints",
                        Value: node.Spec.Taints,
                },
                {
                        OP:    "replace",
                        Path:  "/spec/taints",
                        Value: taintsToKeep,
                },
        }

        patch, err := json.Marshal(patchRemoveTaints)
        if err != nil {
                return err
        }

        _, err = clientset.CoreV1().Nodes().Patch(ctx, nodeName, k8stypes.JSONPatchType, patch, metav1.PatchOptions{})
        if err != nil {
                return err
        }
        klog.V(2).Infof("removed taint with key %s from local node %s successfully", taintKeyToRemove, nodeName)
        return nil
}

func checkAllocatable(ctx context.Context, clientset kubernetes.Interface, nodeName, driverName string) error {
        csiNode, err := clientset.StorageV1().CSINodes().Get(ctx, nodeName, metav1.GetOptions{})
        if err != nil {
                return fmt.Errorf("isAllocatableSet: failed to get CSINode for %s: %w", nodeName, err)
        }

        for _, driver := range csiNode.Spec.Drivers {
                if driver.Name == driverName {
                        if driver.Allocatable != nil && driver.Allocatable.Count != nil {
                                klog.V(2).Infof("CSINode Allocatable value is set for driver on node %s, count %d", nodeName, *driver.Allocatable.Count)
                                return nil
                        }
                        return fmt.Errorf("isAllocatableSet: allocatable value not set for driver on node %s", nodeName)
                }
        }

        return fmt.Errorf("isAllocatableSet: driver not found on node %s", nodeName)
}

kubernetes-sigs / azuredisk-csi-driver / 15660492627

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous