Upgrade testfx and build script invocation (#28474)

Author: vidai-msft

tools/BuildScripts/BuildModules.ps1

@@ -175,14 +175,15 @@ else {
     Write-Output "Modules are added to test sln file"
 }
 
-$buildCmdResult = "dotnet $BuildAction $Buildsln -c $Configuration -fl '/flp1:logFile=$LogFile;verbosity=quiet'"
+$buildCmdArgs = @("$BuildAction", "$Buildsln", "-c", "$Configuration", "-fl", "/flp1:logFile=$LogFile;verbosity=quiet")
 If ($GenerateDocumentationFile -eq "false") {
-    $buildCmdResult += " -p:GenerateDocumentationFile=false"
+    $buildCmdArgs += "-p:GenerateDocumentationFile=false"
 }
 if ($EnableTestCoverage -eq "true") {
-    $buildCmdResult += " -p:TestCoverage=TESTCOVERAGE"
+    $buildCmdArgs += "-p:TestCoverage=TESTCOVERAGE"
 }
-Invoke-Expression -Command $buildCmdResult
+# Use argument splatting to prevent injection
+& dotnet @buildCmdArgs
 
 $versionControllerCsprojPath = Join-Path $toolDirectory 'VersionController' 'VersionController.Netcore.csproj'
 dotnet build $versionControllerCsprojPath -c $Configuration

tools/Modules/TestFx-Tasks.psm1

@@ -181,7 +181,10 @@ function New-TestFxServicePrincipal {
         }
     }
 
-    $sp = Invoke-TestFxCommand -Command "New-AzADServicePrincipal -DisplayName $ServicePrincipalDisplayName"
+    $sp = Invoke-TestFxCommand -ScriptBlock {
+        param($DisplayName)
+        New-AzADServicePrincipal -DisplayName $DisplayName
+    } -Parameters @{ DisplayName = $ServicePrincipalDisplayName }
     Start-Sleep -Seconds 10
     Set-TestFxServicePrincipalPermission -SubscriptionId $SubscriptionId -ServicePrincipalObjectId $sp.Id
 
@@ -204,7 +207,14 @@ function Set-TestFxServicePrincipalPermission {
     try {
         $spRoleAssg = Get-AzRoleAssignment -ObjectId $ServicePrincipalObjectId -Scope $scope -RoleDefinitionName $roleName -ErrorAction Stop
         if ($null -eq $spRoleAssg) {
-            Invoke-TestFxCommand -Command "New-AzRoleAssignment -ObjectId $ServicePrincipalObjectId -RoleDefinitionName $roleName -Scope $scope | Out-Null"
+            Invoke-TestFxCommand -ScriptBlock {
+                param($ObjectId, $RoleName, $Scope)
+                New-AzRoleAssignment -ObjectId $ObjectId -RoleDefinitionName $RoleName -Scope $Scope | Out-Null
+            } -Parameters @{
+                ObjectId = $ServicePrincipalObjectId
+                RoleName = $roleName
+                Scope    = $scope
+            }
         }
     }
     catch {
@@ -264,34 +274,46 @@ function Get-TestFxEnvironment {
 function Invoke-TestFxCommand {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory, ValueFromPipeline)]
+        [Parameter(Mandatory)]
         [ValidateNotNullOrEmpty()]
-        [string] $Command
+        [scriptblock] $ScriptBlock,
+
+        [Parameter()]
+        [hashtable] $Parameters = @{},
+
+        [Parameter()]
+        [int] $MaxRetries = 3,
+
+        [Parameter()]
+        [int] $RetryDelaySeconds = 5
     )
 
     $cmdRetryCount = 0
 
     do {
         try {
-            Write-Verbose "Start to execute the command `"$Command`"."
-            $cmdResult = Invoke-Expression -Command $Command -ErrorAction Stop
-            Write-Verbose "Successfully executed the command `"$Command`"."
+            Write-Verbose "Start to execute the command."
+
+            $cmdResult = & $ScriptBlock @Parameters -ErrorAction Stop
+
+            Write-Verbose "Successfully executed the command."
+
             $cmdResult
             break
         }
         catch {
             $cmdErrorMessage = $_.Exception.Message
-            if ($cmdRetryCount -le 3) {
-                Write-Warning "Error occurred when executing the command `"$Command`" with error message `"$cmdErrorMessage`"."
-                Write-Warning "Will retry automatically in 5 seconds."
+            if ($cmdRetryCount -le $MaxRetries) {
+                Write-Warning "Error occurred when executing the command with error message `"$cmdErrorMessage`"."
+                Write-Warning "Will retry automatically in $RetryDelaySeconds seconds."
                 Write-Host
 
-                Start-Sleep -Seconds 5
+                Start-Sleep -Seconds $RetryDelaySeconds
                 $cmdRetryCount++
-                Write-Warning "Retrying #$cmdRetryCount to execute the command `"$Command`"."
+                Write-Warning "Retrying #$cmdRetryCount to execute the command."
             }
             else {
-                throw "Failed to execute the command `"$Command`" after retrying for 3 times with error message `"$cmdErrorMessage`"."
+                throw "Failed to execute the command after retrying for $MaxRetries times with error message `"$cmdErrorMessage`"."
             }
         }
     }

tools/TestFx/Live/InvokeLiveTestCITask.ps1

@@ -13,20 +13,24 @@ param (
 )
 
 if ($UseWindowsPowerShell) {
-    $process = "powershell"
     Write-Host "##[section]Using Windows PowerShell"
+    $executable = "powershell"
+    $baseArguments = @("-NoLogo", "-NoProfile", "-NonInteractive")
 }
 else {
-    $process = "dotnet tool run pwsh"
     Write-Host "##[section]Using PowerShell"
     dotnet tool run pwsh -NoLogo -NoProfile -NonInteractive -Version
+    $executable = "dotnet"
+    $baseArguments = @("tool", "run", "pwsh", "-NoLogo", "-NoProfile", "-NonInteractive")
 }
 
 switch ($PSCmdlet.ParameterSetName) {
     "ByScriptFile" {
-        Invoke-Expression "$process -NoLogo -NoProfile -NonInteractive -File $ScriptFile"
+        $arguments = $baseArguments + @("-Command", "& $ScriptFile")
+        & $executable @arguments
     }
     "ByScriptBlock" {
-        Invoke-Expression "$process -NoLogo -NoProfile -NonInteractive -Command $ScriptBlock"
+        $arguments = $baseArguments + @("-Command", $ScriptBlock)
+        & $executable @arguments
     }
 }

tools/TestFx/Live/LiveTestUtility.psm1

@@ -222,13 +222,13 @@ function Invoke-LiveTestCommand {
 
     do {
         try {
-            $expandedCommand = $ExecutionContext.InvokeCommand.ExpandString($Command)
-            Write-Host "##[section]Start executing the command `"$expandedCommand`"."
-            Write-Host "##[command]The command `"$expandedCommand`" is running."
+            $displayCommand = $Command.ToString()
+            Write-Host "##[section]Start executing the command `"$displayCommand`"."
+            Write-Host "##[command]The command `"$displayCommand`" is running."
 
             $cmdResult = $Command.InvokeWithContext($null, [psvariable]::new("ErrorActionPreference", "Stop"))
 
-            Write-Host "##[section]Finish executing the command `"$expandedCommand`"."
+            Write-Host "##[section]Finish executing the command `"$displayCommand`"."
 
             $cmdResult
             break