Add binary xapi_gzip for testing Xapi_compression #4685
Conversation
| gunzip Unix.stdin Unix.stdout | ||
|
|
||
| let decompress = | ||
| let doc = "Decomppress." in |
|
|
||
| module C = Cmdliner | ||
|
|
||
| module Gzip = Xapi_compression.Make (struct let executable = "/bin/gzip" end) |
There was a problem hiding this comment.
There is already a gzip module that does this
There was a problem hiding this comment.
I know, but I wanted to avoid the dependency given that it depends on this opam package - that would be circular.
| let doc = "Test compression and uncompression" in | ||
| C.Term.(const compress $ decompress, info "xapi-gzip" ~doc ~man:help) | ||
|
|
||
| let () = if !Sys.interactive then () else C.Term.(exit @@ eval main) |
There was a problem hiding this comment.
This is an interesting way of making the main module testable from utop, I'll keep this in mind
|
|
||
| (** copy bytes from file descriptor [src] to [dst] *) | ||
| let copy ~src ~dst = | ||
| let size = 1024 in |
There was a problem hiding this comment.
for OCaml I think a 64k buffer size is optimal (anything above that causes the Unix module to limit it anyway to 64k: https://github.com/ocaml/ocaml/blob/trunk/otherlibs/unix/write_unix.c#L76
https://github.com/ocaml/ocaml/blob/3f459df2b6dc2224697b5b37ec82ca1df40a1e5a/otherlibs/unix/unixsupport.h#L95
)
There was a problem hiding this comment.
Adding an empty xapi.gzip.mli will make the CI happy and highlight any unused bindings.
The Ci is also unhappy about missing labels:
File "ocaml/libs/xapi-compression/xapi_gzip.ml", line 44, characters 50-54:
44 | let gzip ~src ~dst = Gzip.compress dst (fun fd -> copy src fd)
^^^^
Error (warning 6 [labels-omitted]): labels src, dst were omitted in the application of this function.
File "ocaml/libs/xapi-compression/xapi_gzip.ml", line 46, characters 62-66:
46 | let gunzip ~src ~dst = Gzip.decompress_passive src (fun fd -> copy fd dst)
^^^^
Error (warning 6 [labels-omitted]): labels src, dst were omitted in the application of this function.
File "ocaml/libs/xapi-compression/xapi_gzip.ml", line 51, characters 6-10:
51 | gzip Unix.stdin Unix.stdout
^^^^
Error (warning 6 [labels-omitted]): labels src, dst were omitted in the application of this function.
File "ocaml/libs/xapi-compression/xapi_gzip.ml", line 53, characters 6-12:
53 | gunzip Unix.stdin Unix.stdout
^^^^^^
Error (warning 6 [labels-omitted]): labels src, dst were omitted in the application of this function.
The compression library Xapi_compression spawns processes to compress and uncompress streams. To facilitate easier testing, add a small stand-alone filter that compresses or uncompresses its standard input. This filter requires the presence of forkexecd to work - so typically a Citrix Hypervisor installation. We don't install this binary but it is available for developers. Signed-off-by: Christian Lindig <christian.lindig@citrix.com>
The compression library Xapi_compression spawns processes to compress
and uncompress streams. To facilitate easier testing, add a small
stand-alone filter that compresses or uncompresses its standard input.
This filter requires the presence of forkexecd to work - so typically a
Citrix Hypervisor installation. We don't install this binary but it is
available for developers.
Signed-off-by: Christian Lindig christian.lindig@citrix.com