cron-0.6.2: test/System/Test/Cron.hs
{-# LANGUAGE OverloadedStrings #-}
module System.Test.Cron (tests) where
-------------------------------------------------------------------------------
import Control.Monad
import Data.List (find)
import Data.List.NonEmpty (NonEmpty (..))
import Data.Time.Clock.POSIX
import Hedgehog as HH
import qualified Hedgehog.Gen as Gen
import qualified Hedgehog.Range as Range
-------------------------------------------------------------------------------
import SpecHelper
-------------------------------------------------------------------------------
tests :: TestTree
tests = testGroup "System.Cron"
[ describeScheduleMatches
, describeCronScheduleShow
, describeCrontabEntryShow
, describeCrontabShow
, describeNextMatch
]
describeScheduleMatches :: TestTree
describeScheduleMatches = testGroup "scheduleMatches"
[
testCase "matches a catch-all" $
scheduleMatches stars (day 5 25 1 2) @?= True
, testCase "matches a specific field" $
scheduleMatches stars { hour = mkHourSpec' (Field (SpecificField' (mkSpecificField' 1)))}
(day 5 25 1 2) @?= True
, testCase "matches a range" $
scheduleMatches stars { dayOfMonth = mkDayOfMonthSpec' (Field (RangeField' (mkRangeField' 3 5)))}
(day 5 4 1 2) @?= True
, testCase "matches a list" $
scheduleMatches stars { month = mkMonthSpec' (ListField (SpecificField' (mkSpecificField' 1) :| [SpecificField' (mkSpecificField' 2), SpecificField' (mkSpecificField' 3)]))}
(day 2 3 1 2) @?= True
, testCase "matches a step field" $
scheduleMatches stars { dayOfMonth = mkDayOfMonthSpec' (StepField' (mkStepField' (RangeField' (mkRangeField' 10 16)) 2))}
(day 5 12 1 2) @?= True
, testCase "does not match something missing the step field" $
scheduleMatches stars { dayOfMonth = mkDayOfMonthSpec' (StepField' (mkStepField' (RangeField' (mkRangeField' 10 16)) 2))}
(day 5 13 1 2) @?= False
, testCase "matches starred stepped fields" $
scheduleMatches stars { minute = mkMinuteSpec' (StepField' (mkStepField' Star 2))}
(day 5 13 1 4) @?= True
, testCase "does not match fields that miss starred stepped fields" $
scheduleMatches stars { minute = mkMinuteSpec' (StepField' (mkStepField' Star 2))}
(day 5 13 1 5) @?= False
, testCase "matches multiple fields at once" $
scheduleMatches stars { minute = mkMinuteSpec' (StepField' (mkStepField' Star 2)),
dayOfMonth = mkDayOfMonthSpec' (Field (SpecificField' (mkSpecificField' 3))),
hour = mkHourSpec' (Field (RangeField' (mkRangeField' 10 14))) }
(day 5 3 13 2) @?= True
, testCase "matches a monday as 1" $
scheduleMatches stars { dayOfWeek = mkDayOfWeekSpec' (Field (SpecificField' (mkSpecificField' 1))) }
(UTCTime (fromGregorian 2014 3 17) 0) @?= True
, testCase "matches a sunday as 0" $
scheduleMatches stars { dayOfWeek = mkDayOfWeekSpec' (Field (SpecificField' (mkSpecificField' 0))) }
(UTCTime (fromGregorian 2014 3 16) 0) @?= True
, testCase "matches a sunday as 7" $
scheduleMatches stars { dayOfWeek = mkDayOfWeekSpec' (Field (SpecificField' (mkSpecificField' 7))) }
(UTCTime (fromGregorian 2014 3 16) 0) @?= True
, testCase "matches weekly on a sunday at 0:00" $
scheduleMatches weekly (UTCTime (fromGregorian 2014 4 6) 0) @?= True
, testCase "does not match weekly on a sunday at some time past midnight" $
scheduleMatches weekly (UTCTime (fromGregorian 2014 6 4) 600) @?= False
, testCase "does not match weekly on another day at midnight" $
scheduleMatches weekly (UTCTime (fromGregorian 2014 6 5) 600) @?= False
, testCase "only needs weekday or monthday to match" $
-- man 5 crontab:
-- Note: The day of a command's execution can be specified by two
-- fields — day of month, and day of week. If both fields are
-- restricted (i.e., aren't *), the command will be run when either
-- field matches the current time. For example, ``30 4 1,15 * 5''
-- would cause a command to be run at 4:30 am on the 1st and 15th of
-- each month, plus every Friday. One can, however, achieve the
-- desired result by adding a test to the command (see the last
-- example in EXAMPLE CRON FILE below).
--
-- so we deliberately set the correct day of month but wrong day of week
scheduleMatches stars { dayOfWeek = mkDayOfWeekSpec' (Field (SpecificField' (mkSpecificField' 1))),
dayOfMonth = mkDayOfMonthSpec' (Field (SpecificField' (mkSpecificField' 1))) }
(UTCTime (fromGregorian 2014 11 1) 600) @?= True
-- https://github.com/MichaelXavier/cron/issues/18
, testCase "correctly schedules steps and ranges" $ do
let Right oddMinute = parseOnly cronSchedule "1-59/2 * * * *"
let Right evenMinute = parseOnly cronSchedule "0-59/2 * * * *"
let t1 = mkTime 2015 7 17 15 17 0
let t2 = mkTime 2015 7 17 15 18 0
scheduleMatches oddMinute t1 @?= True
scheduleMatches oddMinute t2 @?= False
scheduleMatches evenMinute t1 @?= False
scheduleMatches evenMinute t2 @?= True
, testProperty "star matches everything" $ property $ do
t <- forAll gen
HH.assert (scheduleMatches stars t)
, testProperty "exact time matches" $ property $ do
t <- forAll gen
let (_, m, d, h, mn) = timeComponents t
sched = CronSchedule (mkMinuteSpec' (Field (SpecificField' (mkSpecificField' mn))))
(mkHourSpec' (Field (SpecificField' (mkSpecificField' h))))
(mkDayOfMonthSpec' (Field (SpecificField' (mkSpecificField' d))))
(mkMonthSpec' (Field (SpecificField' (mkSpecificField' m))))
(mkDayOfWeekSpec' (Field Star))
HH.assert (scheduleMatches sched t)
, testProperty "any time with the same minute as n * * * * matches" $ property $ do
(y, m, d, h, mn) <- forAll genTimeFields
let sched = stars { minute = mkMinuteSpec' (Field (SpecificField' (mkSpecificField' mn))) }
t = day' y m d h mn
HH.assert (scheduleMatches sched t)
, testProperty "any time with the diff minute as n * * * * does not match" $ property $ do
(y, m, d, h, mn) <- forAll genTimeFields
let sched = stars { minute = mkMinuteSpec' (Field (SpecificField' (mkSpecificField' (stepMax 59 mn)))) }
t = day' y m d h mn
HH.assert (not (scheduleMatches sched t))
, testProperty "any time with the same hour as * n * * * matches" $ property $ do
(y, m, d, h, mn) <- forAll genTimeFields
let sched = stars { hour = mkHourSpec' (Field (SpecificField' (mkSpecificField' h))) }
t = day' y m d h mn
HH.assert (scheduleMatches sched t)
, testProperty "any time with the diff hour as * n * * * does not match" $ property $ do
(y, m, d, h, mn) <- forAll genTimeFields
let sched = stars { hour = mkHourSpec' (Field (SpecificField' (mkSpecificField' (stepMax 23 h)))) }
t = day' y m d h mn
HH.assert (not (scheduleMatches sched t))
, testProperty "any time with the same day as * * n * * matches" $ property $ do
t <- forAll gen
let (_, m, d, h, mn) = timeComponents t
sched = CronSchedule (mkMinuteSpec' (Field (SpecificField' (mkSpecificField' mn))))
(mkHourSpec' (Field (SpecificField' (mkSpecificField' h))))
(mkDayOfMonthSpec' (Field (SpecificField' (mkSpecificField' d))))
(mkMonthSpec' (Field (SpecificField' (mkSpecificField' m))))
(mkDayOfWeekSpec' (Field Star))
HH.assert (scheduleMatches sched t)
, testProperty "any time with the diff day as * * n * * does not match" $ property $ do
(y, m, d, h, mn) <- forAll genTimeFields
let sched = stars { dayOfMonth = mkDayOfMonthSpec' (Field (SpecificField' (mkSpecificField' (stepMax 31 d)))) }
t = day' y m d h mn
HH.assert (not (scheduleMatches sched t))
]
where day = day' 2012
day' y m d h mn = UTCTime (fromGregorian y m d) (diffTime h mn)
diffTime h mn = timeOfDayToTime $ TimeOfDay h mn 1
genTimeFields
:: Gen (Integer, Int, Int, Int, Int)
genTimeFields = do
y <- Gen.integral (Range.linear 0 9999)
m <- Gen.int (Range.linear 1 12)
d <- Gen.int (Range.linear 1 28)
h <- Gen.int (Range.linear 1 23)
mn <- Gen.int (Range.linear 1 59)
pure (y, m, d, h, mn)
hoursMins :: DiffTime -> (Int, Int)
hoursMins uTime = (hr, mn)
where
TimeOfDay { todHour = hr,
todMin = mn} = timeToTimeOfDay uTime
stepMax :: (Enum a, Ord a) => a -> a -> a
stepMax mx n | n < mx = succ n
| otherwise = pred n
describeCronScheduleShow :: TestTree
describeCronScheduleShow = testGroup "CronSchedule show"
[
testCase "formats stars" $
show stars @?= "CronSchedule * * * * *"
, testCase "formats specific numbers" $
show stars { dayOfWeek = mkDayOfWeekSpec' (Field (SpecificField' (mkSpecificField' 3)))} @?=
"CronSchedule * * * * 3"
, testCase "formats lists" $
show stars { minute = mkMinuteSpec' (ListField (SpecificField' (mkSpecificField' 1) :| [SpecificField' (mkSpecificField' 2), SpecificField' (mkSpecificField' 3)]))} @?=
"CronSchedule 1,2,3 * * * *"
, testCase "formats ranges" $
show stars { hour = mkHourSpec' (Field (RangeField' (mkRangeField' 7 10)))} @?=
"CronSchedule * 7-10 * * *"
, testCase "formats steps" $
show stars { dayOfMonth = mkDayOfMonthSpec' (StepField' (mkStepField' Star 2))} @?=
"CronSchedule * * */2 * *"
, testCase "formats @yearly" $
show yearly @?= "CronSchedule 0 0 1 1 *"
, testCase "formats @monthly" $
show monthly @?= "CronSchedule 0 0 1 * *"
, testCase "formats @weekly" $
show weekly @?= "CronSchedule 0 0 * * 0"
, testCase "formats @daily" $
show daily @?= "CronSchedule 0 0 * * *"
, testCase "formats @hourly" $
show hourly @?= "CronSchedule 0 * * * *"
, testCase "formats everyMinute" $
show everyMinute @?= "CronSchedule * * * * *"
]
describeCrontabShow :: TestTree
describeCrontabShow = testGroup "Crontab Show"
[
testCase "prints nothing for an empty crontab" $
show (Crontab []) @?= ""
]
describeCrontabEntryShow :: TestTree
describeCrontabEntryShow = testGroup "CrontabEntry Show"
[
testCase "formats environment variable sets" $
show envSet @?= "FOO=BAR"
, testCase "formats command entries" $
show entry @?= "* * * * * do stuff"
]
describeNextMatch :: TestTree
describeNextMatch = testGroup "nextMatch"
[ testProperty "is always in the future (at least 1 minute advanced)" $ property $ do
cs <- forAll gen
t <- forAll gen
let tSecs = floor (utcTimeToPOSIXSeconds t) :: Integer
minT2 = posixSecondsToUTCTime (fromInteger ((tSecs `div` 60) + 1) * 60)
case nextMatch cs t of
Just t2 -> HH.assert (t2 >= minT2)
Nothing -> success
, testProperty "always produces a time that will match the schedule" $ property $ do
cs <- forAll gen
t <- forAll gen
case nextMatch cs t of
Just t2 -> do
unless (scheduleMatches cs t2) $ do
annotate (show t2 <> " does not match " <> show cs)
failure
Nothing -> success
-- , testCase "special case" $ do
-- let Right cs = parseOnly cronSchedule "* * * * *"
-- t = mkTime 1858 11 20 0 0 1
-- nextMatch cs t @?= Just (mkTime 1858 11 20 0 1 0)
-- this test has a really variable workload but is usually quite slow because it has to walk minute by minute until it finds the test case, so we'll set an upper bound here
--TODO: resize 20?
, testProperty "returns the first minute in the future that matches" $ property $ do
cs <- forAll gen
t <- forAll gen
case nextMatch cs t of
Just res ->
let mactual = find (scheduleMatches cs) ((takeWhile (<= res) (nextMinutes t)))
in case mactual of
Just actual -> res `sameMinute` actual
Nothing -> do
annotate ("Could not find a next minute match for " <> show t <> ", expected " <> show res)
failure
Nothing -> success
, testProperty "a schedule that produces Just for one t will produce it for any t" $ property $ do
cs <- forAll gen
t1 <- forAll (Gen.filter (isJust . nextMatch cs) gen)
t2 <- forAll gen
unless (isJust (nextMatch cs t2) == True) $ do
annotate ("nextMatch produced Just for " <> show t1 <> " but not " <> show t2)
failure
, testCase "does not match impossible dates (restricted dow/dom bug)" $ do
let t = posixSecondsToUTCTime 0
let cs = stars { month = mkMonthSpec' (Field (SpecificField' (mkSpecificField' 9)))
, dayOfMonth = mkDayOfMonthSpec' (ListField (SpecificField' (mkSpecificField' 31) :| []))
, dayOfWeek = mkDayOfWeekSpec' (ListField (Star :| []))
}
nextMatch cs t @?= Nothing
]
sameMinute :: (MonadTest m) => UTCTime -> UTCTime -> m ()
sameMinute t1 t2 = t1' === t2'
where
t1' = t1 { utctDayTime = roundToMinute (utctDayTime t1)}
t2' = t2 { utctDayTime = roundToMinute (utctDayTime t2)}
nextMinutes :: UTCTime -> [UTCTime]
nextMinutes t = [ addMinutes tRounded mins | mins <- [1..]]
where
addMinutes time mins = addUTCTime (fromInteger (60 * mins)) time
-- round down to nearest 60
tRounded = t { utctDayTime = roundToMinute (utctDayTime t)}
roundToMinute :: DiffTime -> DiffTime
roundToMinute n = secondsToDiffTime (nInt - (nInt `mod` 60))
where
nInt = truncate n
envSet :: CrontabEntry
envSet = EnvVariable "FOO" "BAR"
entry :: CrontabEntry
entry = CommandEntry stars (CronCommand "do stuff")
stars :: CronSchedule
stars = CronSchedule (mkMinuteSpec' (Field Star))
(mkHourSpec' (Field Star))
(mkDayOfMonthSpec' (Field Star))
(mkMonthSpec' (Field Star))
(mkDayOfWeekSpec' (Field Star))
timeComponents :: UTCTime -> (Integer, Int, Int, Int, Int)
timeComponents (UTCTime dy dt) = (y, m, d, h, mn)
where
(y, m, d) = toGregorian dy
(h, mn) = hoursMins dt
mkTime
:: Integer
-> Int
-> Int
-> DiffTime
-> DiffTime
-> DiffTime
-> UTCTime
mkTime y m d hr mn s = UTCTime day time
where day = fromGregorian y m d
time = s + 60 * mn + 60 * 60 * hr