File: process.ml

package info (click to toggle)
ocaml-luv 0.5.14-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,504 kB
  • sloc: ml: 11,130; makefile: 6,223; sh: 4,592; ansic: 1,517; python: 38
file content (368 lines) | stat: -rw-r--r-- 11,175 bytes parent folder | download | duplicates (2)
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
(* This file is part of Luv, released under the MIT license. See LICENSE.md for
   details, or visit https://github.com/aantron/luv/blob/master/LICENSE.md. *)



open Test_helpers

let tests = [
  "process", [
    "basic", `Quick, begin fun () ->
      Luv.Process.spawn "echo" ["echo"; "-n"]
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      run ()
    end;

    "on_exit", `Quick, begin fun () ->
      let called = ref false in

      let result =
        Luv.Process.spawn "echo" ["echo"; "-n"]
            ~on_exit:begin fun process ~exit_status ~term_signal:_ ->

          Alcotest.(check int64) "exit status" 0L exit_status;
          Luv.Handle.close process ignore;
          called := true
        end
      in
      check_success_result "spawn" result |> ignore;

      run ();

      Alcotest.(check bool) "called" true !called
    end;

    "exception", `Quick, begin fun () ->
      check_exception Exit begin fun () ->
        ignore @@
        check_success_result "spawn" @@
        Luv.Process.spawn "echo" ["echo"; "-n"]
            ~on_exit:begin fun process ~exit_status:_ ~term_signal:_ ->

          Luv.Handle.close process ignore;
          raise Exit
        end;

        run ()
      end
    end;

    "redirect to fd", `Quick, begin fun () ->
      let parent_end, child_end = Unix.(socketpair PF_UNIX SOCK_STREAM) 0 in
      let child_end_raw : int = Obj.magic child_end in
      let parent_end_file : Luv.File.t = Obj.magic parent_end in
      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in
      Luv.Pipe.open_ parent_end parent_end_file
      |> check_success_result "pipe open";

      Luv.Process.(spawn
        "echo" ["echo"; "-n"; "foo"]
        ~redirect:[inherit_fd ~fd:stdout ~from_parent_fd:child_end_raw ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      Unix.close child_end;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        check_success_result "read" result
        |> Luv.Buffer.size
        |> Alcotest.(check int) "byte count" 3;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished
    end;

    "redirect to stream", `Quick, begin fun () ->
      let parent_end, child_end = Unix.(socketpair PF_UNIX SOCK_STREAM) 0 in
      let parent_end_file : Luv.File.t = Obj.magic parent_end in
      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in
      Luv.Pipe.open_ parent_end parent_end_file
      |> check_success_result "pipe open";
      let child_end_file : Luv.File.t = Obj.magic child_end in
      let child_end = Luv.Pipe.init () |> check_success_result "pipe init" in
      Luv.Pipe.open_ child_end child_end_file
      |> check_success_result "pipe open";

      Luv.Process.(spawn
        "echo" ["echo"; "-n"; "foo"]
        ~redirect:[inherit_stream ~fd:stdout ~from_parent_stream:child_end ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      Luv.Handle.close child_end ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        check_success_result "read" result
        |> Luv.Buffer.size
        |> Alcotest.(check int) "byte count" 3;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished
    end;

    "create pipe", `Quick, begin fun () ->
      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in

      Luv.Process.(spawn
        "echo" ["echo"; "-n"; "foo"]
        ~redirect:[to_parent_pipe ~fd:stdout ~parent_pipe:parent_end ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        check_success_result "read" result
        |> Luv.Buffer.size
        |> Alcotest.(check int) "byte count" 3;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished
    end;

    "set environment variable", `Quick, begin fun () ->
      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in

      Luv.Process.(spawn
        "printenv" ["printenv"; "FOO"]
        ~environment:["FOO", "foobar"]
        ~redirect:[to_parent_pipe ~fd:stdout ~parent_pipe:parent_end ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        check_success_result "read" result
        |> Luv.Buffer.size
        |> Alcotest.(check int) "byte count" 7;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished
    end;

    "inherit environment", `Quick, begin fun () ->
      Unix.putenv "FOO" "foobar";
      Alcotest.(check string) "FOO" "foobar" (Unix.getenv "FOO");

      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in

      Luv.Process.(spawn
        "printenv" ["printenv"; "FOO"]
        ~redirect:[to_parent_pipe ~fd:stdout ~parent_pipe:parent_end ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        check_success_result "read" result
        |> Luv.Buffer.size
        |> Alcotest.(check int) "byte count" 7;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished;

      Unix.putenv "FOO" ""
    end;

    "clear environment", `Quick, begin fun () ->
      Unix.putenv "FOO" "foobar";
      Alcotest.(check string) "FOO" "foobar" (Unix.getenv "FOO");

      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in
      let exit_code = ref None in

      let result =
        Luv.Process.(spawn
          "printenv" ["printenv"; "FOO"]
          ~environment:[]
          ~redirect:[to_parent_pipe ~fd:stdout ~parent_pipe:parent_end ()]
          ~on_exit:begin fun process ~exit_status ~term_signal:_ ->
            Luv.Handle.close process ignore;
            exit_code := Some exit_status
          end)
      in
      check_success_result "spawn" result |> ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        check_error_result "read" `EOF result;
        finished := true
      end;

      run ();

      Alcotest.(check (option int64)) "exit code" (Some 1L) !exit_code;
      Alcotest.(check bool) "finished" true !finished;

      Unix.putenv "FOO" ""
    end;

    "set working directory", `Quick, begin fun () ->
      let child_working_directory = Filename.dirname (Sys.getcwd ()) in

      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in

      Luv.Process.(spawn
        "pwd" ["pwd"]
        ~working_directory:child_working_directory
        ~redirect:[to_parent_pipe ~fd:stdout ~parent_pipe:parent_end ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        let data = check_success_result "read" result in
        Luv.Buffer.sub data ~offset:0 ~length:(Luv.Buffer.size data - 1)
        |> Luv.Buffer.to_string
        |> Alcotest.(check string) "data" child_working_directory;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished
    end;

    "inherit working directory", `Quick, begin fun () ->
      let parent_working_directory = Sys.getcwd () in

      let parent_end = Luv.Pipe.init () |> check_success_result "pipe init" in

      Luv.Process.(spawn
        "pwd" ["pwd"]
        ~redirect:[to_parent_pipe ~fd:stdout ~parent_pipe:parent_end ()])
      |> check_success_result "spawn"
      |> fun p -> Luv.Handle.close p ignore;

      let finished = ref false in

      Luv.Stream.read_start parent_end begin fun result ->
        Luv.Handle.close parent_end ignore;
        let data = check_success_result "read" result in
        Luv.Buffer.sub data ~offset:0 ~length:(Luv.Buffer.size data - 1)
        |> Luv.Buffer.to_string
        |> Alcotest.(check string) "data" parent_working_directory;
        finished := true
      end;

      run ();

      Alcotest.(check bool) "finished" true !finished
    end;

    "failure", `Quick, begin fun () ->
      Luv.Process.spawn "./nonexistent" ["nonexistent"]
      |> check_error_result "spawn" `ENOENT
    end;

    "failure handle leak", `Quick, begin fun () ->
      no_memory_leak begin fun _ ->
        Luv.Process.spawn "./nonexistent" ["nonexistent"]
        |> check_error_result "spawn" `ENOENT;

        run ()
      end
    end;

    "failure callback leak", `Quick, begin fun () ->
      let called = ref false in

      no_memory_leak begin fun _ ->
        Luv.Process.spawn "./nonexistent" ["nonexistent"]
            ~on_exit:begin fun _ ~exit_status:_ ~term_signal:_ ->

          called := true
        end
        |> check_error_result "spawn" `ENOENT;

        run ()
      end;

      Alcotest.(check bool) "not called" false !called
    end;

    "kill", `Quick, begin fun () ->
      let received_signal = ref None in

      let result =
        Luv.Process.spawn "cat" ["cat"]
            ~on_exit:begin fun process ~exit_status:_ ~term_signal ->

          Luv.Handle.close process ignore;
          received_signal := Some term_signal
        end
      in
      let process = check_success_result "spawn" result in

      Luv.Process.kill process Luv.Signal.sighup
      |> check_success_result "kill";

      run ();

      (* The terminating signal is sometimes reported as 0 in Travis, for
         reasons not yet known to me. *)
      match !received_signal with
      | Some signal when signal = Luv.Signal.sighup -> ()
      | Some 0 -> ()
      | _ -> Alcotest.fail "Unexpected signal or signal"
    end;

    "pid, kill_pid", `Quick, begin fun () ->
      let received_signal = ref None in

      let result =
        Luv.Process.spawn "cat" ["cat"]
            ~on_exit:begin fun process ~exit_status:_ ~term_signal ->

          Luv.Handle.close process ignore;
          received_signal := Some term_signal
        end
      in
      let process = check_success_result "spawn" result in

      Luv.Process.(kill_pid ~pid:(pid process)) Luv.Signal.sighup
      |> check_success_result "kill_pid";

      run ();

      (* The terminating signal is sometimes reported as 0 in Travis, for
         reasons not yet known to me. *)
      match !received_signal with
      | Some signal when signal = Luv.Signal.sighup -> ()
      | Some 0 -> ()
      | _ -> Alcotest.fail "Unexpected signal or signal"
    end;
  ]
]