SqlServerDsc: clean up code in commands (#1936)

- SqlServerDsc - Fix style changes in all private and public commands.
dsccommunity · May 9, 2023 · f9bde8a · f9bde8a
1 parent fccdb73
commit f9bde8a
Show file tree

Hide file tree

Showing 16 changed files with 66 additions and 63 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -71,6 +71,7 @@
         "Dbcc",
         "creplace",
         "dbatools",
+        "db_datareader",
         "fastbuild"
     ],
     "cSpell.ignorePaths": [

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,8 +20,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Re-enable integration tests for dbatools.
   - Bumped dbatools to v2.0.1 for the integration tests.
 
-### fixed
+### Fixed
 
+- SqlServerDsc
+  - Fix style changes in all private and public commands.
 - `Import-SqlDscPreferredModule`
   - Now when parameter `Force` is passed the command correctly invoke
     `Get-SqlDscPreferredModule` using the parameter `Refresh`.

diff --git a/source/Private/Assert-SetupActionProperties.ps1 b/source/Private/Assert-SetupActionProperties.ps1
@@ -26,7 +26,7 @@
 #>
 function Assert-SetupActionProperties
 {
-    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification='The command uses plural noun to describe that it contain a collection of asserts.')]
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification = 'The command uses plural noun to describe that it contain a collection of asserts.')]
     [CmdletBinding()]
     param
     (
@@ -54,7 +54,7 @@ function Assert-SetupActionProperties
 
     $assertRequiredCommandParameterParameters = @{
         BoundParameterList = $Property
-        RequiredParameter = $assertParameters
+        RequiredParameter  = $assertParameters
         IfParameterPresent = $assertParameters
     }
 

diff --git a/source/Private/Invoke-SetupAction.ps1 b/source/Private/Invoke-SetupAction.ps1
@@ -526,13 +526,13 @@ function Invoke-SetupAction
 
         [Parameter(ParameterSetName = 'UsingConfigurationFile', Mandatory = $true)]
         [ValidateScript({
-            if (-not (Test-Path -Path $_))
-            {
-                throw $script:localizedData.Server_ConfigurationFileNotFound
-            }
+                if (-not (Test-Path -Path $_))
+                {
+                    throw $script:localizedData.Server_ConfigurationFileNotFound
+                }
 
-            return $true
-        })]
+                return $true
+            })]
         [System.String]
         $ConfigurationFile,
 
@@ -565,13 +565,13 @@ function Invoke-SetupAction
 
         [Parameter(Mandatory = $true)]
         [ValidateScript({
-            if (-not (Test-Path -Path (Join-Path -Path $_ -ChildPath 'setup.exe')))
-            {
-                throw $script:localizedData.Server_MediaPathNotFound
-            }
+                if (-not (Test-Path -Path (Join-Path -Path $_ -ChildPath 'setup.exe')))
+                {
+                    throw $script:localizedData.Server_MediaPathNotFound
+                }
 
-            return $true
-        })]
+                return $true
+            })]
         [System.String]
         $MediaPath,
 
@@ -1479,12 +1479,12 @@ function Invoke-SetupAction
         See issue https://github.com/dsccommunity/SqlServerDsc/issues/1254.
     #>
     $boundParameterName.Where( { $_ -in $pathParameter } ).ForEach({
-        # Must not change paths that reference a root directory (they are handle differently later)
-        if ($PSBoundParameters.$_ -notmatch '^[a-zA-Z]:\\$')
-        {
-            $PSBoundParameters.$_ = $PSBoundParameters.$_.TrimEnd('\')
-        }
-    })
+            # Must not change paths that reference a root directory (they are handle differently later)
+            if ($PSBoundParameters.$_ -notmatch '^[a-zA-Z]:\\$')
+            {
+                $PSBoundParameters.$_ = $PSBoundParameters.$_.TrimEnd('\')
+            }
+        })
 
     # Loop through all bound parameters and build arguments for the setup executable.
     foreach ($parameterName in $boundParameterName)

diff --git a/source/Public/Disable-SqlDscAudit.ps1 b/source/Public/Disable-SqlDscAudit.ps1
@@ -79,9 +79,9 @@ function Disable-SqlDscAudit
         {
             $getSqlDscAuditParameters = @{
                 ServerObject = $ServerObject
-                Name = $Name
-                Refresh = $Refresh
-                ErrorAction = 'Stop'
+                Name         = $Name
+                Refresh      = $Refresh
+                ErrorAction  = 'Stop'
             }
 
             # If this command does not find the audit it will throw an exception.

diff --git a/source/Public/Enable-SqlDscAudit.ps1 b/source/Public/Enable-SqlDscAudit.ps1
@@ -79,9 +79,9 @@ function Enable-SqlDscAudit
         {
             $getSqlDscAuditParameters = @{
                 ServerObject = $ServerObject
-                Name = $Name
-                Refresh = $Refresh
-                ErrorAction = 'Stop'
+                Name         = $Name
+                Refresh      = $Refresh
+                ErrorAction  = 'Stop'
             }
 
             # If this command does not find the audit it will throw an exception.

diff --git a/source/Public/Get-SqlDscAudit.ps1 b/source/Public/Get-SqlDscAudit.ps1
@@ -67,9 +67,9 @@ function Get-SqlDscAudit
                 $missingAuditMessage = $script:localizedData.Audit_Missing -f $Name
 
                 $writeErrorParameters = @{
-                    Message = $missingAuditMessage
-                    Category = 'InvalidOperation'
-                    ErrorId = 'GSDA0001' # cspell: disable-line
+                    Message      = $missingAuditMessage
+                    Category     = 'InvalidOperation'
+                    ErrorId      = 'GSDA0001' # cspell: disable-line
                     TargetObject = $Name
                 }
 

diff --git a/source/Public/Get-SqlDscPreferredModule.ps1 b/source/Public/Get-SqlDscPreferredModule.ps1
@@ -162,7 +162,7 @@ function Get-SqlDscPreferredModule
     {
         $errorMessage = $script:localizedData.PreferredModule_ModuleNotFound
 
-         # cSpell: disable-next
+        # cSpell: disable-next
         Write-Error -Message $errorMessage -Category 'ObjectNotFound' -ErrorId 'GSDPM0001' -TargetObject ($Name -join ', ')
     }
 

diff --git a/source/Public/Get-SqlDscServerPermission.ps1 b/source/Public/Get-SqlDscServerPermission.ps1
@@ -51,8 +51,8 @@ function Get-SqlDscServerPermission
         $getSqlDscServerPermissionResult = $null
 
         $testSqlDscIsLoginParameters = @{
-            ServerObject      = $ServerObject
-            Name              = $Name
+            ServerObject = $ServerObject
+            Name         = $Name
         }
 
         $isLogin = Test-SqlDscIsLogin @testSqlDscIsLoginParameters

diff --git a/source/Public/Invoke-SqlDscQuery.ps1 b/source/Public/Invoke-SqlDscQuery.ps1
@@ -246,9 +246,9 @@ function Invoke-SqlDscQuery
             catch
             {
                 $writeErrorParameters = @{
-                    Message = $_.Exception.ToString()
-                    Category = 'InvalidOperation'
-                    ErrorId = 'ISDQ0001' # cSpell: disable-line
+                    Message      = $_.Exception.ToString()
+                    Category     = 'InvalidOperation'
+                    ErrorId      = 'ISDQ0001' # cSpell: disable-line
                     TargetObject = $DatabaseName
                 }
 

diff --git a/source/Public/New-SqlDscAudit.ps1 b/source/Public/New-SqlDscAudit.ps1
@@ -209,9 +209,9 @@ function New-SqlDscAudit
 
         $getSqlDscAuditParameters = @{
             ServerObject = $ServerObject
-            Name = $Name
-            Refresh = $Refresh
-            ErrorAction = 'SilentlyContinue'
+            Name         = $Name
+            Refresh      = $Refresh
+            ErrorAction  = 'SilentlyContinue'
         }
 
         $auditObject = Get-SqlDscAudit @getSqlDscAuditParameters

diff --git a/source/Public/Remove-SqlDscAudit.ps1 b/source/Public/Remove-SqlDscAudit.ps1
@@ -79,9 +79,9 @@ function Remove-SqlDscAudit
         {
             $getSqlDscAuditParameters = @{
                 ServerObject = $ServerObject
-                Name = $Name
-                Refresh = $Refresh
-                ErrorAction = 'Stop'
+                Name         = $Name
+                Refresh      = $Refresh
+                ErrorAction  = 'Stop'
             }
 
             # If this command does not find the audit it will throw an exception.

diff --git a/source/Public/Set-SqlDscAudit.ps1 b/source/Public/Set-SqlDscAudit.ps1
@@ -143,13 +143,13 @@ function Set-SqlDscAudit
 
         [Parameter()]
         [ValidateScript({
-            if ($_ -in 1..999 -or $_ -gt 2147483647)
-            {
-                throw ($script:localizedData.Audit_QueueDelayParameterValueInvalid -f $_)
-            }
+                if ($_ -in 1..999 -or $_ -gt 2147483647)
+                {
+                    throw ($script:localizedData.Audit_QueueDelayParameterValueInvalid -f $_)
+                }
 
-            return $true
-        })]
+                return $true
+            })]
         [System.UInt32]
         $QueueDelay,
 
@@ -200,13 +200,13 @@ function Set-SqlDscAudit
         [Parameter(ParameterSetName = 'AuditObjectWithSizeAndMaxFiles', Mandatory = $true)]
         [Parameter(ParameterSetName = 'AuditObjectWithSizeAndMaxRolloverFiles', Mandatory = $true)]
         [ValidateScript({
-            if ($_ -eq 1 -or $_ -gt 2147483647)
-            {
-                throw ($script:localizedData.Audit_MaximumFileSizeParameterValueInvalid -f $_)
-            }
+                if ($_ -eq 1 -or $_ -gt 2147483647)
+                {
+                    throw ($script:localizedData.Audit_MaximumFileSizeParameterValueInvalid -f $_)
+                }
 
-            return $true
-        })]
+                return $true
+            })]
         [System.UInt32]
         $MaximumFileSize,
 
@@ -254,9 +254,9 @@ function Set-SqlDscAudit
         {
             $getSqlDscAuditParameters = @{
                 ServerObject = $ServerObject
-                Name = $Name
-                Refresh = $Refresh
-                ErrorAction = 'Stop'
+                Name         = $Name
+                Refresh      = $Refresh
+                ErrorAction  = 'Stop'
             }
 
             # If this command does not find the audit it will throw an exception.

diff --git a/source/Public/Set-SqlDscDatabasePermission.ps1 b/source/Public/Set-SqlDscDatabasePermission.ps1
@@ -194,7 +194,7 @@ function Set-SqlDscDatabasePermission
                 $PSCmdlet.ThrowTerminatingError(
                     [System.Management.Automation.ErrorRecord]::new(
                         $missingPrincipalMessage,
-                        'GSDDP0001',
+                        'GSDDP0001', # cSpell: disable-line
                         [System.Management.Automation.ErrorCategory]::InvalidOperation,
                         $Name
                     )
@@ -208,7 +208,7 @@ function Set-SqlDscDatabasePermission
             $PSCmdlet.ThrowTerminatingError(
                 [System.Management.Automation.ErrorRecord]::new(
                     $missingDatabaseMessage,
-                    'GSDDP0002',
+                    'GSDDP0002', # cSpell: disable-line
                     [System.Management.Automation.ErrorCategory]::InvalidOperation,
                     $DatabaseName
                 )

diff --git a/source/Public/Set-SqlDscServerPermission.ps1 b/source/Public/Set-SqlDscServerPermission.ps1
@@ -95,8 +95,8 @@ function Set-SqlDscServerPermission
         }
 
         $testSqlDscIsLoginParameters = @{
-            ServerObject      = $ServerObject
-            Name              = $Name
+            ServerObject = $ServerObject
+            Name         = $Name
         }
 
         $isLogin = Test-SqlDscIsLogin @testSqlDscIsLoginParameters
@@ -172,7 +172,7 @@ function Set-SqlDscServerPermission
             $PSCmdlet.ThrowTerminatingError(
                 [System.Management.Automation.ErrorRecord]::new(
                     $missingPrincipalMessage,
-                    'GSDDP0001',
+                    'GSDDP0001', # cSpell: disable-line
                     [System.Management.Automation.ErrorCategory]::InvalidOperation,
                     $Name
                 )

diff --git a/source/Public/Test-SqlDscIsDatabasePrincipal.ps1 b/source/Public/Test-SqlDscIsDatabasePrincipal.ps1
@@ -108,7 +108,7 @@ function Test-SqlDscIsDatabasePrincipal
             $PSCmdlet.ThrowTerminatingError(
                 [System.Management.Automation.ErrorRecord]::new(
                     ($script:localizedData.IsDatabasePrincipal_DatabaseMissing -f $DatabaseName),
-                    'TSDISO0001',
+                    'TSDISO0001', # cSpell: disable-line
                     [System.Management.Automation.ErrorCategory]::InvalidOperation,
                     $DatabaseName
                 )