Update test files for new output
[mythtv-status.git] / t / 01-test-help.t
1 #!usr/bin/perl
2
3 use Test::More tests => 2;
4 use FindBin qw/$Bin/;
5
6 # Test that the blurb of how to get help is printed.
7 my $out = `$Bin/../bin/mythtv-status --zzz 2>&1`;
8
9 my $expected = <<EOF;
10 Unknown option: zzz
11
12 Use --help for help.
13
14 Usage:
15      mythtv-status [options]
16
17 EOF
18
19 ok($out eq $expected, 'Invalid option returns help blurb');
20
21 # Check the help output, using --help.
22 $out = `$Bin/../bin/mythtv-status --help 2>&1`;
23
24 $expected = <<EOF;
25 Usage:
26      mythtv-status [options]
27
28 Options:
29     -c, --colour
30         Use colour when showing the status of the encoder(s).
31
32     --date
33         Set the date to run as, used for debugging purposes.
34
35     -d, --description
36         Display the description for the scheduled recordings.
37
38     --disk-space-warn
39         The threshold (in percent) of used disk space that we should show
40         the disk space in red (if using colour) or send an email if we're in
41         email mode with email only on warnings.
42
43     --encoder-details
44         Display the input ID and channel name against the recording details.
45
46     --encoder-skip-idle
47         Suppress displaying idle encoders in the Encoders block.
48
49     --encoder-warn-non-idle
50         Display warnings if an encoder is not idle. This is the default, it
51         allows you to know if an encoder or the MythTV system is busy. To
52         disable, use --no-encoder-warn-non-idle.
53
54     -e, --episode
55         Display the episode (subtitle) for the scheduled recordings.
56
57     --email <address>[ --email <address> ...]
58         Send the output to the listed email addresses. By default the
59         encoder status, currently recording shows and time till next
60         recording is suppressed from the email.
61
62         To turn the additional blocks on you can use --encoders,
63         --recording-now and/or --next-recording.
64
65         By default highlight is turned on, to disable it use --nohighlight.
66
67     --email-only-on-alert
68         Only send an email out (if --email is present) if there is an alert
69         (i.e., schedule conflict or low disk space).
70
71     -?, --help
72         Display help.
73
74     --file <file>
75         Load XML from the file specified instead of querying a MythTV
76         backend. Handy for debugging things.
77
78     --save-file <file>
79         Save the XML we received from the MythTV backend. Handy for
80         debugging things.
81
82     --guide-days-warn <days>
83         Warn if the number of days of guide data present is equal to or
84         below this level. Default is 2 days.
85
86     -h HOST, --host=HOST
87         The host to check, defaults to localhost.
88
89     --highlight
90         Surround any items that are considered a warning with asterisks.
91         This helps to highlight an issue if colour mode is disabled.
92
93     --nostatus, --noencoders, --norecording-now, --noscheduled-recordings,
94     --noschedule-conflicts, --nonext-recording, --nototal-disk-space,
95     --nodisk-space, --noguide-data, --noauto-expire
96         Suppress displaying blocks of the output if they would normally be
97         displayed.
98
99     -p PORT, --port=PORT
100         The port to use when connecting to MythTV, defaults to 6544.
101
102     --oneliner-bullets
103         Insert asterisks (*) before each of the oneliners to stop some email
104         clients from thinking the oneliner block is a paragraph and trying
105         to word wrap them.
106
107     --auto-expire
108         Display the shows due to auto expire (output is normally
109         suppressed).
110
111     --auto-expire-count
112         How many of the auto expire shows to display, defaults to 10.
113
114     --recording-in-warn
115         If the "Next Recording In" time is less than this amount, display it
116         in red. This in seconds, and defaults to 3600 (1 hour).
117
118     --verbose
119         Have slightly more verbose output. This includes any warnings that
120         might be generated while parsing the XML.
121
122     -v, --version
123         Show the version of mythtv-status and then exit.
124
125 EOF
126
127 ok($out eq $expected, '--help generates help output');