Skip to content

Commit 4d25fd1

Browse files
tmcgilchristtmcgilchrist
committed
Add cram tests for help commands
1 parent e293956 commit 4d25fd1

File tree

7 files changed

+286
-76
lines changed

7 files changed

+286
-76
lines changed

‎dune-project‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
(name runtime_events_tools)
44
(version "0.5.1")
55
(generate_opam_files true)
6+
(cram enable)
67

78
(source
89
(github tarides/runtime_events_tools))

‎test/cram/dune‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
(cram
2+
(deps %{bin:olly}))

‎test/cram/olly.t‎

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
Display help when called without subcommands
2+
3+
$ olly --help=plain
4+
NAME
5+
olly - An observability tool for OCaml programs
6+
7+
SYNOPSIS
8+
olly COMMAND …
9+
10+
COMMANDS
11+
gc-stats [OPTION]… [EXECUTABLE]…
12+
Report the GC latency profile and stats.
13+
14+
help [--man-format=FMT] [OPTION]… [TOPIC]
15+
Display help about olly and olly commands.
16+
17+
trace [OPTION]… TRACEFILE [EXECUTABLE]…
18+
Save the runtime trace to file.
19+
20+
COMMON OPTIONS
21+
--help[=FMT] (default=auto)
22+
Show this help in format FMT. The value FMT must be one of auto,
23+
pager, groff or plain. With auto, the format is pager or plain
24+
whenever the TERM env var is dumb or undefined.
25+
26+
EXIT STATUS
27+
olly exits with:
28+
29+
0 on success.
30+
31+
123 on indiscriminate errors reported on standard error.
32+
33+
124 on command line parsing errors.
34+
35+
125 on unexpected internal errors (bugs).
36+
37+
Display help for trace
38+
39+
$ olly trace --help=plain
40+
NAME
41+
olly-trace - Save the runtime trace to file.
42+
43+
SYNOPSIS
44+
olly trace [OPTION]… TRACEFILE [EXECUTABLE]…
45+
46+
DESCRIPTION
47+
Save the runtime trace to file.
48+
49+
ARGUMENTS
50+
EXECUTABLE
51+
Executable and arguments to trace.
52+
53+
TRACEFILE (required)
54+
Target trace file name.
55+
56+
OPTIONS
57+
-a [directory:]pid, --attach=[directory:]pid
58+
Attach to the process with the given PID. The directory containing
59+
the PID.events file may be specified. This option cannot be
60+
combined with EXECUTABLE.
61+
62+
-c, --emit-counters
63+
Emit runtime counter events.
64+
65+
-d dir, --dir=dir
66+
Sets the directory where the .events files containing the runtime
67+
event tracing system’s ring buffers will be located. If not
68+
specified a temporary directory will be used.
69+
70+
-f format, --format=format (absent=fuchsia)
71+
Format of the target trace, options are: "fuchsia" (Perfetto),
72+
"json" (Chrome Trace Format).
73+
74+
--freq=freq (absent=0.1)
75+
Set the interval that olly sleeps in seconds, after performing a
76+
[Runtime_events.read_poll]. Fractions of seconds are supported. A
77+
value of 0.0 will skip sleeping altogether.
78+
79+
--log-wsize=log-wsize
80+
Size of the per-domain runtime events ring buffers in log powers
81+
of two words. Defaults to 16.
82+
83+
COMMON OPTIONS
84+
These options are common to all commands.
85+
86+
--help[=FMT] (default=auto)
87+
Show this help in format FMT. The value FMT must be one of auto,
88+
pager, groff or plain. With auto, the format is pager or plain
89+
whenever the TERM env var is dumb or undefined.
90+
91+
MORE HELP
92+
Use olly COMMAND --help for help on a single command.
93+
EXIT STATUS
94+
olly trace exits with:
95+
96+
0 on success.
97+
98+
123 on indiscriminate errors reported on standard error.
99+
100+
124 on command line parsing errors.
101+
102+
125 on unexpected internal errors (bugs).
103+
104+
BUGS
105+
Check bug reports at
106+
http://github.com/tarides/runtime_events_tools/issues.
107+
108+
SEE ALSO
109+
olly(1)
110+
111+
112+
Display help for gc-stats
113+
114+
$ olly gc-stats --help=plain
115+
NAME
116+
olly-gc-stats - Report the GC latency profile and stats.
117+
118+
SYNOPSIS
119+
olly gc-stats [OPTION]… [EXECUTABLE]…
120+
121+
DESCRIPTION
122+
Report the GC latency profile.
123+
124+
Wall time
125+
Real execution time of the program
126+
127+
CPU time
128+
Total CPU time across all domains
129+
130+
GC time
131+
Total time spent by the program performing garbage collection
132+
(major and minor)
133+
134+
GC overhead
135+
Percentage of time taken up by GC against the total execution time
136+
137+
GC time per domain
138+
Time spent by every domain performing garbage collection (major
139+
and minor cycles). Domains are reported with their domain ID (e.g.
140+
`Domain 0`)
141+
142+
GC latency profile
143+
Mean, standard deviation and percentile latency profile of GC
144+
events.
145+
146+
GC allocations
147+
GC allocation and promotion in machine words during program
148+
execution. Counts of Compactions, and Minor and Major collections.
149+
150+
ARGUMENTS
151+
EXECUTABLE
152+
Executable and arguments to trace.
153+
154+
OPTIONS
155+
-a [directory:]pid, --attach=[directory:]pid
156+
Attach to the process with the given PID. The directory containing
157+
the PID.events file may be specified. This option cannot be
158+
combined with EXECUTABLE.
159+
160+
-d dir, --dir=dir
161+
Sets the directory where the .events files containing the runtime
162+
event tracing system’s ring buffers will be located. If not
163+
specified a temporary directory will be used.
164+
165+
--freq=freq (absent=0.1)
166+
Set the interval that olly sleeps in seconds, after performing a
167+
[Runtime_events.read_poll]. Fractions of seconds are supported. A
168+
value of 0.0 will skip sleeping altogether.
169+
170+
--json
171+
Print the output in json instead of human-readable format.
172+
173+
--log-wsize=log-wsize
174+
Size of the per-domain runtime events ring buffers in log powers
175+
of two words. Defaults to 16.
176+
177+
-o output, --output=output
178+
Redirect the output of `olly` to specified file. The output of the
179+
command is not redirected.
180+
181+
COMMON OPTIONS
182+
These options are common to all commands.
183+
184+
--help[=FMT] (default=auto)
185+
Show this help in format FMT. The value FMT must be one of auto,
186+
pager, groff or plain. With auto, the format is pager or plain
187+
whenever the TERM env var is dumb or undefined.
188+
189+
MORE HELP
190+
Use olly COMMAND --help for help on a single command.
191+
EXIT STATUS
192+
olly gc-stats exits with:
193+
194+
0 on success.
195+
196+
123 on indiscriminate errors reported on standard error.
197+
198+
124 on command line parsing errors.
199+
200+
125 on unexpected internal errors (bugs).
201+
202+
BUGS
203+
Check bug reports at
204+
http://github.com/tarides/runtime_events_tools/issues.
205+
206+
SEE ALSO
207+
olly(1)
208+

‎test/dune‎

Lines changed: 56 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,56 @@
1-
; run menhir test
2-
3-
(executable
4-
(name test_gc_stats)
5-
(modules test_gc_stats))
6-
7-
(executable
8-
(name test_fib)
9-
(modules test_fib)
10-
(enabled_if
11-
(>= %{ocaml_version} 5.1.0))
12-
(libraries runtime_events unix))
13-
14-
(rule
15-
(alias runtest)
16-
(package runtime_events_tools)
17-
(deps %{bin:olly} test_gc_stats.exe)
18-
(action
19-
(run olly gc-stats "./test_gc_stats.exe")))
20-
21-
(rule
22-
(alias runtest)
23-
(package runtime_events_tools)
24-
(deps %{bin:olly} test_gc_stats.exe)
25-
(action
26-
(run olly gc-stats ./test_gc_stats.exe 19)))
27-
28-
(rule
29-
(alias runtest)
30-
(package runtime_events_tools)
31-
(enabled_if
32-
(>= %{ocaml_version} 5.1.0))
33-
(deps %{bin:olly} test_fib.exe)
34-
(action
35-
(progn
36-
(run olly trace test.trace ./test_fib.exe))))
37-
38-
(rule
39-
(alias runtest)
40-
(package runtime_events_tools)
41-
(enabled_if
42-
(>= %{ocaml_version} 5.1.0))
43-
(deps %{bin:olly} test_fib.exe)
44-
(action
45-
(progn
46-
(run olly trace --format=json test-json.trace ./test_fib.exe))))
47-
48-
(rule
49-
(alias runtest)
50-
(package runtime_events_tools_bare)
51-
(enabled_if
52-
(>= %{ocaml_version} 5.1.0))
53-
(deps %{bin:olly_bare} test_fib.exe)
54-
(action
55-
(progn
56-
(run olly_bare trace --format=json test-bare-json.trace ./test_fib.exe))))
57-
58-
; Dummy process for testing process launching.
59-
60-
(executables
61-
(names run_endlessly)
62-
(modules run_endlessly)
63-
(libraries unix))
64-
65-
(test
66-
(name test_launch)
67-
(modules test_launch)
68-
(package runtime_events_tools)
69-
(enabled_if
70-
(>= %{ocaml_version} 5.1.0))
71-
(libraries olly_common alcotest)
72-
(deps run_endlessly.exe)
73-
(action
74-
(run %{test} --show-errors)))
1+
; ; run menhir test
2+
3+
; (executable
4+
; (name test_gc_stats)
5+
; (modules test_gc_stats))
6+
7+
; (executable
8+
; (name test_fib)
9+
; (modules test_fib)
10+
; (enabled_if
11+
; (>= %{ocaml_version} 5.1.0))
12+
; (libraries runtime_events unix))
13+
14+
; (rule
15+
; (alias runtest)
16+
; (package runtime_events_tools)
17+
; (deps %{bin:olly} test_gc_stats.exe)
18+
; (action
19+
; (run olly gc-stats "./test_gc_stats.exe")))
20+
21+
; (rule
22+
; (alias runtest)
23+
; (package runtime_events_tools)
24+
; (deps %{bin:olly} test_gc_stats.exe)
25+
; (action
26+
; (run olly gc-stats ./test_gc_stats.exe 19)))
27+
28+
; (rule
29+
; (alias runtest)
30+
; (package runtime_events_tools)
31+
; (enabled_if
32+
; (>= %{ocaml_version} 5.1.0))
33+
; (deps %{bin:olly} test_fib.exe)
34+
; (action
35+
; (progn
36+
; (run olly trace test.trace ./test_fib.exe))))
37+
38+
; (rule
39+
; (alias runtest)
40+
; (package runtime_events_tools)
41+
; (enabled_if
42+
; (>= %{ocaml_version} 5.1.0))
43+
; (deps %{bin:olly} test_fib.exe)
44+
; (action
45+
; (progn
46+
; (run olly trace --format=json test-json.trace ./test_fib.exe))))
47+
48+
; (rule
49+
; (alias runtest)
50+
; (package runtime_events_tools_bare)
51+
; (enabled_if
52+
; (>= %{ocaml_version} 5.1.0))
53+
; (deps %{bin:olly_bare} test_fib.exe)
54+
; (action
55+
; (progn
56+
; (run olly_bare trace --format=json test-bare-json.trace ./test_fib.exe))))

‎test/unit/dune‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
; Dummy process for testing process launching.
2+
3+
(executables
4+
(names run_endlessly)
5+
(modules run_endlessly)
6+
(libraries unix))
7+
8+
(test
9+
(name test_launch)
10+
(modules test_launch)
11+
(package runtime_events_tools)
12+
(enabled_if
13+
(>= %{ocaml_version} 5.1.0))
14+
(libraries olly_common alcotest)
15+
(deps run_endlessly.exe)
16+
(action
17+
(run %{test} --show-errors)))

‎test/run_endlessly.ml‎ renamed to ‎test/unit/run_endlessly.ml‎

File renamed without changes.

‎test/test_launch.ml‎ renamed to ‎test/unit/test_launch.ml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ let process_launch_failure () =
2121

2222
let process_launch () =
2323
let open Olly_common in
24-
let config = { Launch.log_wsize = None; dir = None } in
24+
let config = { Launch.log_wsize = None; dir = Some "./" } in
2525
Alcotest.(check bool)
2626
"process should launch" true
2727
(try
@@ -42,7 +42,7 @@ let process_launch () =
4242

4343
let () =
4444
let open Alcotest in
45-
run "Runtime Events Tools"
45+
run "Runtime-events-tools"
4646
[
4747
( "process",
4848
[

0 commit comments

Comments
 (0)