New-SqlDscLogin: command to create SQL Server logins (#2132)

Author: johlju

.build/Test-ShouldRunDscResourceIntegrationTests.ps1

@@ -413,7 +413,7 @@ function Test-ShouldRunDscResourceIntegrationTests
     }
 
     # Check if any public commands used by DSC resources are changed
-    $changedPublicCommands = $changedFiles | Where-Object -FilterScript { $_ -match '^source/Public/(.+)\.ps1$' } | 
+    $changedPublicCommands = $changedFiles | Where-Object -FilterScript { $_ -match '^source/Public/(.+)\.ps1$' } |
         ForEach-Object -Process { [System.IO.Path]::GetFileNameWithoutExtension((Split-Path -Path $_ -Leaf)) }
 
     $affectedCommands = $changedPublicCommands | Where-Object -FilterScript { $_ -in $PublicCommandsUsedByDscResources }
@@ -428,7 +428,7 @@ function Test-ShouldRunDscResourceIntegrationTests
     }
 
     # Check if any private functions used by the affected public commands or class-based DSC resources are changed
-    $changedPrivateFunctions = $changedFiles | Where-Object -FilterScript { $_ -match '^source/Private/(.+)\.ps1$' } | 
+    $changedPrivateFunctions = $changedFiles | Where-Object -FilterScript { $_ -match '^source/Private/(.+)\.ps1$' } |
         ForEach-Object -Process { [System.IO.Path]::GetFileNameWithoutExtension((Split-Path -Path $_ -Leaf)) }
 
     $affectedPrivateFunctions = @()
@@ -490,10 +490,6 @@ if ($MyInvocation.InvocationName -ne '.')
         Write-Host "RESULT: DSC resource integration tests will be SKIPPED"
     }
 
-    # Output the result for the calling script to capture
-    Write-Output -InputObject ""
-    Write-Output -InputObject "ShouldRunDscResourceIntegrationTests: $shouldRun"
-
     # Return the boolean value for pipeline script to use
     return $shouldRun
 }

.github/instructions/dsc-community-style-guidelines-markdown.instructions.md

@@ -5,7 +5,7 @@ applyTo: "**/*.md"
 
 # Markdown Style Guidelines
 
-- Wrap lines at 80 characters
+- Wrap lines at word boundaries when over 80 characters
 - Use 2 spaces for indentation
 - Use '1.' for all items in ordered lists (1/1/1 numbering style)
 - Surround fenced code blocks with blank lines

.github/instructions/dsc-community-style-guidelines-powershell.instructions.md

@@ -134,6 +134,7 @@ function Get-Something
 - Parameter type on line above parameter name
 - Parameters separated by blank line
 - Parameters should use full type name.
+- Pipeline parameters (`ValueFromPipeline = $true`) must be declared in ALL parameter sets
 
 ## Best Practices
 

.gitignore

@@ -1,3 +1,4 @@
 .vscode
 .vs
 output/
+coverage.xml

.vscode/settings.json

@@ -79,7 +79,14 @@
         "PBIRS",
         "SSRS",
         "DSCSQLTEST",
-        "unshallow"
+        "unshallow",
+        "pullrequest",
+        "targetbranch",
+        "hqrm",
+        "sqlps",
+        "securestring",
+        "encryptorname",
+        "wsfc"
     ],
     "cSpell.ignorePaths": [
         ".git"

.vscode/tasks.json

@@ -84,7 +84,64 @@
             "label": "test",
             "type": "shell",
             "command": "&${cwd}/build.ps1",
-            "args": ["-AutoRestore", "-UseModuleFast", "-Tasks", "test"],
+            "args": [
+                "-AutoRestore",
+                "-UseModuleFast",
+                "-Tasks",
+                "test",
+                "-PesterPath",
+                "./tests/Unit/Classes,./tests/Unit/Private,./tests/Unit/Public,./tests/QA",
+                "-CodeCoverageThreshold",
+                "0"
+            ],
+            "presentation": {
+                "echo": true,
+                "reveal": "always",
+                "focus": true,
+                "panel": "dedicated",
+                "showReuseMessage": true,
+                "clear": false
+            },
+            "problemMatcher": [
+                {
+                    "owner": "powershell",
+                    "fileLocation": [
+                        "absolute"
+                    ],
+                    "severity": "error",
+                    "pattern": [
+                        {
+                            "regexp": "^\\s*(\\[-\\]\\s*.*?)(\\d+)ms\\s*$",
+                            "message": 1
+                        },
+                        {
+                            "regexp": "(.*)",
+                            "code": 1
+                        },
+                        {
+                            "regexp": ""
+                        },
+                        {
+                            "regexp": "^.*,\\s*(.*):\\s*line\\s*(\\d+).*",
+                            "file": 1,
+                            "line": 2
+                        }
+                    ]
+                }
+            ]
+        },
+        {
+            "label": "hqrmtest",
+            "type": "shell",
+            "command": "&${cwd}/build.ps1",
+            "args": [
+                "-AutoRestore",
+                "-UseModuleFast",
+                "-Tasks",
+                "hqrmtest",
+                "-CodeCoverageThreshold",
+                "0"
+            ],
             "presentation": {
                 "echo": true,
                 "reveal": "always",

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Make sure tests forcibly imports the module being tested to avoid AI failing
   when testing changes.
+- Fixed Azure DevOps pipeline conditions that were preventing DSC resource
+  integration tests from running when they should by removing incorrect quotes
+  around boolean values.
 
 ### Added
 
@@ -37,12 +40,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Includes a `-Refresh` parameter to refresh the server's login collection
     before attempting removal.
   - Provides detailed error messages with localization support.
+- `New-SqlDscLogin`
+  - Added new public command to create a new login on a SQL Server Database
+    Engine instance.
+  - Supports creating SQL Server logins, Windows user logins, Windows group
+    logins, certificate-based logins, and asymmetric key-based logins.
+  - Implements proper parameter sets to prevent combining hashed passwords
+    with password policy options, following SQL Server restrictions.
 
 ### Changed
 
 - Module now outputs a verbose message instead of a warning when the SMO
   dependency module is missing during import to work around a DSC v3 issue.
 - VS Code tasks configuration was improved to support AI.
+- `Prerequisites` tests
+  - Added creation of `SqlIntegrationTest` local Windows user for integration testing.
+- `tests/Integration/Commands/README.md`
+  - Added documentation for `SqlIntegrationTest` user and
+    `IntegrationTestSqlLogin` login.
+  - Added run order information for `New-SqlDscLogin` integration test.
 - `azure-pipelines.yml`
   - Remove `windows-2019` images fixes [#2106](https://github.com/dsccommunity/SqlServerDsc/issues/2106).
   - Move individual tasks to `windows-latest`.

CONTRIBUTING.md

@@ -296,7 +296,7 @@ be compiled to a .mof file. If the tests find any errors the build will fail.
 
 A terminating error is an error that prevents the resource to continue further.
 If a DSC resource shall throw an terminating error the commands of the module
-**DscResource.Common** shall be used primarily; [`New-InvalidArgumentException`](https://github.com/dsccommunity/DscResource.Common#new-invalidargumentexception),
+**DscResource.Common** shall be used primarily; [`New-ArgumentException`](https://github.com/dsccommunity/DscResource.Common#new-invalidargumentexception),
 [`New-InvalidDataExcpetion`](https://github.com/dsccommunity/DscResource.Common#new-invaliddataexception),
 [`New-InvalidOperationException`](https://github.com/dsccommunity/DscResource.Common#new-invalidoperationexception),
 [`New-InvalidResultException`](https://github.com/dsccommunity/DscResource.Common#new-invalidresultexception),

azure-pipelines.yml

@@ -92,9 +92,10 @@ stages:
               targetType: 'inline'
               script: |
                 # Set the target branch for comparison
-                $targetBranch = "origin/$(System.PullRequest.TargetBranch)"
-                if (-not $env:SYSTEM_PULLREQUEST_TARGETBRANCH) {
-                    $targetBranch = "origin/main"
+                if ($env:SYSTEM_PULLREQUEST_TARGETBRANCH) {
+                    $targetBranch = "origin/$env:SYSTEM_PULLREQUEST_TARGETBRANCH"
+                } else {
+                    $targetBranch = "origin/$(defaultBranch)"
                 }
 
                 Write-Output "Target branch: $targetBranch"
@@ -103,8 +104,15 @@ stages:
                 # Run the script to determine if DSC resource integration tests should run
                 $shouldRun = ./.build/Test-ShouldRunDscResourceIntegrationTests.ps1 -BaseBranch $targetBranch -CurrentBranch HEAD
 
+                # Debug: print computed value before exporting as output
+                Write-Host "Computed ShouldRunDscResourceIntegrationTests: $shouldRun"
+
+                # Normalize to lowercase string so conditions can use a simple string comparison
+                $shouldRunNormalized = ([string] $shouldRun).ToLower()
+                Write-Host "Normalized ShouldRunDscResourceIntegrationTests: $shouldRunNormalized"
+
                 # Set Azure DevOps output variable for pipeline conditions
-                Write-Host "##vso[task.setvariable variable=ShouldRunDscResourceIntegrationTests;isOutput=true]$shouldRun"
+                Write-Host "##vso[task.setvariable variable=ShouldRunDscResourceIntegrationTests;isOutput=true]$shouldRunNormalized"
               pwsh: true
 
       - job: Test_HQRM
@@ -282,6 +290,7 @@ stages:
                   'tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1'
                   # Group 2
                   'tests/Integration/Commands/Assert-SqlDscLogin.Integration.Tests.ps1'
+                  'tests/Integration/Commands/New-SqlDscLogin.Integration.Tests.ps1'
                   'tests/Integration/Commands/Get-SqlDscLogin.Integration.Tests.ps1'
                   'tests/Integration/Commands/Remove-SqlDscLogin.Integration.Tests.ps1'
                   # Group 9
@@ -438,7 +447,7 @@ stages:
     condition: |
       and(
         succeeded(),
-        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'True')
+        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'true')
       )
     jobs:
       - job: Test_Integration
@@ -536,7 +545,7 @@ stages:
     condition: |
       and(
         succeeded(),
-        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'True')
+        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'true')
       )
     jobs:
       - job: Test_Integration
@@ -631,7 +640,7 @@ stages:
     condition: |
       and(
         succeeded(),
-        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'True')
+        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'true')
       )
     jobs:
       - job: Test_Integration
@@ -707,7 +716,7 @@ stages:
     condition: |
       and(
         succeeded(),
-        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'True')
+        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'true')
       )
     jobs:
       - job: Test_Integration
@@ -774,7 +783,7 @@ stages:
     condition: |
       and(
         succeeded(),
-        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'True')
+        eq(dependencies.Quality_Test_and_Unit_Test.outputs['Determine_DSC_Resource_Test_Requirements.determineDscResourceTests.ShouldRunDscResourceIntegrationTests'], 'true')
       )
     jobs:
       - job: Test_Integration

source/Classes/002.DatabasePermission.ps1

@@ -260,7 +260,7 @@ class DatabasePermission : IComparable, System.IEquatable[Object]
                 $object.GetType().FullName
             )
 
-            New-InvalidArgumentException -ArgumentName 'Object' -Message $errorMessage
+            New-ArgumentException -ArgumentName 'Object' -Message $errorMessage
         }
 
         return $returnValue