xref: /freebsd/contrib/libarchive/tar/test/test_help.c (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
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 
27 /*
28  * Test that "--help", "-h", and "-W help" options all work and
29  * generate reasonable output.
30  */
31 
32 static int
33 in_first_line(const char *p, const char *substring)
34 {
35 	size_t l = strlen(substring);
36 
37 	while (*p != '\0' && *p != '\n') {
38 		if (memcmp(p, substring, l) == 0)
39 			return (1);
40 		++p;
41 	}
42 	return (0);
43 }
44 
45 DEFINE_TEST(test_help)
46 {
47 	int r;
48 	char *p;
49 	size_t plen;
50 
51 	/* Exercise --help option. */
52 	r = systemf("%s --help >help.stdout 2>help.stderr", testprog);
53 	assertEqualInt(r, 0);
54 	failure("--help should generate nothing to stderr.");
55 	assertEmptyFile("help.stderr");
56 	/* Help message should start with name of program. */
57 	p = slurpfile(&plen, "help.stdout");
58 	failure("Help output should be long enough.");
59 	assert(plen >= 6);
60 	failure("First line of help output should contain 'bsdtar': %s", p);
61 	assert(in_first_line(p, "bsdtar"));
62 	/*
63 	 * TODO: Extend this check to further verify that --help output
64 	 * looks approximately right.
65 	 */
66 	free(p);
67 
68 	/* -h option should generate the same output. */
69 	r = systemf("%s -h >h.stdout 2>h.stderr", testprog);
70 	assertEqualInt(r, 0);
71 	failure("-h should generate nothing to stderr.");
72 	assertEmptyFile("h.stderr");
73 	failure("stdout should be same for -h and --help");
74 	assertEqualFile("h.stdout", "help.stdout");
75 
76 	/* -W help should be another synonym. */
77 	r = systemf("%s -W help >Whelp.stdout 2>Whelp.stderr", testprog);
78 	assertEqualInt(r, 0);
79 	failure("-W help should generate nothing to stderr.");
80 	assertEmptyFile("Whelp.stderr");
81 	failure("stdout should be same for -W help and --help");
82 	assertEqualFile("Whelp.stdout", "help.stdout");
83 }
84