Add integration tests for SSL certificate setup by johlju · Pull Request #2303 · dsccommunity/SqlServerDsc

johlju · 2025-10-12T11:33:41Z

Pull Request (PR) description

Added post-installation configuration integration test to configure SSL certificate
support for SQL Server instance DSCSQLTEST in CI environment, enabling testing
of encryption-related functionality. The new PostInstallationConfiguration
integration test includes:
- Self-signed SSL certificate creation and installation
- Certificate configuration for SQL Server Database Engine
- Service account permissions for certificate private key access
- Certificate trust chain configuration
- Verification that encryption is properly configured
- Enabled previously skipped encryption tests in Invoke-SqlDscQuery
- Added integration tests for Connect-SqlDscDatabaseEngine command to verify
  the -Encrypt parameter functionality
  issue #2290.

This Pull Request (PR) fixes the following issues

Fixes Add encryption support for SQL Server instance DSCSQLTEST in CI environment #2290

Task list

Added an entry to the change log under the Unreleased section of the
file CHANGELOG.md. Entry should say what was changed and how that
affects users (if applicable), and reference the issue being resolved
(if applicable).
Resource documentation updated in the resource's README.md.
Resource parameter descriptions updated in schema.mof.
Comment-based help updated, including parameter descriptions.
Localization strings updated.
Examples updated.
Unit tests updated. See DSC Community Testing Guidelines.
Integration tests updated (where possible). See DSC Community Testing Guidelines.
Code changes adheres to DSC Community Style Guidelines.

This change is

coderabbitai · 2025-10-12T11:34:06Z

Walkthrough

Adds a post-installation integration test that configures a self-signed SSL certificate for the DSCSQLTEST SQL Server in CI, reorders pipeline tests to run it after installation, enables and extends encryption tests (Encrypt parameter) across integration suites, updates test README and CHANGELOG, and preserves Agent XPs around a config test.

Changes

Cohort / File(s)	Summary
CI Pipeline `azure-pipelines.yml`	Inserts `PostInstallationConfiguration.Integration.Tests.ps1` into the integration test sequence after `Install-SqlDscServer`, moves `Invoke-SqlDscQuery.Integration.Tests.ps1` earlier, and adjusts Group/run-order labels.
Post-install encryption setup tests `tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1`, `tests/Integration/Commands/README.md`	Adds `PostInstallationConfiguration.Integration.Tests.ps1` to create/import a self-signed SSLServerAuthentication certificate, add it to Trusted Root, grant the SQL service account private-key read access, bind the cert via registry, restart SQL Server, verify service and TLS setup, and document run order/dependencies in README.
Encryption test enablement & coverage `tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1`, `tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1`	Removes the skip for the `-Encrypt` case in `Invoke-SqlDscQuery` and adds explicit `-Encrypt` assertions in `Connect-SqlDscDatabaseEngine` across impersonation, named-instance, and SQL-login scenarios with proper Disconnect cleanup.
Configuration option test safety `tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1`	Adds setup/teardown to capture the current Agent XPs value, ensure it is set to 1 for the test, and restore the original value afterward.
Changelog `CHANGELOG.md`	Replaces prior Added entry with a consolidated description covering the new post-install SSL configuration integration test and related test ordering/encryption changes; removes the standalone Get-SqlDscDatabasePermission test mention.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor CI as CI Runner
  participant PostTest as PostInstallation Test
  participant CertStore as Windows Cert Store
  participant Registry as Windows Registry
  participant SQLService as SQL Server Service
  participant DS as DSCSQLTEST
  participant Client as Test Client

  CI->>PostTest: Run post-install configuration test
  PostTest->>CertStore: Create self-signed SSLServerAuthentication cert
  PostTest->>CertStore: Export public cert -> Import to Trusted Root
  PostTest->>CertStore: Grant SQL service account read access to private key
  PostTest->>Registry: Write certificate thumbprint binding for SQL instance
  PostTest->>SQLService: Restart SQL Server service
  SQLService->>DS: Start with bound TLS cert
  PostTest->>DS: Verify server is online
  PostTest->>Client: Connect without Encrypt (expect unencrypted)
  PostTest->>Client: Connect with Encrypt (expect encrypted)
  PostTest->>DS: Query sys.dm_exec_connections to confirm encryption
  PostTest-->>CI: Report pass/fail

sequenceDiagram
  autonumber
  actor CI as CI Runner
  participant Tests as Integration Tests
  participant DB as DSCSQLTEST

  Note over Tests,DB: Previously skipped encryption tests are now enabled
  CI->>Tests: Run Invoke-SqlDscQuery (Encrypt enabled)
  Tests->>DB: Execute query with -Encrypt
  Tests-->>CI: Assert success

  CI->>Tests: Run Connect-SqlDscDatabaseEngine
  Tests->>DB: Connect with -Encrypt:$true
  Tests-->>CI: Assert ConnectionContext.EncryptConnection == true
  Tests->>DB: Connect without -Encrypt
  Tests-->>CI: Assert ConnectionContext.EncryptConnection == false

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

Update README for integration tests #2298 — Modifies integration tests README and run-order entries; overlaps with test orchestration changes here.
Refactor integration tests to optimize SQL Server service management #2291 — Adjusts integration test lifecycle and DSCSQLTEST service handling; relates to adding post-install configuration and sequencing.
Remove Should -Not -Throw #2302 — Edits the same integration test files (Connect/Invoke) and test assertions; overlaps with enabling/enhancing Encrypt cases.

Pre-merge checks

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes Check	⚠️ Warning	The change to Get-SqlDscConfigurationOption.Integration.Tests.ps1 introduces Agent XPs setup and teardown logic unrelated to the SSL certificate or encryption objectives in issue #2290, representing an out-of-scope addition to this PR.	Please remove or isolate the Agent XPs setup/teardown changes from this PR and submit them separately to keep the SSL certificate integration test scope focused on encryption support.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly describes the primary change of adding integration tests for SSL certificate setup without extraneous detail and aligns directly with the main functionality introduced in the changeset.
Linked Issues Check	✅ Passed	The pull request implements the linked issue #2290 objectives by generating and installing a self-signed SSL certificate, binding it to the DSCSQLTEST instance via registry updates, restarting the service, importing the certificate into the trusted store, enabling and adding encryption tests (Connect-SqlDscDatabaseEngine and Invoke-SqlDscQuery), and verifying encrypted connections through DMV queries, thereby satisfying all technical requirements.
Description Check	✅ Passed	Because the description clearly outlines the new SSL certificate integration test functionality and references the relevant issue and checklist items, it is directly related to the changeset and passes validation.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e111b04 and 41ab95d.

📒 Files selected for processing (1)

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (1 hunks)

🧰 Additional context used

📓 Path-based instructions (8)

**/*.[Tt]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

All public commands, private functions and classes must have unit tests

All public commands and class-based resources must have integration tests

Use Pester v5 syntax only

Test code only inside Describe blocks

Assertions only in It blocks

Never test verbose messages, debug messages or parameter binding behavior

Pass all mandatory parameters to avoid prompts

Requirements

Inside It blocks, assign unused return objects to $null (unless part of pipeline)

Tested entity must be called from within the It blocks

Keep results and assertions in same It block

Avoid try-catch-finally for cleanup, use AfterAll or AfterEach

Avoid unnecessary remove/recreate cycles

Naming

One Describe block per file matching the tested entity name

Context descriptions start with 'When'

It descriptions start with 'Should', must not contain 'when'

Mock variables prefix: 'mock'

Structure & Scope

Public commands: Never use InModuleScope (unless retrieving localized strings)

Private functions/class resources: Always use InModuleScope

Each class method = separate Context block

Each scenario = separate Context block

Use nested Context blocks for complex scenarios

Mocking in BeforeAll (BeforeEach only when required)

Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach

Use -BeTrue/-BeFalse never -Be $true/-Be $false

Never use Assert-MockCalled, use Should -Invoke instead

No Should -Not -Throw - invoke commands directly

Never add an empty -MockWith block

Omit -MockWith when returning $null

Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName

Omit -ModuleName parameter on Pester commands

Never use Mock inside `InModuleSc...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.{ps1,psm1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.{ps1,psm1,psd1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

tests/Integration/Commands/*.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

tests/Integration/Commands/*.Integration.Tests.ps1: Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Add integration tests for all public commands (and resources)

Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: Do not use mocking in integration tests; run against a real environment
Cover all scenarios and code paths in integration tests
Use Get-ComputerName to determine computer names in CI
Avoid using -ExpectedMessage with Should -Throw assertions
Call commands with -Force where applicable to avoid prompting
Use -ErrorAction 'Stop' on commands so failures surface immediately
Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
No mocking - real environment only
Cover all scenarios and code paths
Use Get-ComputerName for computer names in CI
Avoid ExpectedMessage for Should -Throw assertions
Only run integration tests in CI unless explicitly instructed.
Call commands with -Force parameter where applicable (avoids prompting).
Use -ErrorAction 'Stop' on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

Command: Public command

Function: Private function

Resource: DSC class-based resource

Build & Test Workflow Requirements

Run PowerShell script files from repository root

Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop

Build project before running tests: ./build.ps1 -Tasks build

Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

Public commands: source/Public/{CommandName}.ps1

Private functions: source/Private/{FunctionName}.ps1

Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1

Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

Follow instructions over existing code patterns

Follow PowerShell style and test guideline instructions strictly

Always update CHANGELOG.md Unreleased section

Localize all strings using string keys; remove any orphaned string keys

Check DscResource.Common before creating private functions

Separate reusable logic into private functions

DSC resources should always be created as class-based resources

Add unit tests for all commands/functions/resources

Add integration tests for all public commands and resources

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

{**/*.ps1,**/*.psm1,**/*.psd1}

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

Use descriptive names (3+ characters, no abbreviations)

Functions: PascalCase with Verb-Noun format using approved verbs

Parameters: PascalCase

Variables: camelCase

Keywords: lower-case

Classes: PascalCase

Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

Use 4 spaces (no tabs)

One space around operators: $a = 1 + 2

One space between type and variable: [String] $name

One space between keyword and parenthesis: if ($condition)

No spaces on empty lines

Try to limit lines to 120 characters

Braces

Newline before opening brace (except variable assignments)

One newline after opening brace

Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

Single line: @('one', 'two', 'three')

Multi-line: each element on separate line with proper indentation

Do not use the unary comma operator (,) in return statements to force
an array

Hashtables

Empty: @{}

Each property on separate line with proper indentation

Properties: Use PascalCase

Comments

Single line: # Comment (capitalized, on own line)

Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text

No commented-out code

Comment-based help

Always add comment-based help to all functions and scripts

Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class

Comment-based help indentation: keywords 4 spaces, text 8 spaces

Include examples for all parameter sets and combinations

INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

🧠 Learnings (9)

📓 Common learnings

Learnt from: johlju
PR: dsccommunity/SqlServerDsc#2303
File: tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1:127-143
Timestamp: 2025-10-12T12:10:48.606Z
Learning: For the SqlServerDsc module integration tests, ForceEncryption should not be enabled on the SQL Server instance (DSCSQLTEST) because the module needs to test both encrypted and non-encrypted connection scenarios in CI.

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Add integration tests for all public commands (and resources)

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-12T13:21:31.054Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : All public commands and class-based resources must have integration tests

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use Get-ComputerName to determine computer names in CI

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:34:27.319Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-powershell.instructions.md:0-0
Timestamp: 2025-09-16T16:34:27.319Z
Learning: Applies to **/*.{ps1,psm1} : Prefer ::new() over New-Object for .NET types

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-10-12T12:10:48.606Z

Learnt from: johlju
PR: dsccommunity/SqlServerDsc#2303
File: tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1:127-143
Timestamp: 2025-10-12T12:10:48.606Z
Learning: For the SqlServerDsc module integration tests, ForceEncryption should not be enabled on the SQL Server instance (DSCSQLTEST) because the module needs to test both encrypted and non-encrypted connection scenarios in CI.

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use -ErrorAction 'Stop' on commands so failures surface immediately

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:34:44.689Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md:0-0
Timestamp: 2025-09-16T16:34:44.689Z
Learning: Applies to tests/[Uu]nit/**/*.[Tt]ests.ps1 : Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: In unit tests, add $env:SqlServerDscCI = $true in BeforeAll and remove it in AfterAll

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
GitHub Check: PSScriptAnalyzer
GitHub Check: PSScriptAnalyzer

🔇 Additional comments (1)

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (1)

1-211: LGTM! All previous issues have been addressed.

The integration test is well-structured and correctly implements SSL certificate configuration for the DSCSQLTEST instance. All previously flagged issues have been resolved:

✓ Uses Get-ComputerName for CI compatibility (lines 37-38)

✓ Uses ::new() instead of New-Object for .NET objects (lines 111-115)

✓ Includes -ErrorAction 'Stop' on all critical operations (lines 71, 81, 88, 97, 110, 117, 120, 138, 141, 149, 156, 171, 177, 186, 199, 207)

✓ Correctly avoids enabling ForceEncryption to support both encrypted and non-encrypted connection testing (per learnings)

✓ Follows required integration test setup pattern (lines 1-30)

✓ Uses Pester v5 syntax throughout with proper naming conventions

✓ Verifies encryption via DMV query (lines 180-211) as specified in issue Add encryption support for SQL Server instance DSCSQLTEST in CI environment #2290

The test comprehensively covers the SSL certificate lifecycle: creation, export, trust chain configuration, service account permissions, SQL Server configuration, service restart, and connection verification with and without encryption.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

johlju · 2025-10-12T11:38:23Z

@coderabbitai review

coderabbitai · 2025-10-12T11:38:44Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99ad254 and 2cc9d20.

📒 Files selected for processing (6)

CHANGELOG.md (1 hunks)
azure-pipelines.yml (1 hunks)
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/README.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (11)

**/*.[Tt]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

All public commands, private functions and classes must have unit tests

All public commands and class-based resources must have integration tests

Use Pester v5 syntax only

Test code only inside Describe blocks

Assertions only in It blocks

Never test verbose messages, debug messages or parameter binding behavior

Pass all mandatory parameters to avoid prompts

Requirements

Inside It blocks, assign unused return objects to $null (unless part of pipeline)

Tested entity must be called from within the It blocks

Keep results and assertions in same It block

Avoid try-catch-finally for cleanup, use AfterAll or AfterEach

Avoid unnecessary remove/recreate cycles

Naming

One Describe block per file matching the tested entity name

Context descriptions start with 'When'

It descriptions start with 'Should', must not contain 'when'

Mock variables prefix: 'mock'

Structure & Scope

Public commands: Never use InModuleScope (unless retrieving localized strings)

Private functions/class resources: Always use InModuleScope

Each class method = separate Context block

Each scenario = separate Context block

Use nested Context blocks for complex scenarios

Mocking in BeforeAll (BeforeEach only when required)

Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach

Use -BeTrue/-BeFalse never -Be $true/-Be $false

Never use Assert-MockCalled, use Should -Invoke instead

No Should -Not -Throw - invoke commands directly

Never add an empty -MockWith block

Omit -MockWith when returning $null

Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName

Omit -ModuleName parameter on Pester commands

Never use Mock inside `InModuleSc...

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.{ps1,psm1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.{ps1,psm1,psd1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

tests/Integration/Commands/*.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

tests/Integration/Commands/*.Integration.Tests.ps1: Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Add integration tests for all public commands (and resources)

Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: Do not use mocking in integration tests; run against a real environment
Cover all scenarios and code paths in integration tests
Use Get-ComputerName to determine computer names in CI
Avoid using -ExpectedMessage with Should -Throw assertions
Call commands with -Force where applicable to avoid prompting
Use -ErrorAction 'Stop' on commands so failures surface immediately
Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
No mocking - real environment only
Cover all scenarios and code paths
Use Get-ComputerName for computer names in CI
Avoid ExpectedMessage for Should -Throw assertions
Only run integration tests in CI unless explicitly instructed.
Call commands with -Force parameter where applicable (avoids prompting).
Use -ErrorAction 'Stop' on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

Command: Public command

Function: Private function

Resource: DSC class-based resource

Build & Test Workflow Requirements

Run PowerShell script files from repository root

Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop

Build project before running tests: ./build.ps1 -Tasks build

Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

Public commands: source/Public/{CommandName}.ps1

Private functions: source/Private/{FunctionName}.ps1

Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1

Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

Follow instructions over existing code patterns

Follow PowerShell style and test guideline instructions strictly

Always update CHANGELOG.md Unreleased section

Localize all strings using string keys; remove any orphaned string keys

Check DscResource.Common before creating private functions

Separate reusable logic into private functions

DSC resources should always be created as class-based resources

Add unit tests for all commands/functions/resources

Add integration tests for all public commands and resources

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/README.md
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
azure-pipelines.yml
CHANGELOG.md

{**/*.ps1,**/*.psm1,**/*.psd1}

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

Use descriptive names (3+ characters, no abbreviations)

Functions: PascalCase with Verb-Noun format using approved verbs

Parameters: PascalCase

Variables: camelCase

Keywords: lower-case

Classes: PascalCase

Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

Use 4 spaces (no tabs)

One space around operators: $a = 1 + 2

One space between type and variable: [String] $name

One space between keyword and parenthesis: if ($condition)

No spaces on empty lines

Try to limit lines to 120 characters

Braces

Newline before opening brace (except variable assignments)

One newline after opening brace

Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

Single line: @('one', 'two', 'three')

Multi-line: each element on separate line with proper indentation

Do not use the unary comma operator (,) in return statements to force
an array

Hashtables

Empty: @{}

Each property on separate line with proper indentation

Properties: Use PascalCase

Comments

Single line: # Comment (capitalized, on own line)

Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text

No commented-out code

Comment-based help

Always add comment-based help to all functions and scripts

Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class

Comment-based help indentation: keywords 4 spaces, text 8 spaces

Include examples for all parameter sets and combinations

INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

tests/Integration/Commands/README.md
CHANGELOG.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

Wrap lines at word boundaries when over 80 characters (except tables/code blocks)

Use 2 spaces for indentation

Use '1.' for all items in ordered lists (1/1/1 numbering style)

Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters

Empty lines required before/after code blocks and headings (except before line 1)

Escape backslashes in file paths only (not in code blocks)

Code blocks must specify language identifiers

Text Formatting

Parameters: bold

Values/literals: inline code

Resource/module/product names: italic

Commands/files/paths: inline code

Files:

tests/Integration/Commands/README.md
CHANGELOG.md

azure-pipelines.yml

📄 CodeRabbit inference engine (.github/instructions/SqlServerDsc-guidelines.instructions.md)

Integration test script files must be added to a group within the test stage in ./azure-pipelines.yml, choosing an appropriate group number based on dependencies

Files:

azure-pipelines.yml

CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-changelog.instructions.md)

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Skip adding an entry if the same change already exists in the Unreleased section
No duplicate sections or items in the Unreleased section

Always update the Unreleased section of CHANGELOG.md

Files:

CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

Always update the Unreleased section in CHANGELOG.md

Use Keep a Changelog format

Describe notable changes briefly, ≤2 items per change type

Reference issues using format issue #<issue_number>

No empty lines between list items in same section

Skip adding entry if same change already exists in Unreleased section

No duplicate sections or items in Unreleased section

Files:

CHANGELOG.md

🧠 Learnings (16)

📓 Common learnings

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Integration tests must use Connect-SqlDscDatabaseEngine with correct CI credentials and call Disconnect-SqlDscDatabaseEngine after

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Public PowerShell commands must follow the naming format: {Verb}-SqlDsc{Noun}

Applied to files:

tests/Integration/Commands/README.md

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Integration tests must use Connect-SqlDscDatabaseEngine with correct CI credentials and call Disconnect-SqlDscDatabaseEngine after

Applied to files:

tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Add integration tests for all public commands (and resources)

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
azure-pipelines.yml

📚 Learning: 2025-09-12T13:21:31.054Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : All public commands and class-based resources must have integration tests

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
azure-pipelines.yml

📚 Learning: 2025-09-16T16:34:44.689Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md:0-0
Timestamp: 2025-09-16T16:34:44.689Z
Learning: Applies to tests/[Uu]nit/**/*.[Tt]ests.ps1 : Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: In unit tests, add $env:SqlServerDscCI = $true in BeforeAll and remove it in AfterAll

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Applies to azure-pipelines.yml : Integration test script files must be added to a group within the test stage in ./azure-pipelines.yml, choosing an appropriate group number based on dependencies

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Call commands with -Force where applicable to avoid prompting

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Cover all scenarios and code paths in integration tests

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Unit/{Classes,Public,Private}/*.Tests.ps1 : Add unit tests for all commands, functions, and resources

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use -ErrorAction 'Stop' on commands so failures surface immediately

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/Integration/Resources/*.Integration.Tests.ps1 : Place resource integration tests at tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Applied to files:

azure-pipelines.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
GitHub Check: PSScriptAnalyzer

coderabbitai

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99ad254 and 2cc9d20.

📒 Files selected for processing (6)

CHANGELOG.md (1 hunks)
azure-pipelines.yml (1 hunks)
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/README.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (6)

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

Command: Public command

Function: Private function

Resource: DSC class-based resource

Build & Test Workflow Requirements

Run PowerShell script files from repository root

Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop

Build project before running tests: ./build.ps1 -Tasks build

Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

Public commands: source/Public/{CommandName}.ps1

Private functions: source/Private/{FunctionName}.ps1

Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1

Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

Follow instructions over existing code patterns

Follow PowerShell style and test guideline instructions strictly

Always update CHANGELOG.md Unreleased section

Localize all strings using string keys; remove any orphaned string keys

Check DscResource.Common before creating private functions

Separate reusable logic into private functions

DSC resources should always be created as class-based resources

Add unit tests for all commands/functions/resources

Add integration tests for all public commands and resources

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/README.md
CHANGELOG.md
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1
azure-pipelines.yml

{**/*.ps1,**/*.psm1,**/*.psd1}

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

Use descriptive names (3+ characters, no abbreviations)

Functions: PascalCase with Verb-Noun format using approved verbs

Parameters: PascalCase

Variables: camelCase

Keywords: lower-case

Classes: PascalCase

Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

Use 4 spaces (no tabs)

One space around operators: $a = 1 + 2

One space between type and variable: [String] $name

One space between keyword and parenthesis: if ($condition)

No spaces on empty lines

Try to limit lines to 120 characters

Braces

Newline before opening brace (except variable assignments)

One newline after opening brace

Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

Single line: @('one', 'two', 'three')

Multi-line: each element on separate line with proper indentation

Do not use the unary comma operator (,) in return statements to force
an array

Hashtables

Empty: @{}

Each property on separate line with proper indentation

Properties: Use PascalCase

Comments

Single line: # Comment (capitalized, on own line)

Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text

No commented-out code

Comment-based help

Always add comment-based help to all functions and scripts

Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class

Comment-based help indentation: keywords 4 spaces, text 8 spaces

Include examples for all parameter sets and combinations

INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

**/*.[Tt]ests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

All public commands, private functions and classes must have unit tests

All public commands and class-based resources must have integration tests

Use Pester v5 syntax only

Test code only inside Describe blocks

Assertions only in It blocks

Never test verbose messages, debug messages or parameter binding behavior

Pass all mandatory parameters to avoid prompts

Requirements

Inside It blocks, assign unused return objects to $null (unless part of pipeline)

Tested entity must be called from within the It blocks

Keep results and assertions in same It block

Avoid try-catch-finally for cleanup, use AfterAll or AfterEach

Avoid unnecessary remove/recreate cycles

Naming

One Describe block per file matching the tested entity name

Context descriptions start with 'When'

It descriptions start with 'Should', must not contain 'when'

Mock variables prefix: 'mock'

Structure & Scope

Public commands: Never use InModuleScope (unless retrieving localized strings)

Private functions/class resources: Always use InModuleScope

Each class method = separate Context block

Each scenario = separate Context block

Use nested Context blocks for complex scenarios

Mocking in BeforeAll (BeforeEach only when required)

Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach

Use -BeTrue/-BeFalse never -Be $true/-Be $false

Never use Assert-MockCalled, use Should -Invoke instead

No Should -Not -Throw - invoke commands directly

Never add an empty -MockWith block

Omit -MockWith when returning $null

Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName

Omit -ModuleName parameter on Pester commands

Never use Mock inside `InModuleSc...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
No mocking - real environment only
Cover all scenarios and code paths
Use Get-ComputerName for computer names in CI
Avoid ExpectedMessage for Should -Throw assertions
Only run integration tests in CI unless explicitly instructed.
Call commands with -Force parameter where applicable (avoids prompting).
Use -ErrorAction 'Stop' on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Invoke-SqlDscQuery.Integration.Tests.ps1
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

**/*.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

Wrap lines at word boundaries when over 80 characters (except tables/code blocks)

Use 2 spaces for indentation

Use '1.' for all items in ordered lists (1/1/1 numbering style)

Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters

Empty lines required before/after code blocks and headings (except before line 1)

Escape backslashes in file paths only (not in code blocks)

Code blocks must specify language identifiers

Text Formatting

Parameters: bold

Values/literals: inline code

Resource/module/product names: italic

Commands/files/paths: inline code

Files:

tests/Integration/Commands/README.md
CHANGELOG.md

CHANGELOG.md

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

Always update the Unreleased section in CHANGELOG.md

Use Keep a Changelog format

Describe notable changes briefly, ≤2 items per change type

Reference issues using format issue #<issue_number>

No empty lines between list items in same section

Skip adding entry if same change already exists in Unreleased section

No duplicate sections or items in Unreleased section

Files:

CHANGELOG.md

🧠 Learnings (17)

📓 Common learnings

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Integration tests must use Connect-SqlDscDatabaseEngine with correct CI credentials and call Disconnect-SqlDscDatabaseEngine after

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Add integration tests for all public commands (and resources)

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/README.md
azure-pipelines.yml

📚 Learning: 2025-09-16T16:34:44.689Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md:0-0
Timestamp: 2025-09-16T16:34:44.689Z
Learning: Applies to tests/[Uu]nit/**/*.[Tt]ests.ps1 : Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: In unit tests, add $env:SqlServerDscCI = $true in BeforeAll and remove it in AfterAll

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Consult tests/Integration/Commands/README.md and tests/Integration/Resources/README.md for integration test configuration

Applied to files:

tests/Integration/Commands/README.md

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Public PowerShell commands must follow the naming format: {Verb}-SqlDsc{Noun}

Applied to files:

tests/Integration/Commands/README.md

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Integration tests must use Connect-SqlDscDatabaseEngine with correct CI credentials and call Disconnect-SqlDscDatabaseEngine after

Applied to files:

tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Applies to azure-pipelines.yml : Integration test script files must be added to a group within the test stage in ./azure-pipelines.yml, choosing an appropriate group number based on dependencies

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Call commands with -Force where applicable to avoid prompting

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Cover all scenarios and code paths in integration tests

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-12T13:21:31.054Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : All public commands and class-based resources must have integration tests

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Unit/{Classes,Public,Private}/*.Tests.ps1 : Add unit tests for all commands, functions, and resources

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use -ErrorAction 'Stop' on commands so failures surface immediately

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/Integration/Resources/*.Integration.Tests.ps1 : Place resource integration tests at tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Applied to files:

azure-pipelines.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: dsccommunity.SqlServerDsc (Quality Test and Unit Test Determine DSC Resource Test Requirements)
GitHub Check: dsccommunity.SqlServerDsc (Quality Test and Unit Test Unit)
GitHub Check: dsccommunity.SqlServerDsc (Quality Test and Unit Test HQRM)
GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)

…me for computer name

…e test scripts

…e readability and add cleanup step for disconnecting from SQL Server

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2cc9d20 and a76c7f9.

📒 Files selected for processing (4)

azure-pipelines.yml (1 hunks)
tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1 (3 hunks)
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

🧰 Additional context used

📓 Path-based instructions (10)

**/*.[Tt]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

All public commands, private functions and classes must have unit tests

All public commands and class-based resources must have integration tests

Use Pester v5 syntax only

Test code only inside Describe blocks

Assertions only in It blocks

Never test verbose messages, debug messages or parameter binding behavior

Pass all mandatory parameters to avoid prompts

Requirements

Inside It blocks, assign unused return objects to $null (unless part of pipeline)

Tested entity must be called from within the It blocks

Keep results and assertions in same It block

Avoid try-catch-finally for cleanup, use AfterAll or AfterEach

Avoid unnecessary remove/recreate cycles

Naming

One Describe block per file matching the tested entity name

Context descriptions start with 'When'

It descriptions start with 'Should', must not contain 'when'

Mock variables prefix: 'mock'

Structure & Scope

Public commands: Never use InModuleScope (unless retrieving localized strings)

Private functions/class resources: Always use InModuleScope

Each class method = separate Context block

Each scenario = separate Context block

Use nested Context blocks for complex scenarios

Mocking in BeforeAll (BeforeEach only when required)

Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach

Use -BeTrue/-BeFalse never -Be $true/-Be $false

Never use Assert-MockCalled, use Should -Invoke instead

No Should -Not -Throw - invoke commands directly

Never add an empty -MockWith block

Omit -MockWith when returning $null

Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName

Omit -ModuleName parameter on Pester commands

Never use Mock inside `InModuleSc...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.{ps1,psm1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.{ps1,psm1,psd1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

tests/Integration/Commands/*.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

tests/Integration/Commands/*.Integration.Tests.ps1: Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Add integration tests for all public commands (and resources)

Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: Do not use mocking in integration tests; run against a real environment
Cover all scenarios and code paths in integration tests
Use Get-ComputerName to determine computer names in CI
Avoid using -ExpectedMessage with Should -Throw assertions
Call commands with -Force where applicable to avoid prompting
Use -ErrorAction 'Stop' on commands so failures surface immediately
Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
No mocking - real environment only
Cover all scenarios and code paths
Use Get-ComputerName for computer names in CI
Avoid ExpectedMessage for Should -Throw assertions
Only run integration tests in CI unless explicitly instructed.
Call commands with -Force parameter where applicable (avoids prompting).
Use -ErrorAction 'Stop' on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

Command: Public command

Function: Private function

Resource: DSC class-based resource

Build & Test Workflow Requirements

Run PowerShell script files from repository root

Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop

Build project before running tests: ./build.ps1 -Tasks build

Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

Public commands: source/Public/{CommandName}.ps1

Private functions: source/Private/{FunctionName}.ps1

Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1

Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

Follow instructions over existing code patterns

Follow PowerShell style and test guideline instructions strictly

Always update CHANGELOG.md Unreleased section

Localize all strings using string keys; remove any orphaned string keys

Check DscResource.Common before creating private functions

Separate reusable logic into private functions

DSC resources should always be created as class-based resources

Add unit tests for all commands/functions/resources

Add integration tests for all public commands and resources

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/README.md
azure-pipelines.yml

{**/*.ps1,**/*.psm1,**/*.psd1}

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

Use descriptive names (3+ characters, no abbreviations)

Functions: PascalCase with Verb-Noun format using approved verbs

Parameters: PascalCase

Variables: camelCase

Keywords: lower-case

Classes: PascalCase

Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

Use 4 spaces (no tabs)

One space around operators: $a = 1 + 2

One space between type and variable: [String] $name

One space between keyword and parenthesis: if ($condition)

No spaces on empty lines

Try to limit lines to 120 characters

Braces

Newline before opening brace (except variable assignments)

One newline after opening brace

Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

Single line: @('one', 'two', 'three')

Multi-line: each element on separate line with proper indentation

Do not use the unary comma operator (,) in return statements to force
an array

Hashtables

Empty: @{}

Each property on separate line with proper indentation

Properties: Use PascalCase

Comments

Single line: # Comment (capitalized, on own line)

Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text

No commented-out code

Comment-based help

Always add comment-based help to all functions and scripts

Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class

Comment-based help indentation: keywords 4 spaces, text 8 spaces

Include examples for all parameter sets and combinations

INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

**/*.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

tests/Integration/Commands/README.md

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

Wrap lines at word boundaries when over 80 characters (except tables/code blocks)

Use 2 spaces for indentation

Use '1.' for all items in ordered lists (1/1/1 numbering style)

Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters

Empty lines required before/after code blocks and headings (except before line 1)

Escape backslashes in file paths only (not in code blocks)

Code blocks must specify language identifiers

Text Formatting

Parameters: bold

Values/literals: inline code

Resource/module/product names: italic

Commands/files/paths: inline code

Files:

tests/Integration/Commands/README.md

azure-pipelines.yml

📄 CodeRabbit inference engine (.github/instructions/SqlServerDsc-guidelines.instructions.md)

Integration test script files must be added to a group within the test stage in ./azure-pipelines.yml, choosing an appropriate group number based on dependencies

Files:

azure-pipelines.yml

🧠 Learnings (15)

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Add integration tests for all public commands (and resources)

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/README.md
azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use Get-ComputerName to determine computer names in CI

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:34:44.689Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md:0-0
Timestamp: 2025-09-16T16:34:44.689Z
Learning: Applies to tests/[Uu]nit/**/*.[Tt]ests.ps1 : Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: In unit tests, add $env:SqlServerDscCI = $true in BeforeAll and remove it in AfterAll

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Testing CI environment instances: DSCSQLTEST (Database Engine), SSRS (Reporting Services), PBIRS (Power BI Report Server)

Applied to files:

tests/Integration/Commands/README.md

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Applies to azure-pipelines.yml : Integration test script files must be added to a group within the test stage in ./azure-pipelines.yml, choosing an appropriate group number based on dependencies

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Cover all scenarios and code paths in integration tests

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Call commands with -Force where applicable to avoid prompting

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-12T13:21:31.054Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : All public commands and class-based resources must have integration tests

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Unit/{Classes,Public,Private}/*.Tests.ps1 : Add unit tests for all commands, functions, and resources

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/Integration/Resources/*.Integration.Tests.ps1 : Place resource integration tests at tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use -ErrorAction 'Stop' on commands so failures surface immediately

Applied to files:

azure-pipelines.yml

📚 Learning: 2025-09-12T13:21:31.054Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : Cover all scenarios and code paths

Applied to files:

azure-pipelines.yml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
GitHub Check: PSScriptAnalyzer
GitHub Check: PSScriptAnalyzer

codecov · 2025-10-12T12:49:27Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94%. Comparing base (99ad254) to head (41ab95d).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@         Coverage Diff          @@
##           main   #2303   +/-   ##
====================================
  Coverage    94%     94%           
====================================
  Files       150     150           
  Lines      9239    9239           
====================================
  Hits       8751    8751           
  Misses      488     488

Flag	Coverage Δ
unit	`94% <ø> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…gration tests

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a76c7f9 and adc0f43.

📒 Files selected for processing (1)

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1 (1 hunks)

🧰 Additional context used

📓 Path-based instructions (8)

**/*.[Tt]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

All public commands, private functions and classes must have unit tests

All public commands and class-based resources must have integration tests

Use Pester v5 syntax only

Test code only inside Describe blocks

Assertions only in It blocks

Never test verbose messages, debug messages or parameter binding behavior

Pass all mandatory parameters to avoid prompts

Requirements

Inside It blocks, assign unused return objects to $null (unless part of pipeline)

Tested entity must be called from within the It blocks

Keep results and assertions in same It block

Avoid try-catch-finally for cleanup, use AfterAll or AfterEach

Avoid unnecessary remove/recreate cycles

Naming

One Describe block per file matching the tested entity name

Context descriptions start with 'When'

It descriptions start with 'Should', must not contain 'when'

Mock variables prefix: 'mock'

Structure & Scope

Public commands: Never use InModuleScope (unless retrieving localized strings)

Private functions/class resources: Always use InModuleScope

Each class method = separate Context block

Each scenario = separate Context block

Use nested Context blocks for complex scenarios

Mocking in BeforeAll (BeforeEach only when required)

Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach

Use -BeTrue/-BeFalse never -Be $true/-Be $false

Never use Assert-MockCalled, use Should -Invoke instead

No Should -Not -Throw - invoke commands directly

Never add an empty -MockWith block

Omit -MockWith when returning $null

Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName

Omit -ModuleName parameter on Pester commands

Never use Mock inside `InModuleSc...

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**/*.{ps1,psm1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**/*.{ps1,psm1,psd1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

tests/Integration/Commands/*.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

tests/Integration/Commands/*.Integration.Tests.ps1: Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Add integration tests for all public commands (and resources)

Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**/*.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: Do not use mocking in integration tests; run against a real environment
Cover all scenarios and code paths in integration tests
Use Get-ComputerName to determine computer names in CI
Avoid using -ExpectedMessage with Should -Throw assertions
Call commands with -Force where applicable to avoid prompting
Use -ErrorAction 'Stop' on commands so failures surface immediately
Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
No mocking - real environment only
Cover all scenarios and code paths
Use Get-ComputerName for computer names in CI
Avoid ExpectedMessage for Should -Throw assertions
Only run integration tests in CI unless explicitly instructed.
Call commands with -Force parameter where applicable (avoids prompting).
Use -ErrorAction 'Stop' on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

Command: Public command

Function: Private function

Resource: DSC class-based resource

Build & Test Workflow Requirements

Run PowerShell script files from repository root

Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop

Build project before running tests: ./build.ps1 -Tasks build

Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

Public commands: source/Public/{CommandName}.ps1

Private functions: source/Private/{FunctionName}.ps1

Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1

Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

Follow instructions over existing code patterns

Follow PowerShell style and test guideline instructions strictly

Always update CHANGELOG.md Unreleased section

Localize all strings using string keys; remove any orphaned string keys

Check DscResource.Common before creating private functions

Separate reusable logic into private functions

DSC resources should always be created as class-based resources

Add unit tests for all commands/functions/resources

Add integration tests for all public commands and resources

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

{**/*.ps1,**/*.psm1,**/*.psd1}

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

Use descriptive names (3+ characters, no abbreviations)

Functions: PascalCase with Verb-Noun format using approved verbs

Parameters: PascalCase

Variables: camelCase

Keywords: lower-case

Classes: PascalCase

Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

Use 4 spaces (no tabs)

One space around operators: $a = 1 + 2

One space between type and variable: [String] $name

One space between keyword and parenthesis: if ($condition)

No spaces on empty lines

Try to limit lines to 120 characters

Braces

Newline before opening brace (except variable assignments)

One newline after opening brace

Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

Single line: @('one', 'two', 'three')

Multi-line: each element on separate line with proper indentation

Do not use the unary comma operator (,) in return statements to force
an array

Hashtables

Empty: @{}

Each property on separate line with proper indentation

Properties: Use PascalCase

Comments

Single line: # Comment (capitalized, on own line)

Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text

No commented-out code

Comment-based help

Always add comment-based help to all functions and scripts

Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class

Comment-based help indentation: keywords 4 spaces, text 8 spaces

Include examples for all parameter sets and combinations

INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

🧠 Learnings (3)

📓 Common learnings

Learnt from: johlju
PR: dsccommunity/SqlServerDsc#2303
File: tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1:127-143
Timestamp: 2025-10-12T12:10:48.606Z
Learning: For the SqlServerDsc module integration tests, ForceEncryption should not be enabled on the SQL Server instance (DSCSQLTEST) because the module needs to test both encrypted and non-encrypted connection scenarios in CI.

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Integration tests must use Connect-SqlDscDatabaseEngine with correct CI credentials and call Disconnect-SqlDscDatabaseEngine after

Applied to files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: In unit tests, add $env:SqlServerDscCI = $true in BeforeAll and remove it in AfterAll

Applied to files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
GitHub Check: PSScriptAnalyzer

… in integration tests

…scConfigurationOption calls in integration tests

…od for improved clarity

coderabbitai

Actionable comments posted: 3

♻️ Duplicate comments (1)

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1 (1)
54-61: Split AfterAll into two blocks and add -ErrorAction 'Stop' to Disconnect.

The single AfterAll block has a reliability concern: if the restoration on line 58 throws, line 61 (Disconnect) won't execute, potentially leaving connections open. Pester executes all AfterAll blocks even if one fails, ensuring complete cleanup. Additionally, line 61 is missing -ErrorAction 'Stop' per integration test guidelines.

Apply this diff:
     AfterAll {
         # Restore the original value of 'Agent XPs' if it was not 1
         if ($script:originalAgentXPsValue -ne 1)
         {
             Set-SqlDscConfigurationOption -ServerObject $script:serverObject -Name 'Agent XPs' -Value $script:originalAgentXPsValue -Force -ErrorAction 'Stop'
         }
+    }
+
+    AfterAll {
-        Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject
+        Disconnect-SqlDscDatabaseEngine -ServerObject $script:serverObject -ErrorAction 'Stop'
     }
Based on learnings

🧹 Nitpick comments (2)

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (2)

97-97: Add -ErrorAction 'Stop' to certificate retrieval.

Line 97 retrieves the certificate for further ACL processing without -ErrorAction 'Stop'. Per integration test guidelines, commands should use -ErrorAction 'Stop' so failures surface immediately, especially when the result is used for critical downstream operations.

Apply this diff:

             # Get the certificate from the Personal store
-            $cert = Get-ChildItem -Path "Cert:\LocalMachine\My\$script:certificateThumbprint"
+            $cert = Get-ChildItem -Path "Cert:\LocalMachine\My\$script:certificateThumbprint" -ErrorAction 'Stop'

Based on learnings

212-213: Add AfterAll block to clean up certificate resources.

The test creates a certificate, exports it to a file, imports it to Trusted Root, and leaves these resources behind. Add an AfterAll block to clean up the certificate from both stores and delete the exported file to avoid resource leaks and interference with subsequent test runs.

Add this AfterAll block before the closing brace of the Context block:

        AfterAll {
            # Remove certificate from Trusted Root store
            if ($script:certificateThumbprint)
            {
                $trustedCert = Get-ChildItem -Path 'Cert:\LocalMachine\Root' -ErrorAction 'SilentlyContinue' |
                    Where-Object -FilterScript { $_.Thumbprint -eq $script:certificateThumbprint }

                if ($trustedCert)
                {
                    Remove-Item -Path "Cert:\LocalMachine\Root\$script:certificateThumbprint" -Force -ErrorAction 'Stop'
                }
            }

            # Remove certificate from Personal store
            if ($script:certificateThumbprint)
            {
                $personalCert = Get-ChildItem -Path 'Cert:\LocalMachine\My' -ErrorAction 'SilentlyContinue' |
                    Where-Object -FilterScript { $_.Thumbprint -eq $script:certificateThumbprint }

                if ($personalCert)
                {
                    Remove-Item -Path "Cert:\LocalMachine\My\$script:certificateThumbprint" -Force -ErrorAction 'Stop'
                }
            }

            # Remove exported certificate file
            if ($script:certificatePath -and (Test-Path -Path $script:certificatePath))
            {
                Remove-Item -Path $script:certificatePath -Force -ErrorAction 'Stop'
            }
        }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b01cd7 and e111b04.

📒 Files selected for processing (2)

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1 (1 hunks)
tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 (1 hunks)

🧰 Additional context used

📓 Path-based instructions (8)

**/*.[Tt]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-pester.instructions.md)

**/*.[Tt]ests.ps1: All public commands, private functions, and classes must have unit tests
All public commands and class-based resources must have integration tests
Use Pester v5 syntax only
Test code only inside Describe blocks
Assertions only in It blocks
Never test verbose messages, debug messages, or parameter binding behavior
Pass all mandatory parameters to avoid prompts
Inside It blocks, assign unused return objects to $null (unless part of a pipeline)
Call the tested entity from within the It blocks
Keep results and assertions in the same It block
Avoid try/catch/finally for cleanup; use AfterAll or AfterEach
Avoid unnecessary remove/recreate cycles
One Describe block per file matching the tested entity name
Context descriptions start with 'When'
It descriptions start with 'Should' and must not contain 'when'
Mock variables must be prefixed with 'mock'
Public commands: never use InModuleScope (except for retrieving localized strings)
Private functions and class resources: always use InModuleScope
Each class method gets a separate Context block
Each scenario gets a separate Context block
Use nested Context blocks for complex scenarios
Perform mocking in BeforeAll (use BeforeEach only when required)
Place setup/teardown (BeforeAll/BeforeEach/AfterAll/AfterEach) close to usage
Use PascalCase for Pester keywords: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach
Use -BeTrue/-BeFalse; never use -Be $true/-Be $false
Never use Assert-MockCalled; use Should -Invoke instead
Do not use Should -Not -Throw; invoke commands directly
Never add an empty -MockWith block
Omit -MockWith when returning $null
Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, and InModuleScope:ModuleName
Omit the -ModuleName parameter on Pester commands
Never use Mock inside an InModuleScope block
Define variables for -ForEach in a separate BeforeDiscovery near usage
Use -ForEach only on Context and It blocks
Keep variable scope close to the usage c...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

**/*.[Tt]ests.ps1: # Tests Guidelines

Core Requirements

All public commands, private functions and classes must have unit tests

All public commands and class-based resources must have integration tests

Use Pester v5 syntax only

Test code only inside Describe blocks

Assertions only in It blocks

Never test verbose messages, debug messages or parameter binding behavior

Pass all mandatory parameters to avoid prompts

Requirements

Inside It blocks, assign unused return objects to $null (unless part of pipeline)

Tested entity must be called from within the It blocks

Keep results and assertions in same It block

Avoid try-catch-finally for cleanup, use AfterAll or AfterEach

Avoid unnecessary remove/recreate cycles

Naming

One Describe block per file matching the tested entity name

Context descriptions start with 'When'

It descriptions start with 'Should', must not contain 'when'

Mock variables prefix: 'mock'

Structure & Scope

Public commands: Never use InModuleScope (unless retrieving localized strings)

Private functions/class resources: Always use InModuleScope

Each class method = separate Context block

Each scenario = separate Context block

Use nested Context blocks for complex scenarios

Mocking in BeforeAll (BeforeEach only when required)

Setup/teardown in BeforeAll,BeforeEach/AfterAll,AfterEach close to usage

Syntax Rules

PascalCase: Describe, Context, It, Should, BeforeAll, BeforeEach, AfterAll, AfterEach

Use -BeTrue/-BeFalse never -Be $true/-Be $false

Never use Assert-MockCalled, use Should -Invoke instead

No Should -Not -Throw - invoke commands directly

Never add an empty -MockWith block

Omit -MockWith when returning $null

Set $PSDefaultParameterValues for Mock:ModuleName, Should:ModuleName, InModuleScope:ModuleName

Omit -ModuleName parameter on Pester commands

Never use Mock inside `InModuleSc...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**/*.{ps1,psm1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1}: Use descriptive names (3+ characters, no abbreviations)
Function names use PascalCase Verb-Noun with approved verbs
Parameter names use PascalCase
Variable names use camelCase
Keywords are lower-case
Class names use PascalCase
Include scope prefixes for script/global/environment variables: $script:, $global:, $env:
Use one space around operators (e.g., $a = 1 + 2)
Use one space between type and variable (e.g., [String] $name)
Use one space between keyword and parenthesis (e.g., if ($condition))
Place newline before opening brace (except variable assignments)
One newline after opening brace
Two newlines after closing brace (one if followed by another brace or continuation)
Use single quotes unless variable expansion is needed
Arrays on one line use @('one','two'); multi-line arrays have one element per line with proper indentation
Do not use unary comma in return statements to force an array
Single-line comments: '# Comment' capitalized on its own line
Multi-line comments use <# #> with brackets on their own lines and indented text
No commented-out code
Add comment-based help to all functions and scripts
Comment-based help must include SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, and EXAMPLE sections before function/class
Comment-based help indentation: keywords at 4 spaces, text at 8 spaces
Include examples for all parameter sets and combinations
INPUTS: list each pipeline-accepted type with one-line description; repeat .INPUTS per type
OUTPUTS: list each return type with one-line description; repeat .OUTPUTS per type; must match [OutputType()] and actual returns
.NOTES only if critical (constraints, side effects, security, version compatibility, breaking behavior), ≤2 short sentences
Avoid aliases; use full command names
Avoid Write-Host; prefer Write-Verbose/Write-Information/etc.
Avoid Write-Output; use return instead
Do not use ConvertTo-SecureString -AsPlainText in production code
Do not redefine reserved parameters (Verbose, Debug, etc.)
In...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**/*.{ps1,psm1,psd1}

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-powershell.instructions.md)

**/*.{ps1,psm1,psd1}: Indent with 4 spaces; do not use tabs
No spaces on empty lines
Try to limit lines to 120 characters
Empty hashtable is @{}
Hashtable: each property on its own line with proper indentation
Hashtable property names use PascalCase
End files with exactly one blank line
Use line endings as defined by .gitattributes policy
Allow at most two consecutive newlines
No trailing whitespace on any line
Use UTF-8 encoding without BOM for all files

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

tests/Integration/Commands/*.Integration.Tests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

tests/Integration/Commands/*.Integration.Tests.ps1: Place integration tests for public commands in tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Add integration tests for all public commands (and resources)

Place command integration tests at tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**/*.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines.instructions.md)

Follow PowerShell style and test guideline instructions strictly

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md)

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: Do not use mocking in integration tests; run against a real environment
Cover all scenarios and code paths in integration tests
Use Get-ComputerName to determine computer names in CI
Avoid using -ExpectedMessage with Should -Throw assertions
Call commands with -Force where applicable to avoid prompting
Use -ErrorAction 'Stop' on commands so failures surface immediately
Include the required Pester setup block (SuppressMessage param, BeforeDiscovery loading DscResource.Test, and BeforeAll importing the module)

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

⚙️ CodeRabbit configuration file

tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1: # Integration Tests Guidelines

Requirements

Location Commands: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1
Location Resources: tests/Integration/Resources/{ResourceName}.Integration.Tests.ps1
No mocking - real environment only
Cover all scenarios and code paths
Use Get-ComputerName for computer names in CI
Avoid ExpectedMessage for Should -Throw assertions
Only run integration tests in CI unless explicitly instructed.
Call commands with -Force parameter where applicable (avoids prompting).
Use -ErrorAction 'Stop' on commands so failures surface immediately

Required Setup Block

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '', Justification = 'Suppressing this rule because Script Analyzer does not understand Pester syntax.')]
param ()

BeforeDiscovery {
    try
    {
        if (-not (Get-Module -Name 'DscResource.Test'))
        {
            # Assumes dependencies have been resolved, so if this module is not available, run 'noop' task.
            if (-not (Get-Module -Name 'DscResource.Test' -ListAvailable))
            {
                # Redirect all streams to $null, except the error stream (stream 2)
                & "$PSScriptRoot/../../../build.ps1" -Tasks 'noop' 3>&1 4>&1 5>&1 6>&1 > $null
            }

            # If the dependencies have not been resolved, this will throw an error.
            Import-Module -Name 'DscResource.Test' -Force -ErrorAction 'Stop'
        }
    }
    catch [System.IO.FileNotFoundException]
    {
        throw 'DscResource.Test module dependency not found. Please run ".\build.ps1 -ResolveDependency -Tasks noop" first.'
    }
}

BeforeAll {
    $script:moduleName = '{MyModuleName}'

    Import-Module -Name $script:moduleName -Force -ErrorAction 'Stop'
}

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

Command: Public command

Function: Private function

Resource: DSC class-based resource

Build & Test Workflow Requirements

Run PowerShell script files from repository root

Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop

Build project before running tests: ./build.ps1 -Tasks build

Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

Public commands: source/Public/{CommandName}.ps1

Private functions: source/Private/{FunctionName}.ps1

Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1

Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

Follow instructions over existing code patterns

Follow PowerShell style and test guideline instructions strictly

Always update CHANGELOG.md Unreleased section

Localize all strings using string keys; remove any orphaned string keys

Check DscResource.Common before creating private functions

Separate reusable logic into private functions

DSC resources should always be created as class-based resources

Add unit tests for all commands/functions/resources

Add integration tests for all public commands and resources

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

{**/*.ps1,**/*.psm1,**/*.psd1}

⚙️ CodeRabbit configuration file

{**/*.ps1,**/*.psm1,**/*.psd1}: # PowerShell Guidelines

Naming

Use descriptive names (3+ characters, no abbreviations)

Functions: PascalCase with Verb-Noun format using approved verbs

Parameters: PascalCase

Variables: camelCase

Keywords: lower-case

Classes: PascalCase

Include scope for script/global/environment variables: $script:, $global:, $env:

File naming

Class files: ###.ClassName.ps1 format (e.g. 001.SqlReason.ps1, 004.StartupParameters.ps1)

Formatting

Indentation & Spacing

Use 4 spaces (no tabs)

One space around operators: $a = 1 + 2

One space between type and variable: [String] $name

One space between keyword and parenthesis: if ($condition)

No spaces on empty lines

Try to limit lines to 120 characters

Braces

Newline before opening brace (except variable assignments)

One newline after opening brace

Two newlines after closing brace (one if followed by another brace or continuation)

Quotes

Use single quotes unless variable expansion is needed: 'text' vs "text $variable"

Arrays

Single line: @('one', 'two', 'three')

Multi-line: each element on separate line with proper indentation

Do not use the unary comma operator (,) in return statements to force
an array

Hashtables

Empty: @{}

Each property on separate line with proper indentation

Properties: Use PascalCase

Comments

Single line: # Comment (capitalized, on own line)

Multi-line: <# Comment #> format (opening and closing brackets on own line), and indent text

No commented-out code

Comment-based help

Always add comment-based help to all functions and scripts

Comment-based help: SYNOPSIS, DESCRIPTION (40+ chars), PARAMETER, EXAMPLE sections before function/class

Comment-based help indentation: keywords 4 spaces, text 8 spaces

Include examples for all parameter sets and combinations

INPUTS: List each pipeline‑accepted type (one per line) with a 1‑line description...

Files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

🧠 Learnings (12)

📓 Common learnings

Learnt from: johlju
PR: dsccommunity/SqlServerDsc#2303
File: tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1:127-143
Timestamp: 2025-10-12T12:10:48.606Z
Learning: For the SqlServerDsc module integration tests, ForceEncryption should not be enabled on the SQL Server instance (DSCSQLTEST) because the module needs to test both encrypted and non-encrypted connection scenarios in CI.

📚 Learning: 2025-09-16T16:35:31.909Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines.instructions.md:0-0
Timestamp: 2025-09-16T16:35:31.909Z
Learning: Applies to tests/Integration/Commands/*.Integration.Tests.ps1 : Add integration tests for all public commands (and resources)

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-12T13:21:31.054Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-pester.instructions.md:0-0
Timestamp: 2025-09-12T13:21:31.054Z
Learning: Applies to **/*.[Tt]ests.ps1 : All public commands and class-based resources must have integration tests

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use Get-ComputerName to determine computer names in CI

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:34:27.319Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-powershell.instructions.md:0-0
Timestamp: 2025-09-16T16:34:27.319Z
Learning: Applies to **/*.{ps1,psm1} : Prefer ::new() over New-Object for .NET types

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-10-12T12:10:48.606Z

Learnt from: johlju
PR: dsccommunity/SqlServerDsc#2303
File: tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1:127-143
Timestamp: 2025-10-12T12:10:48.606Z
Learning: For the SqlServerDsc module integration tests, ForceEncryption should not be enabled on the SQL Server instance (DSCSQLTEST) because the module needs to test both encrypted and non-encrypted connection scenarios in CI.

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:34:44.689Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-unit-tests.instructions.md:0-0
Timestamp: 2025-09-16T16:34:44.689Z
Learning: Applies to tests/[Uu]nit/**/*.[Tt]ests.ps1 : Include the exact Pester setup block before Describe: SuppressMessage attribute with param (); BeforeDiscovery to ensure DscResource.Test is available (fallback to build.ps1 -Tasks 'noop') and Import-Module; BeforeAll to set $script:moduleName, import the module, and set PSDefaultParameterValues for InModuleScope/Mock/Should; AfterAll to remove those defaults and unload the tested module

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: In unit tests, add $env:SqlServerDscCI = $true in BeforeAll and remove it in AfterAll

Applied to files:

tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1
tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Use -ErrorAction 'Stop' on commands so failures surface immediately

Applied to files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

📚 Learning: 2025-10-12T11:23:30.111Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-integration-tests.instructions.md:0-0
Timestamp: 2025-10-12T11:23:30.111Z
Learning: Applies to tests/[iI]ntegration/**/*.[iI]ntegration.[tT]ests.ps1 : Call commands with -Force where applicable to avoid prompting

Applied to files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

📚 Learning: 2025-09-16T16:34:27.319Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/dsc-community-style-guidelines-powershell.instructions.md:0-0
Timestamp: 2025-09-16T16:34:27.319Z
Learning: Applies to **/*.{ps1,psm1} : Set $ErrorActionPreference='Stop' immediately before commands using -ErrorAction 'Stop' and restore after; do not use try-catch-finally for this

Applied to files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

📚 Learning: 2025-09-23T10:20:59.832Z

Learnt from: CR
PR: dsccommunity/SqlServerDsc#0
File: .github/instructions/SqlServerDsc-guidelines.instructions.md:0-0
Timestamp: 2025-09-23T10:20:59.832Z
Learning: Integration tests must use Connect-SqlDscDatabaseEngine with correct CI credentials and call Disconnect-SqlDscDatabaseEngine after

Applied to files:

tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
GitHub Check: PSScriptAnalyzer
GitHub Check: PSScriptAnalyzer

…uration integration tests for improved error handling

… integration tests

Add integration tests for SSL certificate setup

81d259f

johlju requested a review from a team as a code owner October 12, 2025 11:33

Merge branch 'main' into fix/issue#2290

2cc9d20

coderabbitai Bot reviewed Oct 12, 2025

View reviewed changes

Comment thread tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

Comment thread tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

Comment thread tests/Integration/Commands/README.md Outdated

coderabbitai Bot reviewed Oct 12, 2025

View reviewed changes

Comment thread CHANGELOG.md

Comment thread tests/Integration/Commands/Connect-SqlDscDatabaseEngine.Integration.Tests.ps1

Comment thread tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

johlju added 4 commits October 12, 2025 13:56

Add cleanup step to disconnect from SQL Server after tests

8fc69c9

Update SSL certificate configuration to use fully qualified domain na…

e728036

…me for computer name

Refactor integration test command groups in README and update pipelin…

bbff4c4

…e test scripts

Refactor integration tests for Connect-SqlDscDatabaseEngine to improv…

a76c7f9

…e readability and add cleanup step for disconnecting from SQL Server

coderabbitai Bot reviewed Oct 12, 2025

View reviewed changes

Comment thread tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1 Outdated

Comment thread tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

johlju commented Oct 12, 2025

View reviewed changes

Comment thread tests/Integration/Commands/PostInstallationConfiguration.Integration.Tests.ps1

coderabbitai Bot mentioned this pull request Oct 12, 2025

Refactor DSC_SqlSecureConnection private functions to public commands #2304

Open

Add logic to set and restore 'Agent XPs' configuration option in inte…

adc0f43

…gration tests

coderabbitai Bot reviewed Oct 12, 2025

View reviewed changes

Comment thread tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

Comment thread tests/Integration/Commands/Get-SqlDscConfigurationOption.Integration.Tests.ps1

johlju added 3 commits October 12, 2025 16:33

Add -Force parameter to Set-SqlDscConfigurationOption for 'Agent XPs'…

1b01cd7

… in integration tests

Add -ErrorAction 'Stop' to Get-SqlDscConfigurationOption and Set-SqlD…

a79a563

…scConfigurationOption calls in integration tests

Refactor access rule creation for private key file to use static meth…

e111b04

…od for improved clarity

coderabbitai Bot reviewed Oct 12, 2025

View reviewed changes

johlju added 2 commits October 12, 2025 18:04

Add -ErrorAction 'Stop' to various commands in PostInstallationConfig…

3b69a91

…uration integration tests for improved error handling

Add -ErrorAction 'Stop' to Get-ChildItem for certificate retrieval in…

41ab95d

… integration tests

johlju merged commit 8ec0a9a into dsccommunity:main Oct 12, 2025
22 of 23 checks passed

johlju deleted the fix/issue#2290 branch October 12, 2025 17:55

Conversation

johlju commented Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request (PR) description

This Pull Request (PR) fixes the following issues

Task list

Uh oh!

coderabbitai Bot commented Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Pre-merge checks

Core Requirements

Requirements

Naming

Structure & Scope

Syntax Rules

Requirements

Required Setup Block

Terminology

Build & Test Workflow Requirements

File Organization

Requirements

Naming

File naming

Formatting

Indentation & Spacing

Braces

Quotes

Arrays

Hashtables

Comments

Comment-based help

Uh oh!

johlju commented Oct 12, 2025

Uh oh!

coderabbitai Bot commented Oct 12, 2025

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Core Requirements

Requirements

Naming

Structure & Scope

Syntax Rules

Requirements

Required Setup Block

Terminology

Build & Test Workflow Requirements

File Organization

Requirements

Naming

File naming

Formatting

Indentation & Spacing

Braces

Quotes

Arrays

Hashtables

Comments

Comment-based help

Text Formatting

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Terminology

Build & Test Workflow Requirements

File Organization

Requirements

Naming

File naming

Formatting

Indentation & Spacing

Braces

johlju commented Oct 12, 2025 •

edited

Loading

coderabbitai Bot commented Oct 12, 2025 •

edited

Loading

codecov Bot commented Oct 12, 2025 •

edited

Loading