Merge pull request #86 from martijnbastiaan/fix85

Account for `default-language` sections in Cabal files

Author: martijnbastiaan

.github/workflows/ci.yml

@@ -62,7 +62,7 @@ jobs:
     strategy:
       matrix:
         os: ["macOS-latest", "windows-latest", "ubuntu-22.04"]
-        ghc: ["9.8.1", "9.6.3", "9.4.7", "9.2.8", "9.0.2", "8.10.7", "8.8.4", "8.6.5", "8.4.4"]
+        ghc: ["9.10.1", "9.8.1", "9.6.3", "9.4.7", "9.2.8", "9.0.2", "8.10.7", "8.8.4", "8.6.5", "8.4.4"]
         exclude:
           # Windows gets stuck while running the testsuite, but this is not a
           # doctest-parallel failure
@@ -85,9 +85,9 @@ jobs:
 
         # Uncomment if testing with an unreleased GHC. Make sure to edit the
         #  "Setup Haskell (head)" step too.
-        include:
-          - os: ubuntu-22.04
-            ghc: head
+        # include:
+        #   - os: ubuntu-22.04
+        #     ghc: head
       fail-fast: false
     steps:
       - name: Checkout

CHANGES.markdown

@@ -1,3 +1,6 @@
+# 0.4
+ * Account for `default-language` sections in Cabal files ([#85](https://github.com/martijnbastiaan/doctest-parallel/issues/85))
+
 # 0.3.1.1
  * Add support for GHC 9.10
 

cabal.project

@@ -12,3 +12,6 @@ source-repository-package
 
 allow-newer:
   unordered-containers:template-haskell
+
+package doctest-parallel
+  ghc-options: +RTS -qn4 -A128M -RTS -j4

doctest-parallel.cabal

@@ -186,6 +186,7 @@ test-suite spectests
       MainSpec
       OptionsSpec
       ParseSpec
+      ProjectsSpec
       PropertySpec
       Runner.ExampleSpec
       RunnerSpec

src/Test/DocTest/Helpers.hs

@@ -9,6 +9,7 @@ module Test.DocTest.Helpers where
 
 import GHC.Stack (HasCallStack)
 
+import Data.Maybe (maybeToList)
 import System.Directory
   ( canonicalizePath, doesFileExist )
 import System.FilePath ((</>), isDrive, takeDirectory)
@@ -24,12 +25,13 @@ import qualified Data.Set as Set
 -- Cabal
 import Distribution.ModuleName (ModuleName)
 import Distribution.Simple
-  ( Extension (DisableExtension, EnableExtension, UnknownExtension) )
+  ( Extension (DisableExtension, EnableExtension, UnknownExtension), Language (..) )
 import Distribution.Types.UnqualComponentName ( unUnqualComponentName )
 import Distribution.PackageDescription
   ( GenericPackageDescription (condLibrary)
   , exposedModules, libBuildInfo, hsSourceDirs, defaultExtensions, package
-  , packageDescription, condSubLibraries, includeDirs, autogenModules, ConfVar(..) )
+  , packageDescription, condSubLibraries, includeDirs, autogenModules, ConfVar(..)
+  , defaultLanguage )
 
 import Distribution.Compiler (CompilerFlavor(GHC))
 import Distribution.Pretty (prettyShow)
@@ -69,26 +71,35 @@ data Library = Library
     -- ^ Exposed modules
   , libDefaultExtensions :: [Extension]
     -- ^ Extensions enabled by default
+  , libDefaultLanguages :: [Language]
+    -- ^ Language version(s) to enable
   }
   deriving (Show)
 
 -- | Merge multiple libraries into one, by concatenating all their fields.
 mergeLibraries :: [Library] -> Library
 mergeLibraries libs = Library
+  -- XXX: Why do we merge libraries? Shouldn't we always aim to parse ONE library?
   { libSourceDirectories = concatMap libSourceDirectories libs
   , libCSourceDirectories = concatMap libCSourceDirectories libs
   , libModules = concatMap libModules libs
   , libDefaultExtensions = concatMap libDefaultExtensions libs
+  , libDefaultLanguages = concatMap libDefaultLanguages libs
   }
 
 -- | Convert a "Library" to arguments suitable to be passed to GHCi.
 libraryToGhciArgs :: Library -> ([String], [String], [String])
-libraryToGhciArgs Library{..} = (hsSrcArgs <> cSrcArgs, modArgs, extArgs)
+libraryToGhciArgs Library{..} = (hsSrcArgs <> cSrcArgs, modArgs, extArgs <> langArgs)
  where
   hsSrcArgs = map ("-i" <>) libSourceDirectories
   cSrcArgs = map ("-I" <>) libCSourceDirectories
   modArgs = map prettyShow libModules
   extArgs = map showExt libDefaultExtensions
+  langArgs = map showLanguage libDefaultLanguages
+
+  showLanguage = \case
+    UnknownLanguage ul -> "-X" <> ul
+    l -> "-X" <> show l
 
   showExt = \case
     EnableExtension ext -> "-X" <> show ext
@@ -230,6 +241,7 @@ extractSpecificCabalLibrary maybeLibName pkgPath = do
     , libCSourceDirectories = map (root </>) cSourceDirs
     , libModules = exposedModules lib `rmList` autogenModules buildInfo
     , libDefaultExtensions = defaultExtensions buildInfo
+    , libDefaultLanguages = maybeToList (defaultLanguage buildInfo)
     }
    where
     buildInfo = libBuildInfo lib

test/ProjectsSpec.hs

@@ -0,0 +1,29 @@
+{-# LANGUAGE MultiWayIf #-}
+
+module ProjectsSpec (main, spec) where
+
+import Test.Hspec
+import System.Environment (getEnvironment)
+import System.Process (readCreateProcess, proc)
+
+import qualified Data.Map as Map
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = do
+  env <- Map.fromList <$> runIO getEnvironment
+
+  let
+    -- Only test with cabal
+    cDescribe =
+      if
+        | "STACK_EXE" `Map.member` env -> xdescribe
+        | "NIX_BUILD_TOP" `Map.member` env -> xdescribe
+        | otherwise -> describe
+
+  cDescribe "T85-default-language" $ do
+    it "cabal run doctests" $ do
+      _ <- readCreateProcess (proc "cabal" ["run", "-v0", "--", "doctests", "--quiet"]) ""
+      pure ()

test/Spec.hs

@@ -9,6 +9,7 @@ import qualified LocationSpec
 import qualified MainSpec
 import qualified OptionsSpec
 import qualified ParseSpec
+import qualified ProjectsSpec
 import qualified PropertySpec
 import qualified RunnerSpec
 import qualified RunSpec
@@ -26,6 +27,7 @@ spec = do
   describe "MainSpec"        MainSpec.spec
   describe "OptionsSpec"     OptionsSpec.spec
   describe "ParseSpec"       ParseSpec.spec
+  describe "ProjectsSpec"    ProjectsSpec.spec
   describe "PropertySpec"    PropertySpec.spec
   describe "RunnerSpec"      RunnerSpec.spec
   describe "RunSpec"         RunSpec.spec

test/projects/T85-default-language/T85-default-language.cabal

@@ -0,0 +1,26 @@
+cabal-version:      3.0
+name:               T85-default-language
+version:            0.1.0.0
+license:            BSD-3-Clause
+author:             Martijn Bastiaan
+maintainer:         martijn@hmbastiaan.nl
+build-type:         Simple
+extra-doc-files:    CHANGELOG.md
+
+common warnings
+    ghc-options: -Wall
+
+library
+    import:           warnings
+    exposed-modules:  MyLib
+    build-depends:    base ^>=4.17.2.1
+    hs-source-dirs:   src
+    default-language: Haskell2010
+
+test-suite doctests
+  type:             exitcode-stdio-1.0
+  hs-source-dirs:   test
+  main-is:          doctests.hs
+  ghc-options:      -threaded
+  build-depends:    base, T85-default-language, doctest-parallel >= 0.1
+  default-language: Haskell2010

test/projects/T85-default-language/cabal.project

@@ -0,0 +1,10 @@
+write-ghc-environment-files: always
+
+packages:
+  .
+  ../../..
+
+tests: true
+
+package doctest-parallel
+  ghc-options: +RTS -qn4 -A128M -RTS -j4

test/projects/T85-default-language/src/MyLib.hs

@@ -0,0 +1,10 @@
+module MyLib (someFunc) where
+
+data (Show a) => ShowProxy a = Prox a
+  deriving (Show)
+
+showViaProxy :: (Show a) => a -> IO ()
+showViaProxy a = putStrLn $ show $ Prox a
+
+someFunc :: IO ()
+someFunc = showViaProxy "hello world!"