cleantest.icl 13.5 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

Camil Staps's avatar
Camil Staps committed
75
:: *ProcessOutput =
76 77 78 79
	{ lines :: ![String]
	, rest  :: !String
	}

Camil Staps's avatar
Camil Staps committed
80
append :: !String !(String .e -> .e) !*ProcessOutput .e -> *(*ProcessOutput, .e)
81 82 83 84 85 86 87 88
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
Camil Staps's avatar
Camil Staps committed
195 196 197 198 199
| 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
200 201 202 203 204
// 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
205
	Nothing  -> map JustRun opts.test_options.runs
206
	Just res -> makeRuns res opts.strategy opts.test_options.runs
207 208 209
# (rrs,w) = mapSt (run opts) runs w
// Save results
# (_,f,w) = fopen ".ctest-results.json" FWriteText w
210
# f = f <<< toJSON (mergeResults rrs)
211
# (_,w) = fclose f w
Camil Staps's avatar
Camil Staps committed
212 213
= w
where
214
	exit :: String *World -> *World
Camil Staps's avatar
Camil Staps committed
215
	exit error w = snd $ fclose (stderr <<< error <<< "\n") $ setReturnCode 1 w
Camil Staps's avatar
Camil Staps committed
216

217 218
	makeRuns :: [RunResult] Strategy [TestRun] -> [SubTestRun]
	makeRuns _ S_Default runs = map JustRun runs
219
	makeRuns results S_FailedFirst runs =
220 221 222 223
		map (uncurry (flip Only)) failed_children ++
		map JustRun failed ++
		map (uncurry (flip Without)) failed_children ++
		map JustRun not_failed
224
	where
225 226
		failed_children = [(run, map fst cs) \\ {run,result=Failed (Just (FailedChildren cs))} <- results]
		failed = [run \\ {run,result=Failed fr} <- results | not (fr=:(Just (FailedChildren _)))]
227 228 229 230 231 232
		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
Cleanup  
Camil Staps committed
233 234 235 236 237 238 239 240 241 242 243 244
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)

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

Camil Staps's avatar
Camil Staps committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
		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)

364 365 366
	emit :: TestEvent *File -> *File
	emit ev io
	| isMember (messageType ev) opts.hide = io
367
	| otherwise = case opts.output_format of
368 369 370 371 372
		OF_JSON          -> io <<< toJSON ev <<< "\n"
		OF_HumanReadable -> io <<< humanReadable ev <<< "\n"
	where
		humanReadable :: TestEvent -> String
		humanReadable (StartEvent se) = "Started:  " +++ se.StartEvent.name
373
		humanReadable (EndEvent ee) = event +++ ee.EndEvent.name +++ diff
374 375
		where
			event = case ee.event of
376 377 378
				Passed   -> "\033[0;32mPassed\033[0m:   "
				Failed _ -> "\033[0;31mFailed\033[0m:   "
				Skipped  -> "\033[0;33mSkipped\033[0m:  "
379
			diff = case ee.event of
380 381 382 383
				Failed (Just r) -> case r of
					FailedAssertions fas -> "\n  Failed assumptions:\n    " +++
						replaceSubString "\n" "\n    "
							(replaceSubString "\t" "  " $ join "\n" $ map printFA fas)
384 385
					CounterExamples ces  -> "\n  Counter-examples:\n  - " +++
						join "\n  - " (map (replaceSubString "\n" "\n    " o printCE) ces)
386 387
					FailedChildren fcs   -> "\n  Children tests failed: " +++ join ", " (map fst fcs)
					Crashed              -> "\n  Crashed"
388
				Failed Nothing -> "\n  " +++ ee.message
389 390 391 392 393 394 395
				_ -> ""
			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

396 397 398 399 400
				printCE :: CounterExample -> String
				printCE ce = join " " (map toString ce.counterExample) +++ case ce.failedAssertions of
					[]  -> ""
					fas -> ":\n" +++ join "\n" (map printFA ce.failedAssertions)

401 402
	return :: !EndEventType !TestRun !*File !*World -> *(!RunResult, !*World)
	return eet r io w
403
	# (_,w) = fclose io w
404 405 406
	# w = case eet of
		Failed _ -> setReturnCode 1 w
		_        -> w
407
	= ({run=r, result=eet}, w)