package ppx_inline_test_nobase
Syntax extension for writing in-line tests in ocaml code (with stripped dependencies)
Install
Dune Dependency
Authors
Maintainers
Sources
v0.17+nobase.tar.gz
sha256=325d06a56355e2ad500bf1fb3ddbae8aabb9e9d00713a453bd3da7235bf0ed36
doc/src/ppx_inline_test/ppx_inline_test.ml.html
Source file ppx_inline_test.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
open Ppxlib open Stdppx open Ast_builder.Default (* Generated code should depend on the environment in scope as little as possible. E.g. rather than [foo = []] do [match foo with [] ->], to eliminate the use of [=]. It is especially important to not use polymorphic comparisons, since we are moving more and more to code that doesn't have them in scope. *) type maybe_drop = | Keep | Drop_with_deadcode | Drop let maybe_drop_mode = ref Keep let set_default_maybe_drop x = maybe_drop_mode := x let () = Driver.add_arg "-inline-test-drop" (Unit (fun () -> maybe_drop_mode := Drop)) ~doc:" Drop unit tests"; Driver.add_arg "-inline-test-drop-with-deadcode" (Unit (fun () -> maybe_drop_mode := Drop_with_deadcode)) ~doc: " Drop unit tests by wrapping them inside deadcode to prevent unused variable \ warnings." ;; let () = Driver.Cookies.add_simple_handler "inline-test" Ast_pattern.(pexp_ident (lident __')) ~f:(function | None -> () | Some id -> (match id.txt with | "drop" -> maybe_drop_mode := Drop | "drop_with_deadcode" -> maybe_drop_mode := Drop_with_deadcode | s -> Location.raise_errorf ~loc:id.loc "invalid 'inline-test' cookie (%s), expected one of: drop, \ drop_with_deadcode" s)) ;; (* Same as above, but for the Dune setting *) let () = Driver.Cookies.add_simple_handler "inline_tests" Ast_pattern.(estring __') ~f:(function | None -> () | Some id -> (match id.txt with | "enabled" -> maybe_drop_mode := Keep | "disabled" -> maybe_drop_mode := Drop | "ignored" -> maybe_drop_mode := Drop_with_deadcode | s -> Location.raise_errorf ~loc:id.loc "invalid 'inline_tests' cookie (%s), expected one of: enabled, disabled or \ ignored" s)) ;; let maybe_drop loc code = match !maybe_drop_mode with | Keep -> [%str let () = [%e code]] | Drop_with_deadcode -> [%str let () = if false then [%e code] else ()] | Drop -> Attribute.explicitly_drop#expression code; [%str] ;; let rec short_desc_of_expr ~max_len e = match e.pexp_desc with | Pexp_let (_, _, e) | Pexp_letmodule (_, _, e) -> short_desc_of_expr ~max_len e | _ -> let s = Pprintast.string_of_expression e in let res = if String.length s >= max_len then ( let s_short = String.sub s ~pos:0 ~len:(max_len - 5) in s_short ^ "[...]") else s in String.map res ~f:(function | '\n' -> ' ' | c -> c) ;; let descr ~(loc : Location.t) ?(inner_loc = loc) e_opt id_opt = let filename = loc.loc_start.pos_fname in let line = loc.loc_start.pos_lnum in let start_pos = loc.loc_start.pos_cnum - loc.loc_start.pos_bol in let end_pos = inner_loc.Location.loc_end.pos_cnum - loc.loc_start.pos_bol in let descr = match id_opt with | `Literal id -> estring ~loc id | `Expr e -> e | `None -> estring ~loc (match e_opt with | None -> "" | Some e -> "<<" ^ short_desc_of_expr ~max_len:50 e ^ ">>") in ( pexp_lazy ~loc descr , estring ~loc filename , eint ~loc line , eint ~loc start_pos , eint ~loc end_pos ) ;; let apply_to_descr lid ~loc ?inner_loc e_opt id_opt more_arg = let descr, filename, line, start_pos, end_pos = descr ~loc ?inner_loc e_opt id_opt in let expr = pexp_apply ~loc (evar ~loc ("Ppx_inline_test_lib." ^ lid)) [ Labelled "config", [%expr (module Inline_test_config)] ; Labelled "descr", descr ; Labelled "tags", elist ~loc (List.map ~f:(estring ~loc) tags) ; Labelled "filename", filename ; Labelled "line_number", line ; Labelled "start_pos", start_pos ; Labelled "end_pos", end_pos ; Nolabel, more_arg ] in maybe_drop loc expr ;; let can_use_test_extensions () = match !maybe_drop_mode, Ppx_inline_test_libname.get () with | Keep, None -> false | (Drop | Drop_with_deadcode), _ | _, Some _ -> true ;; (* Set to [true] when we see a [let%test] or [let%expect_test] etc extension. *) module Has_tests = Driver.Create_file_property (struct let name = "ppx_inline_test.has_tests" end) (struct type t = bool let t_of_sexp = Sexplib0.Sexp_conv.bool_of_sexp let sexp_of_t = Sexplib0.Sexp_conv.sexp_of_bool end) let = [ "no-js" ; "js-only" ; "64-bits-only" ; "32-bits-only" ; "fast-flambda" ; "fast-flambda2" ; "x-library-inlining-sensitive" ; "not-on-el7" ; "not-on-el8" ; "disabled" ] ;; let validate_tag tag = if not (List.mem ~set:all_tags tag) then Error (Spellcheck.spellcheck all_tags tag) else Ok () ;; let validate_extension_point_exn ~name_of_ppx_rewriter ~loc ~ = Has_tests.set true; if not (can_use_test_extensions ()) then Location.raise_errorf ~loc "%s: extension is disabled because the tests would be ignored (the build system \ didn't pass -inline-test-lib. With jenga or dune, this usually happens when \ writing tests in files that are part of an executable stanza, but only library \ stanzas support inline tests)" name_of_ppx_rewriter; List.iter tags ~f:(fun tag -> match validate_tag tag with | Ok () -> () | Error hint -> let hint = match hint with | None -> "" | Some hint -> "\n" ^ hint in Location.raise_errorf ~loc "%s: %S is not a valid tag for inline tests.%s" name_of_ppx_rewriter tag hint) ;; let name_of_ppx_rewriter = "ppx_inline_test" let expand_test ~loc ~path:_ ~name:id ~ e = let loc = { loc with loc_ghost = true } in validate_extension_point_exn ~name_of_ppx_rewriter ~loc ~tags; apply_to_descr "test" ~loc (Some e) id tags [%expr fun () -> [%e e]] ;; let expand_test_unit ~loc ~path:_ ~name:id ~ e = let loc = { loc with loc_ghost = true } in validate_extension_point_exn ~name_of_ppx_rewriter ~loc ~tags; (* The "; ()" bit is there to breaks tail call optimization, for better backtraces. *) apply_to_descr "test_unit" ~loc (Some e) id tags [%expr fun () -> [%e e]; ()] ;; let expand_test_module ~loc ~path:_ ~name:id ~ m = let loc = { loc with loc_ghost = true } in validate_extension_point_exn ~name_of_ppx_rewriter ~loc ~tags; apply_to_descr "test_module" ~loc ~inner_loc:m.pmod_loc None id tags (pexp_fun ~loc Nolabel None (punit ~loc) (pexp_letmodule ~loc (Located.mk ~loc (Some "M")) m (eunit ~loc))) ;; module E = struct open Ast_pattern let = Attribute.declare "tags" Attribute.Context.pattern (single_expr_payload (pexp_tuple (many (estring __)) ||| map (estring __) ~f:(fun f x -> f [ x ]))) (fun x -> x) ;; let list_of_option = function | None -> [] | Some x -> x ;; let opt_name () = map (pstring __) ~f:(fun f x -> f (`Literal x)) ||| map ppat_any ~f:(fun f -> f `None) ||| map (ppat_extension (extension (cst ~to_string:Fn.id "name") (single_expr_payload __))) ~f:(fun f e -> f (`Expr e)) ;; let opt_name_and_expr expr = pstr (pstr_value nonrecursive (value_binding ~pat: (map (Attribute.pattern tags (opt_name ())) ~f:(fun f attributes name_opt -> f ~name:name_opt ~tags:(list_of_option attributes))) ~expr ^:: nil) ^:: nil) ;; let test = Extension.declare_inline "inline_test.test" Extension.Context.structure_item (opt_name_and_expr __) expand_test ;; let test_unit = Extension.declare_inline "inline_test.test_unit" Extension.Context.structure_item (opt_name_and_expr __) expand_test_unit ;; let test_module = Extension.declare_inline "inline_test.test_module" Extension.Context.structure_item (opt_name_and_expr (pexp_pack __)) expand_test_module ;; let all = [ test; test_unit; test_module ] end let = E.tags let () = Driver.V2.register_transformation "inline-test" ~extensions:E.all ~enclose_impl:(fun ctxt loc -> match loc, Ppx_inline_test_libname.get () with | None, _ | _, None -> [], [] | Some loc, Some (libname, partition_opt) -> let partition = match partition_opt with | None -> Stdlib.Filename.basename (Expansion_context.Base.input_name ctxt) | Some p -> p in let loc = { loc with loc_ghost = true } in (* See comment in benchmark_accumulator.ml *) let header = let loc = { loc with loc_end = loc.loc_start } in maybe_drop loc [%expr Ppx_inline_test_lib.set_lib_and_partition [%e estring ~loc libname] [%e estring ~loc partition]] and = let loc = { loc with loc_start = loc.loc_end } in maybe_drop loc [%expr Ppx_inline_test_lib.unset_lib [%e estring ~loc libname]] in header, footer) ;;
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>