Merge branch 'testsuite'

2023-01-12 12:58:39 +08:00
parent 0704d2640a 1e32639873
commit 74edf1fc07
12 changed files with 1199 additions and 480 deletions
--- a/lib/GHCup/Errors.hs
+++ b/lib/GHCup/Errors.hs
@@ -83,9 +83,10 @@ allHFError = unlines allErrors
    , let proxy = Proxy :: Proxy ToolShadowed in format proxy
    , let proxy = Proxy :: Proxy ContentLengthError in format proxy
    , ""
-    , "# high level errors (5000+)"
+    , "# high level errors (4000+)"
    , let proxy = Proxy :: Proxy DownloadFailed in format proxy
    , let proxy = Proxy :: Proxy InstallSetError in format proxy
+    , let proxy = Proxy :: Proxy TestFailed in format proxy
    , let proxy = Proxy :: Proxy BuildFailed in format proxy
    , let proxy = Proxy :: Proxy GHCupSetError in format proxy
    , ""
@@ -161,7 +162,6 @@ prettyHFError e =
  let errorCode = "GHCup-" <> padIntAndShow (eNum e)
  in ("[" <> linkEscapeCode errorCode  (hfErrorLink errorCode) <> "] ") <> prettyShow e
 where
-  linkEscapeCode linkText link = "\ESC]8;;" <> link <> "\ESC\\" <> linkText <> "\ESC]8;;\ESC\\"
  hfErrorLink errorCode = "https://errors.haskell.org/messages/" <> errorCode
  padIntAndShow i
    | i < 10    = "0000" <> show i
@@ -178,6 +178,9 @@ class HFErrorProject a where

  eDesc :: Proxy a -> String

+linkEscapeCode :: String -> String -> String
+linkEscapeCode linkText link = "\ESC]8;;" <> link <> "\ESC\\" <> linkText <> "\ESC]8;;\ESC\\"
+

    ------------------------
    --[ Low-level errors ]--
@@ -675,6 +678,22 @@ instance HFErrorProject InstallSetError where
  eDesc _ = "Installation or setting the tool failed."


+-- | A test failed.
+data TestFailed = forall es . (ToVariantMaybe TestFailed es, PopVariant TestFailed es, Pretty (V es), Show (V es), HFErrorProject (V es)) => TestFailed FilePath (V es)
+
+instance Pretty TestFailed where
+  pPrint (TestFailed path reason) =
+    case reason of
+      VMaybe (_ :: TestFailed) -> pPrint reason
+      _ -> text ("The test failed. GHC test suite is fragile and non-portable. Please also check out the " <> linkEscapeCode "issue tracker" " https://gitlab.haskell.org/ghc/ghc/-/issues/?sort=updated_desc&state=opened&label_name%5B%5D=testsuite&label_name%5B%5D=packaging&first_page_size=20" <> ".\nBuild dir was:") <+> text path <+> text "\nReason was:" <+> pPrint reason
+
+deriving instance Show TestFailed
+
+instance HFErrorProject TestFailed where
+  eBase _ = 4000
+  eNum (TestFailed _ xs2) = 4000 + eNum xs2
+  eDesc _ = "The test failed."
+
 -- | A build failed.
 data BuildFailed = forall es . (ToVariantMaybe BuildFailed es, PopVariant BuildFailed es, Pretty (V es), Show (V es), HFErrorProject (V es)) => BuildFailed FilePath (V es)

--- a/lib/GHCup/GHC.hs
+++ b/lib/GHCup/GHC.hs
@@ -86,6 +86,144 @@ data GHCVer v = SourceDist v



+    --------------------
+    --[ Tool testing ]--
+    --------------------
+
+
+
+testGHCVer :: ( MonadFail m
+              , MonadMask m
+              , MonadCatch m
+              , MonadReader env m
+              , HasDirs env
+              , HasSettings env
+              , HasPlatformReq env
+              , HasGHCupInfo env
+              , HasLog env
+              , MonadResource m
+              , MonadIO m
+              , MonadUnliftIO m
+              )
+           => Version
+           -> [T.Text]
+           -> Excepts
+                '[ DigestError
+                 , ContentLengthError
+                 , GPGError
+                 , DownloadFailed
+                 , NoDownload
+                 , ArchiveResult
+                 , TarDirDoesNotExist
+                 , UnknownArchive
+                 , TestFailed
+                 ]
+                m
+                ()
+testGHCVer ver addMakeArgs = do
+  GHCupInfo { _ghcupDownloads = dls } <- lift getGHCupInfo
+
+  dlInfo <-
+    preview (ix GHC % ix ver % viTestDL % _Just) dls
+      ?? NoDownload
+
+  liftE $ testGHCBindist dlInfo ver addMakeArgs
+
+
+
+testGHCBindist :: ( MonadFail m
+                  , MonadMask m
+                  , MonadCatch m
+                  , MonadReader env m
+                  , HasDirs env
+                  , HasSettings env
+                  , HasPlatformReq env
+                  , HasGHCupInfo env
+                  , HasLog env
+                  , MonadResource m
+                  , MonadIO m
+                  , MonadUnliftIO m
+                  )
+               => DownloadInfo
+               -> Version
+               -> [T.Text]
+               -> Excepts
+                    '[ DigestError
+                     , ContentLengthError
+                     , GPGError
+                     , DownloadFailed
+                     , NoDownload
+                     , ArchiveResult
+                     , TarDirDoesNotExist
+                     , UnknownArchive
+                     , TestFailed
+                     ]
+                    m
+                    ()
+testGHCBindist dlinfo ver addMakeArgs = do
+  -- download (or use cached version)
+  dl <- liftE $ downloadCached dlinfo Nothing
+
+  liftE $ testPackedGHC dl (view dlSubdir dlinfo) ver addMakeArgs
+
+
+testPackedGHC :: ( MonadMask m
+                 , MonadCatch m
+                 , MonadReader env m
+                 , HasDirs env
+                 , HasPlatformReq env
+                 , HasSettings env
+                 , MonadThrow m
+                 , HasLog env
+                 , MonadIO m
+                 , MonadUnliftIO m
+                 , MonadFail m
+                 , MonadResource m
+                 )
+              => FilePath          -- ^ Path to the packed GHC bindist
+              -> Maybe TarDir      -- ^ Subdir of the archive
+              -> Version           -- ^ The GHC version
+              -> [T.Text]          -- ^ additional make args
+              -> Excepts
+                   '[ ArchiveResult, UnknownArchive, TarDirDoesNotExist, TestFailed ] m ()
+testPackedGHC dl msubdir ver addMakeArgs = do
+  -- unpack
+  tmpUnpack <- lift mkGhcupTmpDir
+  liftE $ cleanUpOnError tmpUnpack (unpackToDir (fromGHCupPath tmpUnpack) dl)
+
+  -- the subdir of the archive where we do the work
+  workdir <- maybe (pure tmpUnpack)
+                   (liftE . intoSubdir tmpUnpack)
+                   msubdir
+
+  reThrowAll @_ @'[ArchiveResult, UnknownArchive, TarDirDoesNotExist, ProcessError]
+    (TestFailed (fromGHCupPath workdir)) $ liftE $ runBuildAction tmpUnpack
+                         (testUnpackedGHC workdir ver addMakeArgs)
+
+testUnpackedGHC :: ( MonadReader env m
+                   , HasDirs env
+                   , HasSettings env
+                   , MonadThrow m
+                   , HasLog env
+                   , MonadIO m
+                   )
+                => GHCupPath         -- ^ Path to the unpacked GHC bindist (where the make file resides)
+                -> Version           -- ^ The GHC version
+                -> [T.Text]          -- ^ additional configure args for bindist
+                -> Excepts '[ProcessError] m ()
+testUnpackedGHC path ver addMakeArgs = do
+  lift $ logInfo $ "Testing GHC version " <> prettyVer ver <> "!"
+  ghcDir <- lift $ ghcupGHCDir (mkTVer ver)
+  let ghcBinDir = fromGHCupPath ghcDir </> "bin"
+  env <- liftIO $ addToPath ghcBinDir False
+
+  lEM $ make' (fmap T.unpack addMakeArgs)
+              (Just $ fromGHCupPath path)
+              "ghc-test"
+              (Just $ ("STAGE1_GHC", "ghc-" <> T.unpack (prettyVer ver)) : env)
+  pure ()
+
+
    ---------------------
    --[ Tool fetching ]--
    ---------------------
--- a/lib/GHCup/Types.hs
+++ b/lib/GHCup/Types.hs
@@ -138,6 +138,7 @@ data VersionInfo = VersionInfo
  { _viTags        :: [Tag]              -- ^ version specific tag
  , _viChangeLog   :: Maybe URI
  , _viSourceDL    :: Maybe DownloadInfo -- ^ source tarball
+  , _viTestDL      :: Maybe DownloadInfo -- ^ test tarball
  , _viArch        :: ArchitectureSpec   -- ^ descend for binary downloads per arch
  -- informative messages
  , _viPostInstall :: Maybe Text
--- a/lib/GHCup/Utils.hs
+++ b/lib/GHCup/Utils.hs
@@ -93,6 +93,7 @@ import qualified Data.List.NonEmpty            as NE
 import qualified Streamly.Prelude              as S
 import Control.DeepSeq (force)
 import GHC.IO (evaluate)
+import System.Environment (getEnvironment, setEnv)


 -- $setup
@@ -967,11 +968,28 @@ make :: ( MonadThrow m
     => [String]
     -> Maybe FilePath
     -> m (Either ProcessError ())
-make args workdir = do
+make args workdir = make' args workdir "ghc-make" Nothing
+
+
+-- | Calls gmake if it exists in PATH, otherwise make.
+make' :: ( MonadThrow m
+         , MonadIO m
+         , MonadReader env m
+         , HasDirs env
+         , HasLog env
+         , HasSettings env
+         )
+      => [String]
+      -> Maybe FilePath
+      -> FilePath         -- ^ log filename (opened in append mode)
+      -> Maybe [(String, String)] -- ^ optional environment
+      -> m (Either ProcessError ())
+make' args workdir logfile menv = do
  spaths    <- liftIO getSearchPath
  has_gmake <- isJust <$> liftIO (searchPath spaths "gmake")
  let mymake = if has_gmake then "gmake" else "make"
-  execLogged mymake args workdir "ghc-make" Nothing
+  execLogged mymake args workdir logfile menv
+

 makeOut :: (MonadReader env m, HasDirs env, MonadIO m)
        => [String]
@@ -1282,6 +1300,22 @@ warnAboutHlsCompatibility = do



+addToPath :: FilePath
+          -> Bool         -- ^ if False will prepend
+          -> IO [(String, String)]
+addToPath path append = do
+ cEnv <- Map.fromList <$> getEnvironment
+ let paths          = ["PATH", "Path"]
+     curPaths       = (\x -> maybe [] splitSearchPath (Map.lookup x cEnv)) =<< paths
+     {- HLINT ignore "Redundant bracket" -}
+     newPath        = intercalate [searchPathSeparator] (if append then (curPaths ++ [path]) else (path : curPaths))
+     envWithoutPath = foldr (\x y -> Map.delete x y) cEnv paths
+     pathVar        = if isWindows then "Path" else "PATH"
+     envWithNewPath = Map.toList $ Map.insert pathVar newPath envWithoutPath
+ liftIO $ setEnv pathVar newPath
+ return envWithNewPath
+
+
    -----------
    --[ Git ]--
    -----------