1 /*-
2  * Copyright (c) 2003-2008 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 #if defined(HAVE_UTIME_H)
27 #include <utime.h>
28 #elif defined(HAVE_SYS_UTIME_H)
29 #include <sys/utime.h>
30 #endif
31 __FBSDID("$FreeBSD$");
32 
33 static struct {
34 	const char *name;
35 	time_t atime_sec;
36 } files[] = {
37 	{ "f0", 0 },
38 	{ "f1", 0 },
39 	{ "f2", 0 },
40 	{ "f3", 0 },
41 	{ "f4", 0 },
42 	{ "f5", 0 }
43 };
44 
45 /*
46  * Create a bunch of test files and record their atimes.
47  * For the atime preserve/change tests, the files must have
48  * atimes in the past.  We can accomplish this by explicitly invoking
49  * utime() on platforms that support it or by simply sleeping
50  * for a second after creating the files.  (Creating all of the files
51  * at once means we only need to sleep once.)
52  */
53 static void
54 test_create(void)
55 {
56 	struct stat st;
57 	struct utimbuf times;
58 	static const int numfiles = sizeof(files) / sizeof(files[0]);
59 	int i;
60 
61 	for (i = 0; i < numfiles; ++i) {
62 		/*
63 		 * Note: Have to write at least one byte to the file.
64 		 * cpio doesn't bother reading the file if it's zero length,
65 		 * so the atime never gets changed in that case, which
66 		 * makes the tests below rather pointless.
67 		 */
68 		assertMakeFile(files[i].name, 0644, "a");
69 
70 		/* If utime() isn't supported on your platform, just
71 		 * #ifdef this section out.  Most of the test below is
72 		 * still valid. */
73 		memset(&times, 0, sizeof(times));
74 		times.actime = 1;
75 		times.modtime = 3;
76 		assertEqualInt(0, utime(files[i].name, &times));
77 
78 		/* Record whatever atime the file ended up with. */
79 		/* If utime() is available, this should be 1, but there's
80 		 * no harm in being careful. */
81 		assertEqualInt(0, stat(files[i].name, &st));
82 		files[i].atime_sec = st.st_atime;
83 	}
84 
85 	/* Wait until the atime on the last file is actually in the past. */
86 	sleepUntilAfter(files[numfiles - 1].atime_sec);
87 }
88 
89 DEFINE_TEST(test_option_a)
90 {
91 	struct stat st;
92 	int r;
93 	char *p;
94 
95 	/* Create all of the test files. */
96 	test_create();
97 
98 	/* Sanity check; verify that atimes really do get modified. */
99 	p = slurpfile(NULL, "f0");
100 	assert(p != NULL);
101 	free(p);
102 	assertEqualInt(0, stat("f0", &st));
103 	if (st.st_atime == files[0].atime_sec) {
104 		skipping("Cannot verify -a option\n"
105 		    "      Your system appears to not support atime.");
106 	}
107 	else
108 	{
109 		/*
110 		 * If this disk is mounted noatime, then we can't
111 		 * verify correct operation without -a.
112 		 */
113 
114 		/* Copy the file without -a; should change the atime. */
115 		r = systemf("echo %s | %s -pd copy-no-a > copy-no-a.out 2>copy-no-a.err", files[1].name, testprog);
116 		assertEqualInt(r, 0);
117 		assertTextFileContents("1 block\n", "copy-no-a.err");
118 		assertEmptyFile("copy-no-a.out");
119 		assertEqualInt(0, stat(files[1].name, &st));
120 		failure("Copying file without -a should have changed atime.");
121 		assert(st.st_atime != files[1].atime_sec);
122 
123 		/* Archive the file without -a; should change the atime. */
124 		r = systemf("echo %s | %s -o > archive-no-a.out 2>archive-no-a.err", files[2].name, testprog);
125 		assertEqualInt(r, 0);
126 		assertTextFileContents("1 block\n", "copy-no-a.err");
127 		assertEqualInt(0, stat(files[2].name, &st));
128 		failure("Archiving file without -a should have changed atime.");
129 		assert(st.st_atime != files[2].atime_sec);
130 	}
131 
132 	/*
133 	 * We can, of course, still verify that the atime is unchanged
134 	 * when using the -a option.
135 	 */
136 
137 	/* Copy the file with -a; should not change the atime. */
138 	r = systemf("echo %s | %s -pad copy-a > copy-a.out 2>copy-a.err",
139 	    files[3].name, testprog);
140 	assertEqualInt(r, 0);
141 	assertTextFileContents("1 block\n", "copy-a.err");
142 	assertEmptyFile("copy-a.out");
143 	assertEqualInt(0, stat(files[3].name, &st));
144 	failure("Copying file with -a should not have changed atime.");
145 	assertEqualInt(st.st_atime, files[3].atime_sec);
146 
147 	/* Archive the file with -a; should not change the atime. */
148 	r = systemf("echo %s | %s -oa > archive-a.out 2>archive-a.err",
149 	    files[4].name, testprog);
150 	assertEqualInt(r, 0);
151 	assertTextFileContents("1 block\n", "copy-a.err");
152 	assertEqualInt(0, stat(files[4].name, &st));
153 	failure("Archiving file with -a should not have changed atime.");
154 	assertEqualInt(st.st_atime, files[4].atime_sec);
155 }
156