diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## [0.13.0.2] - 2023-03-24 + +### Changed + +* Improved white space diffing + ## [0.13.0.1] - 2023-01-13 ### Changed diff --git a/src/Test/Syd/OptParse.hs b/src/Test/Syd/OptParse.hs --- a/src/Test/Syd/OptParse.hs +++ b/src/Test/Syd/OptParse.hs @@ -603,7 +603,8 @@ auto ( mconcat [ long "retries", - help "The number of retries to use for flakiness diagnostics. 0 means 'no flakiness diagnostics'" + help "The number of retries to use for flakiness diagnostics. 0 means 'no flakiness diagnostics'", + metavar "INTEGER" ] ) ) diff --git a/src/Test/Syd/Output.hs b/src/Test/Syd/Output.hs --- a/src/Test/Syd/Output.hs +++ b/src/Test/Syd/Output.hs @@ -467,11 +467,17 @@ [cs] -> [header : cs] -- If there is more than one line, put the header on a separate line before cs -> [header] : cs + + -- If it's only whitespace, change the background, otherwise change the foreground + foreOrBack :: Colour -> Text -> Chunk + foreOrBack c t = + (if T.null (T.strip t) then back c else fore c) + (chunk t) actualChunks :: [[Chunk]] actualChunks = chunksLinesWithHeader (fore blue "Actual: ") $ splitChunksIntoLines $ flip mapMaybe diff $ \case - First t -> Just $ fore red $ chunk t + First t -> Just $ foreOrBack red t Second _ -> Nothing Both t _ -> Just $ chunk t expectedChunks :: [[Chunk]] @@ -479,7 +485,7 @@ splitChunksIntoLines $ flip mapMaybe diff $ \case First _ -> Nothing - Second t -> Just $ fore green $ chunk t + Second t -> Just $ foreOrBack green t Both t _ -> Just $ chunk t inlineDiffChunks :: [[Chunk]] inlineDiffChunks = @@ -488,8 +494,8 @@ else chunksLinesWithHeader (fore blue "Inline diff: ") $ splitChunksIntoLines $ flip map diff $ \case - First t -> fore red $ chunk t - Second t -> fore green $ chunk t + First t -> foreOrBack red t + Second t -> foreOrBack green t Both t _ -> chunk t in concat [ [[chunk "Expected these values to be equal:"]], diff --git a/sydtest.cabal b/sydtest.cabal --- a/sydtest.cabal +++ b/sydtest.cabal @@ -5,7 +5,7 @@ -- see: https://github.com/sol/hpack name: sydtest -version: 0.13.0.1 +version: 0.13.0.2 synopsis: A modern testing framework for Haskell with good defaults and advanced testing features. description: A modern testing framework for Haskell with good defaults and advanced testing features. Sydtest aims to make the common easy and the hard possible. See https://github.com/NorfairKing/sydtest#readme for more information. category: Testing @@ -13,7 +13,7 @@ bug-reports: https://github.com/NorfairKing/sydtest/issues author: Tom Sydney Kerckhove maintainer: syd@cs-syd.eu -copyright: Copyright (c) 2020-2022 Tom Sydney Kerckhove +copyright: Copyright (c) 2020-2023 Tom Sydney Kerckhove license: OtherLicense license-file: LICENSE.md build-type: Simple diff --git a/test_resources/output-test.txt b/test_resources/output-test.txt --- a/test_resources/output-test.txt +++ b/test_resources/output-test.txt @@ -518,8 +518,8 @@ , 19 ] Expected:  - [ -5 - , 3 + [ -5 + , 3 , 11 , -3 , -13 @@ -539,8 +539,8 @@ , -6 ] Inline diff:  - [ -5 - , 138 + [ -5 + , 138 , -113 , -13 , -132 @@ -567,7 +567,7 @@ Expected these values to be equal: Actual:  ( "foo" - , [ "quux" , "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] + , [ "quux" , "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] , "bar" ) Expected:  @@ -577,7 +577,7 @@ ) Inline diff:  ( "foofoo" - , [ "quux" , "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] + , [ "quux" , "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] , "bazr" ) @@ -585,17 +585,17 @@ ✗ 33 Diff.shows nice multi-line diffs Retries: 3 (does not look flaky) Expected these values to be equal: - Actual: ( "foo" , [] , "bar" ) + Actual: ( "foo" , [] , "bar" ) Expected:  - ( "foofoo" - , [ "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] - , "baz" - ) + ( "foofoo" + , [ "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] + , "baz" + ) Inline diff:  - ( "foofoo"  - , [] "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] - , "barz"  - ) + ( "foofoo"  + , [] "quux" , "quux" , "quux" , "quux" , "quux" , "quux" ] + , "barz"  + )  output-test/Spec.hs:95 ✗ 34 assertions.shouldBe @@ -705,7 +705,7 @@ ✗ 53 String.compares strings Retries: 3 (does not look flaky) Expected these values to be equal: - Actual: "foo\nbar\tquux " + Actual: "foo\nbar\tquux " Expected: "foq\nbaz\tqex"  output-test/Spec.hs:191 @@ -714,19 +714,19 @@ Expected these values to be equal: Actual:  foo - bar quux  + bar quux  Expected:  foq baz qex Inline diff:  fooq - barz quuex  + barz quuex   output-test/Spec.hs:192 ✗ 55 String.compares texts Retries: 3 (does not look flaky) Expected these values to be equal: - Actual: "foo\nbar\tquux " + Actual: "foo\nbar\tquux " Expected: "foq\nbaz\tqex"  output-test/Spec.hs:193 @@ -735,19 +735,19 @@ Expected these values to be equal: Actual:  foo - bar quux  + bar quux  Expected:  foq baz qex Inline diff:  fooq - barz quuex  + barz quuex   output-test/Spec.hs:194 ✗ 57 String.compares bytestrings Retries: 3 (does not look flaky) Expected these values to be equal: - Actual: "foo\nbar\tquux " + Actual: "foo\nbar\tquux " Expected: "foq\nbaz\tqex"  output-test/Spec.hs:197 @@ -798,7 +798,7 @@ Labels: "length of input is 0", "magnitude (digits) of sum of input is 0" Expected these values to be equal: Actual: [] - Expected: [ 0 ] + Expected: [ 0 ]  output-test/Spec.hs:246 ✗ 63 Property.classes.shows the classes in use on failure @@ -808,7 +808,7 @@ Class: empty Expected these values to be equal: Actual: [] - Expected: [ 0 ] + Expected: [ 0 ]  output-test/Spec.hs:269 ✗ 64 Shrinking.can grab the mvar during shrinking