PowerShell / PowerShell/PSScriptAnalyzer

PSPossibleIncorrectComparisonWithNull not checked inside DSC Configurations

Open
#1,745 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Configuration Area - DSC Issue - Bug Up-for-Grabs
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Steps to reproduce

if (@() -eq $null) { 'true' } else { 'false' }
if (@() -ne $null) { 'true' } else { 'false' }

Configuration Test
{
    if (@() -eq $null) { 'true' } else { 'false' }
    if (@() -ne $null) { 'true' } else { 'false' }
}

Expected behavior

All 4 comparisons produce Warnings

Actual behavior

# Only the first two comparisons produce Warnings

RuleName                              Severity ScriptName Line Message
--------                              -------- ---------- ---- -------
PSPossibleIncorrectComparisonWithNull Warning  test.ps1   1    $null should be on the left side of equality comparisons.
PSPossibleIncorrectComparisonWithNull Warning  test.ps1   2    $null should be on the left side of equality comparisons.

If an unexpected error was thrown then please report the full error details using e.g. $error[0] | Select-Object *

Environment data

> $PSVersionTable
Name                           Value
----                           -----
PSVersion                      5.1.18362.1171
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.18362.1171
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.20.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the example with PSScriptAnalyzer 1.20.0 and compare rule behavior for the two top-level comparisons with the two comparisons inside the DSC Configuration. Done means PSPossibleIncorrectComparisonWithNull warns for all four comparisons, including those inside the configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.