test: Overhaul regex tests for change-type-signature-plugin

Author: sgillespie

plugins/hls-change-type-signature-plugin/src/Ide/Plugin/ChangeTypeSignature.hs

@@ -15,7 +15,7 @@ import           Control.Monad.Trans.Except       (ExceptT (..))
 import           Control.Monad.Trans.Maybe        (MaybeT(..), hoistMaybe)
 import           Data.Foldable                    (asum)
 import qualified Data.Map                         as Map
-import           Data.Maybe                       (mapMaybe, catMaybes)
+import           Data.Maybe                       (catMaybes)
 import           Data.Text                        (Text)
 import qualified Data.Text                        as T
 import           Development.IDE                  (realSrcSpanToRange,
@@ -130,7 +130,6 @@ generateAction recorder plId uri decls fileDiag = do
     pure $
         changeSigToCodeAction plId uri <$> changeSig
 
-
 -- | Convert a diagnostic into a ChangeSignature and add the proper SrcSpan
 diagnosticToChangeSig
     :: Recorder (WithPriority Log)
@@ -177,6 +176,7 @@ findSolverReport _ = Nothing
 -- TODO: Make this a prism?
 findMismatchMessage :: TcSolverReportMsg -> Maybe MismatchMsg
 findMismatchMessage (Mismatch m _ _ _) = Just m
+findMismatchMessage (CannotUnifyVariable m _) = Just m
 findMismatchMessage _ = Nothing
 
 -- TODO: Make this a prism?

plugins/hls-change-type-signature-plugin/test/Main.hs

@@ -5,7 +5,7 @@ import           Data.Either                    (rights)
 import           Data.Text                      (Text)
 import qualified Data.Text                      as T
 import qualified Data.Text.IO                   as TIO
-import           Ide.Plugin.ChangeTypeSignature (errorMessageRegexes)
+import           Ide.Plugin.ChangeTypeSignature (Log(..), errorMessageRegexes)
 import qualified Ide.Plugin.ChangeTypeSignature as ChangeTypeSignature
 import           System.FilePath                ((<.>), (</>))
 import           Test.Hls                       (CodeAction (..), Command,
@@ -22,18 +22,20 @@ import           Test.Hls                       (CodeAction (..), Command,
                                                  goldenWithHaskellDoc,
                                                  knownBrokenForGhcVersions,
                                                  liftIO,
-                                                 mkPluginTestDescriptor',
                                                  openDoc, runSessionWithServer,
                                                  testCase, testGroup, toEither,
                                                  type (|?), waitForBuildQueue,
-                                                 waitForDiagnostics, (@?=))
+                                                 waitForDiagnostics, (@?=), mkPluginTestDescriptor)
 import           Text.Regex.TDFA                ((=~))
 
 main :: IO ()
 main = defaultTestRunner test
 
-changeTypeSignaturePlugin :: PluginTestDescriptor ()
-changeTypeSignaturePlugin = mkPluginTestDescriptor' ChangeTypeSignature.descriptor "changeTypeSignature"
+changeTypeSignaturePlugin :: PluginTestDescriptor Log
+changeTypeSignaturePlugin =
+    mkPluginTestDescriptor
+        ChangeTypeSignature.descriptor
+        "changeTypeSignature"
 
 test :: TestTree
 test = testGroup "changeTypeSignature" [
@@ -50,33 +52,16 @@ test = testGroup "changeTypeSignature" [
 
 testRegexes :: TestTree
 testRegexes = testGroup "Regex Testing" [
-        testRegexOne
-        , testRegexTwo
-        , testRegex921One
-    ]
-
-testRegexOne :: TestTree
-testRegexOne = testGroup "Regex One" [
-        regexTest "error1.txt" regex True
-        , regexTest "error2.txt" regex True
-        , regexTest "error3.txt" regex False
-        , regexTest "error4.txt" regex True
-        , regexTest "error5.txt" regex True
+        regexTest "TExpectedActual.txt" regex True
+        , regexTest "TLocalBinding.txt" regex True
+        , regexTest "TLocalBindingShadow1.txt" regex True
+        , regexTest "TLocalBindingShadow2.txt" regex True
+        , regexTest "TRigidType.txt" regex False
+        , regexTest "TRigidType2.txt" regex True
     ]
     where
         regex = errorMessageRegexes !! 0
 
-testRegexTwo :: TestTree
-testRegexTwo = testGroup "Regex Two" [
-        regexTest "error1.txt" regex False
-        , regexTest "error2.txt" regex False
-        , regexTest "error3.txt" regex True
-        , regexTest "error4.txt" regex False
-        , regexTest "error5.txt" regex False
-    ]
-    where
-        regex = errorMessageRegexes !! 1
-
 -- test ghc-9.2 error message regex
 testRegex921One :: TestTree
 testRegex921One = testGroup "Regex One" [
@@ -85,7 +70,7 @@ testRegex921One = testGroup "Regex One" [
         , regexTest "ghc921-error3.txt" regex True
     ]
     where
-        regex = errorMessageRegexes !! 2
+        regex = errorMessageRegexes !! 0
 
 testDataDir :: FilePath
 testDataDir = "plugins" </> "hls-change-type-signature-plugin" </> "test" </> "testdata"
@@ -123,8 +108,8 @@ regexTest :: FilePath -> Text -> Bool -> TestTree
 regexTest fp regex shouldPass = testCase fp $ do
     msg <- TIO.readFile (testDataDir </> fp)
     case (msg =~ regex  :: (Text, Text, Text, [Text]), shouldPass) of
-        ((_, _, _, [_, _, _, _]), True) -> pure ()
-        ((_, _, _, [_, _, _, _]), False) -> assertFailure $  "Unexpected match: " <> fp <> " with " <> T.unpack regex
+        ((_, _, _, [_]), True) -> pure ()
+        ((_, _, _, [_]), False) -> assertFailure $  "Unexpected match: " <> fp <> " with " <> T.unpack regex
         (_, True) -> assertFailure $ "Failed to match: " <> fp <> " with " <> T.unpack regex
         (_, False) -> pure ()
 

plugins/hls-change-type-signature-plugin/test/testdata/TExpectedActual.txt

@@ -0,0 +1,8 @@
+In the expression: go
+In an equation for ‘fullSig’:
+fullSig
+      = go
+      where
+          go = head . reverse
+
+

plugins/hls-change-type-signature-plugin/test/testdata/TLocalBinding.txt

@@ -0,0 +1,8 @@
+Probable cause: ‘forM’ is applied to too few arguments
+In the expression: forM
+In an equation for ‘test’: test = forM
+In the expression:
+  let
+    test :: Int -> Int
+    test = forM
+  in x + 1

plugins/hls-change-type-signature-plugin/test/testdata/TLocalBindingShadow1.txt

@@ -0,0 +1,4 @@
+Probable cause: ‘forM’ is applied to too few arguments
+In the expression: forM
+In an equation for ‘test’: test = forM
+

plugins/hls-change-type-signature-plugin/test/testdata/TLocalBindingShadow2.txt

@@ -0,0 +1,9 @@
+Probable cause: ‘forM’ is applied to too few arguments
+In the expression: forM
+In an equation for ‘test’: test = forM
+In the expression:
+  let
+    test :: Int -> Int
+    test = forM
+  in test x [GHC-83865]
+

plugins/hls-change-type-signature-plugin/test/testdata/TRigidType.txt

@@ -0,0 +1,13 @@
+Expected: a -> [[Int]]
+  Actual: [[Int]] -> [[Int]]
+‘a’ is a rigid type variable bound by
+  the type signature for:
+    test :: forall a. a -> Int
+  at /home/sgillespie/dev/haskell/haskell-language-server/plugins/hls-change-type-signature-plugin/test/testdata/TRigidType.hs:3:1-16
+In the second argument of ‘(.)’, namely ‘reverse’
+In the second argument of ‘(.)’, namely ‘head . reverse’
+In the expression: go . head . reverse
+Relevant bindings include
+  test :: a -> Int
+    (bound at /home/sgillespie/dev/haskell/haskell-language-server/plugins/hls-change-type-signature-plugin/test/testdata/TRigidType.hs:4:1) [GHC-25897]
+

plugins/hls-change-type-signature-plugin/test/testdata/TRigidType2.txt

@@ -0,0 +1,13 @@
+Couldn't match type ‘a’ with ‘[Int]’
+Expected: a -> Int
+  Actual: [Int] -> Int
+‘a’ is a rigid type variable bound by
+  the type signature for:
+    test :: forall a. a -> Int
+  at /home/sgillespie/dev/haskell/haskell-language-server/plugins/hls-change-type-signature-plugin/test/testdata/TRigidType2.hs:3:1-16
+In the expression: head
+In an equation for ‘test’: test = head
+Relevant bindings include
+  test :: a -> Int
+    (bound at /home/sgillespie/dev/haskell/haskell-language-server/plugins/hls-change-type-signature-plugin/test/testdata/TRigidType2.hs:4:1) [GHC-25897]
+