Begin to review, document and conform integration tests

tests/integration/tests/111-custom-snapshot/Main.hs

@@ -1,3 +1,8 @@
+-- Stack should build a package when a custom snapshot is specified in the
+-- project-level configuration file.
+--
+-- See: https://github.com/commercialhaskell/stack/issues/111
+
 import StackTest
 
 main :: IO ()

tests/integration/tests/111-custom-snapshot/files/.gitignore

@@ -0,0 +1 @@
+myPackage.cabal

tests/integration/tests/111-custom-snapshot/files/my-snapshot.yaml

@@ -1,4 +1,5 @@
-compiler: ghc-9.10.3
 name: my-snapshot
+
+compiler: ghc-9.10.3
 packages:
-- mtl-2.3.1
+- acme-missiles-0.3

tests/integration/tests/111-custom-snapshot/files/package.yaml

@@ -0,0 +1,11 @@
+spec-version: 0.36.0
+
+name: myPackage
+version: 0.1.0.0
+
+dependencies:
+- base
+- acme-missiles
+
+library:
+  source-dirs: src

tests/integration/tests/111-custom-snapshot/files/src/Lib.hs

@@ -1,8 +1,5 @@
 module Lib
-    ( someFunc
-    ) where
+  ( launchMissiles
+  ) where
 
-import Control.Monad.Reader ()
-
-someFunc :: IO ()
-someFunc = putStrLn "someFunc"
+import Acme.Missiles ( launchMissiles )

tests/integration/tests/32-unlisted-module/Main.hs

@@ -1,25 +1,30 @@
-import Control.Concurrent
-import StackTest
+-- Stack should rebuild a package when files required for building are dirty,
+-- even if the files are not listed in the package's Cabal file.
+--
+-- See: https://github.com/commercialhaskell/stack/issues/32
+
+import           Control.Concurrent ( threadDelay )
+import           StackTest
 
 main :: IO ()
 main = do
-    copy "src/Unlisted_OK.hs" "src/Unlisted.hs"
-    copy "embed_OK.txt" "embed.txt"
-    stack ["build"]
-    pause
-    copy "src/Unlisted_FAIL.hs" "src/Unlisted.hs"
-    stackErr ["build"]
-    pause
-    copy "src/Unlisted_OK.hs" "src/Unlisted.hs"
-    stack ["build"]
-    stack ["exec", "files-exe"]
-    pause
-    copy "embed_FAIL.txt" "embed.txt"
-    stack ["build"]
-    stackErr ["exec", "files-exe"]
-    pause
-    copy "embed_OK.txt" "embed.txt"
-    stack ["build"]
-    stack ["exec", "files-exe"]
-
-pause = threadDelay 1000000
+  copy "app/Unlisted_OK.hs" "app/Unlisted.hs"
+  copy "embed_OK.txt" "embed.txt"
+  stack ["build"]
+  pause
+  copy "app/Unlisted_FAIL.hs" "app/Unlisted.hs"
+  stackErr ["build"]
+  pause
+  copy "app/Unlisted_OK.hs" "app/Unlisted.hs"
+  stack ["build"]
+  stack ["exec", "fail-if-fail"]
+  pause
+  copy "embed_FAIL.txt" "embed.txt"
+  stack ["build"]
+  stackErr ["exec", "fail-if-fail"]
+  pause
+  copy "embed_OK.txt" "embed.txt"
+  stack ["build"]
+  stack ["exec", "fail-if-fail"]
+ where
+  pause = threadDelay 1000000

tests/integration/tests/32-unlisted-module/files/.gitignore

@@ -1,2 +1,3 @@
 embed.txt
-src/Unlisted.hs
+app/Unlisted.hs
+myPackage.cabal

tests/integration/tests/32-unlisted-module/files/app/Main.hs

@@ -0,0 +1,16 @@
+{-# LANGUAGE TemplateHaskell   #-}
+{-# LANGUAGE OverloadedStrings #-}
+
+module Main where
+
+import           Control.Monad ( when )
+import qualified Data.ByteString.Char8 as C8
+import           Data.FileEmbed ( embedFile )
+import           Unlisted ( unlistedFunc )
+
+main :: IO ()
+main = do
+  unlistedFunc
+  when ("FAIL" `C8.isPrefixOf` embedded) $ error "embedded contains FAIL"
+
+embedded = $(embedFile "embed.txt")

tests/integration/tests/32-unlisted-module/files/app/Unlisted_FAIL.hs

@@ -0,0 +1,3 @@
+-- | Version of Unlisted with a different export that causes Main to fail to
+-- compile.
+module Unlisted where

tests/integration/tests/32-unlisted-module/files/app/Unlisted_OK.hs

@@ -0,0 +1,5 @@
+-- | Version of Unlisted that does not cause Main to fail to compile.
+module Unlisted where
+
+unlistedFunc :: IO ()
+unlistedFunc = pure ()

tests/integration/tests/32-unlisted-module/files/package.yaml

@@ -0,0 +1,15 @@
+spec-version: 0.36.0
+
+name: myPackage
+version: 0.1.0.0
+
+dependencies:
+- base
+- bytestring
+- file-embed
+
+executables:
+  fail-if-fail:
+    source-dirs: app
+    main: Main.hs
+    other-modules: []

tests/integration/tests/335-multi-package-flags/Main.hs

@@ -1,8 +1,13 @@
-import StackTest
+-- Stack should be able to specify Cabal flags for all packages that have a
+-- Cabal flag of the same name.
+--
+-- See: https://github.com/commercialhaskell/stack/issues/335
+
+import           StackTest
 
 main :: IO ()
 main = do
-    stackErr ["build"]
-    stack ["build", "--flag", "new-template:necessary"]
-    stackErr ["build"]
-    stack ["build", "--flag", "*:necessary"]
+  stackErr ["build"]
+  stack ["build", "--flag", "myPackage:necessary"]
+  stackErr ["build"]
+  stack ["build", "--flag", "*:necessary"]

tests/integration/tests/335-multi-package-flags/files/.gitignore

@@ -0,0 +1 @@
+myPackage.cabal

tests/integration/tests/335-multi-package-flags/files/package.yaml

@@ -0,0 +1,19 @@
+spec-version: 0.36.0
+
+name: myPackage
+version: 0.1.0.0
+
+flags:
+  necessary:
+    description: The package will not build unless this flag is true.
+    manual: true
+    default: false
+
+dependencies:
+- base
+
+library:
+  source-dirs: src
+  when:
+  - condition: flag(necessary)
+    cpp-options: -DWORK

tests/integration/tests/335-multi-package-flags/files/src/Lib.hs

@@ -1,10 +1,6 @@
 {-# LANGUAGE CPP #-}
-module Lib
-    ( someFunc
-    ) where
 
-someFunc :: IO ()
-someFunc = putStrLn "someFunc"
+module Lib where
 
 -- Avoid problems with CPP and HLint
 #ifndef __HLINT__

tests/integration/tests/335-multi-package-flags/files/stack.yaml

@@ -1 +1 @@
-snapshot: lts-24.37
+snapshot: ghc-9.10.3

tests/integration/tests/345-override-bytestring/Main.hs

@@ -1,6 +1,9 @@
-import StackTest
+-- An extra-dep in a project-level configuration file should be able to shadow a
+-- GHC boot package such as bytestring.
+--
+-- See: https://github.com/commercialhaskell/stack/issues/345
+
+import           StackTest
 
 main :: IO ()
-main = do
-    stack ["build", "--dry-run"] -- for useful error output
-    stack ["build"]
+main = stack ["build"]

tests/integration/tests/345-override-bytestring/files/.gitignore

@@ -0,0 +1 @@
+myPackage.cabal

tests/integration/tests/345-override-bytestring/files/package.yaml

@@ -0,0 +1,11 @@
+spec-version: 0.36.0
+
+name: myPackage
+version: 0.1.0.0
+
+dependencies:
+- base
+- bytestring
+
+library:
+  source-dirs: src

tests/integration/tests/345-override-bytestring/files/src/Lib.hs

@@ -0,0 +1,3 @@
+module Lib where
+
+import           Data.ByteString ()

tests/integration/tests/345-override-bytestring/files/stack.yaml

@@ -1,4 +1,5 @@
-snapshot: lts-24.37
+snapshot: ghc-9.10.3
+
 extra-deps:
-- bytestring-0.11.5.4
-- binary-0.8.9.0
+# GHC 9.10.3 comes with bytestring-0.12.2.0
+- bytestring-0.12.1.0

tests/integration/tests/365-invalid-success/Main.hs

@@ -1,11 +1,17 @@
-import StackTest
+-- If Stack fails to build a package once, it should fail to build it
+-- (unchanged) a second time.
+--
+-- See: https://github.com/commercialhaskell/stack/issues/365
+
+import           StackTest
 
 main :: IO ()
 main = do
-    stackErr ["build"]
-    stackErr ["build"]
-    writeFile "app/Foo.hs" "module Foo where"
-    stack ["build"]
-    writeFile "app/Foo.hs" "module Foo wher e"
-    stackErr ["build"]
-    stackErr ["build"]
+  copy "src/Lib_FAIL.hs" "src/Lib.hs"
+  stackErr ["build"]
+  stackErr ["build"]
+  copy "src/Lib_OK.hs" "src/Lib.hs"
+  stack ["build"]
+  copy "src/Lib_FAIL.hs" "src/Lib.hs"
+  stackErr ["build"]
+  stackErr ["build"]

tests/integration/tests/365-invalid-success/files/.gitignore

@@ -1 +1,2 @@
-app/Foo.hs
+src/Lib.hs
+myPackage.cabal

tests/integration/tests/365-invalid-success/files/package.yaml

@@ -0,0 +1,13 @@
+spec-version: 0.36.0
+
+name: myPackage
+version: 0.1.0.0
+
+dependencies:
+- base
+
+library:
+  source-dirs: src
+  exposed-modules:
+  - Lib
+  other-modules: []