package ounit2
OUnit testing framework
Install
Dune Dependency
Authors
Maintainers
Sources
ounit-2.2.7.tbz
sha256=90f6e63bd1240a51d8b9b2f722059bd79ce00b5276bdd6238b8f5c613c0e7388
sha512=53463e5b1b5a40f424e19f5f6a86338a544079600d1fd121ffc1a6fcaa239630194018faf91ccf360ba40b1b2a8b01cf491935e014c68d2947f6e027a2f0a0f9
doc/src/ounit2.advanced/oUnitTest.ml.html
Source file oUnitTest.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 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 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
(**************************************************************************) (* The OUnit library *) (* *) (* Copyright (C) 2002-2008 Maas-Maarten Zeeman. *) (* Copyright (C) 2010 OCamlCore SARL *) (* Copyright (C) 2013 Sylvain Le Gall *) (* *) (* The package OUnit is copyright by Maas-Maarten Zeeman, OCamlCore SARL *) (* and Sylvain Le Gall. *) (* *) (* Permission is hereby granted, free of charge, to any person obtaining *) (* a copy of this document and the OUnit software ("the Software"), to *) (* deal in the Software without restriction, including without limitation *) (* the rights to use, copy, modify, merge, publish, distribute, *) (* sublicense, and/or sell copies of the Software, and to permit persons *) (* to whom the Software is furnished to do so, subject to the following *) (* conditions: *) (* *) (* The above copyright notice and this permission notice shall be *) (* included in all copies or substantial portions of the Software. *) (* *) (* The Software is provided ``as is'', without warranty of any kind, *) (* express or implied, including but not limited to the warranties of *) (* merchantability, fitness for a particular purpose and noninfringement. *) (* In no event shall Maas-Maarten Zeeman be liable for any claim, damages *) (* or other liability, whether in an action of contract, tort or *) (* otherwise, arising from, out of or in connection with the Software or *) (* the use or other dealings in the software. *) (* *) (* See LICENSE.txt for details. *) (**************************************************************************) open OUnitUtils exception Skip of string exception Todo of string exception OUnit_failure of string (** See OUnit.mli. *) type node = ListItem of int | Label of string (** See OUnit.mli. *) type path = node list (** See OUnit2.mli. *) type backtrace = string option (* The type of length of a test. *) type test_length = | Immediate (* < 1s *) | Short (* < 1min *) | Long (* < 10min *) | Huge (* < 30min *) | Custom_length of float (** See OUnit.mli. *) type result = | RSuccess | RFailure of string * OUnitLogger.position option * backtrace | RError of string * backtrace | RSkip of string | RTodo of string | RTimeout of test_length (* See OUnit.mli. *) type result_full = (path * result * OUnitLogger.position option) type result_list = result_full list type log_event_t = (path, result) OUnitLogger.log_event_t type logger = (path, result) OUnitLogger.logger type ctxt = (* TODO: hide this to avoid building a context outside. *) { conf: OUnitConf.conf; logger: logger; shared: OUnitShared.shared; path: path; test_logger: result OUnitLogger.Test.t; (* TODO: Still a race condition possible, what if another threads * modify anything during the process (e.g. register tear down). *) mutable tear_down: (ctxt -> unit) list; tear_down_mutex: OUnitShared.Mutex.t; non_fatal: result_full list ref; non_fatal_mutex: OUnitShared.Mutex.t; initial_environment: string array; } type test_fun = ctxt -> unit (* The type of tests. *) type test = | TestCase of test_length * test_fun | TestList of test list | TestLabel of string * test let delay_of_length = function | Immediate -> 20.0 (* 20 seconds *) | Short -> 600.0 (* 10 minutes *) | Long -> 1800.0 (* 30 minutes *) | Huge -> 3600.0 (* 1 hour *) | Custom_length f -> f let get_shard_id test_ctxt = test_ctxt.logger.OUnitLogger.lshard (** Isolate a function inside a context. All the added tear down will run before returning. *) let section_ctxt ctxt f = let old_tear_down = OUnitShared.Mutex.with_lock ctxt.shared ctxt.tear_down_mutex (fun () -> ctxt.tear_down) in let clean_exit () = OUnitShared.Mutex.with_lock ctxt.shared ctxt.tear_down_mutex (fun () -> List.iter (fun tear_down -> tear_down ctxt) ctxt.tear_down; ctxt.tear_down <- old_tear_down) in OUnitShared.Mutex.with_lock ctxt.shared ctxt.tear_down_mutex (fun () -> ctxt.tear_down <- []); try let res = f ctxt in clean_exit (); res with e -> clean_exit (); raise e (** Create a context and run the function. *) let with_ctxt conf logger non_fatal test_path f = let ctxt = { conf = conf; logger = logger; path = test_path; shared = shared; test_logger = OUnitLogger.Test.create logger test_path; tear_down = []; tear_down_mutex = OUnitShared.Mutex.create OUnitShared.ScopeProcess; non_fatal = non_fatal; non_fatal_mutex = OUnitShared.Mutex.create OUnitShared.ScopeProcess; initial_environment = Unix.environment (); } in section_ctxt ctxt f let standard_modules = [ "arg.ml"; "arrayLabels.ml"; "array.ml"; "buffer.ml"; "callback.ml"; "camlinternalLazy.ml"; "camlinternalMod.ml"; "camlinternalOO.ml"; "char.ml"; "complex.ml"; "digest.ml"; "filename.ml"; "format.ml"; "gc.ml"; "genlex.ml"; "hashtbl.ml"; "int32.ml"; "int64.ml"; "lazy.ml"; "lexing.ml"; "listLabels.ml"; "list.ml"; "map.ml"; "marshal.ml"; "moreLabels.ml"; "nativeint.ml"; "obj.ml"; "oo.ml"; "parsing.ml"; "pervasives.ml"; "printexc.ml"; "printf.ml"; "queue.ml"; "random.ml"; "scanf.ml"; "set.ml"; "sort.ml"; "stack.ml"; "std_exit.ml"; "stdLabels.ml"; "stream.ml"; "stringLabels.ml"; "string.ml"; "sys.ml"; "weak.ml"; "unix.ml"; ] (** Transform an exception in a result. *) let result_full_of_exception ctxt e = let backtrace () = if Printexc.backtrace_status () then Some (Printexc.get_backtrace ()) else None in let locate_exn () = if Printexc.backtrace_status () then begin let lst = extract_backtrace_position (Printexc.get_backtrace ()) in let pos_opt = try List.find (function | None -> false | Some (fn, _) -> not (starts_with ~prefix:"oUnit" (Filename.basename fn)) && not (List.mem fn standard_modules)) lst with Not_found -> None in match pos_opt with | Some (filename, line) -> Some {OUnitLogger.filename = filename; line = line} | None -> None end else None in let result = match e with | OUnit_failure s -> RFailure (s, locate_exn (), backtrace ()) | Skip s -> RSkip s | Todo s -> RTodo s | s -> RError (Printexc.to_string s, backtrace ()) in let position = match result with | RSuccess | RSkip _ | RTodo _ | RTimeout _ -> None | RFailure _ | RError _ -> OUnitLogger.position ctxt.logger in ctxt.path, result, position let report_result_full ctxt result_full = let test_path, result, _ = result_full in OUnitLogger.report ctxt.logger (OUnitLogger.TestEvent (test_path, OUnitLogger.EResult result)); result_full (** Isolate a function inside a context, just as [!section_ctxt] but don't propagate a failure, register it for later. *) let non_fatal ctxt f = try section_ctxt ctxt f with e -> let result_full = report_result_full ctxt (result_full_of_exception ctxt e) in OUnitShared.Mutex.with_lock ctxt.shared ctxt.non_fatal_mutex (fun () -> ctxt.non_fatal := result_full :: !(ctxt.non_fatal)) (* Some shorthands which allows easy test construction *) let (>:) s t = TestLabel(s, t) (* infix *) let (>::) s f = TestLabel(s, TestCase(Short, f)) (* infix *) let (>:::) s l = TestLabel(s, TestList(l)) (* infix *) (* Utility function to manipulate test *) let rec test_decorate g = function | TestCase(l, f) -> TestCase (l, g f) | TestList tst_lst -> TestList (List.map (test_decorate g) tst_lst) | TestLabel (str, tst) -> TestLabel (str, test_decorate g tst) (* Return the number of available tests *) let rec test_case_count = function | TestCase _ -> 1 | TestLabel (_, t) -> test_case_count t | TestList l -> List.fold_left (fun c t -> c + test_case_count t) 0 l let string_of_node = function | ListItem n -> string_of_int n | Label s -> s module Path = struct type t = path let compare p1 p2 = Stdlib.compare p1 p2 let to_string p = String.concat ":" (List.rev_map string_of_node p) end module MapPath = Map.Make(Path) let string_of_path = Path.to_string (* Returns all possible paths in the test. The order is from test case to root. *) let test_case_paths test = let rec tcps path test = match test with | TestCase _ -> [path] | TestList tests -> List.concat (mapi (fun t i -> tcps ((ListItem i)::path) t) tests) | TestLabel (l, t) -> tcps ((Label l)::path) t in tcps [] test (* Test filtering with their path *) module SetTestPath = Set.Make(String) let test_filter ?(skip=false) only test = let set_test = List.fold_left (fun st str -> SetTestPath.add str st) SetTestPath.empty only in let rec filter_test path tst = if SetTestPath.mem (string_of_path path) set_test then begin Some tst end else begin match tst with | TestCase (l, _) -> begin if skip then Some (TestCase (l, fun _ -> raise (Skip "Test disabled"))) else None end | TestList tst_lst -> begin let ntst_lst = fold_lefti (fun ntst_lst tst i -> let nntst_lst = match filter_test ((ListItem i) :: path) tst with | Some tst -> tst :: ntst_lst | None -> ntst_lst in nntst_lst) [] tst_lst in if not skip && ntst_lst = [] then None else Some (TestList (List.rev ntst_lst)) end | TestLabel (lbl, tst) -> begin let ntst_opt = filter_test ((Label lbl) :: path) tst in match ntst_opt with | Some ntst -> Some (TestLabel (lbl, ntst)) | None -> if skip then Some (TestLabel (lbl, tst)) else None end end in filter_test [] test
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>