Screenshot diffing

NorfairKing · Aug 4, 2024 · 23baea5 · 23baea5
1 parent a6889a4
commit 23baea5
Show file tree

Hide file tree

Showing 30 changed files with 182 additions and 77 deletions.
diff --git a/.hlint.yaml b/.hlint.yaml
@@ -6,6 +6,8 @@
     name: "Use const"
 - ignore:
     name: "Use ||"
+- ignore:
+    name: "Use &&"
 - ignore:
     name: "Avoid reverse"
 - ignore:

diff --git a/sydtest-aeson/CHANGELOG.md b/sydtest-aeson/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.2.0.0] - 2024-08-04
+
+### Changed
+
+* Compatibility with `sydtest >=0.17`
+
 ## [0.1.0.0] - 2022-04-28
 
 ### Changed

diff --git a/sydtest-aeson/default.nix b/sydtest-aeson/default.nix
@@ -3,7 +3,7 @@
 }:
 mkDerivation {
   pname = "sydtest-aeson";
-  version = "0.1.0.0";
+  version = "0.2.0.0";
   src = ./.;
   libraryHaskellDepends = [
     aeson aeson-pretty base bytestring deepseq path path-io sydtest

diff --git a/sydtest-aeson/package.yaml b/sydtest-aeson/package.yaml
@@ -1,5 +1,5 @@
 name: sydtest-aeson
-version: 0.1.0.0
+version: 0.2.0.0
 github: "NorfairKing/sydtest"
 license: OtherLicense
 license-file: LICENSE.md
@@ -25,7 +25,7 @@ library:
   - deepseq
   - path
   - path-io
-  - sydtest
+  - sydtest >=0.17
   - text
 
 tests:

diff --git a/sydtest-aeson/src/Test/Syd/Aeson.hs b/sydtest-aeson/src/Test/Syd/Aeson.hs
@@ -41,17 +41,18 @@ goldenJSONFile fp produceActualValue =
         ensureDir (parent p)
         SB.writeFile (fromAbsFile p) $ LB.toStrict $ JSON.encodePretty value,
       goldenTestCompare = \actual expected ->
-        if actual == expected
-          then Nothing
-          else
-            Just
-              ( Context
-                  ( textsNotEqualButShouldHaveBeenEqual
-                      (TE.decodeUtf8 (LB.toStrict (JSON.encodePretty actual)))
-                      (TE.decodeUtf8 (LB.toStrict (JSON.encodePretty expected)))
-                  )
-                  (goldenContext fp)
-              )
+        pure $
+          if actual == expected
+            then Nothing
+            else
+              Just
+                ( Context
+                    ( textsNotEqualButShouldHaveBeenEqual
+                        (TE.decodeUtf8 (LB.toStrict (JSON.encodePretty actual)))
+                        (TE.decodeUtf8 (LB.toStrict (JSON.encodePretty expected)))
+                    )
+                    (goldenContext fp)
+                )
     }
 
 -- | Test that the given 'JSON.Value' is the same as what we find in the given golden file.
@@ -82,9 +83,10 @@ goldenJSONValueFile fp produceActualValue =
         ensureDir (parent p)
         SB.writeFile (fromAbsFile p) $ LB.toStrict $ JSON.encodePretty value,
       goldenTestCompare = \actual expected ->
-        if actual == expected
-          then Nothing
-          else Just (Context (stringsNotEqualButShouldHaveBeenEqual (ppShow actual) (ppShow expected)) (goldenContext fp))
+        pure $
+          if actual == expected
+            then Nothing
+            else Just (Context (stringsNotEqualButShouldHaveBeenEqual (ppShow actual) (ppShow expected)) (goldenContext fp))
     }
 
 -- | Test that the given 'JSON.Value' is the same as what we find in the given golden file.

diff --git a/sydtest-aeson/sydtest-aeson.cabal b/sydtest-aeson/sydtest-aeson.cabal
@@ -5,7 +5,7 @@ cabal-version: 1.12
 -- see: https://github.com/sol/hpack
 
 name:           sydtest-aeson
-version:        0.1.0.0
+version:        0.2.0.0
 synopsis:       An aeson companion library for sydtest
 category:       Testing
 homepage:       https://github.com/NorfairKing/sydtest#readme
@@ -42,7 +42,7 @@ library
     , deepseq
     , path
     , path-io
-    , sydtest
+    , sydtest >=0.17
     , text
   default-language: Haskell2010
 

diff --git a/sydtest-mongo/CHANGELOG.md b/sydtest-mongo/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.1.0.0] - 2024-08-04
+
+### Changed
+
+* Compatibility with `sydtest >=0.17`
diff --git a/sydtest-mongo/default.nix b/sydtest-mongo/default.nix
@@ -4,7 +4,7 @@
 }:
 mkDerivation {
   pname = "sydtest-mongo";
-  version = "0.0.0.0";
+  version = "0.1.0.0";
   src = ./.;
   libraryHaskellDepends = [
     base binary bson bytestring mongoDB network path path-io port-utils

diff --git a/sydtest-mongo/package.yaml b/sydtest-mongo/package.yaml
@@ -1,5 +1,5 @@
 name: sydtest-mongo
-version: 0.0.0.0
+version: 0.1.0.0
 github: "NorfairKing/sydtest"
 license: OtherLicense
 license-file: LICENSE.md
@@ -11,6 +11,7 @@ synopsis: An mongoDB companion library for sydtest
 
 extra-source-files:
 - LICENSE.md
+- CHANGELOG.md
 - test_resources/**/*
 
 dependencies:
@@ -28,7 +29,7 @@ library:
   - path-io
   - port-utils
   - process
-  - sydtest
+  - sydtest >=0.17
   - sydtest-process
   - text
   - yaml

diff --git a/sydtest-mongo/src/Test/Syd/MongoDB.hs b/sydtest-mongo/src/Test/Syd/MongoDB.hs
@@ -59,9 +59,10 @@ goldenBSONDocumentFile fp produceActualDocument =
         ensureDir (parent ap)
         SB.writeFile (fromAbsFile ap) $ LB.toStrict $ runPut $ putDocument d,
       goldenTestCompare = \actual expected ->
-        if actual == expected
-          then Nothing
-          else Just (Context (stringsNotEqualButShouldHaveBeenEqual (ppShow actual) (ppShow expected)) (goldenContext fp))
+        pure $
+          if actual == expected
+            then Nothing
+            else Just (Context (stringsNotEqualButShouldHaveBeenEqual (ppShow actual) (ppShow expected)) (goldenContext fp))
     }
 
 -- | Test that the given 'Bson.Document' is the same as what we find in the given golden file.

diff --git a/sydtest-mongo/sydtest-mongo.cabal b/sydtest-mongo/sydtest-mongo.cabal
@@ -5,7 +5,7 @@ cabal-version: 1.12
 -- see: https://github.com/sol/hpack
 
 name:           sydtest-mongo
-version:        0.0.0.0
+version:        0.1.0.0
 synopsis:       An mongoDB companion library for sydtest
 category:       Testing
 homepage:       https://github.com/NorfairKing/sydtest#readme
@@ -18,6 +18,7 @@ license-file:   LICENSE.md
 build-type:     Simple
 extra-source-files:
     LICENSE.md
+    CHANGELOG.md
     test_resources/example.bson
     test_resources/pure-example.bson
 
@@ -48,7 +49,7 @@ library
     , path-io
     , port-utils
     , process
-    , sydtest
+    , sydtest >=0.17
     , sydtest-process
     , text
     , yaml

diff --git a/sydtest-persistent/CHANGELOG.md b/sydtest-persistent/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.1.0.0] - 2024-08-04
+
+### Changed
+
+* Compatibility with `sydtest >=0.17`
+
 ## [0.0.0.2] - 2023-10-09
 
 ### Added

diff --git a/sydtest-persistent/default.nix b/sydtest-persistent/default.nix
@@ -3,7 +3,7 @@
 }:
 mkDerivation {
   pname = "sydtest-persistent";
-  version = "0.0.0.2";
+  version = "0.1.0.0";
   src = ./.;
   libraryHaskellDepends = [
     base bytestring mtl persistent sydtest text unliftio

diff --git a/sydtest-persistent/package.yaml b/sydtest-persistent/package.yaml
@@ -1,5 +1,5 @@
 name: sydtest-persistent
-version: 0.0.0.2
+version: 0.1.0.0
 github: "NorfairKing/sydtest"
 license: OtherLicense
 license-file: LICENSE.md
@@ -22,6 +22,6 @@ library:
   - bytestring
   - mtl
   - persistent
-  - sydtest
+  - sydtest >=0.17
   - text
   - unliftio
diff --git a/sydtest-persistent/src/Test/Syd/Persistent.hs b/sydtest-persistent/src/Test/Syd/Persistent.hs
@@ -110,7 +110,7 @@ migrationsSucceedsSpecHelper connectionPoolSetupFunc migrationFile currentMigrat
                in gt
                     { goldenTestCompare = \actual expected ->
                         let addHelpContext a = Context a helpText
-                         in addHelpContext <$> goldenTestCompare gt actual expected
+                         in fmap addHelpContext <$> goldenTestCompare gt actual expected
                     }
 
             it migrationTestDescription $ do

diff --git a/sydtest-persistent/sydtest-persistent.cabal b/sydtest-persistent/sydtest-persistent.cabal
@@ -5,7 +5,7 @@ cabal-version: 1.12
 -- see: https://github.com/sol/hpack
 
 name:           sydtest-persistent
-version:        0.0.0.2
+version:        0.1.0.0
 synopsis:       A persistent companion library for sydtest
 category:       Testing
 homepage:       https://github.com/NorfairKing/sydtest#readme
@@ -36,7 +36,7 @@ library
     , bytestring
     , mtl
     , persistent
-    , sydtest
+    , sydtest >=0.17
     , text
     , unliftio
   default-language: Haskell2010
diff --git a/sydtest-test/output-test/Spec.hs b/sydtest-test/output-test/Spec.hs
@@ -106,29 +106,29 @@ spec = do
           goldenTestProduce = pure (),
           goldenTestWrite = \() -> do
             pure (),
-          goldenTestCompare = \() () -> Nothing
+          goldenTestCompare = \() () -> pure Nothing
         }
     it "does not fail the suite when an exception happens while producing" $
       GoldenTest
         { goldenTestRead = pure Nothing,
           goldenTestProduce = die "test",
           goldenTestWrite = \() -> do
             pure (),
-          goldenTestCompare = \() () -> Nothing
+          goldenTestCompare = \() () -> pure Nothing
         }
     it "does not fail the suite when an exception happens while writing" $
       GoldenTest
         { goldenTestRead = pure Nothing,
           goldenTestProduce = pure (),
           goldenTestWrite = \() -> die "test",
-          goldenTestCompare = \() () -> Nothing
+          goldenTestCompare = \() () -> pure Nothing
         }
     it "does not fail the suite when an exception happens while checking for equality" $
       GoldenTest
         { goldenTestRead = pure (Just ()),
           goldenTestProduce = pure (),
           goldenTestWrite = \() -> pure (),
-          goldenTestCompare = \actual expected -> case 1 `div` (0 :: Int) of
+          goldenTestCompare = \actual expected -> pure $ case 1 `div` (0 :: Int) of
             1 -> Nothing
             _ ->
               if actual == expected

diff --git a/sydtest-test/package.yaml b/sydtest-test/package.yaml
@@ -33,7 +33,7 @@ tests:
     - path-io
     - safe-coloured-text
     - stm
-    - sydtest
+    - sydtest >=0.17
     - text
     - vector
 

diff --git a/sydtest-test/sydtest-test.cabal b/sydtest-test/sydtest-test.cabal
@@ -115,7 +115,7 @@ test-suite sydtest-test
     , path-io
     , safe-coloured-text
     , stm
-    , sydtest
+    , sydtest >=0.17
     , text
     , vector
   default-language: Haskell2010
diff --git a/sydtest-webdriver-screenshot/CHANGELOG.md b/sydtest-webdriver-screenshot/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.1.0.0] - 2024-08-04
+
+### Added
+
+* Screenshot diff and similarity score
+
+### Changed
+
+* Compatibility with `sydtest >=0.17`
+
 ## [0.0.0.2] - 2023-10-09
 
 ### Added

diff --git a/sydtest-webdriver-screenshot/default.nix b/sydtest-webdriver-screenshot/default.nix
@@ -1,14 +1,14 @@
 { mkDerivation, base, bytestring, http-types, JuicyPixels, lib, mtl
 , network-uri, path, path-io, sydtest, sydtest-discover
-, sydtest-wai, sydtest-webdriver, wai, webdriver
+, sydtest-wai, sydtest-webdriver, vector, wai, webdriver
 }:
 mkDerivation {
   pname = "sydtest-webdriver-screenshot";
-  version = "0.0.0.2";
+  version = "0.1.0.0";
   src = ./.;
   libraryHaskellDepends = [
     base bytestring JuicyPixels mtl path path-io sydtest
-    sydtest-webdriver webdriver
+    sydtest-webdriver vector webdriver
   ];
   testHaskellDepends = [
     base http-types network-uri sydtest sydtest-wai sydtest-webdriver

diff --git a/sydtest-webdriver-screenshot/package.yaml b/sydtest-webdriver-screenshot/package.yaml
@@ -1,5 +1,5 @@
 name: sydtest-webdriver-screenshot
-version: 0.0.0.2
+version: 0.1.0.0
 license: OtherLicense
 license-file: LICENSE.md
 author: "Tom Sydney Kerckhove"
@@ -25,6 +25,7 @@ library:
   - path-io
   - sydtest
   - sydtest-webdriver
+  - vector
   - webdriver
 
 tests: