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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
(******************************************************************************)
(* OASIS: architecture for building OCaml libraries and applications *)
(* *)
(* Copyright (C) 2011-2016, Sylvain Le Gall *)
(* Copyright (C) 2008-2011, OCamlCore SARL *)
(* *)
(* This library is free software; you can redistribute it and/or modify it *)
(* under the terms of the GNU Lesser General Public License as published by *)
(* the Free Software Foundation; either version 2.1 of the License, or (at *)
(* your option) any later version, with the OCaml static compilation *)
(* exception. *)
(* *)
(* This library is distributed in the hope that it will be useful, but *)
(* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *)
(* or FITNESS FOR A PARTICULAR PURPOSE. See the file COPYING for more *)
(* details. *)
(* *)
(* You should have received a copy of the GNU Lesser General Public License *)
(* along with this library; if not, write to the Free Software Foundation, *)
(* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *)
(******************************************************************************)
(** End to end tests for examples/ sub-directories.
Tests in this file run end to end compilation with OASIS for sub-directories
found in examples/.
@author Sylvain Le Gall
*)
open OUnit2
open TestCommon
open TestFullUtils
let all_tests =
[
"flags",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/simplelib/simplelib.mllib";
"src/simplelib/simplelib.mldylib";
"src/simplelib/simplelib.odocl";
"src/simplelibext/simplelibext.mllib";
"src/simplelibext/simplelibext.mldylib";
"src/simplelibext/simplelibext.odocl";
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("simplelib",
["simplelib.cma";
"Foo.cmi"; "Foo.ml"; "Foo.annot"; "Foo.cmt";
"Bar.cmi"; "Bar.ml"; "Bar.annot"; "Bar.cmt";
"META";
"simplelib.cmxa";
"simplelib.cmxs";
"Foo.cmx"; "Bar.cmx";
"simplelib.a"]);
InstalledOCamlLibrary
("simplelibext",
["simplelibext.cma";
"FooExt.cmi"; "FooExt.ml"; "FooExt.annot";
"FooExt.cmt";
"BarExt.cmi"; "BarExt.ml"; "BarExt.annot";
"BarExt.cmt";
"META";
"simplelibext.cmxa";
"simplelibext.cmxs";
"FooExt.cmx"; "BarExt.cmx";
"simplelibext.a"]);
InstalledAPIRef("simplelib", ["Foo"; "Bar"]);
InstalledAPIRef("simplelibext", ["FooExt"; "BarExt"]);
];
(* Run standard test. *)
standard_test test_ctxt t);
(* Complete library *)
"simplelib",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/simplelib.mllib";
"src/simplelib.mldylib";
"src/simplelib.odocl";
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("simplelib" ,
["simplelib.cma";
"foo.cmi"; "foo.mli"; "foo.annot"; "foo.cmt"; "foo.cmti";
"bar.cmi"; "bar.mli"; "bar.annot"; "bar.cmt"; "bar.cmti";
"META";
"simplelib.cmxa";
"simplelib.cmxs";
"foo.cmx"; "bar.cmx";
"simplelib.a"]);
InstalledAPIRef("simplelib", ["Bar"; "Foo"]);
];
(* Run standard test. *)
standard_test test_ctxt t);
(* Packed library *)
"packedlib",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
["src/packedlib.mlpack";
"src/packedlib.mllib";
"src/packedlib.mldylib";
"src/META"]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("packedlib",
["packedlib.cma"; "packedlib.cmi"; "packedlib.cmx";
"foo.mli"; "bar.mli"; "Baz.ml"; "META";
"packedlib.cmxa"; "packedlib.cmxs";
"packedlib.a";
"Baz.annot"; "Baz.cmt"; "bar.annot"; "bar.cmt"; "bar.cmti";
"foo.annot"; "foo.cmt"; "foo.cmti"])
];
if OASISVersion.StringVersion.compare t.ocaml_version "4.02" >= 0 then begin
register_installed_files
test_ctxt
t
[InstalledOCamlLibrary("packedlib", ["packedlib.cmt"])]
end;
(* Run standard test. *)
standard_test test_ctxt t;
try_installed_library test_ctxt t "packedlib" ["Packedlib.Foo"]);
(* Complete library with findlib package to check *)
"findlib",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t oasis_ocamlbuild_files;
(* Run standard test. *)
standard_test test_ctxt t);
(* Complete library with custom build system *)
"custom",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("simplelib",
["simplelib.cma";
"foo.cmi"; "foo.mli";
"bar.cmi"; "bar.mli";
"META"])
];
(* Run standard test. *)
standard_test test_ctxt t);
(* Library/executable using C files *)
"with-c",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/META";
"src/libtest-with-c-custom_stubs.clib";
"src/libtest-with-c-native_stubs.clib";
"src/libtest-with-c_stubs.clib";
"src/libwith-c_stubs.clib";
"src/with-c.mllib";
"src/with-c.mldylib";
"src/with-c.odocl";
]);
if t.is_native then
register_installed_files test_ctxt t
[InstalledBin ["test-with-c-native"]];
register_installed_files test_ctxt t
[
InstalledBin ["test-with-c"; "test-with-c-custom"];
InstalledLibrary ["with-c/dlltest-with-c_stubs.so"];
InstalledOCamlLibrary
("with-c",
["A.cmi"; "A.ml"; "META"; "with-c.cma";
"libwith-c_stubs.a"; "dllwith-c_stubs.so";
"with-c.a"; "A.cmx"; "with-c.cmxa"; "with-c.cmxs";
"A.annot"; "A.cmt"]);
InstalledAPIRef("with-c", ["A"]);
];
if OASISVersion.StringVersion.compare t.ocaml_version "4.00" < 0 then
register_installed_files test_ctxt t
[InstalledHTML("with-c", ["code_VALA.ident.html"])];
(* Run standard test. *)
standard_test test_ctxt t;
(* Try the result. *)
if t.is_native then
try_installed_exec test_ctxt t "test-with-c-native" [];
try_installed_exec test_ctxt t "test-with-c-custom" [];
try_installed_exec test_ctxt t "test-with-c" [];
try_installed_library test_ctxt t "with-c" ["A"]);
(* Library/executable using data files *)
"with-data",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/META";
"src/test.mllib";
"src/test.mldylib";
"src/test.odocl";
]);
register_installed_files test_ctxt t
[
InstalledBin ["test"];
InstalledOCamlLibrary
("test",
[
"test.ml"; "test.cmi"; "META"; "test.cma";
"test.annot"; "test.cmt"
]);
InstalledData
["with-data/test.txt";
"doc/html/test.html";
"with-data-0.1/test.txt"];
InstalledAPIRef("test", ["Test"]);
];
(* Run standard test. *)
standard_test test_ctxt t;
(* Try the result. *)
try_installed_library test_ctxt t "test" ["Test"]);
(* Library with a pure interface module in subdirectory. *)
"with-interface-module",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/META";
"src/pimlib.mllib";
"src/pimlib.mldylib";
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("pimlib",
["META";
"pimlib.cma"; "pimlib.cmxa"; "pimlib.a"; "pimlib.cmxs";
"pim_impl.mli"; "pim_impl.cmi"; "pim_impl.cmx";
"pim_intf.mli"; "pim_intf.cmi";
"pim_types.mli"; "pim_types.cmi";
"pim_impl.annot"; "pim_impl.cmt"; "pim_impl.cmti";
"pim_intf.cmti"; "pim_types.cmti"]);
];
(* Run standard test. *)
standard_test test_ctxt t;
(* Try the result. *)
try_installed_library test_ctxt t "pimlib" ["Pim_intf"; "Pim_impl"]);
(* Test executable *)
"with-test",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t oasis_ocamlbuild_files;
(* Run standard test. *)
standard_test test_ctxt t);
(* Use sub-packages *)
"with-subpackage",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/META";
"src/test.mllib";
"src/test.mldylib";
"src/test.odocl";
"src/syntax/pa_test.mllib";
"src/syntax/pa_test.mldylib";
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("test",
["META"; "test.cma"; "pa_test.cma";
"A.ml"; "A.cmi"; "B.ml"; "B.cmi";
"pa_test.ml"; "pa_test.cmi";
"test.cmxa"; "test.cmxs"; "A.cmx"; "B.cmx";
"test.a";
"A.annot"; "A.cmt"; "B.annot"; "B.cmt";
"pa_test.annot"; "pa_test.cmt"]);
InstalledAPIRef
("test", ["A"; "B"]);
];
(* Run standard test. *)
standard_test test_ctxt t;
(* Try the result. *)
try_installed_library test_ctxt t "test" ["A"; "B"]);
(* Interdependencies *)
"interdepend-libraries",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/interdepend.odocl";
"src/liba/liba.mllib";
"src/liba/liba.mldylib";
"src/libb/libb.mllib";
"src/libb/libb.mldylib";
"src/libc/libc.mllib";
"src/libc/libc.mldylib";
"src/libd/libd.mllib";
"src/libd/libd.mldylib";
"src/libe/libe.mllib";
"src/libe/libe.mldylib";
]);
(* Run standard test. *)
standard_test test_ctxt t);
(* Build order *)
"order-matter",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/order-matter.odocl";
"src/foo/foo.mllib";
"src/foo/foo.mldylib";
"src/bar/bar.mllib";
"src/bar/bar.mldylib";
"src/baz/baz.mllib";
"src/baz/baz.mldylib";
]);
(* Run standard test. *)
standard_test test_ctxt t);
"syntax-camlp4",
(fun test_ctxt t ->
let () =
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/META";
"src/pi.mllib";
"src/pi.mldylib";
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("syntax-camlp4",
["META"; "pi.ml"; "pi.cmi"; "pi.cma";
"pi.cmx"; "pi.cmxa"; "pi.cmxs";
"pi.a";
"pi.annot"; "pi.cmt"]);
];
(* Run standard test. *)
standard_test test_ctxt t;
try_installed_library test_ctxt t "syntax-camlp4.syntax" []
in
(* Check what happens when link all is set. *)
let srcdir = bracket_tmpdir test_ctxt in
let fn = FilePath.concat srcdir "foo.ml" in
let exec_byte = FilePath.replace_extension fn "byte" in
FileUtil.cp
[in_example_dir test_ctxt
["syntax-camlp4"; "test"; "data"; "foo.ml"]]
fn;
assert_compile test_ctxt t "syntax-camlp4.syntax"
"ocamlc" ["-o"; exec_byte;
"-linkall"; "-linkpkg"; "-syntax"; "camlp4o"; fn];
assert_bool
("Executable is not linked with camlp4")
(not (contains_string fn "Camlp4")));
"object",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
["src1/META"; "src2/META"; "src2/packed_modules.mlpack"]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("single_module",
["META"; "single.o" ; "single.mli"; "single.cmx"; "single.cmo";
"single.cmi"]);
InstalledOCamlLibrary
("packed_modules",
["packed_modules.o"; "packed_modules.cmx";
"packed_modules.cmo"; "packed_modules.cmi";
"m1.ml"; "m2.mli"; "META"]);
];
(* Run standard test. *)
standard_test test_ctxt t);
"ocamlbuild",
(fun test_ctxt t ->
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @ [
"src/test.mldylib"; "src/test.mllib"; "src/META"]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("test",
["test.ml"; "test.a"; "test.annot"; "test.cma"; "test.cmi";
"test.cmt"; "test.cmx"; "test.cmxa"; "test.cmxs"; "META"]);
];
(* Run standard test. *)
standard_test test_ctxt t);
]
let tests_match_native =
[
"plugins/oasis-plugin-print-hello",
(fun test_ctxt t ->
let assert_oasis_cli_output_contains args lst =
let _, extra_env = TestFullUtils.ocaml_env test_ctxt t in
assert_oasis_cli ~extra_env ~ctxt:test_ctxt ~output_contains:lst args
in
let t = install_oasis_library test_ctxt t in
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/lib/oasis-plugin-print-hello/oasis-plugin-print-hello.mldylib";
"src/lib/oasis-plugin-print-hello/oasis-plugin-print-hello.mllib";
"src/lib/oasis-plugin-print-hello/META"
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("oasis-plugin-print-hello",
["OASISPluginPrintHello.ml";
"OASISPluginPrintHello.annot";
"OASISPluginPrintHello.cmi";
"OASISPluginPrintHello.cmt";
"OASISPluginPrintHello.cmx";
"oasis-plugin-print-hello.a";
"oasis-plugin-print-hello.cma";
"oasis-plugin-print-hello.cmxa";
"oasis-plugin-print-hello.cmxs";
"META"]);
];
(* Run standard test. *)
standard_test test_ctxt t;
assert_oasis_cli_output_contains ["--help"] ["print-hello"];
assert_oasis_cli_output_contains ["print-hello"] ["Hello"]);
"plugins/oasis-plugin-versionfile",
(fun test_ctxt t ->
let t = install_oasis_library test_ctxt t in
let with_versionfile_plugin_dir =
Filename.concat t.src_dir "with-versionfile-plugin"
in
oasis_setup test_ctxt t;
(* Setup expectation. *)
register_generated_files t
(oasis_ocamlbuild_files @
[
"src/lib/oasis-plugin-versionfile/oasis-plugin-versionfile.mldylib";
"src/lib/oasis-plugin-versionfile/oasis-plugin-versionfile.mllib";
"src/lib/oasis-plugin-versionfile/META"
]);
register_installed_files test_ctxt t
[
InstalledOCamlLibrary
("oasis-plugin-versionfile",
["OASISPluginVersionFile.ml";
"OASISPluginVersionFile.annot";
"OASISPluginVersionFile.cmi";
"OASISPluginVersionFile.cmt";
"OASISPluginVersionFile.cmx";
"OASISPluginVersionFileConf.cmx";
"OASISPluginVersionFileData.cmx";
"OASISPluginVersionFileGettext.cmx";
"oasis-plugin-versionfile.a";
"oasis-plugin-versionfile.cma";
"oasis-plugin-versionfile.cmxa";
"oasis-plugin-versionfile.cmxs";
"META"]);
];
(* Run standard test. *)
standard_test test_ctxt t;
(* Copy the other package into the temporary source, to test it. *)
FileUtil.cp
~recurse:true
[in_example_dir test_ctxt ["plugins"; "with-plugin-versionfile"]]
with_versionfile_plugin_dir;
(* Try to setup the package. *)
assert_oasis_cli
~chdir:with_versionfile_plugin_dir
~extra_env:(snd (TestFullUtils.ocaml_env test_ctxt t))
~ctxt:test_ctxt
["setup"];
begin
let tgt = Filename.concat with_versionfile_plugin_dir "myversion.ml" in
assert_bool
(Printf.sprintf "File %S hasn't been created" tgt)
(Sys.file_exists tgt)
end;
)
]
let gen_tests ?is_native tests =
let runner (nm, f) =
("examples/"^nm) >::
(fun test_ctxt ->
let () = skip_long_test test_ctxt in
let is_native =
match is_native with
| Some b -> b
| None -> TestCommon.is_native test_ctxt
in
let t =
setup_test_directories test_ctxt ~is_native
~native_dynlink:is_native
(in_example_dir test_ctxt [nm])
in
let pkg =
OASISParse.from_file
~ctxt:(oasis_ctxt test_ctxt)
(in_src_dir t OASISParse.default_oasis_fn)
in
assert_equal
~msg:"Latest OASIS version"
~cmp:(fun v1 v2 -> OASISVersion.version_compare v1 v2 = 0)
OASISConf.version_short pkg.OASISTypes.oasis_version;
f test_ctxt t)
in
List.map runner tests
let tests =
"TestExamples" >:::
[
"best=native">:::
(skip_test_on_non_native_arch
(gen_tests ~is_native:true all_tests));
"best=byte">:::
(gen_tests ~is_native:false all_tests);
"best=matching" >:::
(gen_tests tests_match_native);
"all_examples">::
(fun test_ctxt ->
all_subdirectories test_ctxt
(in_example_dir test_ctxt [])
("plugins" :: "oasis" :: List.map fst all_tests)
(Printf.sprintf "examples/%s is not tested."));
"examples/oasis">::
(fun test_ctxt ->
let dn = in_example_dir test_ctxt ["oasis"] in
Array.iter
(fun bn ->
let fn = Filename.concat dn bn in
non_fatal test_ctxt
(fun test_ctxt ->
try
let _pkg: OASISTypes.package =
OASISParse.from_file ~ctxt:(oasis_ctxt test_ctxt) fn
in
()
with e ->
assert_failure
(Printf.sprintf "Parsing error of %s: %s."
("oasis/"^bn) (Printexc.to_string e))))
(Sys.readdir dn));
]
|
