{-# LANGUAGE RecordWildCards, PatternGuards, ViewPatterns #-} module Cabal(run, readCabal) where import Control.Monad.Extra import Data.Char import Data.List.Extra import Data.Maybe import Data.Functor import System.Directory.Extra import System.IO.Extra import System.FilePath import System.Process.Extra import Arguments import Prelude defAllow = ["7.2.2","7.4.2","7.6.3","7.8.4","7.10.1"] --------------------------------------------------------------------- -- COMMANDS -- | Check the .cabal file is well formed cabalCheck :: IO () cabalCheck = do -- a lot of the warnings aren't real problems, so whitelist some (_, res) <- systemOutput "cabal check" let allowed = ["No errors or warnings could be found in the package." ,"These warnings may cause trouble when distributing the package:" ,"* 'ghc-options: -main-is' is not portable." ,""] let bad = lines res \\ allowed when (bad /= []) $ error $ unlines $ "Cabal check gave bad warnings:" : map show bad checkCabalFile checkReadme checkGhci checkTravis checkGhci :: IO () checkGhci = do let warns = words "-fwarn-unused-binds -fwarn-unused-imports" src <- words <$> readFile' ".ghci" unless ("-W" `elem` src || all (`elem` src) warns) $ error $ "The .ghci file does not enough of " ++ unwords ("-W":warns) checkTravis :: IO () checkTravis = do tests <- testedWith let require = ["env:"] ++ [" - GHCVER=" ++ t | t <- reverse tests] ++ [" - GHCVER=head" ,"script:" ," - wget https://raw.github.com/ndmitchell/neil/master/travis.sh -O - --no-check-certificate --quiet | sh" ] src <- readFile' ".travis.yml" let got = filter (not . null) $ replace ["matrix:"," allow_failures:"," - env: GHCVER=head"] [] $ map (trimEnd . takeWhile (/= '#')) $ lines src when ("allow_failures:" `isInfixOf` src) $ putStrLn $ "Warning: .travis.yml allows failures with GHC HEAD" got <- return $ take (length require - 1) got ++ [last got] -- drop everything between script/wget when (got /= require) $ error $ unlines $ [".travis.yml file mismatch","Wanted:"] ++ require ++ ["Got:"] ++ got -- | Run some commands in a temporary directory with the unpacked cabal withSDist :: IO a -> IO a withSDist run = withTempDir $ \tdir -> do system_ "git diff --stat --exit-code" system_ $ "cabal configure --builddir=" ++ tdir system_ $ "cabal sdist --builddir=" ++ tdir files <- getDirectoryContents tdir let tarball = head $ [x | x <- files, ".tar.gz" `isSuffixOf` x] withCurrentDirectory tdir $ system_ $ "tar -xf " ++ tarball lst <- listFilesRecursive tdir let binary = [".png",".gz",".bat",".zip",".gif",""] bad <- flip filterM lst $ \file -> return (takeExtension file `notElem` binary) &&^ fmap ('\r' `elem`) (readFileBinary' file) when (bad /= []) $ do error $ unlines $ "The following files have \\r characters in, Windows newlines?" : bad withCurrentDirectory (tdir dropExtension (dropExtension $ takeFileName tarball)) run run :: Arguments -> Maybe (IO ()) run Test{..} = Just $ do cabalCheck withSDist $ do system_ "cabal install --only-dependencies" system_ $ "cabal configure --enable-tests --disable-library-profiling " ++ "--ghc-option=-rtsopts " ++ "--ghc-option=-fwarn-unused-binds --ghc-option=-fwarn-unused-imports " ++ "--ghc-option=-fwarn-tabs " ++ (if no_warnings then "" else "--ghc-option=-Werror") system_ "cabal build" system_ "cabal test --show-details=always" when install $ do system_ "cabal copy" system_ "cabal register" run Check = Just cabalCheck run Sdist = Just $ do cabalCheck tested <- testedWith withSDist $ do system_ "cabal clean" system_ "cabal install --only-dependencies" system_ $ "cabal configure --ghc-option=-fwarn-unused-imports --disable-library-profiling " ++ "--ghc-option=-Werror --ghc-option=-fno-warn-warnings-deprecations " ++ -- CABAL BUG WORKAROUND :( "--flags=testprog" system_ "cabal build" system_ "cabal haddock" system_ "cabal sdist" putStrLn $ "Ready to release! (remember to neil tag after uploading)" run Docs{..} = Just $ do src <- readCabal let ver = extractCabal "version" src let name = extractCabal "name" src system_ $ "cabal haddock --hoogle --html --hyperlink-source " ++ "--contents-location=/package/" ++ name withTempDir $ \dir -> do system_ $ "cp -R dist/doc/html/" ++ name ++ " \"" ++ dir ++ "/" ++ name ++ "-" ++ ver ++ "-docs\"" files <- listFilesRecursive dir forM_ files $ \file -> when (takeExtension file == ".html") $ do system_ $ "chmod u+w " ++ (dir file) src <- readFileBinary' $ dir file src <- return $ filter (/= '\r') src -- filter out \r, due to CPP bugs src <- return $ fixFileLinks $ fixHashT src writeFileBinary (dir file) src system_ $ "tar cvz -C " ++ dir ++ " --format=ustar -f " ++ dir ++ "/" ++ name ++ "-" ++ ver ++ "-docs.tar.gz " ++ name ++ "-" ++ ver ++ "-docs" system_ $ "curl -X PUT -H \"Content-Type: application/x-tar\" " ++ "-H \"Content-Encoding: gzip\" " ++ "-u " ++ username ++ " " ++ "--data-binary \"@" ++ dir ++ "/" ++ name ++ "-" ++ ver ++ "-docs.tar.gz\" " ++ host ++ "/package/" ++ name ++ "-" ++ ver ++ "/docs" run _ = Nothing fixHashT :: String -> String fixHashT (stripPrefix ".html#t:" -> Just (x:xs)) | not $ isUpper x = ".html#v:" ++ fixHashT (x:xs) fixHashT (x:xs) = x : fixHashT xs fixHashT [] = [] fixFileLinks :: String -> String fixFileLinks (stripPrefix " Just xs) | (a,'\"':b) <- break (== '\"') xs , modu <- takeFileName a , pkg <- dropEnd 1 $ dropWhileEnd (/= '-') $ takeFileName $ dropHTML $ takeDirectory a = " Just _) = error $ "Unable to remove file link, " ++ take 200 xs fixFileLinks (x:xs) = x : fixFileLinks xs fixFileLinks [] = [] testedWith :: IO [String] testedWith = do src <- readCabal return $ concat [ map f $ words $ map (\x -> if x == ',' then ' ' else x) $ drop 12 x | x <- lines src, "tested-with:" `isPrefixOf` x] where f x | Just rest <- stripPrefix "GHC==" x = rest | otherwise = error $ "Invalid tested-with, " ++ x checkReadme :: IO () checkReadme = do project <- takeBaseName . fromMaybe (error "Couldn't find cabal file") <$> findCabal src <- fmap lines $ readFile "README.md" let want = "[![Hackage version](https://img.shields.io/hackage/v/" ++ project ++ ".svg?style=flat)]" ++ "(https://hackage.haskell.org/package/" ++ project ++ ") " ++ "[![Build Status](https://img.shields.io/travis/" ++ qualify src project ++ ".svg?style=flat)]" ++ "(https://travis-ci.org/" ++ qualify src project ++ ")" let line1 = head $ src ++ [""] when (not $ want `isSuffixOf` line1) $ error $ "Expected first line of README.md to end with:\n" ++ want ++ "\nBut got:\n" ++ line1 checkCabalFile :: IO () checkCabalFile = do project <- takeBaseName . fromMaybe (error "Couldn't find cabal file") <$> findCabal src <- fmap lines readCabal test <- testedWith let grab tag = [trimStart $ drop (length tag + 1) x | x <- relines src, (tag ++ ":") `isPrefixOf` x] license <- readFile' $ concat $ grab "license-file" let bad = ["Incorrect declaration style: " ++ x | (x,':':_) <- map (break (== ':') . trimStart) src , not $ any isSpace $ trim x, not $ "http" `isSuffixOf` x || "https" `isSuffixOf` x , not $ all (\x -> isLower x || x == '-') x] ++ ["2015 is not in the copyright year" | not $ "2015" `isInfixOf` concat (grab "copyright")] ++ ["copyright string is not at the start of the license" | not $ (concat (grab "copyright") `isInfixOf` concat (take 1 $ lines license)) || grab "license" == ["GPL"]] ++ ["No correct source-repository link" | let want = "source-repository head type: git location: https://github.com/" ++ qualify src project ++ ".git" , not $ want `isInfixOf` unwords (words $ unlines src)] ++ ["No bug-reports link" | grab "bug-reports" /= ["https://github.com/" ++ qualify src project ++ "/issues"]] ++ ["Incorrect license " | grab "license" `notElem` [["BSD3"],["MIT"],["GPL"]]] ++ ["Invalid tested-with: " ++ show test | not $ validTests test] ++ ["Bad stabilty, should be missing" | grab "stability" /= []] ++ ["Missing CHANGES.txt in extra-doc-files" | ["CHANGES.txt","changelog.md"] `disjoint` concatMap words (grab "extra-doc-files")] ++ ["Missing README.md in extra-doc-files" | "README.md" `notElem` concatMap words (grab "extra-doc-files")] unless (null bad) $ error $ unlines bad validTests :: [String] -> Bool validTests xs = length xs > 1 && xs `isPrefixOf` reverse defAllow qualify :: [String] -> String -> String qualify src proj = user ++ "/" ++ proj where user1 = takeWhile (/= '/') $ drop 19 $ snd $ breakOn "https://github.com/" $ unlines src user2 = takeWhile (/= '/') $ drop 30 $ snd $ breakOn "https://img.shields.io/travis/" $ unlines src user = if user2 /= "" then user2 else if user1 /= "" then user1 else "ndmitchell" relines :: [String] -> [String] relines (x:xs) | ":" `isSuffixOf` x = unwords (x:a) : relines b where (a,b) = break (\x -> trimStart x == x) xs relines (x:xs) = x : relines xs relines [] = [] readCabal :: IO String readCabal = do file <- findCabal case file of Nothing -> return [] Just file -> readFile' file extractCabal :: String -> String -> String extractCabal find = f . words . replace ":" " : " where f (name:":":val:_) | lower find == lower name = val f (x:xs) = f xs f [] = error "Failed to find the Cabal key " ++ find findCabal :: IO (Maybe FilePath) findCabal = do x <- getDirectoryContents "." return $ listToMaybe $ filter ((==) ".cabal" . takeExtension) x