1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
|
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE OverloadedStrings #-}
import Conduit
( (.|), connect, filterC, filterMC, foldMapC, mapM_C
, runConduit, runConduitRes, runResourceT, sourceDirectory
, sourceDirectoryDeep, stderrC, withSourceFile
)
import Data.List ( stripPrefix )
import Options.Generic
( ParseField, ParseRecord (..), defaultModifiers
, fieldNameModifier, firstLetter, getRecord
, parseRecordWithModifiers, shortNameModifier
)
import RIO
import RIO.Char ( toLower )
import RIO.Directory
( canonicalizePath, copyFile, createDirectoryIfMissing
, doesFileExist, getAppUserDataDirectory
)
import RIO.FilePath
( (</>), (<.>), isPathSeparator, takeDirectory
, takeExtensions, takeFileName
)
import RIO.List ( isInfixOf, partition )
import qualified RIO.Map as Map
import RIO.Process
( HasProcessContext (..), closed, findExecutable, proc
, runProcess, runProcess_, setStderr, setStdin, setStdout
, useHandleOpen, withModifyEnvVars, withWorkingDir
)
import qualified RIO.Set as Set
import qualified RIO.Text as T
import System.Environment ( getExecutablePath, lookupEnv )
import System.Info ( os )
import System.PosixCompat.Files ( createSymbolicLink )
-- This code does not use a test framework so that we get direct
-- control of how the output is displayed.
main :: IO ()
main = runSimpleApp $ do
logInfo "Initiating Stack integration test running"
options <- getRecord "Stack integration tests"
results <- runApp options $ do
logInfo "Running with the following environment"
proc "env" [] runProcess_
tests <- asks appTestDirs
let count = Set.size tests
loop !idx rest !accum =
case rest of
[] -> pure accum
next:rest' -> do
logInfo $ "Running integration test "
<> display idx
<> "/"
<> display count
<> ": "
<> fromString (takeFileName next)
res <- test next
loop (idx + 1) rest' (res <> accum)
loop (1 :: Int) (Set.toList tests) mempty
let (successes, failures) = partition ((== ExitSuccess) . snd)
$ Map.toList results
unless (null successes) $ do
logInfo "Successful tests:"
for_ successes $ \(x, _) -> logInfo $ "- " <> display x
logInfo ""
if null failures
then logInfo "No failures!"
else do
logInfo "Failed tests:"
for_ failures $ \(x, ec) -> logInfo $ "- " <> display x <> " - " <> displayShow ec
exitFailure
data Options = Options
{ optSpeed :: Maybe Speed
, optMatch :: Maybe String
, optNot :: [String]
}
deriving Generic
instance ParseRecord Options where
parseRecord = parseRecordWithModifiers modifiers
where
optName = map toLower . drop 3
modifiers = defaultModifiers { fieldNameModifier = optName
, shortNameModifier = firstLetter . optName
}
data Speed = Fast | Normal | Superslow
deriving (Read, Generic)
instance ParseField Speed
exeExt :: String
exeExt = if isWindows then ".exe" else ""
isWindows :: Bool
isWindows = os == "mingw32"
runApp :: Options -> RIO App a -> RIO SimpleApp a
runApp options inner = do
let speed = fromMaybe Normal $ optSpeed options
simpleApp <- ask
runghc <- findExecutable "runghc" >>= either throwIO pure
srcDir <- canonicalizePath ""
testsRoot <- canonicalizePath $ srcDir </> "tests/integration"
libdir <- canonicalizePath $ testsRoot </> "lib"
myPath <- liftIO getExecutablePath
stack <- canonicalizePath $ takeDirectory myPath </> "stack" ++ exeExt
logInfo $ "Using Stack located at " <> fromString stack
proc stack ["--version"] runProcess_
logInfo $ "Using runghc located at " <> fromString runghc
proc runghc ["--version"] runProcess_
let matchTest = case (optMatch options, optNot options) of
(Just str, _) -> (str `isInfixOf`)
(_, []) -> const True
(_, nl) -> \a -> all (\b -> not $ b `isInfixOf` a) nl
testDirs
<- runConduitRes
$ sourceDirectory (testsRoot </> "tests")
.| filterMC (liftIO . hasTest)
.| filterC matchTest
.| foldMapC Set.singleton
let modifyEnvCommon
= Map.insert "SRC_DIR" (fromString srcDir)
. Map.insert "STACK_EXE" (fromString stack)
. Map.delete "GHC_PACKAGE_PATH"
. Map.insert "STACK_TEST_SPEED"
(case speed of
Superslow -> "SUPERSLOW"
_ -> "NORMAL")
. Map.fromList
. map (first T.toUpper)
. Map.toList
case speed of
Fast -> do
let app = App
{ appSimpleApp = simpleApp
, appRunghc = runghc
, appLibDir = libdir
, appSetupHome = id
, appTestDirs = testDirs
}
runRIO app $ withModifyEnvVars modifyEnvCommon inner
_ -> do
morigStackRoot <- liftIO $ lookupEnv "STACK_ROOT"
origStackRoot <-
case morigStackRoot of
Nothing -> getAppUserDataDirectory "stack"
Just x -> pure x
logInfo "Initializing/updating the original Pantry store"
proc stack ["update"] runProcess_
pantryRoot <- canonicalizePath $ origStackRoot </> "pantry"
let modifyEnv
= Map.insert "PANTRY_ROOT" (fromString pantryRoot)
. modifyEnvCommon
app = App
{ appSimpleApp = simpleApp
, appRunghc = runghc
, appLibDir = libdir
, appSetupHome = \inner' -> withSystemTempDirectory "home" $ \newHome -> do
let newStackRoot = newHome </> ".stack"
createDirectoryIfMissing True newStackRoot
let modifyEnv'
= Map.insert "HOME" (fromString newHome)
. Map.insert "APPDATA" (fromString newHome)
. Map.insert "STACK_ROOT" (fromString newStackRoot)
writeFileBinary (newStackRoot </> "config.yaml") "system-ghc: true\ninstall-ghc: false\n"
withModifyEnvVars modifyEnv' inner'
, appTestDirs = testDirs
}
runRIO app $ withModifyEnvVars modifyEnv inner
hasTest :: FilePath -> IO Bool
hasTest dir = doesFileExist $ dir </> "Main.hs"
data App = App
{ appRunghc :: !FilePath
, appLibDir :: !FilePath
, appSetupHome :: !(forall a. RIO App a -> RIO App a)
, appSimpleApp :: !SimpleApp
, appTestDirs :: !(Set FilePath)
}
simpleAppL :: Lens' App SimpleApp
simpleAppL = lens appSimpleApp (\x y -> x { appSimpleApp = y })
instance HasLogFunc App where
logFuncL = simpleAppL.logFuncL
instance HasProcessContext App where
processContextL = simpleAppL.processContextL
-- | Call 'appSetupHome' on the inner action
withHome :: RIO App a -> RIO App a
withHome inner = do
app <- ask
appSetupHome app inner
test :: FilePath -- ^ test dir
-> RIO App (Map Text ExitCode)
test testDir = withDir $ \dir -> withHome $ do
runghc <- asks appRunghc
libDir <- asks appLibDir
let mainFile = testDir </> "Main.hs"
copyTree (testDir </> "files") dir
withSystemTempFile (name <.> "log") $ \logfp logh -> do
ec <- withWorkingDir dir
$ withModifyEnvVars (Map.insert "TEST_DIR" $ fromString testDir)
$ proc runghc
[ "-clear-package-db"
, "-global-package-db"
, "-i" ++ libDir
, mainFile
]
$ runProcess
. setStdin closed
. setStdout (useHandleOpen logh)
. setStderr (useHandleOpen logh)
hClose logh
case ec of
ExitSuccess -> logInfo "Success!"
_ -> do
logError "Failure, dumping log\n\n"
withSourceFile logfp $ \src ->
runConduit $ src .| stderrC
logError $ "\n\nEnd of log for " <> fromString name
pure $ Map.singleton (fromString name) ec
where
name = takeFileName testDir
withDir = withSystemTempDirectory ("stack-integration-" ++ name)
copyTree :: MonadIO m => FilePath -> FilePath -> m ()
copyTree src dst =
liftIO $
runResourceT (sourceDirectoryDeep False src `connect` mapM_C go)
`catch` \(_ :: IOException) -> pure ()
where
go srcfp = liftIO $ do
Just suffix <- pure $ stripPrefix src srcfp
let dstfp = dst </> stripHeadSeparator suffix
createDirectoryIfMissing True $ takeDirectory dstfp
-- copying yaml files so lock files won't get created in
-- the source directory
if takeFileName srcfp /= "package.yaml" &&
(takeExtensions srcfp == ".yaml" || takeExtensions srcfp == ".yml")
then
copyFile srcfp dstfp
else
createSymbolicLink srcfp dstfp `catch` \(_ :: IOException) ->
copyFile srcfp dstfp -- for Windows
stripHeadSeparator :: FilePath -> FilePath
stripHeadSeparator [] = []
stripHeadSeparator fp@(x:xs) = if isPathSeparator x
then xs
else fp
|