Add --cabal-global-options

Author: tbidne

clc-stackage.cabal

@@ -45,7 +45,8 @@ library utils
     , deepseq          >=1.4.6.0   && <1.6
     , directory        ^>=1.3.5.0
     , file-io          ^>=0.1.0.0
-    , filepath         >=1.4.100.0 && <1.6
+    , filepath         >=1.5.0.0   && <1.6
+    , os-string        ^>=2.0.0
     , pretty-terminal  ^>=0.1.0.0
     , text             >=1.2.3.2   && <2.2
     , time             >=1.9.3     && <1.15

src/runner/CLC/Stackage/Runner/Args.hs

@@ -45,6 +45,8 @@ data Args = MkArgs
   { -- | If given, batches packages together so we build more than one.
     -- Defaults to batching everything together in the same group.
     batch :: Maybe Int,
+    -- | Global options to pass to cabal e.g. --store-dir.
+    cabalGlobalOpts :: [String],
     -- | Options to pass to cabal e.g. --semaphore.
     cabalOpts :: [String],
     -- | Optional path to cabal executable.
@@ -123,7 +125,7 @@ getArgs = OA.execParser parserInfoArgs
             ],
           mkExample
             [ "# Run with custom cabal",
-              "$ clc-stackage --cabal-path=path/to/cabal --cabal-options='--store-dir=path/to/store'"
+              "$ clc-stackage --cabal-path=path/to/cabal --cabal-global-options='--store-dir=path/to/store'"
             ],
           mkExample
             [ "# Run with custom snapshot",
@@ -139,6 +141,7 @@ parseCliArgs :: Parser Args
 parseCliArgs =
   ( do
       batch <- parseBatch
+      cabalGlobalOpts <- parseCabalGlobalOpts
       cabalOpts <- parseCabalOpts
       cabalPath <- parseCabalPath
       colorLogs <- parseColorLogs
@@ -153,6 +156,7 @@ parseCliArgs =
       pure $
         MkArgs
           { batch,
+            cabalGlobalOpts,
             cabalOpts,
             cabalPath,
             colorLogs,
@@ -186,6 +190,24 @@ parseBatch =
           ]
       )
 
+parseCabalGlobalOpts :: Parser [String]
+parseCabalGlobalOpts =
+  OA.option
+    readOpts
+    ( mconcat
+        [ OA.long "cabal-global-options",
+          OA.metavar "ARGS...",
+          OA.value [],
+          mkHelp $
+            mconcat
+              [ "Global arguments to pass to cabal e.g. '--store-dir=path/to/store'. ",
+                "These precede the build command."
+              ]
+        ]
+    )
+  where
+    readOpts = Str.words <$> OA.str
+
 parseCabalOpts :: Parser [String]
 parseCabalOpts =
   OA.option
@@ -194,7 +216,7 @@ parseCabalOpts =
         [ OA.long "cabal-options",
           OA.metavar "ARGS...",
           OA.value [],
-          mkHelp "Quoted arguments to pass to cabal e.g. '--semaphore --verbose=1'"
+          mkHelp "Quoted arguments to pass to cabal e.g. '--semaphore --verbose=1'."
         ]
     )
   where

src/runner/CLC/Stackage/Runner/Env.hs

@@ -46,7 +46,7 @@ import CLC.Stackage.Utils.Logging qualified as Logging
 import CLC.Stackage.Utils.Package (Package (MkPackage, name, version))
 import CLC.Stackage.Utils.Paths qualified as Paths
 import Control.Exception (throwIO)
-import Control.Monad (unless)
+import Control.Monad (join, unless)
 import Data.Bool (Bool (False, True), not)
 import Data.Foldable (Foldable (foldl'))
 import Data.IORef (newIORef, readIORef)
@@ -61,7 +61,7 @@ import System.Directory.OsPath qualified as Dir
 import System.Exit (ExitCode (ExitSuccess))
 import System.OsPath (osp)
 import System.OsPath qualified as OsP
-import Prelude (IO, Monad ((>>=)), mconcat, pure, show, ($), (++), (.), (<$>), (<>))
+import Prelude (IO, Monad ((>>=)), mconcat, pure, show, ($), (.), (<$>), (<>))
 
 -- | Args used for building all packages.
 data RunnerEnv = MkRunnerEnv
@@ -103,21 +103,27 @@ setup hLoggerRaw modifyPackages = do
 
   -- Set up build args for cabal, filling in missing defaults
   let buildArgs =
-        "build"
-          : keepGoingArg
-          ++ cliArgs.cabalOpts
+        join
+          [ cliArgs.cabalGlobalOpts,
+            ["build"],
+            keepGoingArg,
+            cliArgs.cabalOpts
+          ]
 
       -- when packageFailFast is false, add keep-going so that we build as many
       -- packages in the group.
       keepGoingArg = ["--keep-going" | not cliArgs.packageFailFast]
 
-  let cabalPathRaw = fromMaybe [osp|cabal|] cliArgs.cabalPath
+  cabalPathRaw <- case cliArgs.cabalPath of
+    Nothing -> pure [osp|cabal|]
+    Just p -> Paths.canonicalizePath p
+
   cabalPath <-
     Dir.findExecutable cabalPathRaw >>= \case
       -- TODO: It would be nice to avoid the decode here and keep everything
       -- in OsPath, though that is blocked until process support OsPath.
       Just p -> OsP.decodeUtf p
-      Nothing -> Ex.throwText "Cabal not found"
+      Nothing -> Ex.throwText $ "Cabal not found: " <> T.pack (show cabalPathRaw)
 
   successesRef <- newIORef Set.empty
   failuresRef <- newIORef Set.empty

src/utils/CLC/Stackage/Utils/Paths.hs

@@ -11,6 +11,7 @@ module CLC.Stackage.Utils.Paths
     generatedCabalProjectLocalPath,
 
     -- * Utils
+    canonicalizePath,
     OsPath.encodeUtf,
     decodeUtfLenient,
     unsafeDecodeUtf,
@@ -20,8 +21,10 @@ where
 import GHC.IO.Encoding.Failure (CodingFailureMode (TransliterateCodingFailure))
 import GHC.IO.Encoding.UTF16 qualified as UTF16
 import GHC.IO.Encoding.UTF8 qualified as UTF8
+import System.Directory.OsPath qualified as Dir
 import System.OsPath (OsPath, osp, (</>))
 import System.OsPath qualified as OsPath
+import System.OsString qualified as OsStr
 
 -- | Leniently decodes OsPath to String.
 decodeUtfLenient :: OsPath -> String
@@ -37,6 +40,21 @@ unsafeDecodeUtf p = case OsPath.decodeUtf p of
   Just fp -> fp
   Nothing -> error $ "Error decoding ospath: " <> show p
 
+-- | Calls canonicalizePath, after manually expanding tilde (~) to the home
+-- directory. The latter usually shouldn't be needed, as the shell normally
+-- performs such expansions before the string makes it to the program.
+-- But when it is part of an argument e.g.
+--
+--   --cabal-path=~/...
+--
+-- it is not expanded.
+canonicalizePath :: OsPath -> IO OsPath
+canonicalizePath p = case OsStr.stripPrefix [osp|~/|] p of
+  Nothing -> Dir.canonicalizePath p
+  Just rest -> do
+    home <- Dir.getHomeDirectory
+    Dir.canonicalizePath $ home </> rest
+
 -- | Output directory.
 outputDir :: OsPath
 outputDir = [osp|output|]