module Ketrew_host_io: sig .. end
Definition of a host; a place to run commands or handle files.
module Ssh: sig .. end
Helper functions to build SSH commands.
module Error: sig .. end
val default_timeout_upper_bound : float Pervasives.ref
Default (upper bound) of the `?timeout` arguments.
type [ `At_most_seconds of float | `Host_default | `None | `Seconds of float ]
Timeout specification for execution functions below.
`Host_default → use the excution_timeout value of the host. `None → force no timeout even if the host has a execution_timeout.`Seconds f → use f seconds as timeout.`At_most_seconds f -> use f seconds, unless the host has a smaller
execution_timeout field.
The default value is
`At_most_seconds !default_timeout_upper_bound.
val execute : ?timeout:timeout ->
Ketrew_host.t ->
string list ->
(< exited : int; stderr : string; stdout : string >,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution ])
Ketrew_unix_io.Deferred_result.t
Generic execution which tries to behave like Unix.execv even
on top of SSH.
type string -> string list
A “shell” is a function that takes a command and returns, and
execv-style string list; the default for each host
is "sh"; "-c"; cmd
val shell_sh : sh:string -> shell
Call sh-style commands using the command argument (e.g. shell_sh "/bin/sh"
for a known path or command).
val get_shell_command_output : ?timeout:timeout ->
?with_shell:shell ->
Ketrew_host.t ->
string ->
(string * string,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Non_zero of string * int
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution Error.non_zero_execution ])
Ketrew_unix_io.Deferred_result.t
Run a shell command on the host, and return its (stdout, stderr) pair
(succeeds iff the exit status is 0).
val get_shell_command_return_value : ?timeout:timeout ->
?with_shell:shell ->
Ketrew_host.t ->
string ->
(int,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution ])
Ketrew_unix_io.Deferred_result.t
Run a shell command on the host, and return its exit status value.
val run_shell_command : ?timeout:timeout ->
?with_shell:shell ->
Ketrew_host.t ->
string ->
(unit,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Non_zero of string * int
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution Error.non_zero_execution ])
Ketrew_unix_io.Deferred_result.t
Run a shell command on the host (succeeds iff the exit status is 0).
val do_files_exist : ?timeout:timeout ->
?with_shell:shell ->
Ketrew_host.t ->
Ketrew_path.t list ->
(bool,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution ])
Ketrew_unix_io.Deferred_result.t
Check existence of a list of files/directories.
val get_fresh_playground : Ketrew_host.t -> Ketrew_path.t option
Get a new subdirectory in the host's playground
val ensure_directory : ?timeout:timeout ->
?with_shell:shell ->
Ketrew_host.t ->
path:Ketrew_path.t ->
(unit,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Non_zero of string * int
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution Error.non_zero_execution ])
Ketrew_unix_io.Deferred_result.t
Make sure the directory path exists on the host.
val put_file : ?timeout:timeout ->
Ketrew_host.t ->
path:Ketrew_path.t ->
content:string ->
(unit,
[> `Host of
[> `Execution of
< host : string; message : string; stderr : string option;
stdout : string option >
| `Ssh_failure of
[> `Wrong_log of string
| `Wrong_status of Ketrew_unix_process.Exit_code.t ] *
string
| `System of [> `Sleep of float ] * [> `Exn of exn ]
| `Timeout of float
| `Unix_exec of string ]
Error.execution
| `IO of [> `Write_file_exn of Ketrew_unix_io.IO.path * exn ] ])
Ketrew_unix_io.Deferred_result.t
Write a file on the host at path containing contents.
val get_file : ?timeout:timeout ->
Ketrew_host.t ->
path:Ketrew_path.t ->
(string,
[> `Cannot_read_file of string * string
| `Timeout of Ketrew_pervasives.Time.t ])
Ketrew_unix_io.Deferred_result.t
Read the file from the host at path.
val grab_file_or_log : ?timeout:timeout ->
Ketrew_host.t ->
Ketrew_path.t ->
(string, Ketrew_pervasives.Log.t) Ketrew_unix_io.Deferred_result.t