quick mods for improving compliance with psscriptanalyzer

Author: exactmike

Functions/Get-JSMRequiredJob.ps1

@@ -34,7 +34,7 @@ function Invoke-JSMProcessingLoop
     {
         $message = 'Invoke-JobProcessingLoop: Get-RequiredJob'
         Write-Verbose -Message $message
-        $RequiredJobs = Get-JSMRequiredJob -Settings $Settings -JobDefinitions $jobDefinitions -ErrorAction Stop
+        $RequiredJobs = Get-JSMRequiredJob -Settings $Settings -JobDefinition $jobDefinitions -ErrorAction Stop
         $RequiredJobsLookup = @{}
         foreach ($j in $RequiredJobs) {$RequiredJobsLookup.$($j.name) = $true}
         Write-Verbose -Message $message

Functions/Invoke-JSMProcessingLoop.ps1

@@ -10,7 +10,6 @@ function Test-JSMJobCondition
         $ConditionValuesObject
         ,
         [Parameter(Mandatory)]
-        [ValidateSet($true,$false)]
         [bool]$TestFor
     )
     switch ($TestFor)

Functions/Set-JSMPeriodicReportSettings.ps1

@@ -2,4 +2,5 @@
 
 - [x] when restarting a job processing loop some start/end times are lost on jobs.  Need to detangle requiredjobs and definedjobs in invoke-jsmprocessingloop
 - [ ] make RequiredJobs a hashtable just like the other *jobs variables
-- [x] fix the notification settings
+- [x] fix the notification settings
+- [ ] make set-jsmperiodicreportsetting leave current values in place and only set what is specified each time it is used

Functions/Test-JSMJobCondition.ps1

@@ -100,6 +100,7 @@ FunctionsToExport = @(
     'Test-JSMStopWatchPeriod'
     'New-JSMProcessingLoopStatusEntry'
     'Get-JSMProcessingLoopStatusEntry'
+)
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 #CmdletsToExport = '*'

Issues.md

@@ -19,6 +19,7 @@
     # for a few rules you wish to "exclude".  Note: if a rule is in both IncludeRules
     # and ExcludeRules, the rule will be excluded.
     #ExcludeRules = @('PSAvoidUsingWriteHost')
+    ExcludeRules = @('PSUseShouldProcessForStateChangingFunctions')
 
     # You can use the following entry to supply parameters to rules that take parameters.
     # For instance, the PSAvoidUsingCmdletAliases rule takes a whitelist for aliases you

JobSetManager.psd1

@@ -6,7 +6,7 @@ Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
         [object[]]$params = (Get-ChildItem "function:\$CommandName").Parameters.Keys
         $knownParameters = 'JobName','Message','Status','PassThru'
         $paramCount = $knownParameters.Count
-        It "Should contain our specific parameters" {
+        It "Should contain specific parameters" {
             ( (Compare-Object -ReferenceObject $knownParameters -DifferenceObject $params -IncludeEqual | Where-Object SideIndicator -eq "==").Count ) | Should Be $paramCount
         }
         It "Should only contain $paramCount parameters" {
@@ -30,7 +30,7 @@ Describe "$commandname Integration Tests" -Tags "IntegrationTests" {
             $Entry.status | Should Be $true
         }
 
-        It "Increments the EntryID" {
+        It "Increments and returns the EntryID" {
             $NextEntry = New-JSMProcessingLoopStatusEntry -JobName 'Job1' -Message 'Doing Something with or to Job1' -Status $false -PassThru
             $Entry.EntryID -lt $NextEntry.EntryID | Should Be $true
         }