tests

Author: VenInf

haskell-language-server.cabal

@@ -281,6 +281,7 @@ test-suite hls-cabal-plugin-tests
     Completer
     Context
     Utils
+    Outline
   build-depends:
     , base
     , bytestring

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

@@ -6,10 +6,7 @@
 {-# LANGUAGE RecordWildCards       #-}
 {-# LANGUAGE ViewPatterns          #-}
 
-module Ide.Plugin.Cabal.Outline
-  ( moduleOutline,
-  )
-where
+module Ide.Plugin.Cabal.Outline where
 
 import           Control.Monad.IO.Class
 import           Data.Maybe

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

@@ -16,6 +16,7 @@ import qualified Data.Text                       as Text
 import           Ide.Plugin.Cabal.LicenseSuggest (licenseErrorSuggestion)
 import qualified Ide.Plugin.Cabal.Parse          as Lib
 import qualified Language.LSP.Protocol.Lens      as L
+import           Outline                         (outlineTests)
 import           System.FilePath
 import           Test.Hls
 import           Utils
@@ -29,6 +30,7 @@ main = do
             , pluginTests
             , completerTests
             , contextTests
+            , outlineTests
             ]
 
 -- ------------------------------------------------------------------------

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

@@ -0,0 +1,70 @@
+{-# LANGUAGE DisambiguateRecordFields #-}
+{-# LANGUAGE OverloadedStrings        #-}
+
+module Outline (
+    outlineTests
+) where
+
+import qualified Ide.Plugin.Cabal.Outline    as Outline
+import qualified Language.LSP.Protocol.Types as LSP
+import           Test.Hls
+import           Utils
+
+testSymbols :: (HasCallStack) => TestName -> FilePath -> [DocumentSymbol] -> TestTree
+testSymbols testName path expectedSymbols =
+  runCabalTestCaseSession testName "outline-cabal" $ do
+    docId <- openDoc path "cabal"
+    symbols <- getDocumentSymbols docId
+    liftIO $ symbols @?= Right expectedSymbols
+
+outlineTests :: TestTree
+outlineTests =
+  testGroup
+    "Cabal Outline Tests"
+    [ testSymbols
+        "cabal Field outline test"
+        "field.cabal"
+        [fieldDocumentSymbol],
+      testSymbols
+        "cabal FieldLine outline test"
+        "fieldline.cabal"
+        [fieldLineDocumentSymbol],
+      testSymbols
+        "cabal Section outline test"
+        "section.cabal"
+        [sectionDocumentSymbol],
+      testSymbols
+        "cabal SectionArg outline test"
+        "sectionarg.cabal"
+        [sectionArgDocumentSymbol]
+    ]
+  where
+    fieldDocumentSymbol = (Outline.defDocumentSymbol (LSP.Range {_start = LSP.Position {_line = 0, _character = 0},
+                                                                 _end = LSP.Position {_line = 0, _character = 8}}))
+                                    { LSP._name = "homepage",
+                                      LSP._kind = LSP.SymbolKind_Field,
+                                      LSP._children = Nothing
+                                    }
+    fieldLineDocumentSymbol = (Outline.defDocumentSymbol (LSP.Range {_start = LSP.Position {_line = 0, _character = 0},
+                                                                     _end = LSP.Position {_line = 0, _character = 13}}))
+                                    { LSP._name = "cabal-version",
+                                      LSP._kind = LSP.SymbolKind_Field,
+                                      LSP._children = Nothing -- the values of fieldLine are removed from the outline
+                                    }
+    sectionDocumentSymbol = (Outline.defDocumentSymbol (LSP.Range {_start = LSP.Position {_line = 0, _character = 2},
+                                                                     _end = LSP.Position {_line = 0, _character = 15}}))
+                                    { LSP._name = "build-depends",
+                                      LSP._kind = LSP.SymbolKind_Field,
+                                      LSP._children = Nothing -- the values of fieldLine are removed from the outline
+                                    }
+    sectionArgDocumentSymbol = (Outline.defDocumentSymbol (LSP.Range {_start = LSP.Position {_line = 0, _character = 2},
+                                                                     _end = LSP.Position {_line = 0, _character = 19}}))
+                                    { LSP._name = "if os ( windows )",
+                                      LSP._kind = LSP.SymbolKind_Object,
+                                      LSP._children = Just $ [sectionArgChildrenDocumentSymbol]                                    }
+    sectionArgChildrenDocumentSymbol = (Outline.defDocumentSymbol (LSP.Range {_start = LSP.Position {_line = 1, _character = 4},
+                                                                     _end = LSP.Position {_line = 1, _character = 17}}))
+                                    { LSP._name = "build-depends",
+                                      LSP._kind = LSP.SymbolKind_Field,
+                                      LSP._children = Nothing
+                                    }

plugins/hls-cabal-plugin/test/testdata/outline-cabal/field.cabal

@@ -0,0 +1 @@
+homepage:

plugins/hls-cabal-plugin/test/testdata/outline-cabal/fieldline.cabal

@@ -0,0 +1 @@
+cabal-version:      3.0

plugins/hls-cabal-plugin/test/testdata/outline-cabal/section.cabal

@@ -0,0 +1,2 @@
+  build-depends:
+    base                         >=4.16     && <5

plugins/hls-cabal-plugin/test/testdata/outline-cabal/sectionarg.cabal

@@ -0,0 +1,2 @@
+  if os(windows)
+    build-depends: Win32