Improve test robustness

tbidne · Feb 22, 2025 · ecf973a · ecf973a
1 parent 00aecdd
commit ecf973a
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/test/unit/Unit/TestUtils.hs b/test/unit/Unit/TestUtils.hs
@@ -187,7 +187,16 @@ genWithLineComments = do
 
 genWithBlockComments :: Gen ByteString
 genWithBlockComments = do
-  xs <- G.list r genNonComment
+  -- Strip out forward slashes. Why? Consider the following scenario:
+  -- xs := ["foo/", "bar"]
+  -- cs := ["/* some comment */"]
+  -- shuffled := ["foo/", "/* some comment */", "bar"]
+  -- concat := "foo//* some comment */bar"
+  --
+  -- In other words, the concat turned the block comment into a line comment!
+  -- That's bad because we didn't generate the corresponding line end, i.e.
+  -- it is invalid.
+  xs <- G.list r $ (encodeUtf8 . T.replace "/" "") <$> genNonCommentTxt
   cs <- G.list r genBlockComment
   mconcat <$> G.shuffle (xs ++ cs)
   where