Get PSScriptAnalyzer clean again (#180)

Somehow a number of PSScriptAnalyzer issues snuck in. This fixes them. The main PSScriptAnalyzer issues needing to be fixed were: * `PSReviewUnusedParameter` - This one came up a lot due to our heavy usage of `Resolve-RepositoryElements` and `Resolve-ParameterWithDefaultConfigurationValue` which both end up referencing their parameters by grabbing them off the stack. That means that `NoStatus` and `Uri` are frequently never directly referenced. So, exceptions were added. There were two cases (in GitHubAnalytics) where there was a false positive due to PowerShell/PSScriptAnalyzer#1472 * `PSUseProcessBlockForPipelineCommand` - We had a number of functions that took pipeline input, but didn't actuall use the `process` block. This actually caught a bug with `Group-GitHubIssue` and `Group-GitHubPullRequest`. Added correct `process` block usage for most of the functions, but removed pipeline support for those where it didn't actually make sense anymore. * `PSUseDeclaredVarsMoreThanAssignments` - These are false positives in the Pester tests due to the usage of `BeforeAll`. There wasn't an obvious way to use `SuppressMessageAttribute` in the Pester test, so I used a hacky workaround to "use" the variable in the `BeforeAll` block. I could have added the suppression to the top of the file, but I still want to catch real issues in those files later. * `PSAvoidOverwritingBuiltInCmdlets` - It turns out that there's a bug with PSDesiredStateConfiguration in PS Core 6.1.0 where it was exporting internal functions. This was thus a false-postive flag for Write-Log. See PowerShell/PowerShell#7209 for more info. Also, it turns out that `Group-GitHubPullRequest` hadn't actually been exported, so I fixed that too.
microsoft · May 26, 2020 · b7e1ea1 · b7e1ea1
1 parent 93689d6
commit b7e1ea1
Show file tree

Hide file tree

Showing 24 changed files with 330 additions and 128 deletions.
diff --git a/GitHubAnalytics.ps1 b/GitHubAnalytics.ps1
@@ -37,6 +37,7 @@ function Group-GitHubIssue
         SupportsShouldProcess,
         DefaultParameterSetName='Weekly')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="DateType due to PowerShell/PSScriptAnalyzer#1472")]
     param
     (
         [Parameter(
@@ -55,41 +56,68 @@ function Group-GitHubIssue
         [string] $DateType = 'Created'
     )
 
-    Write-InvocationLog
-
-    if ($PSCmdlet.ParameterSetName -eq 'Weekly')
+    begin
     {
-        $totalIssues = 0
-        $weekDates = Get-WeekDate -Weeks $Weeks
-        $endOfWeek = Get-Date
+        Write-InvocationLog
 
-        foreach ($week in $weekDates)
+        if ($PSCmdlet.ParameterSetName -eq 'Weekly')
         {
-            $filteredIssues = @($Issue | Where-Object {
-                (($DateType -eq 'Created') -and ($_.created_at -ge $week) -and ($_.created_at -le $endOfWeek)) -or
-                (($DateType -eq 'Closed') -and ($_.closed_at -ge $week) -and ($_.closed_at -le $endOfWeek))
-            })
-
-            $endOfWeek = $week
-            $count = $filteredIssues.Count
-            $totalIssues += $count
-
-            Write-Output -InputObject ([PSCustomObject]([ordered]@{
-                'WeekStart' = $week
-                'Count' = $count
-                'Issues' = $filteredIssues
+            $weekDates = Get-WeekDate -Weeks $Weeks
+
+            $result = [ordered]@{}
+            foreach ($week in $weekDates)
+            {
+                $result[$week] = ([PSCustomObject]([ordered]@{
+                    'WeekStart' = $week
+                    'Count' = 0
+                    'Issues' = @()
+                }))
+            }
+
+            $result['total'] = ([PSCustomObject]([ordered]@{
+                'WeekStart' = 'total'
+                'Count' = 0
+                'Issues' = @()
             }))
         }
+    }
 
-        Write-Output -InputObject ([PSCustomObject]([ordered]@{
-            'WeekStart' = 'total'
-            'Count' = $totalIssues
-            'Issues' = $Issue
-        }))
+    process
+    {
+        if ($PSCmdlet.ParameterSetName -eq 'Weekly')
+        {
+            $endOfWeek = Get-Date
+            foreach ($week in $weekDates)
+            {
+                $filteredIssues = @($Issue | Where-Object {
+                    (($DateType -eq 'Created') -and ($_.created_at -ge $week) -and ($_.created_at -le $endOfWeek)) -or
+                    (($DateType -eq 'Closed') -and ($_.closed_at -ge $week) -and ($_.closed_at -le $endOfWeek))
+                })
+
+                $endOfWeek = $week
+
+                $result[$week].Issues += $filteredIssues
+                $result[$week].Count += ($filteredIssues.Count)
+
+                $result['total'].Issues += $filteredIssues
+                $result['total'].Count += ($filteredIssues.Count)
+            }
+        }
+        else
+        {
+            Write-Output -InputObject $Issue
+        }
     }
-    else
+
+    end
     {
-        Write-Output -InputObject $Issue
+        if ($PSCmdlet.ParameterSetName -eq 'Weekly')
+        {
+            foreach ($entry in $result.Values.GetEnumerator())
+            {
+                Write-Output -InputObject $entry
+            }
+        }
     }
 }
 
@@ -130,6 +158,7 @@ function Group-GitHubPullRequest
         SupportsShouldProcess,
         DefaultParameterSetName='Weekly')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="DateType due to PowerShell/PSScriptAnalyzer#1472")]
     param
     (
         [Parameter(
@@ -148,41 +177,68 @@ function Group-GitHubPullRequest
         [string] $DateType = 'Created'
     )
 
-    Write-InvocationLog
-
-    if ($PSCmdlet.ParameterSetName -eq 'Weekly')
+    begin
     {
-        $totalPullRequests = 0
-        $weekDates = Get-WeekDate -Weeks $Weeks
-        $endOfWeek = Get-Date
+        Write-InvocationLog
 
-        foreach ($week in $weekDates)
+        if ($PSCmdlet.ParameterSetName -eq 'Weekly')
         {
-            $filteredPullRequests = @($PullRequest | Where-Object {
-                (($DateType -eq 'Created') -and ($_.created_at -ge $week) -and ($_.created_at -le $endOfWeek)) -or
-                (($DateType -eq 'Merged') -and ($_.merged_at -ge $week) -and ($_.merged_at -le $endOfWeek))
-            })
-
-            $endOfWeek = $week
-            $count = $filteredPullRequests.Count
-            $totalPullRequests += $count
-
-            Write-Output -InputObject ([PSCustomObject]([ordered]@{
-                'WeekStart' = $week
-                'Count' = $count
-                'PullRequests' = $filteredPullRequests
+            $weekDates = Get-WeekDate -Weeks $Weeks
+
+            $result = [ordered]@{}
+            foreach ($week in $weekDates)
+            {
+                $result[$week] = ([PSCustomObject]([ordered]@{
+                    'WeekStart' = $week
+                    'Count' = 0
+                    'PullRequests' = @()
+                }))
+            }
+
+            $result['total'] = ([PSCustomObject]([ordered]@{
+                'WeekStart' = 'total'
+                'Count' = 0
+                'PullRequests' = @()
             }))
         }
+    }
 
-        Write-Output -InputObject ([PSCustomObject]([ordered]@{
-            'WeekStart' = 'total'
-            'Count' = $totalPullRequests
-            'PullRequests' = $PullRequest
-        }))
+    process
+    {
+        if ($PSCmdlet.ParameterSetName -eq 'Weekly')
+        {
+            $endOfWeek = Get-Date
+            foreach ($week in $weekDates)
+            {
+                $filteredPullRequests = @($PullRequest | Where-Object {
+                    (($DateType -eq 'Created') -and ($_.created_at -ge $week) -and ($_.created_at -le $endOfWeek)) -or
+                    (($DateType -eq 'Merged') -and ($_.merged_at -ge $week) -and ($_.merged_at -le $endOfWeek))
+                })
+
+                $endOfWeek = $week
+
+                $result[$week].PullRequests += $filteredPullRequests
+                $result[$week].Count += ($filteredPullRequests.Count)
+
+                $result['total'].PullRequests += $filteredPullRequests
+                $result['total'].Count += ($filteredPullRequests.Count)
+            }
+        }
+        else
+        {
+            Write-Output -InputObject $PullRequest
+        }
     }
-    else
+
+    end
     {
-        Write-Output -InputObject $PullRequest
+        if ($PSCmdlet.ParameterSetName -eq 'Weekly')
+        {
+            foreach ($entry in $result.Values.GetEnumerator())
+            {
+                Write-Output -InputObject $entry
+            }
+        }
     }
 }
 

diff --git a/GitHubAssignees.ps1 b/GitHubAssignees.ps1
@@ -41,6 +41,7 @@ function Get-GitHubAssignee
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -128,6 +129,7 @@ function Test-GitHubAssignee
         DefaultParameterSetName='Elements')]
         [OutputType([bool])]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -228,6 +230,7 @@ function New-GithubAssignee
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -330,6 +333,7 @@ function Remove-GithubAssignee
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,

diff --git a/GitHubBranches.ps1 b/GitHubBranches.ps1
@@ -55,6 +55,7 @@ function Get-GitHubRepositoryBranch
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     [Alias('Get-GitHubBranch')]
     param(
         [Parameter(ParameterSetName='Elements')]

diff --git a/GitHubComments.ps1 b/GitHubComments.ps1
@@ -244,6 +244,7 @@ function New-GitHubComment
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -355,6 +356,7 @@ function Set-GitHubComment
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -456,6 +458,7 @@ function Remove-GitHubComment
         DefaultParameterSetName='Elements')]
     [Alias('Delete-GitHubComment')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,

diff --git a/GitHubCore.ps1 b/GitHubCore.ps1
@@ -612,6 +612,7 @@ function Invoke-GHRestMethodMultipleResult
 #>
     [CmdletBinding(SupportsShouldProcess)]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     [OutputType([Object[]])]
     param(
         [Parameter(Mandatory)]

diff --git a/GitHubIssues.ps1 b/GitHubIssues.ps1
@@ -378,6 +378,7 @@ function Get-GitHubIssueTimeline
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -861,6 +862,7 @@ function Unlock-GitHubIssue
     SupportsShouldProcess,
     DefaultParameterSetName='Elements')]
 [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
 param(
     [Parameter(ParameterSetName='Elements')]
     [string] $OwnerName,

diff --git a/GitHubLabels.ps1 b/GitHubLabels.ps1
@@ -206,6 +206,7 @@ function New-GitHubLabel
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -320,6 +321,7 @@ function Remove-GitHubLabel
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     [Alias('Delete-GitHubLabel')]
     param(
         [Parameter(ParameterSetName='Elements')]
@@ -551,6 +553,7 @@ function Set-GitHubLabel
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -662,6 +665,7 @@ function Add-GitHubIssueLabel
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(Mandatory, ParameterSetName='Elements')]
         [string] $OwnerName,
@@ -763,6 +767,7 @@ function Set-GitHubIssueLabel
         SupportsShouldProcess,
         DefaultParameterSetName='Elements')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(ParameterSetName='Elements')]
         [string] $OwnerName,

diff --git a/GitHubMilestones.ps1 b/GitHubMilestones.ps1
@@ -506,6 +506,7 @@ function Remove-GitHubMilestone
         DefaultParameterSetName='Elements')]
     [Alias('Delete-GitHubMilestone')]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="One or more parameters (like NoStatus) are only referenced by helper methods which get access to it from the stack via Get-Variable -Scope 1.")]
     param(
         [Parameter(Mandatory, ParameterSetName='Elements')]
         [string] $OwnerName,