slackbuilder/tests/SlackBuilder/InfoSpec.hs

module SlackBuilder.InfoSpec
    ( spec
    ) where

import Crypto.Hash (Digest, MD5, digestFromByteString)
import qualified Data.ByteString as ByteString
import Data.ByteString.Char8 (ByteString)
import Data.Maybe (maybeToList)
import qualified Data.Text.Encoding as Text
import Data.Void (Void)
import SlackBuilder.Info
import Test.Hspec (Spec, describe, it, shouldBe)
import Test.Hspec.Megaparsec (parseSatisfies, shouldSucceedOn)
import Text.Megaparsec (parse)
import Text.Megaparsec.Error (ParseErrorBundle)
import Text.URI (mkURI)

parseInfoFile'
    :: ByteString
    -> Either (ParseErrorBundle ByteString Void) PackageInfo
parseInfoFile' = parse parseInfoFile ""

infoDownload0 :: ByteString
infoDownload0 = "PKGNAM=\"pkgnam\"\n\
    \VERSION=\"1.2.3\"\n\
    \HOMEPAGE=\"homepage\"\n\
    \DOWNLOAD=\"\"\n\
    \MD5SUM=\"\"\n"

infoDownload1 :: ByteString
infoDownload1 = "PKGNAM=\"pkgnam\"\n\
    \VERSION=\"1.2.3\"\n\
    \HOMEPAGE=\"homepage\"\n\
    \DOWNLOAD=\"https://dlackware.com/download.tar.gz\"\n\
    \MD5SUM=\"0102030405060708090a0b0c0d0e0f10\"\n"

maybeToDoubleList :: forall a. Maybe a -> [a]
maybeToDoubleList xs = [y | x <- maybeToList xs, y <- [x, x]]

checksumSample :: [Digest MD5]
checksumSample = maybeToList $ digestFromByteString (ByteString.pack [1 .. 16])

spec :: Spec
spec = do
    describe "parseInfoFile" $ do
        it "returns package on a valid input" $
            parseInfoFile' `shouldSucceedOn` infoDownload1

        it "returns an array with one element if one download is given" $
            let condition = (== 1) . length . checksums
             in parseInfoFile' infoDownload1 `parseSatisfies` condition

        it "translates checksum characters into the binary format" $
            let expected = "0102030405060708090a0b0c0d0e0f10"
                condition = (== expected) . show . head . checksums
             in parseInfoFile' infoDownload1 `parseSatisfies` condition

        it "accepts an empty downloads list" $
            parseInfoFile' `shouldSucceedOn` infoDownload0

    describe "generate" $ do
        it "generates an .info file without downloads" $
            let given =  PackageInfo "pkgnam" "1.2.3" "homepage" [] []
             in generate given `shouldBe` Text.decodeUtf8 infoDownload0

        it "splits multiple downloads into multiple lines" $
            let downloads' = maybeToDoubleList
                    $ mkURI "https://dlackware.com/download.tar.gz"
                checksums' = maybeToDoubleList
                    $ digestFromByteString (ByteString.pack [1.. 16])
                given = PackageInfo
                    "pkgnam" "1.2.3" "homepage" downloads' checksums'
                expected = "PKGNAM=\"pkgnam\"\n\
                    \VERSION=\"1.2.3\"\n\
                    \HOMEPAGE=\"homepage\"\n\
                    \DOWNLOAD=\"https://dlackware.com/download.tar.gz \\\n\
                    \          https://dlackware.com/download.tar.gz\"\n\
                    \MD5SUM=\"0102030405060708090a0b0c0d0e0f10 \\\n\
                    \        0102030405060708090a0b0c0d0e0f10\"\n"
             in generate given `shouldBe` expected

        it "prints the checksum as a sequence of hexadecimal numbers" $
            let downloads' = maybeToList
                    $ mkURI "https://dlackware.com/download.tar.gz"
                given = PackageInfo
                    "pkgnam" "1.2.3" "homepage" downloads' checksumSample
             in generate given `shouldBe` Text.decodeUtf8 infoDownload1

    describe "updateDownloadVersion" $ do
        it "replaces the version" $
            let downloads' = maybeToList
                    $ mkURI "https://dlackware.com/download-1.2.3.tar.gz"
                testPackage = PackageInfo
                    "pkgnam" "1.2.3" "homepage" downloads' checksumSample
                expected = maybeToList
                    $ mkURI "https://dlackware.com/download-2.3.4.tar.gz"
                actual = updateDownloadVersion testPackage "2.3.4" Nothing
             in actual `shouldBe` expected

        it "updates the major version" $
            let downloads' = maybeToList
                    $ mkURI "https://dlackware.com/1.2/download.tar.gz"
                testPackage = PackageInfo
                    "pkgnam" "1.2.3" "homepage" downloads' checksumSample
                expected = maybeToList
                    $ mkURI "https://dlackware.com/2.3/download.tar.gz"
                actual = updateDownloadVersion testPackage "2.3.4" Nothing
             in actual `shouldBe` expected

        it "updates gnome version" $
            let downloads' = maybeToList
                    $ mkURI "https://download.gnome.org/core/3.36/3.36.0/sources/gnome-calendar-3.36.0.tar.xz"
                testPackage = PackageInfo
                    "gnome-calendar" "3.36.0" "https://wiki.gnome.org/Core/Calendar" downloads' checksumSample
                expected = maybeToList
                    $ mkURI "https://download.gnome.org/core/3.36/3.36.4/sources/gnome-calendar-3.36.2.tar.xz"
                actual = updateDownloadVersion testPackage "3.36.2" $ Just "3.36.4"
             in actual `shouldBe` expected

        it "updates versions without a patch number" $
            let downloads' = maybeToList
                    $ mkURI "https://dlackware.com/gnome-contacts-3.36.tar.xz"
                testPackage = PackageInfo
                    "gnome-contacts" "3.36" "homepage" downloads' checksumSample
                expected = maybeToList
                    $ mkURI "https://dlackware.com/gnome-contacts-3.36.2.tar.xz"
                actual = updateDownloadVersion testPackage "3.36.2" Nothing
             in actual `shouldBe` expected

    describe "update" $
        it "replaces the version" $
            let downloads' = maybeToList
                    $ mkURI "https://dlackware.com/1.2/download.tar.gz"
                testPackage = PackageInfo
                    "pkgnam" "1.2.3" "homepage" downloads' checksumSample
                expected = PackageInfo
                    "pkgnam" "2.3.4" "homepage" downloads' checksumSample
                given = update testPackage "2.3.4" downloads' checksumSample
             in given `shouldBe` expected