1/*-
2 * Copyright (c) 2003-2007 Tim Kientzle
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25#include "test.h"
26__FBSDID("$FreeBSD$");
27
28/*
29 * Test that "--help", "-h", and "-W help" options all work and
30 * generate reasonable output.
31 */
32
33static int
34in_first_line(const char *p, const char *substring)
35{
36	size_t l = strlen(substring);
37
38	while (*p != '\0' && *p != '\n') {
39		if (memcmp(p, substring, l) == 0)
40			return (1);
41		++p;
42	}
43	return (0);
44}
45
46DEFINE_TEST(test_option_help)
47{
48	int r;
49	char *p;
50	size_t plen;
51
52	/* Exercise --help option. */
53	r = systemf("%s --help >help.stdout 2>help.stderr", testprog);
54	assertEqualInt(r, 0);
55	failure("--help should generate nothing to stderr.");
56	assertEmptyFile("help.stderr");
57	/* Help message should start with name of program. */
58	p = slurpfile(&plen, "help.stdout");
59	failure("Help output should be long enough.");
60	assert(plen >= 7);
61	failure("First line of help output should contain string 'bsdcpio'");
62	assert(in_first_line(p, "bsdcpio"));
63	/*
64	 * TODO: Extend this check to further verify that --help output
65	 * looks approximately right.
66	 */
67	free(p);
68
69	/* -h option should generate the same output. */
70	r = systemf("%s -h >h.stdout 2>h.stderr", testprog);
71	assertEqualInt(r, 0);
72	failure("-h should generate nothing to stderr.");
73	assertEmptyFile("h.stderr");
74	failure("stdout should be same for -h and --help");
75	assertEqualFile("h.stdout", "help.stdout");
76
77	/* -W help should be another synonym. */
78	r = systemf("%s -W help >Whelp.stdout 2>Whelp.stderr", testprog);
79	assertEqualInt(r, 0);
80	failure("-W help should generate nothing to stderr.");
81	assertEmptyFile("Whelp.stderr");
82	failure("stdout should be same for -W help and --help");
83	assertEqualFile("Whelp.stdout", "help.stdout");
84}
85