cleantest.icl 14.6 KB
Newer Older
Camil Staps's avatar
Camil Staps committed
1
module cleantest
Bas Lijnse's avatar
Bas Lijnse committed
2

3
import StdArray
4
import StdBool
Camil Staps's avatar
Camil Staps committed
5
import StdFile
6
from StdFunc import flip, o
Camil Staps's avatar
Camil Staps committed
7
import StdList
8
import StdMisc
Camil Staps's avatar
Camil Staps committed
9
import StdString
Camil Staps's avatar
Camil Staps committed
10
import StdTuple
Camil Staps's avatar
Camil Staps committed
11

12
import Control.Monad => qualified join
Camil Staps's avatar
Camil Staps committed
13
import Data.Error
14 15
from Data.Func import $, mapSt, seqSt
import Data.Functor
16 17
import Data.GenDiff
import Data.GenEq
18
import Data.List
Camil Staps's avatar
Camil Staps committed
19
import Data.Maybe
20
import Data.Tuple
Camil Staps's avatar
Camil Staps committed
21 22
import System.CommandLine
import System.FilePath
23
import System.Options
Camil Staps's avatar
Camil Staps committed
24
import System.Process
25
import Testing.Options
Camil Staps's avatar
Camil Staps committed
26
import Testing.TestEvents
27
from Text import <+, class Text(join,replaceSubString,split,trim), instance Text String
28
import Text.GenJSON
29
import Text.GenParse
Camil Staps's avatar
Camil Staps committed
30
import Text.GenPrint
Camil Staps's avatar
Camil Staps committed
31
import Text.Language
Camil Staps's avatar
Camil Staps committed
32

Camil Staps's avatar
Camil Staps committed
33 34 35 36 37 38 39
derive gDiff GenConsAssoc, Maybe, JSONNode
derive gPrint Expression, JSONNode

gDiff{|Expression|} x y = case (x,y) of
	(JSON x,   JSON y)   -> gDiff{|*|} x y
	(GPrint x, GPrint y) -> gDiff{|*|} (preParseString x) (preParseString y)
	_                    -> simpleDiff (printToString x) (printToString y)
Camil Staps's avatar
Camil Staps committed
40 41 42 43 44 45 46

gDiff{|Expr|} x y = case (x,y) of
	(ExprInt a,    ExprInt b)    -> gDiff{|*|} a b
	(ExprChar a,   ExprChar b)   -> gDiff{|*|} a b
	(ExprBool a,   ExprBool b)   -> gDiff{|*|} a b
	(ExprReal a,   ExprReal b)   -> gDiff{|*|} a b
	(ExprString a, ExprString b) -> gDiff{|*|} a b
Steffen Michels's avatar
Steffen Michels committed
47 48 49 50 51 52 53
	(ExprApp a, ExprApp b) | a.[0] == b.[0] -> [
			{ status   = parentStatus argDiffs
			, value    = toString a.[0]
			, children = argDiffs
			}]
	where
		argDiffs = flatten [gDiff{|*|} x y \\ x <-: a & y <-: b & n <- [0..] | n > 0]
54 55 56
	(ExprTuple a,  ExprTuple b)  -> [ {diff & value="_Tuple"}
	                                \\ diff <- gDiff{|*->*|} gDiff{|*|} [x \\ x <-: a] [y \\ y <-: b]
	                                ]
Camil Staps's avatar
Camil Staps committed
57
	(ExprList a,   ExprList b)   -> gDiff{|*|} a b
58 59 60
	(ExprArray a,  ExprArray b)  -> [ {diff & value="_Array"}
	                                \\ diff <- gDiff{|*->*|} gDiff{|*|} [x \\ x <- a] [y \\ y <- b]
	                                ]
Camil Staps's avatar
Camil Staps committed
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
	(ExprRecord r1 xs, ExprRecord r2 ys) | r1 == r2 -> [
			{ status   = parentStatus field_diffs
			, value    = fromMaybe "<unnamed record>" r1
			, children = field_diffs
			}]
		with
			field_diffs =
				[ let ds = gDiff{|*|} (find k xs) (find k ys) in
					{status=parentStatus ds, value=k +++ "=", children=ds} \\ k <- both] ++
				[{status=OnlyLeft,  value=k +++ "=", children=[{status=OnlyLeft,  value=toString (find k xs), children=[]}]} \\ k <- xonly] ++
				[{status=OnlyRight, value=k +++ "=", children=[{status=OnlyRight, value=toString (find k ys), children=[]}]} \\ k <- yonly]

			xkeys = [k \\ ExprField k _ <-: xs]
			ykeys = [k \\ ExprField k _ <-: ys]
			both = intersect xkeys ykeys
			xonly = difference xkeys ykeys
			yonly = difference ykeys xkeys
			find k vs = case [e \\ ExprField f e <-: vs | f == k] of
				[e:_] -> e
				_     -> abort "gDiff_Expr: internal error\n"
Camil Staps's avatar
Camil Staps committed
81 82
	_ -> simpleDiff (toString x) (toString y)

Steffen Michels's avatar
Steffen Michels committed
83 84 85
parentStatus :: [Diff] -> DiffStatus
parentStatus diffs = if (all (\d -> d.status == Common) diffs) Common Changed

Camil Staps's avatar
Camil Staps committed
86
simpleDiff :: !String !String -> [Diff]
Steffen Michels's avatar
Steffen Michels committed
87 88 89 90 91
simpleDiff left right
	| left == right =  [ {status=Common,    value=left,  children=[]} ]
	| otherwise     =  [ {status=OnlyLeft,  value=left,  children=[]}
	                   , {status=OnlyRight, value=right, children=[]}
	                   ]
92

Camil Staps's avatar
Camil Staps committed
93
:: *ProcessOutput =
94 95 96 97
	{ lines :: ![String]
	, rest  :: !String
	}

Camil Staps's avatar
Camil Staps committed
98
append :: !String !(String .e -> .e) !*ProcessOutput .e -> *(*ProcessOutput, .e)
99 100 101 102 103 104 105 106
append s f out env
# out & rest = out.rest +++ s
# lines = split "\n" out.rest
| length lines == 1 = (out, env)
# env = seqSt f (init lines) env
# out & lines = out.lines ++ init lines
# out & rest  = last lines
= (out, env)
Camil Staps's avatar
Camil Staps committed
107

108 109 110 111 112 113 114 115 116 117 118 119 120
:: MessageType = MT_Started | MT_Passed | MT_Failed | MT_Skipped | MT_Lost
:: OutputFormat = OF_JSON | OF_HumanReadable
:: Strategy = S_Default | S_FailedFirst

messageType :: TestEvent -> MessageType
messageType (StartEvent _) = MT_Started
messageType (EndEvent ee) = case ee.event of
	Passed   -> MT_Passed
	Failed _ -> MT_Failed
	Skipped  -> MT_Skipped

derive gEq MessageType; instance == MessageType where == a b = a === b

121
:: RunResult =
122
	{ run    :: !TestRun
123 124 125
	, result :: !EndEventType
	}

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
mergeResults :: ![RunResult] -> [RunResult]
mergeResults [] = []
mergeResults [rr:rrs] = case partition (\rr` -> rr.run.TestRun.name == rr`.run.TestRun.name) rrs of
	([], rrs)    -> [rr:mergeResults rrs]
	([rr`], rrs) -> [{rr & result=merge rr.result rr`.result}:mergeResults rrs]
where
	merge :: !EndEventType !EndEventType -> EndEventType
	merge (Failed (Just r1)) (Failed (Just r2)) = case (r1,r2) of
		(FailedChildren cs1, FailedChildren cs2) -> Failed $ Just $ FailedChildren $ cs1 ++ cs2
	merge (Failed r) _ = Failed r
	merge _ (Failed r) = Failed r
	merge Skipped _       = Skipped
	merge _       Skipped = Skipped
	merge Passed  Passed  = Passed

141 142 143
derive JSONEncode RunResult, TestRun, EndEventType
derive JSONDecode RunResult, TestRun, EndEventType

144 145 146 147 148 149 150 151 152 153 154 155
instance <<< RunResult where <<< f rr = f <<< toJSON rr <<< "\n"

readResults :: !*File -> *(!Maybe [RunResult], !*File)
readResults f
# (e,f) = fend f
| e = (Just [], f)
# (l,f) = freadline f
# rr = fromJSON $ fromString l
| isNothing rr = (Nothing, f)
# (rrs,f) = readResults f
= ((\rrs -> [fromJust rr:rrs]) <$> rrs, f)

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
:: Options =
	{ test_options  :: !TestOptions
	, strategy      :: !Strategy
	, output_format :: !OutputFormat
	, hide          :: ![MessageType]
	}

derive gDefault MessageType, Options, OutputFormat, Strategy

optionDescription :: Option Options
optionDescription = WithHelp True $ Options
	[ Shorthand "-s" "--strategy" $ AddHelpLines
		[ "default       Order of the --run parameters"
		, "failed-first  First run tests that failed last time; if they passed continue with the rest"
		] $ Option
		"--strategy"
		(\s opts -> case s of
			"default"      -> Ok {opts & strategy=S_Default}
			"failed-first" -> Ok {opts & strategy=S_FailedFirst}
			s              -> Error ["Unknown strategy '" <+ s <+ "'"])
		"STRATEGY"
		"The test order strategy:"
	, Shorthand "-f" "--output-format" $ Option
		"--output-format"
		(\f opts -> case f of
			"json"  -> Ok {opts & output_format=OF_JSON}
			"human" -> Ok {opts & output_format=OF_HumanReadable}
			f       -> Error ["Unknown output format '" <+ f <+ "'"])
		"FMT"
		"The output format (json,human)"
	, Shorthand "-H" "--hide" $ Option
		"--hide"
		(\mts opts -> (\mts -> {opts & hide=mts}) <$> (mapM parseMT $ split "," mts))
		"TYPES"
		"Message types that should be hidden (start,pass,fail,skip,lost)"
	, Biject (\r->r.test_options) (\old r -> {old & test_options=r}) testOptionDescription
	]
where
	parseMT :: String -> MaybeError [String] MessageType
	parseMT "start" = Ok MT_Started
	parseMT "pass"  = Ok MT_Passed
	parseMT "fail"  = Ok MT_Failed
	parseMT "skip"  = Ok MT_Skipped
	parseMT "lost"  = Ok MT_Lost
	parseMT s       = Error ["Unknown message type '" <+ s <+ "'"]
201

202 203 204 205
:: SubTestRun
	= JustRun           !TestRun
	| Only    ![String] !TestRun
	| Without ![String] !TestRun
206

Camil Staps's avatar
Camil Staps committed
207
Start w
208
// Parse command line arguments
Camil Staps's avatar
Camil Staps committed
209
# ([prog:args],w) = getCommandLine w
210 211
# opts = parseOptions optionDescription args gDefault{|*|}
| isError opts = exit (join "\n" $ fromError opts) w
Camil Staps's avatar
Camil Staps committed
212
# opts = fromOk opts
Camil Staps's avatar
Camil Staps committed
213 214 215 216 217
| opts.test_options.list
	# (io,w) = stdio w
	# io = foldl (<<<) io [r.TestRun.name +++ "\n" \\ r <- opts.test_options.runs]
	# (_,w) = fclose io w
	= w
218 219 220 221 222
// Run tests
# (ok,f,w) = fopen ".ctest-results.json" FReadText w
# (l,f) = if ok freadline (tuple "") f
# (_,w) = fclose f w
# runs = case fromJSON (fromString l) of
223
	Nothing  -> map JustRun opts.test_options.runs
224
	Just res -> makeRuns res opts.strategy opts.test_options.runs
225 226 227
# (rrs,w) = mapSt (run opts) runs w
// Save results
# (_,f,w) = fopen ".ctest-results.json" FWriteText w
228
# f = f <<< toJSON (mergeResults rrs)
229
# (_,w) = fclose f w
Camil Staps's avatar
Camil Staps committed
230 231
= w
where
232
	exit :: String *World -> *World
Camil Staps's avatar
Camil Staps committed
233
	exit error w = snd $ fclose (stderr <<< error <<< "\n") $ setReturnCode 1 w
Camil Staps's avatar
Camil Staps committed
234

235 236
	makeRuns :: [RunResult] Strategy [TestRun] -> [SubTestRun]
	makeRuns _ S_Default runs = map JustRun runs
237
	makeRuns results S_FailedFirst runs =
238 239 240 241
		map (uncurry (flip Only)) failed_children ++
		map JustRun failed ++
		map (uncurry (flip Without)) failed_children ++
		map JustRun not_failed
242
	where
243 244
		failed_children = [(run, map fst cs) \\ {run,result=Failed (Just (FailedChildren cs))} <- results]
		failed = [run \\ {run,result=Failed fr} <- results | not (fr=:(Just (FailedChildren _)))]
245 246 247 248 249 250
		not_failed = [run \\ {run,result=res} <- results | not (res=:(Failed _))]

		prepend :: a [a] -> [a]
		prepend _ []     = []
		prepend p [x:xs] = [p,x:prepend p xs]

Camil Staps's avatar
Camil Staps committed
251 252 253 254 255 256 257 258 259 260 261 262
list :: !TestRun !*World -> *(![String], !*World)
list r w
# (h,w) = runProcessIO r.TestRun.name ["--list"] Nothing w
| isError h = ([], w)
# (h,io) = fromOk h
# (c,w) = waitForProcess h w
| isError c = ([], w)
# (s,w) = readPipeBlocking io.stdOut w
| isError s = ([], w)
# (_,w) = closeProcessIO io w
= (filter (not o (==) 0 o size) $ map trim $ split "\n" (fromOk s), w)

263
run :: !Options !SubTestRun !*World -> *(!RunResult, !*World)
264
run opts r w
Camil Staps's avatar
Camil Staps committed
265
# (io,w) = stdio w
266 267 268 269 270
# io = emit (StartEvent {StartEvent | name=name}) io
	with name = (case r of JustRun r   -> r; Only _ r    -> r; Without _ r -> r).TestRun.name
# (extra_opts,r,w) = case r of
	JustRun r       -> (Just [], r, w)
	Only names    r -> (Just ["--run":intersperse "--run" names], r, w)
Camil Staps's avatar
Camil Staps committed
271
	Without names r -> (\(all,w) -> (case difference all names of
272
		[] -> Nothing
Camil Staps's avatar
Camil Staps committed
273
		_  -> Just ["--skip":intersperse "--skip" names], r, w)) $ list r w
274 275 276 277 278 279 280 281 282
| isNothing extra_opts
	# io = emit (EndEvent
		{ name    = r.TestRun.name
		, event   = Passed
		, message = "No remaining tests"
		}) io
	= return Passed r io w
# extra_opts = fromJust extra_opts
# (h,w) = runProcessIO r.TestRun.name (r.options ++ extra_opts) Nothing w
Camil Staps's avatar
Camil Staps committed
283 284
| isError h
	# (err,msg) = fromError h
285
	# event = Failed Nothing
286
	# io = emit (EndEvent
287
		{ name    = r.TestRun.name
288
		, event   = event
289
		, message = "Failed to execute " <+ r.TestRun.name <+ " (" <+ err <+ "; " <+ msg <+ ")"
290
		}) io
291
	= return event r io w
Camil Staps's avatar
Camil Staps committed
292 293
# (h,pio) = fromOk h
# w = snd $ fclose io w
294
= redirect {lines=[], rest=""} h pio r w
Camil Staps's avatar
Camil Staps committed
295
where
Camil Staps's avatar
Camil Staps committed
296
	redirect :: *ProcessOutput ProcessHandle ProcessIO TestRun *World -> *(!RunResult, !*World)
297
	redirect output h pio r w
Camil Staps's avatar
Camil Staps committed
298 299
	# (io,w) = stdio w
	// Check child output
Camil Staps's avatar
Camil Staps committed
300 301
	# (ok,output,io,w) = readPipes output pio io w
	| isError ok = return (Failed Nothing) r io w
Camil Staps's avatar
Camil Staps committed
302 303 304 305
	// Check if child has terminated
	# (t,w) = checkProcess h w
	| isError t
		# (err,msg) = fromError t
306
		# event = Failed Nothing
307
		# io = emit (EndEvent
308
			{ name    = r.TestRun.name
309
			, event   = event
310
			, message = "Failed to check on child process (" <+ err <+ "; " <+ msg <+ ")"
311
			}) io
312
		= return event r io w
Camil Staps's avatar
Camil Staps committed
313 314
	# rcode = fromOk t
	// Check return code
315
	| isJust rcode
Camil Staps's avatar
Camil Staps committed
316
		# (_,output,io,w) = readPipes output pio io w
317
		# results = map (fromJSON o fromString) $ filter ((<>) "") output.lines
Camil Staps's avatar
Camil Staps committed
318
		| any isNothing results
319
			# event = Failed Nothing
320
			# io = emit (EndEvent
321
				{ name    = r.TestRun.name
322
				, event   = event
323
				, message = "Failed to read child messages"
324
				}) io
325
			= return event r io w
326 327
		# ee = mergeResults $ map fromJust results
		# io = emit (EndEvent ee) io
328 329 330 331 332 333 334 335 336
		| fromJust rcode <> 0
			# event = Failed Nothing
			# io = emit ( EndEvent  { name    = r.TestRun.name
			                        , event   = event
			                        , message = "Child process exited with " <+ fromJust rcode
			                        }
			            )
			            io
			= return event r io w
337
		= return ee.event r io w
Camil Staps's avatar
Camil Staps committed
338
	# w = snd $ fclose io w
339
	= redirect output h pio r w
Camil Staps's avatar
Camil Staps committed
340 341 342
	where
		mergeResults :: [TestEvent] -> EndEvent
		mergeResults tes =
343
			{ name    = r.TestRun.name
344
			, event   = if (isEmpty failed && isEmpty lost) Passed
345
				(Failed $ Just $ FailedChildren $
346
					[(name, fr) \\ EndEvent {name,event=Failed fr} <- failed] ++
347
					[(l, Just Crashed) \\ l <- lost])
Camil Staps's avatar
Camil Staps committed
348
			, message =
349 350 351 352
				pluralisen English (length passed)  "test" <+ " passed, " <+
				pluralisen English (length failed)  "test" <+ " failed, " <+
				pluralisen English (length skipped) "test" <+ " skipped and " <+
				pluralisen English (length lost)    "test" <+ " lost."
Camil Staps's avatar
Camil Staps committed
353 354
			}
		where
355 356 357 358 359 360 361
			passed  = filter (\te -> te=:(EndEvent {event=Passed}))   tes
			failed  = filter (\te -> te=:(EndEvent {event=Failed _})) tes
			skipped = filter (\te -> te=:(EndEvent {event=Skipped}))  tes
			lost = [se.StartEvent.name \\ StartEvent se <- tes
				| not
					$ any (\(EndEvent ee) -> se.StartEvent.name == ee.EndEvent.name)
					$ passed ++ failed ++ skipped]
362

Camil Staps's avatar
Camil Staps committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
		readPipes :: !*ProcessOutput !ProcessIO !*File !*World -> *(!MaybeOSError (), !*ProcessOutput, !*File, !*World)
		readPipes output pio io w
		# (ss,w) = readPipeBlockingMulti [pio.stdOut, pio.stdErr] w
		| isError ss
			# oserr=:(err,msg) = fromError ss
			# event = Failed Nothing
			# io = emit (EndEvent
				{ name    = r.TestRun.name
				, event   = event
				, message = "Failed to read child process IO (" <+ err <+ "; " <+ msg <+ ")"
				}) io
			= (Error oserr, output, io, w)
		# [out,err:_] = fromOk ss
		# (output,io) = append out (\s io -> case fromJSON $ fromString s of
			Nothing -> io
			Just ev -> emit ev io) output io
		# w = snd $ fclose (stderr <<< err) w
		= (Ok (), output, io, w)

382 383 384
	emit :: TestEvent *File -> *File
	emit ev io
	| isMember (messageType ev) opts.hide = io
385
	| otherwise = case opts.output_format of
386 387 388 389 390
		OF_JSON          -> io <<< toJSON ev <<< "\n"
		OF_HumanReadable -> io <<< humanReadable ev <<< "\n"
	where
		humanReadable :: TestEvent -> String
		humanReadable (StartEvent se) = "Started:  " +++ se.StartEvent.name
391
		humanReadable (EndEvent ee) = event +++ ee.EndEvent.name +++ diff
392 393
		where
			event = case ee.event of
394 395 396
				Passed   -> "\033[0;32mPassed\033[0m:   "
				Failed _ -> "\033[0;31mFailed\033[0m:   "
				Skipped  -> "\033[0;33mSkipped\033[0m:  "
397
			diff = case ee.event of
398 399 400 401
				Failed (Just r) -> case r of
					FailedAssertions fas -> "\n  Failed assumptions:\n    " +++
						replaceSubString "\n" "\n    "
							(replaceSubString "\t" "  " $ join "\n" $ map printFA fas)
402 403
					CounterExamples ces  -> "\n  Counter-examples:\n  - " +++
						join "\n  - " (map (replaceSubString "\n" "\n    " o printCE) ces)
404 405
					FailedChildren fcs   -> "\n  Children tests failed: " +++ join ", " (map fst fcs)
					Crashed              -> "\n  Crashed"
406
				Failed Nothing -> "\n  " +++ ee.message
407 408 409 410
				_ -> ""
			where
				printFA :: FailedAssertion -> String
				printFA (ExpectedRelation x rel y) = "Expected " +++ toString rel +++ " on:\n" +++ case rel of
Camil Staps's avatar
Camil Staps committed
411
					Eq -> diffToConsole $ gDiff{|*|} x y
412 413
					_  -> toString x +++ "\n" +++ toString y

414 415 416 417 418
				printCE :: CounterExample -> String
				printCE ce = join " " (map toString ce.counterExample) +++ case ce.failedAssertions of
					[]  -> ""
					fas -> ":\n" +++ join "\n" (map printFA ce.failedAssertions)

419 420
	return :: !EndEventType !TestRun !*File !*World -> *(!RunResult, !*World)
	return eet r io w
421
	# (_,w) = fclose io w
422 423 424
	# w = case eet of
		Failed _ -> setReturnCode 1 w
		_        -> w
425
	= ({run=r, result=eet}, w)