Add projectConfigBuildOnly flags jobs, offline,...

Author: jgotoh

cabal-install/src/Distribution/Client/ProjectConfig/FieldGrammar.hs

@@ -41,16 +41,14 @@ projectConfigBuildOnlyFieldGrammar =
     <*> monoidalFieldAla "build-summary" (alaNubList VCat) L.projectConfigSummaryFile
     <*> optionalFieldDef "build-log" L.projectConfigLogFile mempty
     <*> pure mempty -- cli flag: projectConfigBuildReports
-    <*> optionalFieldDef "report-planning-failure" L.projectConfigReportPlanningFailure (pure False)
+    <*> optionalFieldDef "report-planning-failure" L.projectConfigReportPlanningFailure mempty
     <*> monoidalFieldAla "symlink-bindir" (alaFlag FilePathNT) L.projectConfigSymlinkBinDir
-    -- TODO check numJobsParser
-    -- <*> optionalFieldDef "jobs" L.projectConfigNumJobs (pure )
-    <*> undefined
-    <*> undefined
-    <*> undefined
-    <*> undefined
-    <*> undefined
-    <*> undefined
-    <*> undefined
-    <*> undefined
-    <*> undefined
+    <*> monoidalFieldAla "jobs" (alaFlag NumJobs) L.projectConfigNumJobs
+    <*> optionalFieldDef "keep-going" L.projectConfigKeepGoing mempty
+    <*> optionalFieldDef "offline" L.projectConfigOfflineMode mempty
+    <*> optionalFieldDef "haddock-keep-temp-files" L.projectConfigKeepTempFiles mempty
+    <*> monoidalFieldAla "http-transport" (alaFlag Token) L.projectConfigHttpTransport
+    <*> optionalFieldDef "ignore-expiry" L.projectConfigIgnoreExpiry mempty
+    <*> monoidalFieldAla "remote-repo-cache" (alaFlag FilePathNT) L.projectConfigCacheDir
+    <*> monoidalFieldAla "logs-dir" (alaFlag FilePathNT) L.projectConfigLogsDir
+    <*> pure mempty

cabal-install/src/Distribution/Client/ProjectConfig/Types.hs

@@ -157,6 +157,7 @@ data ProjectConfigBuildOnly = ProjectConfigBuildOnly
   , projectConfigReportPlanningFailure :: Flag Bool
   , projectConfigSymlinkBinDir :: Flag FilePath
   , projectConfigNumJobs :: Flag (Maybe Int)
+  -- ^ Use 'Just n' for number of jobs, 'Nothing' for number of jobs equal to the number of CPUs and 'NoFlag' if flag is not given.
   , projectConfigKeepGoing :: Flag Bool
   , projectConfigOfflineMode :: Flag Bool
   , projectConfigKeepTempFiles :: Flag Bool

cabal-install/src/Distribution/Client/Utils/Parsec.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE MultiParamTypeClasses #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
@@ -12,6 +13,7 @@ module Distribution.Client.Utils.Parsec
   , alaNubList
   , alaNubList'
   , NubList'
+  , NumJobs (..)
   ) where
 
 import Distribution.Client.Compat.Prelude
@@ -23,7 +25,8 @@ import qualified Data.ByteString as BS
 import qualified Data.ByteString.Char8 as BS8
 
 import Distribution.FieldGrammar.Newtypes
-import Distribution.Parsec (PError (..), PWarning (..), Position (..), showPos, zeroPos)
+import Distribution.Parsec (PError (..), PWarning (..), Position (..), showPos, zeroPos, parsecWarning, PWarnType (..))
+import Distribution.Compat.CharParsing
 import Distribution.Simple.Flag
 import Distribution.Simple.Utils (fromUTF8BS)
 import Distribution.Utils.NubList (NubList (..))
@@ -167,3 +170,23 @@ instance (Newtype a b, Ord a, Sep sep, Parsec b) => Parsec (NubList' sep b a) wh
 
 instance (Newtype a b, Sep sep, Pretty b) => Pretty (NubList' sep b a) where
   pretty = prettySep (Proxy :: Proxy sep) . map (pretty . (pack :: a -> b)) . NubList.fromNubList . unpack
+
+newtype NumJobs = NumJobs {getNumJobs :: Maybe Int}
+
+instance Newtype (Maybe Int) NumJobs
+
+instance Parsec NumJobs where
+  parsec = parsecNumJobs
+
+parsecNumJobs :: CabalParsing m => m NumJobs
+parsecNumJobs = ncpus <|> numJobs
+  where
+    ncpus = string "$ncpus" >> return (NumJobs Nothing)
+    numJobs = do
+      num <- integral
+      if num < (1 :: Int)
+        then do
+          parsecWarning PWTOther "The number of jobs should be 1 or more."
+          return (NumJobs Nothing)
+        else return (NumJobs $ Just num)
+

cabal-install/tests/IntegrationTests2/ProjectConfig/ParsecTests.hs

@@ -92,23 +92,23 @@ testProjectConfigBuildOnly = do
   assertConfig expected config legacy (projectConfigBuildOnly . condTreeData)
   where
     projectConfigVerbosity = toFlag (toEnum 2)
-    projectConfigDryRun = toFlag False -- cli only
-    projectConfigOnlyDeps = toFlag False -- cli only
-    projectConfigOnlyDownload = toFlag False -- cli only
+    projectConfigDryRun = mempty -- cli only
+    projectConfigOnlyDeps = mempty -- cli only
+    projectConfigOnlyDownload = mempty -- cli only
     projectConfigSummaryFile = toNubList [toPathTemplate "summaryFile"]
-    projectConfigLogFile = toFlag $ toPathTemplate "myLog.log" -- TODO could be build-log
-    projectConfigBuildReports = toFlag NoReports -- TODO maybe cli only?
+    projectConfigLogFile = toFlag $ toPathTemplate "myLog.log"
+    projectConfigBuildReports = mempty -- cli only
     projectConfigReportPlanningFailure = toFlag True
     projectConfigSymlinkBinDir = toFlag "some-bindir"
     projectConfigNumJobs = toFlag $ Just 4
-    projectConfigKeepGoing = toFlag True -- cli only
+    projectConfigKeepGoing = toFlag True
     projectConfigOfflineMode = toFlag True
     projectConfigKeepTempFiles = toFlag True
     projectConfigHttpTransport = toFlag "wget"
     projectConfigIgnoreExpiry = toFlag True
     projectConfigCacheDir = toFlag "some-cache-dir"
     projectConfigLogsDir = toFlag "logs-directory"
-    projectConfigClientInstallFlags = mempty -- TODO are these actually cli only?
+    projectConfigClientInstallFlags = mempty -- cli only
 
 readConfigDefault :: FilePath -> IO (ProjectConfigSkeleton, ProjectConfigSkeleton)
 readConfigDefault rootFp = readConfig rootFp "cabal.project"

cabal-install/tests/IntegrationTests2/ProjectConfig/files/project-config-build-only/cabal.project

@@ -1,7 +1,7 @@
 verbose: 2
 build-summary: summaryFile
 build-log: myLog.log
-report-planned-failure: true
+report-planning-failure: true
 symlink-bindir: some-bindir
 jobs: 4
 keep-going: true