v2-sdist now respects --ignore-project

cabal-install/src/Distribution/Client/CmdSdist.hs

@@ -138,7 +138,7 @@ sdistOptions showOrParseArgs =
 
 sdistAction :: (ProjectFlags, SdistFlags) -> [String] -> GlobalFlags -> IO ()
 sdistAction (ProjectFlags{..}, SdistFlags{..}) targetStrings globalFlags = do
-    (baseCtx, distDirLayout) <- withProjectOrGlobalConfig verbosity ignoreProject globalConfigFlag withProject withoutProject
+    (baseCtx, distDirLayout) <- withProjectOrGlobalConfig verbosity flagIgnoreProject globalConfigFlag withProject withoutProject
 
     let localPkgs = localPackages baseCtx
 
@@ -187,7 +187,6 @@ sdistAction (ProjectFlags{..}, SdistFlags{..}) targetStrings globalFlags = do
     listSources    = fromFlagOrDefault False sdistListSources
     nulSeparated   = fromFlagOrDefault False sdistNulSeparated
     mOutputPath    = flagToMaybe sdistOutputPath
-    ignoreProject  = flagIgnoreProject
 
     prjConfig :: ProjectConfig
     prjConfig = commandLineFlagsToProjectConfig

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

@@ -462,7 +462,7 @@ renderBadProjectRoot (BadProjectRootExplicitFile projectFile) =
 
 withProjectOrGlobalConfig
     :: Verbosity                  -- ^ verbosity
-    -> Flag Bool                  -- ^ whether to ignore local project
+    -> Flag Bool                  -- ^ whether to ignore local project (--ignore-project flag)
     -> Flag FilePath              -- ^ @--cabal-config@
     -> IO a                       -- ^ with project
     -> (ProjectConfig -> IO a)    -- ^ without projet
@@ -504,16 +504,22 @@ withProjectOrGlobalConfig' verbosity globalConfigFlag with without = do
 --
 readProjectConfig :: Verbosity
                   -> HttpTransport
+                  -> Flag Bool -- ^ @--ignore-project@
                   -> Flag FilePath
                   -> DistDirLayout
                   -> Rebuild ProjectConfigSkeleton
-readProjectConfig verbosity httpTransport configFileFlag distDirLayout = do
+readProjectConfig verbosity httpTransport ignoreProjectFlag configFileFlag distDirLayout = do
     global <- singletonProjectConfigSkeleton <$> readGlobalConfig verbosity configFileFlag
     local  <- readProjectLocalConfigOrDefault verbosity httpTransport distDirLayout
     freeze <- readProjectLocalFreezeConfig    verbosity httpTransport distDirLayout
     extra  <- readProjectLocalExtraConfig     verbosity httpTransport distDirLayout
-    return (global <> local <> freeze <> extra)
-
+    if ignoreProjectFlag == Flag True then return (global <> (singletonProjectConfigSkeleton defaultProject))
+    else return (global <> local <> freeze <> extra)
+    where
+      defaultProject :: ProjectConfig
+      defaultProject = mempty {
+        projectPackages = ["./"]
+      }
 
 -- | Reads an explicit @cabal.project@ file in the given project root dir,
 -- or returns the default project config for an implicitly defined project.
@@ -534,15 +540,13 @@ readProjectLocalConfigOrDefault verbosity httpTransport distDirLayout = do
   where
     projectFile :: FilePath
     projectFile = distProjectFile distDirLayout ""
-
     defaultImplicitProjectConfig :: ProjectConfig
-    defaultImplicitProjectConfig =
-      mempty {
-        -- We expect a package in the current directory.
-        projectPackages         = [ "./*.cabal" ],
+    defaultImplicitProjectConfig = mempty {
+      -- We expect a package in the current directory.
+      projectPackages         = [ "./*.cabal" ],
 
-        projectConfigProvenance = Set.singleton Implicit
-      }
+      projectConfigProvenance = Set.singleton Implicit
+    }
 
 -- | Reads a @cabal.project.local@ file in the given project root dir,
 -- or returns empty. This file gets written by @cabal configure@, or in

cabal-install/src/Distribution/Client/ProjectFlags.hs

@@ -47,7 +47,10 @@ projectFlagsOptions showOrParseArgs =
         (reqArg "FILE" (succeedReadE Flag) flagToList)
     , option ['z'] ["ignore-project"]
         "Ignore local project configuration"
-        flagIgnoreProject (\v flags -> flags { flagIgnoreProject = v })
+        -- Flag True: --ignore-project is given and --project-file is not given
+        -- Flag False: --ignore-project and --project-file is given
+        -- NoFlag: neither --ignore-project or --project-file is given
+        flagIgnoreProject (\v flags -> flags { flagIgnoreProject = if v == NoFlag then NoFlag else toFlag ((flagProjectFileName flags) == NoFlag && v == Flag True) })
         (yesNoOpt showOrParseArgs)
     ]
 

cabal-install/src/Distribution/Client/ProjectPlanning.hs

@@ -352,6 +352,9 @@ rebuildProjectConfig verbosity
     ProjectConfigShared { projectConfigConfigFile } =
       projectConfigShared cliConfig
 
+    ProjectConfigShared { projectConfigIgnoreProject } =
+      projectConfigShared cliConfig
+
     fileMonitorProjectConfig ::
       FileMonitor
         (FilePath, FilePath)
@@ -364,7 +367,7 @@ rebuildProjectConfig verbosity
     --
     phaseReadProjectConfig :: Rebuild ProjectConfigSkeleton
     phaseReadProjectConfig = do
-      readProjectConfig verbosity httpTransport projectConfigConfigFile distDirLayout
+      readProjectConfig verbosity httpTransport projectConfigIgnoreProject projectConfigConfigFile distDirLayout
 
     -- Look for all the cabal packages in the project
     -- some of which may be local src dirs, tarballs etc
@@ -375,8 +378,8 @@ rebuildProjectConfig verbosity
                                projectConfigShared,
                                projectConfigBuildOnly
                              } = do
-      pkgLocations <- findProjectPackages distDirLayout projectConfig
 
+      pkgLocations <- findProjectPackages distDirLayout projectConfig
       -- Create folder only if findProjectPackages did not throw a
       -- BadPackageLocations exception.
       liftIO $ do

cabal-install/tests/IntegrationTests2.hs

@@ -53,6 +53,7 @@ import Distribution.Simple.Setup (toFlag, HaddockFlags(..), defaultHaddockFlags)
 import Distribution.Client.Setup (globalCommand)
 import Distribution.Simple.Compiler
 import Distribution.Simple.Command
+import qualified Distribution.Simple.Flag as Flag
 import Distribution.System
 import Distribution.Version
 import Distribution.ModuleName (ModuleName)
@@ -147,7 +148,8 @@ tests config =
     ]
   , testGroup "Flag tests" $
     [
-      testCase "Test Nix Flag" testNixFlags
+      testCase "Test Nix Flag" testNixFlags,
+      testCase "Test Ignore Project Flag" testIgnoreProjectFlag
     ]
   ]
 
@@ -1960,4 +1962,20 @@ testNixFlags = do
     fromFlag NoFlag = Nothing
     getFlags :: CommandUI GlobalFlags -> CommandParse (GlobalFlags -> GlobalFlags, [String]) -> Maybe GlobalFlags
     getFlags cui (CommandReadyToGo (mkflags, _)) = Just . mkflags . commandDefaultFlags $ cui
-    getFlags _ _ = Nothing
+    getFlags _ _ = Nothing
+
+testIgnoreProjectFlag :: Assertion
+testIgnoreProjectFlag = do
+  -- Coverage flag should be false globally by default (~/.cabal folder)
+  (_, _, prjConfigGlobal, _, _) <- configureProject testdir ignoreSetConfig
+  let globalCoverageFlag = packageConfigCoverage . projectConfigLocalPackages $ prjConfigGlobal
+  False @=? Flag.fromFlagOrDefault False globalCoverageFlag
+  -- It is set to true in the cabal.project file
+  (_, _, prjConfigLocal, _, _) <- configureProject testdir emptyConfig
+  let localCoverageFlag = packageConfigCoverage . projectConfigLocalPackages $ prjConfigLocal
+  True @=? Flag.fromFlagOrDefault False localCoverageFlag
+  where
+    testdir = "build/ignore-project"
+    emptyConfig = mempty
+    ignoreSetConfig :: ProjectConfig
+    ignoreSetConfig = mempty { projectConfigShared = mempty { projectConfigIgnoreProject = Flag True } }

cabal-install/tests/IntegrationTests2/build/ignore-project/A.hs

@@ -0,0 +1,4 @@
+module A where
+
+a :: Int
+a = 42

cabal-install/tests/IntegrationTests2/build/ignore-project/Setup.hs

@@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain

cabal-install/tests/IntegrationTests2/build/ignore-project/a.cabal

@@ -0,0 +1,10 @@
+name: a
+version: 0.1
+build-type: Simple
+cabal-version: >= 1.10
+
+library
+  exposed-modules: A
+  build-depends: base
+  default-language: Haskell2010
+  profiling: true

cabal-install/tests/IntegrationTests2/build/ignore-project/cabal.project

@@ -0,0 +1,3 @@
+packages: .
+
+coverage: true

cabal-testsuite/PackageTests/Regression/T5318/cabal.project

@@ -0,0 +1 @@
+packages: ./

cabal-testsuite/PackageTests/Regression/T5318/sdist-list-sources.test.hs

@@ -2,6 +2,6 @@ import Test.Cabal.Prelude
 main = cabalTest $ do
   tmpdir <- fmap testTmpDir getTestEnv
   let fn = tmpdir </> "empty-data-dir-0.list"
-  cabal "v2-sdist" ["--ignore-project", "--list-only", "--output-directory", tmpdir]
+  cabal "v2-sdist" ["--list-only", "--output-directory", tmpdir]
   -- --list-sources outputs with slashes on posix and backslashes on Windows. 'normalise' converts our needle to the necessary format.
   assertFileDoesContain fn $ normalise "foo.dat"

cabal-testsuite/PackageTests/SDist/T5195/cabal.project

@@ -0,0 +1 @@
+packages: ./

cabal-testsuite/PackageTests/SDist/T5195/cabal.test.hs

@@ -1,5 +1,5 @@
 import Test.Cabal.Prelude
 main = cabalTest $ do
   tmpdir <- fmap testTmpDir getTestEnv
-  res <- fails $ cabal' "v2-sdist" ["--ignore-project", "--list-only", "--output-directory", tmpdir]
+  res <- fails $ cabal' "v2-sdist" ["--list-only", "--output-directory", tmpdir]
   assertOutputContains "filepath wildcard './actually-a-directory' does not match any files" res

cabal-testsuite/PackageTests/SDist/T7028/cabal.test.hs

@@ -1,4 +1,4 @@
 import Test.Cabal.Prelude
 main = cabalTest $ do
   tmpdir <- fmap testTmpDir getTestEnv
-  cabal "v2-sdist" ["--ignore-project", "--list-only", "--output-directory", tmpdir, "t7028"]
+  cabal "v2-sdist" ["--list-only", "--output-directory", tmpdir, "t7028"]

cabal-testsuite/PackageTests/SDist/T7124/cabal-list.test.hs

@@ -6,4 +6,4 @@ import Test.Cabal.Prelude
 main :: IO ()
 main = cabalTest $ do
   tmpdir <- fmap testTmpDir getTestEnv
-  fails $ cabal "v2-sdist" ["--ignore-project", "--list-only", "--output-directory", tmpdir, "all"]
+  fails $ cabal "v2-sdist" ["--list-only", "--output-directory", tmpdir, "all"]

cabal-testsuite/PackageTests/SDist/T7124/cabal.test.hs

@@ -6,4 +6,4 @@ import Test.Cabal.Prelude
 main :: IO ()
 main = cabalTest $ do
   tmpdir <- fmap testTmpDir getTestEnv
-  fails $ cabal "v2-sdist" ["--ignore-project", "--output-directory", tmpdir, "all"]
+  fails $ cabal "v2-sdist" ["--output-directory", tmpdir, "all"]

cabal-testsuite/PackageTests/SDist/T7698/cabal.test.hs

@@ -1,4 +1,4 @@
 import Test.Cabal.Prelude
 main = cabalTest $ do
   tmpdir <- fmap testTmpDir getTestEnv
-  cabal "v2-sdist" ["--ignore-project", "--list-only", "--output-directory", tmpdir, "all"]
+  cabal "v2-sdist" ["--list-only", "--output-directory", tmpdir, "all"]

changelog.d/issue-7965

@@ -0,0 +1,5 @@
+synopsis: Ensure that v2-sdist command respects the --ignore-project flag
+-- If the "--project-file" flag is set, then this [--ignore-project] will always be false
+packages: cabal-install
+issues: #7965
+prs: #8109

doc/cabal-project.rst

@@ -295,6 +295,13 @@ package, and thus apply globally:
 
     This option cannot be specified via a ``cabal.project`` file.
 
+-- option:: --ignore-project
+
+    Ignores the local ``cabal.project`` file and uses the default
+    configuration with the local ``foo.cabal`` file. Note that
+    if this flag is set while the ``--project-file`` flag is also
+    set then this flag will be ignored.
+
 .. option:: --store-dir=DIR
 
     Specifies the name of the directory of the global package store.