File: TestPluginOCamlbuild.ml

package info (click to toggle)
oasis 0.4.11-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,752 kB
  • sloc: ml: 38,989; sh: 192; makefile: 122; ansic: 67
file content (267 lines) | stat: -rw-r--r-- 10,031 bytes parent folder | download | duplicates (3)
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
(******************************************************************************)
(* 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              *)
(******************************************************************************)

open FileUtil
open OUnit2
open TestCommon
open OASISPlugin
open OASISFileTemplate
open TestFullUtils


let all_tests =
  [
    "set-ocamlfind",
    (fun test_ctxt t ->
       let () =
         skip_if
           (OASISVersion.StringVersion.compare t.ocaml_version "3.12.1" < 0)
           "OCaml >= 3.12.1 needed."
       in
       let real_ocamlfind = FileUtil.which "ocamlfind" in
       let fake_ocamlfind =
         Filename.concat t.bin_dir (Filename.basename real_ocamlfind)
       in
       let extra_env = ["REAL_OCAMLFIND", real_ocamlfind] in
       let () =
         oasis_setup test_ctxt t;
         FileUtil.cp [fake_ocamlfind_exec test_ctxt] fake_ocamlfind;
         Unix.chmod fake_ocamlfind 0o755;
         run_ocaml_setup_ml ~with_ocaml_env:true ~extra_env test_ctxt t
           ["-configure"]
       in
       let env = BaseEnvLight.load ~filename:(in_src_dir t "setup.data") () in
       let () =
         assert_equal ~printer:(Printf.sprintf "%S")
           fake_ocamlfind
           (BaseEnvLight.var_get "ocamlfind" env);
         run_ocaml_setup_ml ~extra_env test_ctxt t ["-build"]
       in
       let build_log =
         file_content (in_src_dir t (Filename.concat "_build" "_log"))
       in
         logf test_ctxt `Info "%s" build_log;
         List.iter
           (fun line ->
              if OASISString.contains ~what:"ocamlfind" line then
                assert_bool
                  (Printf.sprintf
                     "line %S should starts with %S"
                     line fake_ocamlfind)
                  (OASISString.starts_with ~what:fake_ocamlfind line))
           (OASISString.nsplit build_log '\n'));

    "use-ocamlfind",
    (fun test_ctxt t ->
       oasis_setup test_ctxt t;
       run_ocaml_setup_ml ~check_output:true test_ctxt t
         ["-configure"; "--enable-docs"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t
         ["-build"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t
         ["-doc"]);

    (* This test changes a c-source file and asserts that an executable
       depending on a library which uses this c-file is re-linked
       properly
       TODO: reassert that this test fails without the fix in cb96135a
       TODO: test is flaky.
     *)
    "external-c-rebuild",
    (fun test_ctxt t ->
       let () = skip_if true "to be fixed" in

       (* contain c-source code here to avoid any problems with
          aborted evaluation *)
       let code_a = "#include \"header.h\"\n\
                     CAMLprim value oasis_c_build_test_foo(value x) {\n\
                       CAMLparam1(x);\n\
                       CAMLreturn(Val_int(42));\n\
                     }\n"

       and code_b = "#include \"header.h\"\n\
                     CAMLprim value oasis_c_build_test_foo(value x) {\n\
                       CAMLparam1(x);\n\
                       CAMLreturn(Val_int(23));\n\
                     }\n"
       in
       let c_source = (in_src_dir t "c_source.c") in

       oasis_setup test_ctxt t;

       begin
         let c = open_out c_source in
           Printf.fprintf c "%s\n" code_a;
           close_out c
       end;

       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-configure" ];
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"];

       (* first, compile and assert everything worked *)
       assert_bool "File 'B.native' has been created"
         (Sys.file_exists (in_src_dir t "B.native"));

       assert_command
         ~ctxt:test_ctxt
         ~chdir:t.src_dir
         ~exit_code:(Unix.WEXITED 42)
         (in_src_dir t "B.native")
         [];

       (* change c-file, rebuild and assert result-code *)
       begin
         let c = open_out c_source in
           Printf.fprintf c "%s\n" code_b;
           close_out c
       end;

       (* uncomment to make this test succeed *)
       (* run_ocaml_setup_ml ~check_output:true test_ctxt t ["-clean"]; *)
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"];

       assert_command
         ~ctxt:test_ctxt
         ~chdir:t.src_dir
         ~exit_code:(Unix.WEXITED 23)
         (in_src_dir t "B.native")
         []
    );

    "env-tags",
    (fun test_ctxt t ->
       let tests_tag_detected_fn = in_src_dir t "tests-tag-detected" in
       oasis_setup test_ctxt t;

       run_ocaml_setup_ml
         ~check_output:true test_ctxt t ["-configure"; "--enable-tests"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"];
       assert_bool
         "tests-tag-detected should be existed."
         (Sys.file_exists tests_tag_detected_fn);

       rm [tests_tag_detected_fn];
       run_ocaml_setup_ml
         ~check_output:true test_ctxt t ["-configure"; "--disable-tests"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"];
       assert_bool
         "tests-tag-detected should not be existed."
         (not (Sys.file_exists tests_tag_detected_fn)));

    (* This test checks that the "no_automatic_syntax" AlphaFeature doesn't
       disable the pkg_* flag injection that is necessary for OCaml < 3.12.1 *)
    "pr63-no-automatic-syntax",
    (fun test_ctxt t ->
       oasis_setup test_ctxt t;
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-configure"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"]);

    "pr61-pass-thread-to-C-files",
    (fun test_ctxt _ ->
      let t =
         setup_test_directories test_ctxt
           ~is_native:(is_native test_ctxt)
           ~native_dynlink:(native_dynlink test_ctxt)
           (in_testdata_dir test_ctxt
              ["TestPluginOCamlbuild"; "pr61-pass-thread-to-C-files"])
       in
       oasis_setup test_ctxt t;
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-configure"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"]);

    "bug1659-ocamlbuild-support-plugins",
    (fun test_ctxt _ ->
      let t =
         setup_test_directories test_ctxt
           ~is_native:(is_native test_ctxt)
           ~native_dynlink:(native_dynlink test_ctxt)
           (in_testdata_dir test_ctxt
              ["TestPluginOCamlbuild"; "bug1659-ocamlbuild-support-plugins"])
       in
       oasis_setup test_ctxt t;
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-configure"];
       run_ocaml_setup_ml ~check_output:true test_ctxt t ["-build"]);
  ]

let other_tests =
  [
    "missing-source",
    (fun test_ctxt ->
       let dn =
         in_testdata_dir test_ctxt ["TestPluginOCamlbuild"; "missing-source"]
       in
       let fn = Filename.concat dn OASISParse.default_oasis_fn in
       let pkg = OASISParse.from_file ~ctxt:(oasis_ctxt test_ctxt) fn in
       let ctxt, _ =
         with_bracket_chdir test_ctxt dn
           (fun _ ->
              BaseSetup.of_package
                ~setup_update:false OASISSetupUpdate.NoUpdate pkg)
       in
       let () =
         assert_bool "No error during generation." (not ctxt.error)
       in
       let tmpl = find "test.mllib" ctxt.files in
         match tmpl.body with
           | Body lst | BodyWithDigest (_, lst) ->
               assert_equal
                 ~printer:(fun lst ->
                             String.concat ", "
                               (List.map (Printf.sprintf "%S") lst))
                 ["A"; "B"; "C"]
                 (List.sort String.compare lst);
           | NoBody ->
             assert_failure "No content for test.mllib.");

    "quote_parametrized_plugin",
    (fun _ ->
       ());
  ]

let gen_test (nm, f) =
  nm >::
  (fun test_ctxt ->
     let () = skip_long_test test_ctxt in
     let t =
       setup_test_directories test_ctxt
         ~is_native:(is_native test_ctxt)
         ~native_dynlink:(native_dynlink test_ctxt)
         (in_testdata_dir test_ctxt ["TestPluginOCamlbuild"; nm])
     in
       f test_ctxt t)

let tests =
  "Plugin OCamlbuild" >:::
  List.flatten
    [
      [
        "all_TestOCamlbuild" >::
        (fun test_ctxt ->
           all_subdirectories test_ctxt
             (in_testdata_dir test_ctxt ["TestPluginOCamlbuild"])
             ((List.map fst all_tests)
             @ (List.map fst other_tests))
           (Printf.sprintf "test/data/TestPluginOCamlbuild/%s is not tested."));
      ];
      List.map gen_test all_tests;
      List.map (fun (nm, f) -> nm >:: f) other_tests;
  ]