Refactor test suite

Author: Jana Chadt

hls-test-utils/src/Test/Hls.hs

@@ -97,23 +97,16 @@ goldenWithHaskellDoc plugin title testDataDir path desc ext act =
     documentContents doc
 
 goldenWithHaskellDocFormatter
-  :: PluginDescriptor IdeState
-  -> String
-  -> TestName
-  -> FilePath
-  -> FilePath
-  -> FilePath
-  -> FilePath
+  :: PluginDescriptor IdeState -- ^ Formatter plugin to be used
+  -> String -- ^ Name of the formatter to be used
+  -> TestName -- ^ Title of the test
+  -> FilePath -- ^ Directory of the test data to be used
+  -> FilePath -- ^ Path to the testdata to be used within the directory
+  -> FilePath -- ^ Additional suffix to be appended to the output file
+  -> FilePath -- ^ Extension of the output file
   -> (TextDocumentIdentifier -> Session ())
   -> TestTree
-goldenWithHaskellDocFormatter plugin formatter title testDataDir path desc ext act =
-  goldenGitDiff title (testDataDir </> path <.> desc <.> ext)
-  $ runSessionWithServerFormatter plugin formatter testDataDir
-  $ TL.encodeUtf8 . TL.fromStrict
-  <$> do
-    doc <- openDoc (path <.> ext) "haskell"
-    act doc
-    documentContents doc
+goldenWithHaskellDocFormatter = goldenWithDocFormatter "haskell"
 
 runSessionWithServer :: PluginDescriptor IdeState -> FilePath -> Session a -> IO a
 runSessionWithServer plugin = runSessionWithServer' [plugin] def def fullCaps
@@ -127,21 +120,34 @@ runSessionWithServerFormatter plugin formatter =
     fullCaps
 
 goldenWithCabalDocFormatter
-  :: PluginDescriptor IdeState
-  -> String
-  -> TestName
-  -> FilePath
-  -> FilePath
-  -> FilePath
-  -> FilePath
+  :: PluginDescriptor IdeState -- ^ Formatter plugin to be used
+  -> String -- ^ Name of the formatter to be used
+  -> TestName -- ^ Title of the test
+  -> FilePath -- ^ Directory of the test data to be used
+  -> FilePath -- ^ Path to the testdata to be used within the directory
+  -> FilePath -- ^ Additional suffix to be appended to the output file
+  -> FilePath -- ^ Extension of the output file
+  -> (TextDocumentIdentifier -> Session ())
+  -> TestTree
+goldenWithCabalDocFormatter = goldenWithDocFormatter "cabal"
+
+goldenWithDocFormatter
+  :: T.Text  -- ^ Type of the document to open
+  -> PluginDescriptor IdeState -- ^ Formatter plugin to be used
+  -> String -- ^ Name of the formatter to be used
+  -> TestName -- ^ Title of the test
+  -> FilePath -- ^ Directory of the test data to be used
+  -> FilePath -- ^ Path to the testdata to be used within the directory
+  -> FilePath -- ^ Additional suffix to be appended to the output file
+  -> FilePath -- ^ Extension of the output file
   -> (TextDocumentIdentifier -> Session ())
   -> TestTree
-goldenWithCabalDocFormatter plugin formatter title testDataDir path desc ext act =
+goldenWithDocFormatter filetype plugin formatter title testDataDir path desc ext act =
   goldenGitDiff title (testDataDir </> path <.> desc <.> ext)
   $ runSessionWithServerFormatter plugin formatter testDataDir
   $ TL.encodeUtf8 . TL.fromStrict
   <$> do
-    doc <- openDoc (path <.> ext) "cabal"
+    doc <- openDoc (path <.> ext) filetype
     act doc
     documentContents doc