ActiveDirectoryDsc: Fix PowerShell Script Formatting (#545)

- ActiveDirectoryDsc - Fix PowerShell script file formatting and culture string alignment. - Add the `pipelineIndentationStyle` setting to the Visual Studio Code settings file.
dsccommunity · Jan 13, 2020 · 6734fa4 · 6734fa4
1 parent 4b2be8e
commit 6734fa4
Show file tree

Hide file tree

Showing 44 changed files with 651 additions and 640 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -7,6 +7,7 @@
     "powershell.codeFormatting.whitespaceAroundOperator": true,
     "powershell.codeFormatting.whitespaceAfterSeparator": true,
     "powershell.codeFormatting.ignoreOneLineBlock": false,
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
     "powershell.codeFormatting.preset": "Custom",
     "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": true,

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,6 +33,8 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)
   - Updated PowerShell help files.
   - Updated Wiki link in README.md.
   - Remove verbose parameters from unit tests.
+  - Fix PowerShell script file formatting and culture string alignment.
+  - Add the `pipelineIndentationStyle` setting to the Visual Studio Code settings file.
 
 ### Fixed
 

diff --git a/Tests/Unit/ActiveDirectoryDsc.Common.Tests.ps1 b/Tests/Unit/ActiveDirectoryDsc.Common.Tests.ps1
diff --git a/Tests/Unit/MSFT_ADDomain.Tests.ps1 b/Tests/Unit/MSFT_ADDomain.Tests.ps1
@@ -49,8 +49,8 @@ try
         )
 
         $mockDefaultParameters = @{
-            DomainName = $mockDomainName
-            Credential = $mockAdministratorCredential
+            DomainName                    = $mockDomainName
+            Credential                    = $mockAdministratorCredential
             SafeModeAdministratorPassword = $mockAdministratorCredential
         }
 
@@ -130,17 +130,17 @@ try
                 BeforeAll {
                     Mock -CommandName Get-ADDomain -MockWith {
                         [PSObject] @{
-                            Forest     = $mockDomainName
-                            DomainMode = $mgmtDomainMode
+                            Forest       = $mockDomainName
+                            DomainMode   = $mgmtDomainMode
                             ParentDomain = $mockDomainName
-                            NetBIOSName = $mockNetBiosName
-                            DnsRoot = $mockDnsRoot
+                            NetBIOSName  = $mockNetBiosName
+                            DnsRoot      = $mockDnsRoot
                         }
                     }
 
                     Mock -CommandName Get-ADForest -MockWith {
                         [PSObject] @{
-                            Name = $mockDomainName
+                            Name       = $mockDomainName
                             ForestMode = $mgmtForestMode
                         }
                     }
@@ -396,19 +396,19 @@ try
             )
 
             $mockDefaultParameters = @{
-                Credential = $mockAdministratorCredential
+                Credential                    = $mockAdministratorCredential
                 SafeModeAdministratorPassword = $mockAdministratorCredential
             }
 
             $stubDomain = @{
-                DnsRoot = $mockDomainName
+                DnsRoot           = $mockDomainName
                 DomainNetBIOSName = $correctDomainNetBIOSName
             }
 
             # Get-TargetResource returns the domain FQDN for .DomainName
             $stubChildDomain = @{
-                DnsRoot = "$correctChildDomainName.$parentDomainName"
-                ParentDomainName = $parentDomainName
+                DnsRoot           = "$correctChildDomainName.$parentDomainName"
+                ParentDomainName  = $parentDomainName
                 DomainNetBIOSName = $correctDomainNetBIOSName
             }
 
@@ -487,26 +487,26 @@ try
             )
 
             $newForestParams = @{
-                DomainName = $testDomainName
-                Credential = $mockAdministratorCredential
+                DomainName                    = $testDomainName
+                Credential                    = $mockAdministratorCredential
                 SafeModeAdministratorPassword = $testSafemodeCredential
             }
 
             $newDomainParams = @{
-                DomainName = $testDomainName
-                ParentDomainName = $testParentDomainName
-                Credential = $mockAdministratorCredential
+                DomainName                    = $testDomainName
+                ParentDomainName              = $testParentDomainName
+                Credential                    = $mockAdministratorCredential
                 SafeModeAdministratorPassword = $testSafemodeCredential
             }
 
             $stubTargetResource = @{
-                DomainName = $testDomainName
-                ParentDomainName = $testParentDomainName
+                DomainName        = $testDomainName
+                ParentDomainName  = $testParentDomainName
                 DomainNetBIOSName = $testDomainNetBIOSNameName
-                ForestName = $testParentDomainName
-                ForestMode = $testDomainForestMode
-                DomainMode = $testDomainForestMode
-                DomainExist = $false
+                ForestName        = $testParentDomainName
+                ForestMode        = $testDomainForestMode
+                DomainMode        = $testDomainForestMode
+                DomainExist       = $false
             }
 
             Mock -CommandName Get-TargetResource -MockWith { return $stubTargetResource }
@@ -517,7 +517,7 @@ try
 
                 Set-TargetResource @newForestParams
 
-                Assert-MockCalled -CommandName Install-ADDSForest -ParameterFilter  { $DomainName -eq $testDomainName } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSForest -ParameterFilter { $DomainName -eq $testDomainName } -Scope It
             }
 
             It 'Calls "Install-ADDSForest" with "SafeModeAdministratorPassword" when creating forest' {
@@ -533,15 +533,15 @@ try
 
                 Set-TargetResource @newForestParams -DnsDelegationCredential $testDelegationCredential
 
-                Assert-MockCalled -CommandName Install-ADDSForest -ParameterFilter  { $DnsDelegationCredential -eq $testDelegationCredential } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSForest -ParameterFilter { $DnsDelegationCredential -eq $testDelegationCredential } -Scope It
             }
 
             It 'Calls "Install-ADDSForest" with "CreateDnsDelegation" when creating forest, if specified' {
                 Mock -CommandName Install-ADDSForest -ParameterFilter { $CreateDnsDelegation -eq $true }
 
                 Set-TargetResource @newForestParams -DnsDelegationCredential $testDelegationCredential
 
-                Assert-MockCalled -CommandName Install-ADDSForest -ParameterFilter  { $CreateDnsDelegation -eq $true } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSForest -ParameterFilter { $CreateDnsDelegation -eq $true } -Scope It
             }
 
             It 'Calls "Install-ADDSForest" with "DatabasePath" when creating forest, if specified' {
@@ -602,23 +602,23 @@ try
 
                 Set-TargetResource @newDomainParams
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $NewDomainName -eq $testDomainName } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $NewDomainName -eq $testDomainName } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "ParentDomainName" when creating child domain' {
                 Mock -CommandName Install-ADDSDomain -ParameterFilter { $ParentDomainName -eq $testParentDomainName }
 
                 Set-TargetResource @newDomainParams
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $ParentDomainName -eq $testParentDomainName } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $ParentDomainName -eq $testParentDomainName } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "DomainType" when creating child domain' {
                 Mock -CommandName Install-ADDSDomain -ParameterFilter { $DomainType -eq 'ChildDomain' }
 
                 Set-TargetResource @newDomainParams
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $DomainType -eq 'ChildDomain' } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $DomainType -eq 'ChildDomain' } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "SafeModeAdministratorPassword" when creating child domain' {
@@ -634,31 +634,31 @@ try
 
                 Set-TargetResource @newDomainParams
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $ParentDomainName -eq $testParentDomainName } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $ParentDomainName -eq $testParentDomainName } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "ParentDomainName" when creating child domain' {
                 Mock -CommandName Install-ADDSDomain -ParameterFilter { $ParentDomainName -eq $testParentDomainName }
 
                 Set-TargetResource @newDomainParams
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $ParentDomainName -eq $testParentDomainName } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $ParentDomainName -eq $testParentDomainName } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "DnsDelegationCredential" when creating child domain, if specified' {
                 Mock -CommandName Install-ADDSDomain -ParameterFilter { $DnsDelegationCredential -eq $testDelegationCredential }
 
                 Set-TargetResource @newDomainParams -DnsDelegationCredential $testDelegationCredential
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $DnsDelegationCredential -eq $testDelegationCredential } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $DnsDelegationCredential -eq $testDelegationCredential } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "CreateDnsDelegation" when creating child domain, if specified' {
                 Mock -CommandName Install-ADDSDomain -ParameterFilter { $CreateDnsDelegation -eq $true }
 
                 Set-TargetResource @newDomainParams -DnsDelegationCredential $testDelegationCredential
 
-                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter  { $CreateDnsDelegation -eq $true } -Scope It
+                Assert-MockCalled -CommandName Install-ADDSDomain -ParameterFilter { $CreateDnsDelegation -eq $true } -Scope It
             }
 
             It 'Calls "Install-ADDSDomain" with "DatabasePath" when creating child domain, if specified' {