Pester migration - Third batch (#9531)

dataplat · Oct 27, 2024 · 2740d7d · 2740d7d
1 parent f2d3146
commit 2740d7d
Show file tree

Hide file tree

Showing 47 changed files with 2,113 additions and 1,106 deletions.
diff --git a/.aider/aider.psm1 b/.aider/aider.psm1
@@ -27,7 +27,10 @@ function Update-PesterTest {
 
     .PARAMETER MaxFileSize
         The maximum size of test files to process, in bytes. Files larger than this will be skipped.
-        Defaults to 8KB.
+        Defaults to 7.5kb.
+
+    .PARAMETER Model
+        The AI model to use (e.g., azure/gpt-4o, gpt-4o-mini, claude-3-5-sonnet).
 
     .NOTES
         Tags: Testing, Pester
@@ -61,7 +64,8 @@ function Update-PesterTest {
         [int]$Skip,
         [string[]]$PromptFilePath = "/workspace/.aider/prompts/template.md",
         [string[]]$CacheFilePath = @("/workspace/.aider/prompts/conventions.md","/workspace/private/testing/Get-TestConfig.ps1"),
-        [int]$MaxFileSize = 8kb
+        [int]$MaxFileSize = 7.5kb,
+        [string]$Model
     )
     begin {
         # Full prompt path
@@ -158,9 +162,10 @@ function Update-PesterTest {
                     Message      = $cmdPrompt
                     File         = $filename
                     YesAlways    = $true
-                    Stream       = $false
+                    NoStream     = $true
                     CachePrompts = $true
                     ReadFile     = $CacheFilePath
+                    Model        = $Model
                 }
 
                 Write-Verbose "Invoking Aider to update test file"
@@ -244,7 +249,7 @@ function Repair-Error {
         $aiderParams = @{
             Message      = $cmdPrompt
             File         = $filename
-            Stream       = $false
+            NoStream     = $true
             CachePrompts = $true
             ReadFile     = $CacheFilePath
         }
@@ -386,7 +391,7 @@ function Repair-SmallThing {
             }
 
             # if file is larger than MaxFileSize, skip
-            if ((Get-Item $filename).Length -gt 8kb) {
+            if ((Get-Item $filename).Length -gt 7.5kb) {
                 Write-Warning "Skipping $cmdName because it's too large"
                 continue
             }
@@ -715,7 +720,7 @@ function Repair-Error {
         $aiderParams = @{
             Message      = $cmdPrompt
             File         = $filename
-            Stream       = $false
+            NoStream     = $true
             CachePrompts = $true
             ReadFile     = $CacheFilePath
         }

diff --git a/.aider/prompts/conventions.md b/.aider/prompts/conventions.md
@@ -126,28 +126,27 @@ Describe "Add-DbaAgReplica" -Tag "IntegrationTests" {
 
 ```powershell
 Describe "Get-DbaDatabase" -Tag "UnitTests" {
-   Context "Parameter validation" {
-       BeforeAll {
-           $command = Get-Command Get-DbaDatabase
-           $expected = $TestConfig.CommonParameters
-           $expected += @(
-               "SqlInstance",
-               "SqlCredential",
-               "Database",
-               "Confirm",
-               "WhatIf"
-           )
-       }
-
-       It "Has parameter: <_>" -ForEach $expected {
-           $command | Should -HaveParameter $PSItem
-       }
-
-       It "Should have exactly the number of expected parameters ($($expected.Count))" {
-           $hasparms = $command.Parameters.Values.Name
-           Compare-Object -ReferenceObject $expected -DifferenceObject $hasparms | Should -BeNullOrEmpty
-       }
-   }
+    BeforeAll {
+        $command = Get-Command Get-DbaDatabase
+        $expected = $TestConfig.CommonParameters
+        $expected += @(
+            "SqlInstance",
+            "SqlCredential",
+            "Database",
+            "Confirm",
+            "WhatIf"
+        )
+    }
+    Context "Parameter validation" {
+        It "Has parameter: <_>" -ForEach $expected {
+            $command | Should -HaveParameter $PSItem
+        }
+
+        It "Should have exactly the number of expected parameters ($($expected.Count))" {
+            $hasparms = $command.Parameters.Values.Name
+            Compare-Object -ReferenceObject $expected -DifferenceObject $hasparms | Should -BeNullOrEmpty
+        }
+    }
 }
 ```
 
@@ -172,11 +171,22 @@ Describe "Get-DbaDatabase" -Tag "IntegrationTests" {
 }
 ```
 
-## Additional instructions
+## Additional Instructions
+
+### Test Structure
+- Parameter validation must be tagged as Unit Test
+- No loose code outside of proper test blocks
+- Must maintain all instance reference comments (#TestConfig.instance3, etc.)
+
+### Syntax Requirements
+- Use $PSItem instead of $_
+- No trailing spaces
+- Use $results.Status.Count for accurate counting
+
+### Must Not Use
+- $MyInvocation.MyCommand.Name for command names
+- Old knownParameters validation approach
+- Assumed parameter names - match original tests exactly
 
-- DO NOT use `$MyInvocation.MyCommand.Name` to get command names
-- DO NOT use the old `knownParameters` validation approach
-- DO NOT include loose code outside of proper test blocks
-- DO NOT remove comments like "#TestConfig.instance3" or "#$TestConfig.instance2 for appveyor"
-- DO NOT use $_ DO use $PSItem instead
-- Parameter validation is ALWAYS tagged as a Unit Test
+# Important
+ALL comments must be preserved exactly as they appear in the original code, including seemingly unrelated or end-of-file comments. Even comments that appear to be development notes or temporary must be kept. This is especially important for comments related to CI/CD systems like AppVeyor.
diff --git a/tests/Copy-DbaAgentProxy.Tests.ps1 b/tests/Copy-DbaAgentProxy.Tests.ps1
@@ -1,19 +1,40 @@
-$CommandName = $MyInvocation.MyCommand.Name.Replace(".Tests.ps1", "")
-Write-Host -Object "Running $PSCommandPath" -ForegroundColor Cyan
-$global:TestConfig = Get-TestConfig
-
-Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
-    Context "Validate parameters" {
-        [object[]]$params = (Get-Command $CommandName).Parameters.Keys | Where-Object { $_ -notin ('whatif', 'confirm') }
-        [object[]]$knownParameters = 'Source', 'SourceSqlCredential', 'Destination', 'DestinationSqlCredential', 'ProxyAccount', 'ExcludeProxyAccount', 'Force', 'EnableException'
-        $knownParameters += [System.Management.Automation.PSCmdlet]::CommonParameters
-        It "Should only contain our specific parameters" {
-            (@(Compare-Object -ReferenceObject ($knownParameters | Where-Object { $_ }) -DifferenceObject $params).Count ) | Should Be 0
+#Requires -Module @{ ModuleName="Pester"; ModuleVersion="5.0"}
+param(
+    $ModuleName = "dbatools",
+    $PSDefaultParameterValues = ($TestConfig = Get-TestConfig).Defaults
+)
+
+Describe "Copy-DbaAgentProxy" -Tag "UnitTests" {
+    Context "Parameter validation" {
+        BeforeAll {
+            $command = Get-Command Copy-DbaAgentProxy
+            $expected = $TestConfig.CommonParameters
+            $expected += @(
+                "Source",
+                "SourceSqlCredential",
+                "Destination",
+                "DestinationSqlCredential",
+                "ProxyAccount",
+                "ExcludeProxyAccount",
+                "Force",
+                "EnableException",
+                "Confirm",
+                "WhatIf"
+            )
+        }
+
+        It "Has parameter: <_>" -ForEach $expected {
+            $command | Should -HaveParameter $PSItem
+        }
+
+        It "Should have exactly the number of expected parameters ($($expected.Count))" {
+            $hasparms = $command.Parameters.Values.Name
+            Compare-Object -ReferenceObject $expected -DifferenceObject $hasparms | Should -BeNullOrEmpty
         }
     }
 }
 
-Describe "$commandname Integration Tests" -Tag "IntegrationTests" {
+Describe "Copy-DbaAgentProxy" -Tag "IntegrationTests" {
     BeforeAll {
         $server = Connect-DbaInstance -SqlInstance $TestConfig.instance2
         $sql = "CREATE CREDENTIAL dbatoolsci_credential WITH IDENTITY = 'sa', SECRET = 'dbatools'"
@@ -25,6 +46,7 @@ Describe "$commandname Integration Tests" -Tag "IntegrationTests" {
         $sql = "CREATE CREDENTIAL dbatoolsci_credential WITH IDENTITY = 'sa', SECRET = 'dbatools'"
         $server.Query($sql)
     }
+
     AfterAll {
         $server = Connect-DbaInstance -SqlInstance $TestConfig.instance2
         $sql = "EXEC msdb.dbo.sp_delete_proxy @proxy_name = 'dbatoolsci_agentproxy'"
@@ -39,17 +61,19 @@ Describe "$commandname Integration Tests" -Tag "IntegrationTests" {
         $server.Query($sql)
     }
 
-    Context "Copies Agent Proxy" {
-        $results = Copy-DbaAgentProxy -Source $TestConfig.instance2 -Destination $TestConfig.instance3 -ProxyAccount dbatoolsci_agentproxy
+    Context "When copying agent proxy between instances" {
+        BeforeAll {
+            $results = Copy-DbaAgentProxy -Source $TestConfig.instance2 -Destination $TestConfig.instance3 -ProxyAccount dbatoolsci_agentproxy
+        }
 
-        It "returns one results" {
-            $results.Count -eq 1
-            $results.Status -eq "Successful"
+        It "Should return one successful result" {
+            $results.Status.Count | Should -Be 1
+            $results.Status | Should -Be "Successful"
         }
 
-        It "return one result that's skipped" {
-            $results = Get-DbaAgentProxy -SqlInstance $TestConfig.instance3 -Proxy dbatoolsci_agentproxy
-            $results.Count -eq 1
+        It "Should create the proxy on the destination" {
+            $proxyResults = Get-DbaAgentProxy -SqlInstance $TestConfig.instance3 -Proxy dbatoolsci_agentproxy
+            $proxyResults.Name | Should -Be "dbatoolsci_agentproxy"
         }
     }
 }
diff --git a/tests/Copy-DbaAgentSchedule.Tests.ps1 b/tests/Copy-DbaAgentSchedule.Tests.ps1
@@ -1,24 +1,47 @@
-$CommandName = $MyInvocation.MyCommand.Name.Replace(".Tests.ps1", "")
-Write-Host -Object "Running $PSCommandPath" -ForegroundColor Cyan
-$global:TestConfig = Get-TestConfig
-
-Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
-    Context "Validate parameters" {
-        [object[]]$params = (Get-Command $CommandName).Parameters.Keys | Where-Object { $_ -notin ('whatif', 'confirm') }
-        [object[]]$knownParameters = 'Source', 'SourceSqlCredential', 'Destination', 'DestinationSqlCredential', 'Force', 'EnableException', 'Schedule', 'Id', 'InputObject'
-        $knownParameters += [System.Management.Automation.PSCmdlet]::CommonParameters
-        It "Should only contain our specific parameters" {
-            (@(Compare-Object -ReferenceObject ($knownParameters | Where-Object { $_ }) -DifferenceObject $params).Count ) | Should Be 0
+#Requires -Module @{ ModuleName="Pester"; ModuleVersion="5.0"}
+param(
+    $ModuleName = "dbatools",
+    $PSDefaultParameterValues = ($TestConfig = Get-TestConfig).Defaults
+)
+
+Describe "Copy-DbaAgentSchedule" -Tag "UnitTests" {
+    Context "Parameter validation" {
+        BeforeAll {
+            $command = Get-Command Copy-DbaAgentSchedule
+            $expected = $TestConfig.CommonParameters
+            $expected += @(
+                "Source",
+                "SourceSqlCredential",
+                "Destination",
+                "DestinationSqlCredential",
+                "Schedule",
+                "Id",
+                "InputObject",
+                "Force",
+                "EnableException",
+                "Confirm",
+                "WhatIf"
+            )
+        }
+
+        It "Has parameter: <_>" -ForEach $expected {
+            $command | Should -HaveParameter $PSItem
+        }
+
+        It "Should have exactly the number of expected parameters ($($expected.Count))" {
+            $hasparms = $command.Parameters.Values.Name
+            Compare-Object -ReferenceObject $expected -DifferenceObject $hasparms | Should -BeNullOrEmpty
         }
     }
 }
 
-Describe "$commandname Integration Tests" -Tag "IntegrationTests" {
+Describe "Copy-DbaAgentSchedule" -Tag "IntegrationTests" {
     BeforeAll {
         $server = Connect-DbaInstance -SqlInstance $TestConfig.instance2
         $sql = "EXEC msdb.dbo.sp_add_schedule @schedule_name = N'dbatoolsci_DailySchedule' , @freq_type = 4, @freq_interval = 1, @active_start_time = 010000"
         $server.Query($sql)
     }
+
     AfterAll {
         $server = Connect-DbaInstance -SqlInstance $TestConfig.instance2
         $sql = "EXEC msdb.dbo.sp_delete_schedule @schedule_name = 'dbatoolsci_DailySchedule'"
@@ -27,20 +50,24 @@ Describe "$commandname Integration Tests" -Tag "IntegrationTests" {
         $server = Connect-DbaInstance -SqlInstance $TestConfig.instance3
         $sql = "EXEC msdb.dbo.sp_delete_schedule @schedule_name = 'dbatoolsci_DailySchedule'"
         $server.Query($sql)
-
     }
 
-    Context "Copies Agent Schedule" {
-        $results = Copy-DbaAgentSchedule -Source $TestConfig.instance2 -Destination $TestConfig.instance3
+    Context "When copying agent schedule between instances" {
+        BeforeAll {
+            $results = Copy-DbaAgentSchedule -Source $TestConfig.instance2 -Destination $TestConfig.instance3
+        }
 
-        It "returns one results" {
+        It "Returns more than one result" {
             $results.Count | Should -BeGreaterThan 1
-            ($results | Where Status -eq "Successful") | Should -Not -Be $null
         }
 
-        It "return one result of Start Time 1:00 AM" {
-            $results = Get-DbaAgentSchedule -SqlInstance $TestConfig.instance3 -Schedule dbatoolsci_DailySchedule
-            $results.ActiveStartTimeOfDay -eq '01:00:00'
+        It "Contains at least one successful copy" {
+            $results | Where-Object Status -eq "Successful" | Should -Not -BeNullOrEmpty
+        }
+
+        It "Creates schedule with correct start time" {
+            $schedule = Get-DbaAgentSchedule -SqlInstance $TestConfig.instance3 -Schedule dbatoolsci_DailySchedule
+            $schedule.ActiveStartTimeOfDay | Should -Be '01:00:00'
         }
     }
 }
diff --git a/tests/Copy-DbaAgentServer.Tests.ps1 b/tests/Copy-DbaAgentServer.Tests.ps1
@@ -1,19 +1,36 @@
-$CommandName = $MyInvocation.MyCommand.Name.Replace(".Tests.ps1", "")
-Write-Host -Object "Running $PSCommandPath" -ForegroundColor Cyan
-$global:TestConfig = Get-TestConfig
+#Requires -Module @{ ModuleName="Pester"; ModuleVersion="5.0"}
+param(
+    $ModuleName = "dbatools",
+    $PSDefaultParameterValues = ($TestConfig = Get-TestConfig).Defaults
+)
 
-Describe "$CommandName Unit Tests" -Tag 'UnitTests' {
-    Context "Validate parameters" {
-        [object[]]$params = (Get-Command $CommandName).Parameters.Keys | Where-Object {$_ -notin ('whatif', 'confirm')}
-        [object[]]$knownParameters = 'Source', 'SourceSqlCredential', 'Destination', 'DestinationSqlCredential', 'DisableJobsOnDestination', 'DisableJobsOnSource', 'ExcludeServerProperties', 'Force', 'EnableException'
-        $knownParameters += [System.Management.Automation.PSCmdlet]::CommonParameters
-        It "Should only contain our specific parameters" {
-            (@(Compare-Object -ReferenceObject ($knownParameters | Where-Object {$_}) -DifferenceObject $params).Count ) | Should Be 0
+Describe "Copy-DbaAgentServer" -Tag "UnitTests" {
+    Context "Parameter validation" {
+        BeforeAll {
+            $command = Get-Command Copy-DbaAgentServer
+            $expected = $TestConfig.CommonParameters
+            $expected += @(
+                "Source",
+                "SourceSqlCredential",
+                "Destination",
+                "DestinationSqlCredential",
+                "DisableJobsOnDestination",
+                "DisableJobsOnSource",
+                "ExcludeServerProperties",
+                "Force",
+                "EnableException",
+                "Confirm",
+                "WhatIf"
+            )
+        }
+
+        It "Has parameter: <_>" -ForEach $expected {
+            $command | Should -HaveParameter $PSItem
+        }
+
+        It "Should have exactly the number of expected parameters ($($expected.Count))" {
+            $hasParams = $command.Parameters.Values.Name
+            Compare-Object -ReferenceObject $expected -DifferenceObject $hasParams | Should -BeNullOrEmpty
         }
     }
-}
-<#
-    Integration test should appear below and are custom to the command you are writing.
-    Read https://github.com/dataplat/dbatools/blob/development/contributing.md#tests
-    for more guidence.
-#>
+}