PowerShell / PowerShell/PSScriptAnalyzer

Invalid reformatting when docker command executed directly from PS

Open
#2,094 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Formatter
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Steps to reproduce

$def = @"
docker build --secret id=NUGET_USER,env=NUGET_USER
"@

Invoke-Formatter -ScriptDefinition $def

Expected behavior

Unchanged:
docker build --secret id=NUGET_USER,env=NUGET_USER

Actual behavior

A whitespace added:
docker build --secret id=NUGET_USER, env=NUGET_USER

Image

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.4.7
PSEdition                      Core
GitCommitId                    7.4.7
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

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

1.24.0 # (latest from `main`, imported by `Import-Module .\out\PSScriptAnalyzer\1.24.0\PSScriptAnalyzer.psd1`

Possible tests to repro:

    Context "When a comma is not followed by a space" {
        It "Should not find violation if there are no whitespaces after a comma for a docker command parameter" {
            $def = 'docker build --secret id=NUGET_USER,env=NUGET_USER'
            Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings | Should -Be $null
        }
   }

    Context "When non-PS commands are embedded" {
        It "Docker parameters are kept intact" {
            $def = @"
docker build -t local.rgm-service.image . -f BaseMonitor.Dockerfile --secret id=NUGET_USER,env=NUGET_USER --secret id=NUGET_TOKEN,env=NUGET_TOKEN
"@
            Invoke-Formatter -ScriptDefinition $def | Should -Be $def
        }
    }

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 with the supplied Invoke-Formatter reproduction and the two proposed Pester test contexts for Docker commands embedded in PowerShell. Trace how formatting handles the comma in the Docker --secret argument. Done means the command remains unchanged and the proposed tests pass.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.