Merge pull request #400 from laozc/wmi-library-bump-wmi

cleanup: Bump microsoft/wmi to 0.34.0 containing WMI method call fix (library version)

Author: k8s-ci-robot

.github/workflows/windows.yml

@@ -5,7 +5,7 @@ jobs:
   integration_tests:
     strategy:
       matrix:
-        go: ['1.22']
+        go: ['1.24']
         platform: [windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
@@ -30,7 +30,7 @@ jobs:
   unit_tests:
     strategy:
       matrix:
-        go: ['1.22']
+        go: ['1.24']
         platform: [windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:

go.mod

@@ -1,13 +1,17 @@
 module github.com/kubernetes-csi/csi-proxy/v2
 
-go 1.22
+go 1.24.3
+
+godebug winsymlink=0
+
+toolchain go1.24.4
 
 require (
 	github.com/go-ole/go-ole v1.3.0
-	github.com/microsoft/wmi v0.25.1
+	github.com/microsoft/wmi v0.34.0
 	github.com/pkg/errors v0.9.1
 	github.com/stretchr/testify v1.7.0
-	golang.org/x/sys v0.25.0
+	golang.org/x/sys v0.32.0
 	k8s.io/klog/v2 v2.9.0
 )
 

go.sum

@@ -5,8 +5,8 @@ github.com/go-logr/logr v0.4.0 h1:K7/B1jt6fIBQVd4Owv2MqGQClcgf0R266+7C/QjRcLc=
 github.com/go-logr/logr v0.4.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU=
 github.com/go-ole/go-ole v1.3.0 h1:Dt6ye7+vXGIKZ7Xtk4s6/xVdGDQynvom7xCFEdWr6uE=
 github.com/go-ole/go-ole v1.3.0/go.mod h1:5LS6F96DhAwUc7C+1HLexzMXY1xGRSryjyPPKW6zv78=
-github.com/microsoft/wmi v0.25.1 h1:sQv9hCEHtW5K6yEVL78T6XGRMGxk4aTpcJwCiB5rLN0=
-github.com/microsoft/wmi v0.25.1/go.mod h1:1zbdSF0A+5OwTUII5p3hN7/K6KF2m3o27pSG6Y51VU8=
+github.com/microsoft/wmi v0.34.0 h1:1OqBM8Ha8CWMbKYDH6EqUmozgxZ0IuoYwtLkgsJj2zc=
+github.com/microsoft/wmi v0.34.0/go.mod h1:uImvBuQss3NEnzU5bcwq0DsUh54seU3Sl//oBn62LDw=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -15,8 +15,8 @@ github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=
-golang.org/x/sys v0.25.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
+golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/cim/wmi.go

@@ -9,7 +9,6 @@ import (
 	"runtime"
 
 	"github.com/go-ole/go-ole"
-	"github.com/go-ole/go-ole/oleutil"
 	"github.com/microsoft/wmi/pkg/base/query"
 	wmierrors "github.com/microsoft/wmi/pkg/errors"
 	cim "github.com/microsoft/wmi/pkg/wmiinstance"
@@ -91,105 +90,6 @@ func QueryInstances(namespace string, query *query.WmiQuery) ([]*cim.WmiInstance
 	return instances, err
 }
 
-// TODO: fix the panic in microsoft/wmi library and remove this workaround
-// Refer to https://github.com/microsoft/wmi/issues/167
-func executeClassMethodParam(classInst *cim.WmiInstance, method *cim.WmiMethod, inParam, outParam cim.WmiMethodParamCollection) (result *cim.WmiMethodResult, err error) {
-	klog.V(6).Infof("[WMI] - Executing Method [%s]\n", method.Name)
-
-	iDispatchInstance := classInst.GetIDispatch()
-	if iDispatchInstance == nil {
-		return nil, wmierrors.Wrapf(wmierrors.InvalidInput, "InvalidInstance")
-	}
-	rawResult, err := iDispatchInstance.GetProperty("Methods_")
-	if err != nil {
-		return nil, err
-	}
-	defer rawResult.Clear()
-	// Retrieve the method
-	rawMethod, err := rawResult.ToIDispatch().CallMethod("Item", method.Name)
-	if err != nil {
-		return nil, err
-	}
-	defer rawMethod.Clear()
-
-	addInParam := func(inparamVariant *ole.VARIANT, paramName string, paramValue interface{}) error {
-		rawProperties, err := inparamVariant.ToIDispatch().GetProperty("Properties_")
-		if err != nil {
-			return err
-		}
-		defer rawProperties.Clear()
-		rawProperty, err := rawProperties.ToIDispatch().CallMethod("Item", paramName)
-		if err != nil {
-			return err
-		}
-		defer rawProperty.Clear()
-
-		p, err := rawProperty.ToIDispatch().PutProperty("Value", paramValue)
-		if err != nil {
-			return err
-		}
-		defer p.Clear()
-		return nil
-	}
-
-	params := []interface{}{method.Name}
-	if len(inParam) > 0 {
-		inparamsRaw, err := rawMethod.ToIDispatch().GetProperty("InParameters")
-		if err != nil {
-			return nil, err
-		}
-		defer inparamsRaw.Clear()
-
-		inparams, err := oleutil.CallMethod(inparamsRaw.ToIDispatch(), "SpawnInstance_")
-		if err != nil {
-			return nil, err
-		}
-		defer inparams.Clear()
-
-		for _, inp := range inParam {
-			addInParam(inparams, inp.Name, inp.Value)
-		}
-
-		params = append(params, inparams)
-	}
-
-	result = &cim.WmiMethodResult{
-		OutMethodParams: map[string]*cim.WmiMethodParam{},
-	}
-	outparams, err := classInst.GetIDispatch().CallMethod("ExecMethod_", params...)
-	if err != nil {
-		return
-	}
-	defer outparams.Clear()
-	returnRaw, err := outparams.ToIDispatch().GetProperty("ReturnValue")
-	if err != nil {
-		return
-	}
-	defer returnRaw.Clear()
-	if returnRaw.Value() != nil {
-		result.ReturnValue = returnRaw.Value().(int32)
-		klog.V(6).Infof("[WMI] - Return [%d] ", result.ReturnValue)
-	}
-
-	for _, outp := range outParam {
-		returnRawIn, err1 := outparams.ToIDispatch().GetProperty(outp.Name)
-		if err1 != nil {
-			err = err1
-			return
-		}
-		defer returnRawIn.Clear()
-
-		value, err1 := cim.GetVariantValue(returnRawIn)
-		if err1 != nil {
-			err = err1
-			return
-		}
-
-		result.OutMethodParams[outp.Name] = cim.NewWmiMethodParam(outp.Name, value)
-	}
-	return
-}
-
 // InvokeCimMethod calls a static method on a specific WMI class with given input parameters,
 // returning the method's return value, output parameters, and any error encountered.
 func InvokeCimMethod(namespace, class, methodName string, inputParameters map[string]interface{}) (int, map[string]interface{}, error) {
@@ -225,7 +125,7 @@ func InvokeCimMethod(namespace, class, methodName string, inputParameters map[st
 
 	var outParam cim.WmiMethodParamCollection
 	var result *cim.WmiMethodResult
-	result, err = executeClassMethodParam(classInst, method, inParam, outParam)
+	result, err = method.Execute(inParam, outParam)
 	if err != nil {
 		return -1, nil, err
 	}