/// <summary>
        /// Invokde script by given file path and arguments.
        /// </summary>
        /// <param name="path">The file path to the cmd script.</param>
        /// <param name="targetMethod">The method the caller invoked.</param>
        /// <param name="args">The argument to be passed to the script.</param>
        /// <param name="helpMessage">The help message from the attribute.</param>
        /// <returns>The return value of script executation.</returns>
        private PSParameterBuilder InvokeScript(string path, MethodInfo targetMethod, object[] args, string helpMessage)
        {
            //the patameter builder to handle all parameters
            PSParameterBuilder builder = null;

            //use the Dot operation in PowerShell to make all variables can be accessed in whole runspace.
            string scriptContent = string.Format(". \"{0}\"", Path.GetFullPath(path));

            //call static method, and create the instance of runspace type
            Runspace runspace = RunspaceFactory.CreateRunspace();

            //open run space
            runspace.Open();

            //call runspace.CreatePipeline to create an instance of Pipeline
            Pipeline pipeline = runspace.CreatePipeline();

            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
            {
                //set execution policy for Windows in order to load and run local script files
                pipeline.Commands.AddScript("Set-ExecutionPolicy -Scope Process RemoteSigned");
            }

            pipeline.Commands.AddScript(scriptContent);

            SessionStateProxy sessionStateProxy = runspace.SessionStateProxy;

            //set current location to the folder containing the script
            sessionStateProxy.Path.SetLocation(Path.GetDirectoryName(path));
            //set variables which can be used in PowerShell script
            SetPTFVariables(sessionStateProxy);

            //set all parameters as variables which can be used
            //by users directly in the PowerShell script
            builder = new PSParameterBuilder(targetMethod);
            builder.SetAllParametersAsVariables(sessionStateProxy, args, helpMessage);

            try
            {
                if (builder != null)
                {
                    //invoke script and get the return value and out/ref parameters
                    if (builder.HasRetValue)
                    {
                        Collection <PSObject> returnValueCollection = pipeline.Invoke();

                        //get return value object
                        KeyValuePair <string, object> retValue = GetRetValueFromCollection(returnValueCollection);

                        if (retValue.Value != null)
                        {
                            if (builder.RetType.IsInstanceOfType(retValue.Value))
                            {
                                builder.RetValue = retValue.Value;
                            }
                            else
                            {
                                throw new InvalidOperationException("The returned type is mismatched");
                            }
                        }
                        else
                        {
                            builder.RetValue = null;
                        }
                    }
                    else
                    {
                        pipeline.Invoke();
                    }

                    //get out parameters values
                    builder.GetAllOutParameterValues(
                        sessionStateProxy,
                        targetMethod.GetParameters().Length);
                }
                else
                {
                    pipeline.Invoke();
                }

                //check errors in the error pipeline
                CheckErrorsInPipeline(pipeline);
            }
            catch (RuntimeException ex)
            {
                string errorMessage        = ex.Message;
                string traceInfo           = ex.ErrorRecord.InvocationInfo.PositionMessage;
                string ptfAdFailureMessage = string.Format(
                    "Exception thrown in PowerShell Adapter: {0} {1}", errorMessage, traceInfo);
                throw new InvalidOperationException(ptfAdFailureMessage);
            }

            //close runspace and release resources
            runspace.Close();

            return(builder);
        }
Example #2
0
        //use reflection to invoke PowerShell script via APIs in System.Management.Automation.dll
        private PSParameterBuilder InvokeScript(string path, IMethodCallMessage methodCall, string helpMessage)
        {
            //the patameter builder to handle all parameters
            PSParameterBuilder builder             = null;
            Assembly           sysMgmtAutoAssembly = null;

            try
            {
                sysMgmtAutoAssembly = Assembly.Load(PSConstant.SystemManagementAutomationAssemblyNameV3);
            }
            catch { }
            // If loading System.Management.Automation, Version=3.0.0.0 failed, try Version=1.0.0.0
            if (sysMgmtAutoAssembly == null)
            {
                try
                {
                    sysMgmtAutoAssembly = Assembly.Load(PSConstant.SystemManagementAutomationAssemblyNameV1);
                }
                catch
                {
                    throw new InvalidOperationException("Can not find system management automation assembly from GAC." +
                                                        "Please make sure your PowerShell installation is valid." +
                                                        "Or you need to reinstall PowerShell.");
                }
            }

            if (sysMgmtAutoAssembly != null)
            {
                //use the Dot operation in PowerShell to make all variables can be accessed in whole runspace.
                string scriptContent = string.Format(". \"{0}\"", Path.GetFullPath(path));

                BindingFlags flag = BindingFlags.Public | BindingFlags.Instance | BindingFlags.InvokeMethod;

                //call static method, and create the instance of runspace type
                Type runspaceFactory =
                    GetPSType(sysMgmtAutoAssembly, "System.Management.Automation.Runspaces.RunspaceFactory");

                object runspaceInstance = runspaceFactory.InvokeMember(
                    "CreateRunspace", BindingFlags.InvokeMethod, null, null, null);

                //open run space
                Type runspace =
                    GetPSType(sysMgmtAutoAssembly, "System.Management.Automation.Runspaces.Runspace");

                runspace.InvokeMember("Open", flag, null, runspaceInstance, null);

                //call runspace.CreatePipeline to create an instance of Pipeline
                Type pipeline =
                    GetPSType(sysMgmtAutoAssembly, "System.Management.Automation.Runspaces.Pipeline");

                object pipelineInstance = runspace.InvokeMember(
                    "CreatePipeline", flag, null, runspaceInstance, null);

                //get the Commands property of the pipeline instance
                object commandsInstance = pipeline.InvokeMember(
                    "Commands", BindingFlags.GetProperty, null, pipelineInstance, null);

                //add commands to invoke script
                Type commands =
                    GetPSType(sysMgmtAutoAssembly, "System.Management.Automation.Runspaces.CommandCollection");

                commands.InvokeMember(
                    "AddScript", flag, null, commandsInstance, new object[] { scriptContent });

                //get "SessionStateProxy" instance from runspace
                Type sessionStateProxy =
                    GetPSType(sysMgmtAutoAssembly, "System.Management.Automation.Runspaces.SessionStateProxy");

                object proxyInstance = runspace.InvokeMember(
                    "SessionStateProxy",
                    BindingFlags.GetProperty,
                    null,
                    runspaceInstance,
                    null);

                //set variables which can be used in PowerShell script
                builder = SetPSVariables(methodCall, sessionStateProxy, proxyInstance, helpMessage);

                try
                {
                    if (builder != null)
                    {
                        //invoke script and get the return value and out/ref parameters
                        if (builder.HasRetValue)
                        {
                            object returnValueCollection =
                                pipeline.InvokeMember("Invoke", flag, null, pipelineInstance, null);
                            Type psObject =
                                GetPSType(sysMgmtAutoAssembly, "System.Management.Automation.PSObject");

                            //get return value object
                            KeyValuePair <string, object> retValue =
                                this.GetRetValueFromCollection(returnValueCollection, psObject);

                            if (retValue.Value != null)
                            {
                                if (builder.RetType.IsInstanceOfType(retValue.Value))
                                {
                                    builder.RetValue = retValue.Value;
                                }
                                else
                                {
                                    throw new InvalidOperationException("The returned type is mismatched");
                                }
                            }
                            else
                            {
                                builder.RetValue = null;
                            }
                        }
                        else
                        {
                            pipeline.InvokeMember("Invoke", flag, null, pipelineInstance, null);
                        }

                        //get out parameters values
                        builder.GetAllOutParameterValues(
                            sysMgmtAutoAssembly,
                            sessionStateProxy,
                            proxyInstance,
                            methodCall.MethodBase.GetParameters().Length);
                    }
                    else
                    {
                        pipeline.InvokeMember("Invoke", flag, null, pipelineInstance, null);
                    }

                    //check errors in the error pipeline
                    CheckErrorsInPipeline(sysMgmtAutoAssembly, pipeline, pipelineInstance);
                }
                catch (TargetInvocationException ex)
                {
                    string    innerException = string.Empty;
                    string    traceInfo      = string.Empty;
                    Exception e = ex as Exception;
                    if (null != e.InnerException)
                    {
                        innerException = e.InnerException.Message;
                        traceInfo      = GetPSScriptPositionMessage(sysMgmtAutoAssembly, e.InnerException);
                    }
                    string ptfAdFailureMessage = string.Format(
                        "Exception thrown. InnerException: {0} {1}", innerException, traceInfo);
                    throw new InvalidOperationException(ptfAdFailureMessage);
                }

                //close runspace and release resources
                runspace.InvokeMember("Close", flag, null, runspaceInstance, null);
            }
            else
            {
                throw new InvalidOperationException("Can not find system management automation assembly from GAC." +
                                                    "Please make sure your PowerShell installation is valid." +
                                                    "Or you need to reinstall PowerShell.");
            }

            return(builder);
        }