single test suite failure should show entire log #388

ChangeLog.md

@@ -4,6 +4,7 @@
 * Put stackage snapshots JSON on S3 [#380](https://github.com/commercialhaskell/stack/issues/380)
 * Specifying flags for multiple packages [#335](https://github.com/commercialhaskell/stack/issues/335)
 * single test suite failure should show entire log [#388](https://github.com/commercialhaskell/stack/issues/388)
+* valid-wanted is a confusing option name [#386](https://github.com/commercialhaskell/stack/issues/386)
 
 ## 0.1.0.0
 

src/Stack/Config.hs

@@ -342,7 +342,10 @@ resolvePackageEntry menv projRoot pe = do
         case peSubdirs pe of
             [] -> return [entryRoot]
             subs -> mapM (resolveDir entryRoot) subs
-    return $ map (, peValidWanted pe) paths
+    case peValidWanted pe of
+        Nothing -> return ()
+        Just _ -> $logWarn "Warning: you are using the deprecated valid-wanted field. You should instead use extra-dep. See: https://github.com/commercialhaskell/stack/wiki/stack.yaml#packages"
+    return $ map (, not $ peExtraDep pe) paths
 
 -- | Resolve a PackageLocation into a path, downloading and cloning as
 -- necessary.

src/Stack/Init.hs

@@ -88,7 +88,8 @@ initProject initOpts = do
             }
         pkgs = map toPkg cabalfps
         toPkg fp = PackageEntry
-            { peValidWanted = True
+            { peValidWanted = Nothing
+            , peExtraDepMaybe = Nothing
             , peLocation = PLFilePath $
                 case stripDir currDir $ parent fp of
                     Nothing

src/Stack/Types/Config.hs

@@ -173,7 +173,7 @@ data BuildConfig = BuildConfig
       -- ^ Version of GHC we expected for this build
     , bcPackages   :: !(Map (Path Abs Dir) Bool)
       -- ^ Local packages identified by a path, Bool indicates whether it is
-      -- allowed to be wanted (see 'peValidWanted')
+      -- a non-dependency (the opposite of 'peExtraDep')
     , bcExtraDeps  :: !(Map PackageName Version)
       -- ^ Extra dependencies specified in configuration.
       --
@@ -221,32 +221,52 @@ data NoBuildConfigStrategy
     deriving (Show, Eq, Ord)
 
 data PackageEntry = PackageEntry
-    { peValidWanted :: !Bool
-    -- ^ Can this package be considered wanted? Useful to disable when simply
-    -- modifying an upstream package, see:
+    { peExtraDepMaybe :: !(Maybe Bool)
+    -- ^ Is this package a dependency? This means the local package will be
+    -- treated just like an extra-deps: it will only be built as a dependency
+    -- for others, and its test suite/benchmarks will not be run.
+    --
+    -- Useful modifying an upstream package, see:
     -- https://github.com/commercialhaskell/stack/issues/219
+    -- https://github.com/commercialhaskell/stack/issues/386
+    , peValidWanted :: !(Maybe Bool)
+    -- ^ Deprecated name meaning the opposite of peExtraDep. Only present to
+    -- provide deprecation warnings to users.
     , peLocation :: !PackageLocation
     , peSubdirs :: ![FilePath]
     }
     deriving Show
+
+-- | Once peValidWanted is removed, this should just become the field name in PackageEntry.
+peExtraDep :: PackageEntry -> Bool
+peExtraDep pe =
+    case peExtraDepMaybe pe of
+        Just x -> x
+        Nothing ->
+            case peValidWanted pe of
+                Just x -> not x
+                Nothing -> False
+
 instance ToJSON PackageEntry where
-    toJSON pe | peValidWanted pe && null (peSubdirs pe) =
+    toJSON pe | not (peExtraDep pe) && null (peSubdirs pe) =
         toJSON $ peLocation pe
     toJSON pe = object
-        [ "valid-wanted" .= peValidWanted pe
+        [ "extra-dep" .= peExtraDep pe
         , "location" .= peLocation pe
         , "subdirs" .= peSubdirs pe
         ]
 instance FromJSON PackageEntry where
     parseJSON (String t) = do
         loc <- parseJSON $ String t
         return PackageEntry
-            { peValidWanted = True
+            { peExtraDepMaybe = Nothing
+            , peValidWanted = Nothing
             , peLocation = loc
             , peSubdirs = []
             }
     parseJSON v = withObject "PackageEntry" (\o -> PackageEntry
-        <$> o .:? "valid-wanted" .!= True
+        <$> o .:? "extra-dep"
+        <*> o .:? "valid-wanted"
         <*> o .: "location"
         <*> o .:? "subdirs" .!= []) v
 
@@ -714,7 +734,8 @@ instance FromJSON ProjectAndConfigMonoid where
 -- | A PackageEntry for the current directory, used as a default
 packageEntryCurrDir :: PackageEntry
 packageEntryCurrDir = PackageEntry
-    { peValidWanted = True
+    { peValidWanted = Nothing
+    , peExtraDepMaybe = Nothing
     , peLocation = PLFilePath "."
     , peSubdirs = []
     }