Merge pull request #49 from stadiamaps/make-snapshot-tests-reproducible

Make snapshot helpers reproducible
maplibre · Aug 24, 2024 · a789bbe · a789bbe
2 parents cee1194 + 2c197b0
commit a789bbe
Show file tree

Hide file tree

Showing 17 changed files with 60 additions and 32 deletions.
diff --git a/Tests/MapLibreSwiftUITests/Examples/CameraPreviewTests.swift b/Tests/MapLibreSwiftUITests/Examples/CameraPreviewTests.swift
@@ -4,7 +4,7 @@ import XCTest
 
 final class CameraPreviewTests: XCTestCase {
     func testCameraPreview() {
-        assertView(named: "CameraPreview") {
+        assertView {
             CameraDirectManipulationPreview(
                 styleURL: URL(string: "https://demotiles.maplibre.org/style.json")!
             )

diff --git a/Tests/MapLibreSwiftUITests/Examples/MapControlsTests.swift b/Tests/MapLibreSwiftUITests/Examples/MapControlsTests.swift
@@ -1,79 +1,104 @@
+import CoreLocation
 import MapLibreSwiftDSL
 import SnapshotTesting
 import XCTest
 @testable import MapLibreSwiftUI
 
 final class MapControlsTests: XCTestCase {
+    // NOTE: The map views in this test intentionally have a non-north orientation
+    // so that the compass will be rendered if present.
+
     @MainActor
     func testEmptyControls() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    // No controls
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                // No controls
+            }
         }
     }
 
     @MainActor
     func testLogoOnly() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    LogoView()
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                LogoView()
+            }
         }
     }
 
     @MainActor
     func testLogoChangePosition() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    LogoView()
-                        .position(.topLeft)
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                LogoView()
+                    .position(.topLeft)
+            }
         }
     }
 
     @MainActor
     func testCompassOnly() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    CompassView()
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                CompassView()
+            }
         }
     }
 
     @MainActor
     func testCompassChangePosition() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    CompassView()
-                        .position(.topLeft)
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                CompassView()
+                    .position(.topLeft)
+            }
         }
     }
 
     @MainActor
     func testAttributionOnly() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    AttributionButton()
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                AttributionButton()
+            }
         }
     }
 
     @MainActor
     func testAttributionChangePosition() {
         assertView {
-            MapView(styleURL: demoTilesURL)
-                .mapControls {
-                    AttributionButton()
-                        .position(.topLeft)
-                }
+            MapView(
+                styleURL: demoTilesURL,
+                camera: .constant(.center(CLLocationCoordinate2D(), zoom: 4, direction: 45))
+            )
+            .mapControls {
+                AttributionButton()
+                    .position(.topLeft)
+            }
         }
     }
 }
diff --git a/...eSwiftUITests/Examples/__Snapshots__/CameraPreviewTests/testCameraPreview.1.png b/...eSwiftUITests/Examples/__Snapshots__/CameraPreviewTests/testCameraPreview.1.png
diff --git a/...s/Examples/__Snapshots__/CameraPreviewTests/testCameraPreview.CameraPreview.png b/...s/Examples/__Snapshots__/CameraPreviewTests/testCameraPreview.CameraPreview.png
diff --git a/...ftUITests/Examples/__Snapshots__/LayerPreviewTests/testCirclesWithSymbols.1.png b/...ftUITests/Examples/__Snapshots__/LayerPreviewTests/testCirclesWithSymbols.1.png
diff --git a/...apLibreSwiftUITests/Examples/__Snapshots__/LayerPreviewTests/testRoseTint.1.png b/...apLibreSwiftUITests/Examples/__Snapshots__/LayerPreviewTests/testRoseTint.1.png
diff --git a/...ftUITests/Examples/__Snapshots__/LayerPreviewTests/testRotatedSymbolConst.1.png b/...ftUITests/Examples/__Snapshots__/LayerPreviewTests/testRotatedSymbolConst.1.png
diff --git a/...ITests/Examples/__Snapshots__/LayerPreviewTests/testRotatedSymboleDynamic.1.png b/...ITests/Examples/__Snapshots__/LayerPreviewTests/testRotatedSymboleDynamic.1.png
diff --git a/...breSwiftUITests/Examples/__Snapshots__/LayerPreviewTests/testSimpleSymbol.1.png b/...breSwiftUITests/Examples/__Snapshots__/LayerPreviewTests/testSimpleSymbol.1.png
diff --git a/...sts/Examples/__Snapshots__/MapControlsTests/testAttributionChangePosition.1.png b/...sts/Examples/__Snapshots__/MapControlsTests/testAttributionChangePosition.1.png
diff --git a/...eSwiftUITests/Examples/__Snapshots__/MapControlsTests/testAttributionOnly.1.png b/...eSwiftUITests/Examples/__Snapshots__/MapControlsTests/testAttributionOnly.1.png
diff --git a/...UITests/Examples/__Snapshots__/MapControlsTests/testCompassChangePosition.1.png b/...UITests/Examples/__Snapshots__/MapControlsTests/testCompassChangePosition.1.png
diff --git a/...LibreSwiftUITests/Examples/__Snapshots__/MapControlsTests/testCompassOnly.1.png b/...LibreSwiftUITests/Examples/__Snapshots__/MapControlsTests/testCompassOnly.1.png
diff --git a/...breSwiftUITests/Examples/__Snapshots__/MapControlsTests/testEmptyControls.1.png b/...breSwiftUITests/Examples/__Snapshots__/MapControlsTests/testEmptyControls.1.png
diff --git a/...iftUITests/Examples/__Snapshots__/MapControlsTests/testLogoChangePosition.1.png b/...iftUITests/Examples/__Snapshots__/MapControlsTests/testLogoChangePosition.1.png
diff --git a/...MapLibreSwiftUITests/Examples/__Snapshots__/MapControlsTests/testLogoOnly.1.png b/...MapLibreSwiftUITests/Examples/__Snapshots__/MapControlsTests/testLogoOnly.1.png
diff --git a/Tests/MapLibreSwiftUITests/Support/XCTestAssertView.swift b/Tests/MapLibreSwiftUITests/Support/XCTestAssertView.swift
@@ -7,6 +7,7 @@ extension XCTestCase {
     func assertView(
         named name: String? = nil,
         record: Bool = false,
+        colorScheme: ColorScheme = .light,
         frame: CGSize = CGSize(width: 430, height: 932),
         expectation _: XCTestExpectation? = nil,
         @ViewBuilder content: () -> some View,
@@ -15,7 +16,9 @@ extension XCTestCase {
         line: UInt = #line
     ) {
         let view = content()
+            .environment(\.colorScheme, colorScheme)
             .frame(width: frame.width, height: frame.height)
+            .background(Color(red: 130 / 255, green: 203 / 255, blue: 114 / 255))
 
         assertSnapshot(of: view,
                        as: .image(precision: 0.9, perceptualPrecision: 0.95),