Add snapshot tests

ShaunLawrie · Feb 18, 2024 · 3793ba1 · 3793ba1
1 parent 6a180d5
commit 3793ba1
Show file tree

Hide file tree

Showing 28 changed files with 456 additions and 214 deletions.
diff --git a/PwshSpectreConsole.Tests/@snapshots/Format-SpectreBarChart.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Format-SpectreBarChart.snapshot.txt
@@ -0,0 +1,3 @@
+Test 1  [38;5;45m█████████████████████ 10[0m[38;5;8m                                                [0m
+Test 2  [38;5;12m█████████████████████████████████████████████ 20[0m[38;5;8m                        [0m
+Test 3  [38;5;45m█████████████████████████████████████████████████████████████████████ 30[0m
diff --git a/PwshSpectreConsole.Tests/@snapshots/Format-SpectreBreakdownChart.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Format-SpectreBreakdownChart.snapshot.txt
@@ -0,0 +1,2 @@
+[38;5;45m████████████████████████████████████████████████████████████████████████████████[0m
+[38;5;45m■[0m Test 1 [38;5;8m10[0m                [38;5;45m■[0m Test 2 [38;5;8m20[0m                [38;5;45m■[0m Test 3 [38;5;8m30[0m               
diff --git a/PwshSpectreConsole.Tests/@snapshots/Format-SpectreJson.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Format-SpectreJson.snapshot.txt
@@ -1,25 +1,25 @@
-╔═Test title═════════════════════════════════════════════════════════════════╗
-║ {                                                                          ║
-║    "Name": "John",                                                         ║
-║    "Age": 25,                                                              ║
-║    "City": "New York",                                                     ║
-║    "IsEmployed": true,                                                     ║
-║    "Salary": 10,                                                           ║
-║    "Hobbies": [                                                            ║
-║       "Reading",                                                           ║
-║       "Swimming"                                                           ║
-║    ],                                                                      ║
-║    "Address": {                                                            ║
-║       "Street": "123 Main St",                                             ║
-║       "City": "New York",                                                  ║
-║       "State": "NY",                                                       ║
-║       "Deep": {                                                            ║
-║          "Nested": "System.Collections.Hashtable"                          ║
-║       },                                                                   ║
-║       "Zip": "10001"                                                       ║
-║    }                                                                       ║
-║ }                                                                          ║
-║                                                                            ║
-║                                                                            ║
-║                                                                            ║
-╚════════════════════════════════════════════════════════════════════════════╝
+[38;5;35m╔═Test title═════════════════════════════════════════════════════════════════╗[0m
+[38;5;35m║[0m [38;5;9m{[0m                                                                          [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"Name":[0m [38;5;11m"John"[0m[38;5;72m,[0m                                                         [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"Age":[0m [38;5;50m25[0m[38;5;72m,[0m                                                              [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"City":[0m [38;5;11m"New York"[0m[38;5;72m,[0m                                                     [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"IsEmployed":[0m [38;5;6mtrue[0m[38;5;72m,[0m                                                     [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"Salary":[0m [38;5;50m10[0m[38;5;72m,[0m                                                           [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"Hobbies":[0m [38;5;2m[[0m                                                            [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;11m"Reading"[0m[38;5;72m,[0m                                                           [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;11m"Swimming"[0m                                                           [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;2m][0m[38;5;72m,[0m                                                                      [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;12m"Address":[0m [38;5;9m{[0m                                                            [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;12m"State":[0m [38;5;11m"NY"[0m[38;5;72m,[0m                                                       [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;12m"City":[0m [38;5;11m"New York"[0m[38;5;72m,[0m                                                  [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;12m"Street":[0m [38;5;11m"123 Main St"[0m[38;5;72m,[0m                                             [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;12m"Deep":[0m [38;5;9m{[0m                                                            [38;5;35m║[0m
+[38;5;35m║[0m          [38;5;12m"Nested":[0m [38;5;11m"System.Collections.Hashtable"[0m                          [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;9m}[0m[38;5;72m,[0m                                                                   [38;5;35m║[0m
+[38;5;35m║[0m       [38;5;12m"Zip":[0m [38;5;11m"10001"[0m                                                       [38;5;35m║[0m
+[38;5;35m║[0m    [38;5;9m}[0m                                                                       [38;5;35m║[0m
+[38;5;35m║[0m [38;5;9m}[0m                                                                          [38;5;35m║[0m
+[38;5;35m║[0m                                                                            [38;5;35m║[0m
+[38;5;35m║[0m                                                                            [38;5;35m║[0m
+[38;5;35m║[0m                                                                            [38;5;35m║[0m
+[38;5;35m╚════════════════════════════════════════════════════════════════════════════╝[0m
diff --git a/PwshSpectreConsole.Tests/@snapshots/Format-SpectrePanel.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Format-SpectrePanel.snapshot.txt
@@ -1,3 +1,3 @@
-╭─Test title───────────╮
-│ This is a test panel │
-╰──────────────────────╯
+[38;5;45m╭─Test title───────────╮[0m
+[38;5;45m│[0m This is a test panel [38;5;45m│[0m
+[38;5;45m╰──────────────────────╯[0m
diff --git a/PwshSpectreConsole.Tests/@snapshots/Format-SpectreTable.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Format-SpectreTable.snapshot.txt
@@ -0,0 +1,7 @@
+[38;5;45m╭────────────┬────────┬───────╮[0m
+[38;5;45m│[0m Color      [38;5;45m│[0m Name   [38;5;45m│[0m Value [38;5;45m│[0m
+[38;5;45m├────────────┼────────┼───────┤[0m
+[38;5;45m│[0m Turquoise2 [38;5;45m│[0m Test 1 [38;5;45m│[0m 10    [38;5;45m│[0m
+[38;5;45m│[0m #ff0000    [38;5;45m│[0m Test 2 [38;5;45m│[0m 20    [38;5;45m│[0m
+[38;5;45m│[0m Turquoise2 [38;5;45m│[0m Test 3 [38;5;45m│[0m 30    [38;5;45m│[0m
+[38;5;45m╰────────────┴────────┴───────╯[0m
diff --git a/PwshSpectreConsole.Tests/@snapshots/Format-SpectreTree.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Format-SpectreTree.snapshot.txt
@@ -0,0 +1,7 @@
+Root
+[38;5;197m┣━━ [0mChild 1
+[38;5;197m┃   ┗━━ [0mGrandchild 1
+[38;5;197m┃       ┣━━ [0mGreat Grandchild 1
+[38;5;197m┃       ┣━━ [0mGreat Grandchild 2
+[38;5;197m┃       ┗━━ [0mGreat Grandchild 3
+[38;5;197m┗━━ [0mChild 2
diff --git a/PwshSpectreConsole.Tests/@snapshots/Write-SpectreCalendar.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Write-SpectreCalendar.snapshot.txt
@@ -0,0 +1,17 @@
+                 [38;5;35mJuly 2024[0m                 
+[38;5;35m╭─────┬─────┬─────┬─────┬─────┬─────┬─────╮[0m
+[38;5;35m│[0m Mon [38;5;35m│[0m Tue [38;5;35m│[0m Wed [38;5;35m│[0m Thu [38;5;35m│[0m Fri [38;5;35m│[0m Sat [38;5;35m│[0m Sun [38;5;35m│[0m
+[38;5;35m├─────┼─────┼─────┼─────┼─────┼─────┼─────┤[0m
+[38;5;35m│[0m 1   [38;5;35m│[0m 2   [38;5;35m│[0m 3   [38;5;35m│[0m 4   [38;5;35m│[0m 5   [38;5;35m│[0m 6   [38;5;35m│[0m 7   [38;5;35m│[0m
+[38;5;35m│[0m 8   [38;5;35m│[0m 9   [38;5;35m│[0m 10  [38;5;35m│[0m 11  [38;5;35m│[0m 12  [38;5;35m│[0m 13  [38;5;35m│[0m 14  [38;5;35m│[0m
+[38;5;35m│[0m 15  [38;5;35m│[0m 16  [38;5;35m│[0m 17  [38;5;35m│[0m 18  [38;5;35m│[0m 19  [38;5;35m│[0m 20  [38;5;35m│[0m 21  [38;5;35m│[0m
+[38;5;35m│[0m 22  [38;5;35m│[0m 23  [38;5;35m│[0m 24  [38;5;35m│[0m 25  [38;5;35m│[0m 26  [38;5;35m│[0m 27  [38;5;35m│[0m 28  [38;5;35m│[0m
+[38;5;35m│[0m 29  [38;5;35m│[0m 30  [38;5;35m│[0m 31  [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m
+[38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m     [38;5;35m│[0m
+[38;5;35m╰─────┴─────┴─────┴─────┴─────┴─────┴─────╯[0m
+[38;5;35m╭─────────────┬──────┬───────┬─────╮[0m
+[38;5;35m│[0m Description [38;5;35m│[0m Year [38;5;35m│[0m Month [38;5;35m│[0m Day [38;5;35m│[0m
+[38;5;35m├─────────────┼──────┼───────┼─────┤[0m
+[38;5;35m│[0m Event 1     [38;5;35m│[0m 2022 [38;5;35m│[0m 3     [38;5;35m│[0m 10  [38;5;35m│[0m
+[38;5;35m│[0m Event 2     [38;5;35m│[0m 2022 [38;5;35m│[0m 3     [38;5;35m│[0m 20  [38;5;35m│[0m
+[38;5;35m╰─────────────┴──────┴───────┴─────╯[0m
diff --git a/PwshSpectreConsole.Tests/@snapshots/Write-SpectreFigletText.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Write-SpectreFigletText.snapshot.txt
@@ -0,0 +1,6 @@
+                                                                   [38;5;193m   __     _             _          _     _   [0m
+                                                                   [38;5;193m  / _|   (_)     __ _  | |   ___  | |_  | |_ [0m
+                                                                   [38;5;193m | |_    | |    / _` | | |  / _ \ | __| | __|[0m
+                                                                   [38;5;193m |  _|   | |   | (_| | | | |  __/ | |_  | |_ [0m
+                                                                   [38;5;193m |_|     |_|    \__, | |_|  \___|  \__|  \__|[0m
+                                                                   [38;5;193m                |___/                        [0m
diff --git a/PwshSpectreConsole.Tests/@snapshots/Write-SpectreHost.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Write-SpectreHost.snapshot.txt
@@ -0,0 +1 @@
+[38;2;0;255;0mHello[0m, [38;5;32mWorld![0m 😎 Yay!
diff --git a/PwshSpectreConsole.Tests/@snapshots/Write-SpectreRule.snapshot.txt b/PwshSpectreConsole.Tests/@snapshots/Write-SpectreRule.snapshot.txt
@@ -0,0 +1 @@
+───────────────────────────────────────────────────────── [38;5;9myo, this is a test rule[0m ──────────────────────────────────────────────────────────
diff --git a/PwshSpectreConsole.Tests/formatting/Format-SpectreBarChart.snapshot.compare.txt b/PwshSpectreConsole.Tests/formatting/Format-SpectreBarChart.snapshot.compare.txt
@@ -0,0 +1,3 @@
+Test 1  [38;5;45m█████████████████████ 10[0m[38;5;8m                                                [0m
+Test 2  [38;5;12m█████████████████████████████████████████████ 20[0m[38;5;8m                        [0m
+Test 3  [38;5;45m█████████████████████████████████████████████████████████████████████ 30[0m
diff --git a/PwshSpectreConsole.Tests/formatting/Format-SpectreBarChart.tests.ps1 b/PwshSpectreConsole.Tests/formatting/Format-SpectreBarChart.tests.ps1
@@ -7,6 +7,7 @@ Describe "Format-SpectreBarChart" {
 
         BeforeEach {
             $testConsole = [Spectre.Console.Testing.TestConsole]::new()
+            $testConsole.EmitAnsiSequences = $true
             $testWidth = Get-Random -Minimum 10 -Maximum 100
             $testTitle = "Test Chart $([guid]::NewGuid())"
             $testData = @()
@@ -69,5 +70,24 @@ Describe "Format-SpectreBarChart" {
             Format-SpectreBarChart -Data $testData
             Assert-MockCalled -CommandName "Write-AnsiConsole" -Times 1 -Exactly
         }
+
+        It "Should match the snapshot" {
+            Mock Write-AnsiConsole {
+                $testConsole.Write($RenderableObject)
+            }
+            $testWidth = 120
+            Write-Debug "Setting test width to $testWidth"
+            $testData = @(
+                (New-SpectreChartItem -Label "Test 1" -Value 10 -Color "Turquoise2"),
+                (New-SpectreChartItem -Label "Test 2" -Value 20 -Color "#ff0000"),
+                (New-SpectreChartItem -Label "Test 3" -Value 30 -Color "Turquoise2")
+            )
+            Format-SpectreBarChart -Data $testData
+            $snapShotComparison = "$PSScriptRoot\..\@snapshots\Format-SpectreBarChart.snapshot.compare.txt"
+            Set-Content -Path $snapShotComparison -Value ($testConsole.Output -replace "`r", "") -NoNewline
+            $compare = Get-Content -Path $snapShotComparison -AsByteStream
+            $snapshot = Get-Content -Path "$PSScriptRoot\..\@snapshots\Format-SpectreBarChart.snapshot.txt" -AsByteStream
+            $snapshot | Should -Be $compare
+        }
     }
 }
diff --git a/PwshSpectreConsole.Tests/formatting/Format-SpectreBreakdownChart.tests.ps1 b/PwshSpectreConsole.Tests/formatting/Format-SpectreBreakdownChart.tests.ps1
@@ -6,6 +6,7 @@ Describe "Format-SpectreBreakdownChart" {
     InModuleScope "PwshSpectreConsole" {
         BeforeEach {
             $testConsole = [Spectre.Console.Testing.TestConsole]::new()
+            $testConsole.EmitAnsiSequences = $true
             $testWidth = Get-Random -Minimum 10 -Maximum 100
             $testData = @()
             for($i = 0; $i -lt (Get-Random -Minimum 3 -Maximum 10); $i++) {
@@ -53,5 +54,31 @@ Describe "Format-SpectreBreakdownChart" {
             Format-SpectreBreakdownChart -Data $testData
             Assert-MockCalled -CommandName "Write-AnsiConsole" -Times 1 -Exactly
         }
+
+        It "Should match the snapshot" {
+            Mock Write-AnsiConsole {
+                $testConsole.Write($RenderableObject)
+            }
+            $testWidth = 120
+            Write-Debug "Setting test width to $testWidth"
+            $testData = @(
+                (New-SpectreChartItem -Label "Test 1" -Value 10 -Color "Turquoise2"),
+                (New-SpectreChartItem -Label "Test 2" -Value 20 -Color "Turquoise2"),
+                (New-SpectreChartItem -Label "Test 3" -Value 30 -Color "Turquoise2")
+            )
+            Format-SpectreBreakdownChart -Data $testData
+            $snapShotComparison = "$PSScriptRoot\..\@snapshots\Format-SpectreBreakdownChart.snapshot.compare.txt"
+            Set-Content -Path $snapShotComparison -Value ($testConsole.Output -replace "`r", "") -NoNewline
+            $compare = Get-Content -Path $snapShotComparison -AsByteStream
+            $snapShot = Get-Content -Path "$PSScriptRoot\..\@snapshots\Format-SpectreBreakdownChart.snapshot.txt" -AsByteStream
+            try {
+                $snapshot | Should -Be $compare
+            } catch {
+                # byte array to string
+                Write-Host "Expected:`n`n$([System.Text.Encoding]::UTF8.GetString($snapshot))"
+                Write-Host "Got:`n`n$([System.Text.Encoding]::UTF8.GetString($compare))"
+                throw
+            }
+        }
     }
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[38;5;45m████████████████████████████████████████████████████████████████████████████████[0m
		[38;5;45m■[0m Test 1 [38;5;8m10[0m [38;5;45m■[0m Test 2 [38;5;8m20[0m [38;5;45m■[0m Test 3 [38;5;8m30[0m
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		[38;2;0;255;0mHello[0m, [38;5;32mWorld![0m 😎 Yay!
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		───────────────────────────────────────────────────────── [38;5;9myo, this is a test rule[0m ──────────────────────────────────────────────────────────