Refactor autogen completions using libExecTestBenchCommons and consolidate test data

Author: Sid1005

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Data.hs

@@ -71,12 +71,12 @@ cabalKeywords =
 stanzaKeywordMap :: Map StanzaType (Map KeyWordName Completer)
 stanzaKeywordMap =
   Map.fromList
-    [ ("library", libraryFields <> libExecTestBenchCommons),
-      ("executable", executableFields <> libExecTestBenchCommons),
-      ("test-suite", testSuiteFields <> libExecTestBenchCommons),
-      ("benchmark", benchmarkFields <> libExecTestBenchCommons),
-      ("foreign-library", foreignLibraryFields <> libExecTestBenchCommons),
-      ("common", libExecTestBenchCommons),
+    [ ("library", libraryFields <> libExecTestBenchCommons "library"),
+      ("executable", executableFields <> libExecTestBenchCommons "executable"),
+      ("test-suite", testSuiteFields <> libExecTestBenchCommons "test-suite"),
+      ("benchmark", benchmarkFields <> libExecTestBenchCommons "benchmark"),
+      ("foreign-library", foreignLibraryFields <> libExecTestBenchCommons "benchmark"),
+      ("common", libExecTestBenchCommons "library"),
       ("flag", flagFields),
       ("source-repository", sourceRepositoryFields)
     ]
@@ -90,9 +90,7 @@ libraryFields =
       ("visibility:", constantCompleter ["private", "public"]),
       ("reexported-modules:", noopCompleter),
       ("signatures:", noopCompleter),
-      ("other-modules:", modulesCompleter sourceDirsExtractionLibrary),
-      ("autogen-includes:", filePathCompleter),
-      ("autogen-modules:", modulesCompleter sourceDirsExtractionLibrary)
+      ("other-modules:", modulesCompleter sourceDirsExtractionLibrary)
 
     ]
 
@@ -101,28 +99,23 @@ executableFields =
   Map.fromList
     [ ("main-is:", mainIsCompleter sourceDirsExtractionExecutable),
       ("scope:", constantCompleter ["public", "private"]),
-      ("other-modules:", modulesCompleter sourceDirsExtractionExecutable),
-      ("autogen-modules:", modulesCompleter sourceDirsExtractionExecutable)
+      ("other-modules:", modulesCompleter sourceDirsExtractionExecutable)
     ]
 
 testSuiteFields :: Map KeyWordName Completer
 testSuiteFields =
   Map.fromList
     [ ("type:", constantCompleter ["exitcode-stdio-1.0", "detailed-0.9"]),
       ("main-is:", mainIsCompleter sourceDirsExtractionTestSuite),
-      ("other-modules:", modulesCompleter sourceDirsExtractionTestSuite),
-      ("autogen-modules:", modulesCompleter sourceDirsExtractionTestSuite),
-      ("autogen-includes:", filePathCompleter)
+      ("other-modules:", modulesCompleter sourceDirsExtractionTestSuite)
     ]
 
 benchmarkFields :: Map KeyWordName Completer
 benchmarkFields =
   Map.fromList
     [ ("type:", noopCompleter),
       ("main-is:", mainIsCompleter sourceDirsExtractionBenchmark),
-      ("other-modules:", modulesCompleter sourceDirsExtractionBenchmark),
-      ("autogen-modules:", modulesCompleter sourceDirsExtractionBenchmark),
-      ("autogen-includes:", filePathCompleter)
+      ("other-modules:", modulesCompleter sourceDirsExtractionBenchmark)
     ]
 
 foreignLibraryFields :: Map KeyWordName Completer
@@ -170,8 +163,20 @@ flagFields =
       ("lib-version-linux:", noopCompleter)
     ]
 
-libExecTestBenchCommons :: Map KeyWordName Completer
-libExecTestBenchCommons =
+libExecTestBenchCommons :: StanzaType -> Map KeyWordName Completer
+libExecTestBenchCommons stanza =
+  Map.insert "autogen-modules:" (modulesCompleter extractor) $
+  Map.insert "autogen-includes:" filePathCompleter baseBenchCommons
+  where
+    extractor = case stanza of
+      "library"    -> sourceDirsExtractionLibrary
+      "executable" -> sourceDirsExtractionExecutable
+      "test-suite" -> sourceDirsExtractionTestSuite
+      "benchmark"  -> sourceDirsExtractionBenchmark
+      _            -> sourceDirsExtractionLibrary
+
+baseBenchCommons :: Map KeyWordName Completer
+baseBenchCommons =
   Map.fromList
     [ ("import:", importCompleter),
       ("build-depends:", noopCompleter),

plugins/hls-cabal-plugin/test/Completer.hs

@@ -48,41 +48,22 @@ autogenModulesCompletionTests :: TestTree
 autogenModulesCompletionTests =
   testGroup
     "Autogen modules completion"
-    [ runCabalTestCaseSession "Completes autogen-modules in library stanza" "" $ do
-        doc <- openDoc "cabal-files/autogen-completion.cabal" "cabal"
-        completions <- getCompletions doc (Position 5 4)
-        liftIO $ do
-          print (map (^. L.label) completions)
-          assertBool "autogen-modules: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-modules:" (c ^. L.label)) completions
-          assertBool "autogen-includes: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-includes:" (c ^. L.label)) completions
-    
-    , runCabalTestCaseSession "Completes autogen-modules in executable stanza" "" $ do
-        doc <- openDoc "cabal-files/autogen-completion-exe.cabal" "cabal"
-        completions <- getCompletions doc (Position 5 4)
-        liftIO $ do
-          assertBool "autogen-modules: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-modules:" (c ^. L.label)) completions
-    
-    , runCabalTestCaseSession "Completes autogen fields in test-suite stanza" "" $ do
-        doc <- openDoc "cabal-files/autogen-completion-test.cabal" "cabal"
-        completions <- getCompletions doc (Position 6 4)
-        liftIO $ do
-          assertBool "autogen-modules: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-modules:" (c ^. L.label)) completions
-          assertBool "autogen-includes: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-includes:" (c ^. L.label)) completions
-    
-    , runCabalTestCaseSession "Completes autogen fields in benchmark stanza" "" $ do
-        doc <- openDoc "cabal-files/autogen-completion-bench.cabal" "cabal"
-        completions <- getCompletions doc (Position 6 4)
-        liftIO $ do
-          assertBool "autogen-modules: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-modules:" (c ^. L.label)) completions
-          assertBool "autogen-includes: should be in completions" $
-            any (\c -> T.isInfixOf "autogen-includes:" (c ^. L.label)) completions
+    [ checkCompletion "library"     (Position 4 4)  ["autogen-modules:", "autogen-includes:"]
+    , checkCompletion "executable"  (Position 8 4) ["autogen-modules:"]
+    , checkCompletion "test-suite"  (Position 13 4) ["autogen-modules:", "autogen-includes:"]
+    , checkCompletion "benchmark"   (Position 18 4) ["autogen-modules:", "autogen-includes:"]
     ]
+  where
+    checkCompletion :: String -> Position -> [T.Text] -> TestTree
+    checkCompletion name pos expectedLabels =
+      runCabalTestCaseSession ("Completes autogen fields in " ++ name ++ " stanza") "" $ do
+        doc <- openDoc "completions/autogen-completions.cabal" "cabal"
+        completions <- getCompletions doc pos
+        liftIO $ mapM_ (\label ->
+          assertBool (T.unpack label ++ " should be in completions") $
+            any (\c -> T.isInfixOf label (c ^. L.label)) completions
+          ) expectedLabels
+
 
 
 basicCompleterTests :: TestTree

plugins/hls-cabal-plugin/test/testdata/cabal-files/autogen-completion-bench.cabal

@@ -0,0 +1,19 @@
+cabal-version: 3.2
+name: test-project
+
+library
+  autogen
+
+executable exe
+  main-is: Main.hs
+  autogen
+
+test-suite test
+  type: exitcode-stdio-1.0
+  main-is: Test.hs
+  autogen
+
+benchmark bench
+  type: exitcode-stdio-1.0
+  main-is: Bench.hs
+  autogen

plugins/hls-cabal-plugin/test/testdata/cabal-files/autogen-completion-exe.cabal

@@ -150,7 +150,7 @@ pathModuleNames recorder state normFilePath filePath
       -- TODO, this can be avoid if the filePath is already absolute,
       -- we can avoid the toAbsolute call in the future.
       -- see Note [Root Directory]
-      let mdlPath = (toAbsolute $ rootDir state) filePath
+      let mdlPath = normalise $ (toAbsolute $ rootDir state) filePath
       logWith recorder Debug (AbsoluteFilePath mdlPath)
 
       let suffixes = mapMaybe (`stripPrefix` mdlPath) paths