cleantest.icl 13 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
Camil Staps's avatar
Camil Staps committed
29
import Text.Language
Camil Staps's avatar
Camil Staps committed
30

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
gDiff{|JSONNode|} x y = case x of
	JSONBool i -> case y of
		JSONBool j -> gDiff{|*|} i j
		_         -> add i ++ remove y
	JSONInt i -> case y of
		JSONInt j -> gDiff{|*|} i j
		_         -> add i ++ remove y
	JSONReal i -> case y of
		JSONReal j -> gDiff{|*|} i j
		_         -> add i ++ remove y
	JSONString i -> case y of
		JSONString j -> gDiff{|*|} i j
		_         -> add i ++ remove y
	JSONArray xs -> case y of
		JSONArray ys -> gDiff{|*|} xs ys
		_            -> add xs ++ remove y
	JSONObject xs -> case y of
		JSONObject ys -> [
				{ status   = if (all (\d -> d.status == Common) field_diffs) Common Changed
				, value    = "Object"
				, children = field_diffs
				}]
			with
				field_diffs =
					[let ds = gDiff{|*|} (find k xs) (find k ys) in
						{status=if (all (\d->d.status==Common) ds) Common Changed, value=k <+ "=", children=ds} \\ k <- both] ++
Steffen Michels's avatar
Steffen Michels committed
57 58
					[{status=OnlyLeft,  value=k <+ "=", children=[d]} \\ k <- xonly, d <- remove (find k xs)] ++
					[{status=OnlyRight, value=k <+ "=", children=[d]} \\ k <- yonly, d <- add    (find k ys)]
59 60 61 62 63 64 65 66 67 68 69
				with
					xkeys = map fst xs
					ykeys = map fst ys
					both = intersect xkeys ykeys
					xonly = difference xkeys ykeys
					yonly = difference ykeys xkeys
					find k = fromJust o lookup k
		_ -> add xs ++ remove y
	_ -> abort "Unimplemented gDiff for JSONNode\n"
where
	add :: a -> [Diff] | gDiff{|*|} a
Steffen Michels's avatar
Steffen Michels committed
70
	add x = map (setStatus OnlyRight) (gDiff{|*|} x x)
71 72

	remove :: a -> [Diff] | gDiff{|*|} a
Steffen Michels's avatar
Steffen Michels committed
73
	remove x = map (setStatus OnlyLeft) (gDiff{|*|} x x)
74

75 76 77 78 79 80 81 82 83 84 85 86 87 88
:: ProcessOutput =
	{ lines :: ![String]
	, rest  :: !String
	}

append :: !String !(String .e -> .e) !ProcessOutput .e -> .(ProcessOutput, .e)
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
89

90 91 92 93 94 95 96 97 98 99 100 101 102
:: 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

103
:: RunResult =
104
	{ run    :: !TestRun
105 106 107
	, result :: !EndEventType
	}

108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
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

123 124 125
derive JSONEncode RunResult, TestRun, EndEventType
derive JSONDecode RunResult, TestRun, EndEventType

126 127 128 129 130 131 132 133 134 135 136 137
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)

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 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
:: 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 <+ "'"]
183

184 185 186 187
:: SubTestRun
	= JustRun           !TestRun
	| Only    ![String] !TestRun
	| Without ![String] !TestRun
188

Camil Staps's avatar
Camil Staps committed
189
Start w
190
// Parse command line arguments
Camil Staps's avatar
Camil Staps committed
191
# ([prog:args],w) = getCommandLine w
192 193
# opts = parseOptions optionDescription args gDefault{|*|}
| isError opts = exit (join "\n" $ fromError opts) w
Camil Staps's avatar
Camil Staps committed
194
# opts = fromOk opts
195 196 197 198 199
// 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
200
	Nothing  -> map JustRun opts.test_options.runs
201
	Just res -> makeRuns res opts.strategy opts.test_options.runs
202 203 204
# (rrs,w) = mapSt (run opts) runs w
// Save results
# (_,f,w) = fopen ".ctest-results.json" FWriteText w
205
# f = f <<< toJSON (mergeResults rrs)
206
# (_,w) = fclose f w
Camil Staps's avatar
Camil Staps committed
207 208
= w
where
209
	exit :: String *World -> *World
Camil Staps's avatar
Camil Staps committed
210
	exit error w = snd $ fclose (stderr <<< error <<< "\n") $ setReturnCode 1 w
Camil Staps's avatar
Camil Staps committed
211

212 213
	makeRuns :: [RunResult] Strategy [TestRun] -> [SubTestRun]
	makeRuns _ S_Default runs = map JustRun runs
214
	makeRuns results S_FailedFirst runs =
215 216 217 218
		map (uncurry (flip Only)) failed_children ++
		map JustRun failed ++
		map (uncurry (flip Without)) failed_children ++
		map JustRun not_failed
219
	where
220 221
		failed_children = [(run, map fst cs) \\ {run,result=Failed (Just (FailedChildren cs))} <- results]
		failed = [run \\ {run,result=Failed fr} <- results | not (fr=:(Just (FailedChildren _)))]
222 223 224 225 226 227
		not_failed = [run \\ {run,result=res} <- results | not (res=:(Failed _))]

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

228
run :: !Options !SubTestRun !*World -> *(!RunResult, !*World)
229
run opts r w
Camil Staps's avatar
Camil Staps committed
230
# (io,w) = stdio w
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
# 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)
	Without names r -> appFst3 (\all -> case difference all names of
		[] -> Nothing
		_  -> Just ["--skip":intersperse "--skip" names]) $ list w
	with
		list :: !*World -> *(![String], !TestRun, !*World)
		list w
		# (h,w) = runProcessIO r.TestRun.name ["--list"] Nothing w
		| isError h = ([], r, w)
		# (h,io) = fromOk h
		# (c,w) = waitForProcess h w
		| isError c = ([], r, w)
		# (s,w) = readPipeBlocking io.stdOut w
		| isError s = ([], r, w)
		# (_,w) = closeProcessIO io w
		= (filter (not o (==) 0 o size) $ map trim $ split "\n" (fromOk s), r, w)
| 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
260 261
| isError h
	# (err,msg) = fromError h
262
	# event = Failed Nothing
263
	# io = emit (EndEvent
264
		{ name    = r.TestRun.name
265
		, event   = event
266
		, message = "Failed to execute " <+ r.TestRun.name <+ " (" <+ err <+ "; " <+ msg <+ ")"
267
		}) io
268
	= return event r io w
Camil Staps's avatar
Camil Staps committed
269 270
# (h,pio) = fromOk h
# w = snd $ fclose io w
271
= redirect {lines=[], rest=""} h pio r w
Camil Staps's avatar
Camil Staps committed
272
where
273 274
	redirect :: ProcessOutput ProcessHandle ProcessIO TestRun *World -> *(!RunResult, !*World)
	redirect output h pio r w
Camil Staps's avatar
Camil Staps committed
275 276 277 278 279
	# (io,w) = stdio w
	// Check child output
	# (ss,w) = readPipeBlockingMulti [pio.stdOut, pio.stdErr] w
	| isError ss
		# (err,msg) = fromError ss
280
		# event = Failed Nothing
281
		# io = emit (EndEvent
282
			{ name    = r.TestRun.name
283
			, event   = event
284
			, message = "Failed to read child process IO (" <+ err <+ "; " <+ msg <+ ")"
285
			}) io
286
		= return event r io w
Camil Staps's avatar
Camil Staps committed
287
	# [out,err:_] = fromOk ss
288 289
	# (output,io) = append out (\s io -> case fromJSON $ fromString s of
		Nothing -> io
290
		Just ev -> emit ev io) output io
Camil Staps's avatar
Camil Staps committed
291 292 293 294 295
	# w = snd $ fclose (stderr <<< err) w
	// Check if child has terminated
	# (t,w) = checkProcess h w
	| isError t
		# (err,msg) = fromError t
296
		# event = Failed Nothing
297
		# io = emit (EndEvent
298
			{ name    = r.TestRun.name
299
			, event   = event
300
			, message = "Failed to check on child process (" <+ err <+ "; " <+ msg <+ ")"
301
			}) io
302
		= return event r io w
Camil Staps's avatar
Camil Staps committed
303 304 305
	# rcode = fromOk t
	// Check return code
	| rcode == Just 0
306
		# results = map (fromJSON o fromString) $ filter ((<>) "") output.lines
Camil Staps's avatar
Camil Staps committed
307
		| any isNothing results
308
			# event = Failed Nothing
309
			# io = emit (EndEvent
310
				{ name    = r.TestRun.name
311
				, event   = event
312
				, message = "Failed to read child messages"
313
				}) io
314
			= return event r io w
315 316
		# ee = mergeResults $ map fromJust results
		# io = emit (EndEvent ee) io
317
		= return ee.event r io w
Camil Staps's avatar
Camil Staps committed
318
	| isJust rcode
319
		# event = Failed Nothing
320
		# io = emit (EndEvent
321
			{ name    = r.TestRun.name
322
			, event   = event
323
			, message = "Child process exited with " <+ fromJust rcode
324
			}) io
325
		= return event r io w
Camil Staps's avatar
Camil Staps committed
326
	# w = snd $ fclose io w
327
	= redirect output h pio r w
Camil Staps's avatar
Camil Staps committed
328 329 330
	where
		mergeResults :: [TestEvent] -> EndEvent
		mergeResults tes =
331
			{ name    = r.TestRun.name
332
			, event   = if (isEmpty failed && isEmpty lost) Passed
333
				(Failed $ Just $ FailedChildren $
334
					[(name, fr) \\ EndEvent {name,event=Failed fr} <- failed] ++
335
					[(l, Just Crashed) \\ l <- lost])
Camil Staps's avatar
Camil Staps committed
336
			, message =
337 338 339 340
				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
341 342
			}
		where
343 344 345 346 347 348 349
			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]
350

351 352 353
	emit :: TestEvent *File -> *File
	emit ev io
	| isMember (messageType ev) opts.hide = io
354
	| otherwise = case opts.output_format of
355 356 357 358 359
		OF_JSON          -> io <<< toJSON ev <<< "\n"
		OF_HumanReadable -> io <<< humanReadable ev <<< "\n"
	where
		humanReadable :: TestEvent -> String
		humanReadable (StartEvent se) = "Started:  " +++ se.StartEvent.name
360
		humanReadable (EndEvent ee) = event +++ ee.EndEvent.name +++ diff
361 362
		where
			event = case ee.event of
363 364 365
				Passed   -> "\033[0;32mPassed\033[0m:   "
				Failed _ -> "\033[0;31mFailed\033[0m:   "
				Skipped  -> "\033[0;33mSkipped\033[0m:  "
366
			diff = case ee.event of
367 368 369 370
				Failed (Just r) -> case r of
					FailedAssertions fas -> "\n  Failed assumptions:\n    " +++
						replaceSubString "\n" "\n    "
							(replaceSubString "\t" "  " $ join "\n" $ map printFA fas)
371 372
					CounterExamples ces  -> "\n  Counter-examples:\n  - " +++
						join "\n  - " (map (replaceSubString "\n" "\n    " o printCE) ces)
373 374
					FailedChildren fcs   -> "\n  Children tests failed: " +++ join ", " (map fst fcs)
					Crashed              -> "\n  Crashed"
375
				Failed Nothing -> "\n  " +++ ee.message
376 377 378 379 380 381 382
				_ -> ""
			where
				printFA :: FailedAssertion -> String
				printFA (ExpectedRelation x rel y) = "Expected " +++ toString rel +++ " on:\n" +++ case rel of
					Eq -> diffToConsole $ gDiff{|*|} x y
					_  -> toString x +++ "\n" +++ toString y

383 384 385 386 387
				printCE :: CounterExample -> String
				printCE ce = join " " (map toString ce.counterExample) +++ case ce.failedAssertions of
					[]  -> ""
					fas -> ":\n" +++ join "\n" (map printFA ce.failedAssertions)

388 389
	return :: !EndEventType !TestRun !*File !*World -> *(!RunResult, !*World)
	return eet r io w
390
	# (_,w) = fclose io w
391 392 393
	# w = case eet of
		Failed _ -> setReturnCode 1 w
		_        -> w
394
	= ({run=r, result=eet}, w)