Resolve PowerShell lint errors and enable CI enforcement

.build/BuildHelper/Start-PesterTest.ps1

@@ -14,6 +14,7 @@ function Start-PesterTest
     $rootPath = ((Get-Item -Path $PSScriptRoot).Parent.Parent).FullName
     $pesterArgs = New-PesterConfiguration
     $pesterArgs.Output.Verbosity = 'Detailed'
+    $pesterArgs.Run.Exit = $true
 
     switch ($Type)
     {

.editorconfig

@@ -10,6 +10,15 @@ trim_trailing_whitespace = true
 
 [*.ps1]
 indent_size = 4
+charset = utf-8-bom
+
+[*.psm1]
+indent_size = 4
+charset = utf-8-bom
+
+[*.psd1]
+indent_size = 4
+charset = utf-8-bom
 
 [*.md]
 max_line_length = off

.vscode/settings.json

@@ -16,7 +16,9 @@
   },
   "[powershell]": {
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "ms-vscode.powershell"
+    "editor.defaultFormatter": "ms-vscode.powershell",
+    "files.encoding": "utf8bom",
+    "files.trimTrailingWhitespace": true
   },
   "cSpell.words": [
     "ADLS",

src/powershell/Private/Invoke-Rest.ps1

@@ -62,9 +62,9 @@ function Invoke-Rest
 
     # TODO: Remove after Az PowerShell 13.0
     # Temporarily suppress warnings for Get-AzAccessToken
-    $prevWarningPreference = $WarningPreference 
-    $WarningPreference = "SilentlyContinue" 
-    $token = (Get-AzAccessToken -AsSecureString).Token | ConvertFrom-SecureString -AsPlainText 
+    $prevWarningPreference = $WarningPreference
+    $WarningPreference = "SilentlyContinue"
+    $token = (Get-AzAccessToken -AsSecureString).Token | ConvertFrom-SecureString -AsPlainText
     $WarningPreference = $prevWarningPreference
 
     $arm = (Get-AzContext).Environment.ResourceManagerUrl

src/powershell/Private/Save-FinOpsHubTemplate.ps1

@@ -70,7 +70,7 @@ function Save-FinOpsHubTemplate
             Write-Information $LocalizedData.Hub_Deploy_02to021
             $Version = '0.3'
         }
- 
+
         # Get the version
         if ($Version.ToLower() -eq 'latest')
         {

src/powershell/Private/Split-AzureResourceId.ps1

@@ -53,7 +53,7 @@ function Split-AzureResourceId
 
         if (-not $Id)
         {
-            return @{ ResourceId = $null }
+            return [AzureResourceIdInfo]@{ ResourceId = $null }
         }
 
         # Add leading slash

src/powershell/Public/Get-FinOpsCostExport.ps1

@@ -1,4 +1,4 @@
-# Copyright (c) Microsoft Corporation.
+# Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 
 <#

src/powershell/Public/Initialize-FinOpsHubDeployment.ps1

@@ -21,5 +21,8 @@ function Initialize-FinOpsHubDeployment
     [CmdletBinding(SupportsShouldProcess)]
     param()
 
-    Register-FinOpsHubProviders -WhatIf:$WhatIfPreference | Out-Null
+    if ($PSCmdlet.ShouldProcess('FinOps hub resource providers', 'Register'))
+    {
+        Register-FinOpsHubProviders | Out-Null
+    }
 }

src/powershell/Public/New-FinOpsCostExport.ps1

@@ -136,7 +136,7 @@
 function New-FinOpsCostExport
 {
     [Diagnostics.CodeAnalysis.SuppressMessage("PSReviewUnusedParameter", "", Justification = "False positive rule")]
-    [CmdletBinding(DefaultParameterSetName = "Scheduled")]
+    [CmdletBinding(SupportsShouldProcess, DefaultParameterSetName = "Scheduled")]
     param
     (
         [Parameter(Mandatory = $true)]
@@ -446,23 +446,26 @@ function New-FinOpsCostExport
         }
 
         # Create/update export
-        $createResponse = Invoke-Rest -Method PUT -Uri $uri -Body $properties @commandDetails
-        if ($createResponse.Failure)
+        if ($PSCmdlet.ShouldProcess($Name, 'Create cost export'))
         {
-            Write-Error "Unable to create export $Name in scope $Scope. Error: $($createResponse.Content.error.message) ($($createResponse.Content.error.code))" -ErrorAction Stop
-            return
-        }
+            $createResponse = Invoke-Rest -Method PUT -Uri $uri -Body $properties @commandDetails
+            if ($createResponse.Failure)
+            {
+                Write-Error "Unable to create export $Name in scope $Scope. Error: $($createResponse.Content.error.message) ($($createResponse.Content.error.code))" -ErrorAction Stop
+                return
+            }
 
-        # Run now if requested
-        if ($Backfill -gt 0 -and $OneTime -eq $false)
-        {
-            Start-FinOpsCostExport -Name $Name -Scope $Scope -Backfill $Backfill
-        }
-        elseif ($Execute -eq $true -or $OneTime -eq $true)
-        {
-            Start-FinOpsCostExport -Name $Name -Scope $Scope
-        }
+            # Run now if requested
+            if ($Backfill -gt 0 -and $OneTime -eq $false)
+            {
+                Start-FinOpsCostExport -Name $Name -Scope $Scope -Backfill $Backfill
+            }
+            elseif ($Execute -eq $true -or $OneTime -eq $true)
+            {
+                Start-FinOpsCostExport -Name $Name -Scope $Scope
+            }
 
-        return (Get-FinOpsCostExport -Name $Name -Scope $Scope -ApiVersion $ApiVersion)
+            return (Get-FinOpsCostExport -Name $Name -Scope $Scope -ApiVersion $ApiVersion)
+        }
     }
 }

src/powershell/Public/Remove-FinOpsCostExport.ps1

@@ -1,4 +1,4 @@
-# Copyright (c) Microsoft Corporation.
+# Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 
 <#

src/powershell/Public/Remove-FinOpsHub.ps1

@@ -103,8 +103,8 @@ function Remove-FinOpsHub
         }
 
         # List all resources to be deleted
-        Write-Host "The following resources will be deleted:"
-        $resources | ForEach-Object { Write-Host "- $($_.ResourceId)" }
+        Write-Information "The following resources will be deleted:"
+        $resources | ForEach-Object { Write-Information "- $($_.ResourceId)" }
 
         # Prompt the user for confirmation
         if ($PSCmdlet.ShouldProcess($Name, 'DeleteFinOpsHub'))
@@ -165,7 +165,7 @@ function Remove-FinOpsHub
                     # Delete the resource
                     Write-Verbose -Message "Deleting resource: $($resource.Name)"
                     Remove-AzResource -ResourceId $resource.ResourceId -Force -ErrorAction Stop
-                    Write-Host "Deleted resource: $($resource.Name)"
+                    Write-Information "Deleted resource: $($resource.Name)"
                 }
                 catch
                 {

src/powershell/Public/Start-FinOpsCostExport.ps1

@@ -1,4 +1,4 @@
-# Copyright (c) Microsoft Corporation.
+# Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 
 <#
@@ -53,7 +53,7 @@
 function Start-FinOpsCostExport
 {
     [OutputType([bool])]
-    [cmdletBinding()]
+    [CmdletBinding(SupportsShouldProcess)]
     param
     (
         [Parameter(Mandatory = $true)]
@@ -146,6 +146,12 @@ function Start-FinOpsCostExport
     {
         Write-Verbose "Exporting $($StartDate) - $($EndDate)"
     }
+
+    if (-not $PSCmdlet.ShouldProcess($Name, 'Run cost export'))
+    {
+        return $false
+    }
+
     do
     {
         # Report progress
@@ -173,15 +179,15 @@ function Start-FinOpsCostExport
                 $firstDay = $StartDate
                 $lastDay = $EndDate
             }
-            
+
             # Ensure end date is not in the future
             $today = (Get-Date).ToUniversalTime().Date
             if ($lastDay -ge $today)
             {
                 Write-Verbose "Adjusting end date to yesterday as it cannot be in the future."
                 $lastDay = $today.AddDays(-1)
             }
-            
+
             $body = @{ timePeriod = @{ from = $firstDay.ToString("yyyy-MM-dd'T'HH:mm:ss'Z'"); to = $lastDay.ToString("yyyy-MM-dd'T'HH:mm:ss'Z'") } }
             Write-Verbose "Executing $($firstDay.ToString("yyyy-MM-dd'T'HH:mm:ss'Z'")) to $($lastDay.ToString("yyyy-MM-dd'T'HH:mm:ss'Z'")) export $runpath"
         }
@@ -224,7 +230,7 @@ function Start-FinOpsCostExport
         {
             # If not retrying, then track the success
             $success = $success -and $response.Success
-            
+
             # Only increment month if not throttled
             $monthToExport += 1
         }

src/powershell/Tests/Initialize-Tests.ps1

@@ -5,11 +5,11 @@ Remove-Module FinOpsToolkit -ErrorAction SilentlyContinue
 Import-Module -FullyQualifiedName "$PSScriptRoot/../FinOpsToolkit.psm1"
 
 BeforeAll {
-    [Diagnostics.CodeAnalysis.SuppressMessage("PSAvoidGlobalVars", "", Justification = "Used for testing only")]
-    param()
-
     # Bring the Monitor functions in to simplify debugging
     . "$PSScriptRoot/../../scripts/Monitor.ps1"
+}
 
-    $global:ftk_InitializeTests_Hubs_RequiredRPs = @( 'Microsoft.CostManagementExports', 'Microsoft.EventGrid' )
+function Get-FinOpsHubRequiredResourceProvider
+{
+    return @( 'Microsoft.CostManagementExports', 'Microsoft.EventGrid' )
 }

src/powershell/Tests/Integration/Hubs.Tests.ps1

@@ -6,7 +6,7 @@
 Describe 'Hubs' {
     BeforeDiscovery {
         [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')]
-        $requiredRPs = $global:ftk_InitializeTests_Hubs_RequiredRPs
+        $requiredRPs = Get-FinOpsHubRequiredResourceProvider
 
         # TODO: Automatically validate the last 3 versions only
         # TODO: Automatically validate the last 3 versions only
@@ -17,7 +17,7 @@ Describe 'Hubs' {
     BeforeAll {
         # Must be duplicated because pre-discovery vars aren't accessible
         [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')]
-        $requiredRPs = $global:ftk_InitializeTests_Hubs_RequiredRPs
+        $requiredRPs = Get-FinOpsHubRequiredResourceProvider
     }
 
     Context 'Register-FinOpsHubProviders' {

src/powershell/Tests/Unit/Deploy-FinOpsHub.Tests.ps1

@@ -8,7 +8,9 @@ InModuleScope 'FinOpsToolkit' {
         BeforeAll {
             function Get-AzResourceGroup {}
             function New-AzResourceGroup {}
-            function New-AzResourceGroupDeployment {}
+            function New-AzResourceGroupDeployment {
+                param($TemplateFile, $TemplateParameterObject, $ResourceGroupName)
+            }
 
             [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseDeclaredVarsMoreThanAssignments", "")]
             $hubName = 'ftk-test-Deploy-FinOpsHub'
@@ -114,6 +116,7 @@ InModuleScope 'FinOpsToolkit' {
                 Mock -CommandName 'Get-AzResourceGroup' -MockWith { return @{ ResourceGroupName = $rgName } }
                 Mock -CommandName 'New-AzResourceGroup'
                 Mock -CommandName 'Save-FinOpsHubTemplate'
+                Mock -CommandName 'Initialize-FinOpsHubDeployment'
             }
 
             It 'Should throw if template file is not found' {

src/powershell/Tests/Unit/New-FinOpsCostExport.Tests.ps1

@@ -270,7 +270,7 @@ InModuleScope 'FinOpsToolkit' {
 
                 # Assert
                 Assert-MockCalled -ModuleName FinOpsToolkit -CommandName 'Invoke-Rest' -Times 1 -ParameterFilter {
-                    $Body.properties.deliveryInfo.destination.rootFolderPath -eq ($scopeWithColons -replace ':','-')
+                    $Body.properties.deliveryInfo.destination.rootFolderPath -eq (($scopeWithColons -replace ':','-').Trim('/'))
                 }
             }
 
@@ -308,7 +308,7 @@ InModuleScope 'FinOpsToolkit' {
 
                 # Assert
                 Assert-MockCalled -ModuleName FinOpsToolkit -CommandName 'Invoke-Rest' -Times 1 -ParameterFilter {
-                    $Body.properties.deliveryInfo.destination.rootFolderPath -eq $scopeWithoutColons
+                    $Body.properties.deliveryInfo.destination.rootFolderPath -eq $scopeWithoutColons.Trim('/')
                 }
             }
         }