PowerShell / PowerShell/PSScriptAnalyzer

Invalid reformatting when docker command executed directly from PS

Aperta
#2,094 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Area - Formatter
Lingua principale
C#
Stelle
2.2k
Fork
414
Merge medio
13h 1m
PR unite (30g)
2

Descrizione

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
        }
    }

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con la riproduzione fornita di Invoke-Formatter e i due contesti di test Pester proposti per i comandi Docker incorporati in PowerShell. Traccia il modo in cui la formattazione gestisce la virgola nell’argomento --secret di Docker. Il lavoro è completato quando il comando rimane invariato e i test proposti hanno esito positivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
docker, powershell
Ambito
tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.