utimens: add test
[gnulib.git] / tests / test-utimens.h
1 /* Test of file timestamp modification functions.
2    Copyright (C) 2009 Free Software Foundation, Inc.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation; either version 2 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
16
17 /* This file assumes that BASE and ASSERT are already defined.  */
18
19 #ifndef GL_TEST_UTIMENS
20 # define GL_TEST_UTIMENS
21
22 #include <fcntl.h>
23 #include <errno.h>
24 #include <string.h>
25 #include <unistd.h>
26
27 #include "stat-time.h"
28 #include "timespec.h"
29 #include "utimecmp.h"
30
31 enum {
32   BILLION = 1000 * 1000 * 1000,
33
34   Y2K = 946684800, /* Jan 1, 2000, in seconds since epoch.  */
35
36   /* Bogus positive and negative tv_nsec values closest to valid
37      range, but without colliding with UTIME_NOW or UTIME_OMIT.  */
38   UTIME_BOGUS_POS = BILLION + ((UTIME_NOW == BILLION || UTIME_OMIT == BILLION)
39                                ? (1 + (UTIME_NOW == BILLION + 1)
40                                   + (UTIME_OMIT == BILLION + 1))
41                                : 0),
42   UTIME_BOGUS_NEG = -1 - ((UTIME_NOW == -1 || UTIME_OMIT == -1)
43                           ? (1 + (UTIME_NOW == -2) + (UTIME_OMIT == -2))
44                           : 0)
45 };
46
47 #endif /* GL_TEST_UTIMENS */
48
49 /* This function is designed to test both utimens(a,b) and
50    utimensat(AT_FDCWD,a,b,0).  FUNC is the function to test.  */
51 static int
52 test_utimens (int (*func) (char const *, struct timespec const *))
53 {
54   struct stat st1;
55   struct stat st2;
56
57   ASSERT (close (creat (BASE "file", 0600)) == 0);
58   /* If utimens truncates to less resolution than the file system
59      supports, then time can appear to go backwards between now and
60      the follow-up utimens(file,NULL).  Use UTIMECMP_TRUNCATE_SOURCE
61      to compensate, with st1 as the source.  */
62   ASSERT (stat (BASE "file", &st1) == 0);
63
64   /* Invalid arguments.  */
65   errno = 0;
66   ASSERT (func ("no_such", NULL) == -1);
67   ASSERT (errno == ENOENT);
68   errno = 0;
69   ASSERT (func ("", NULL) == -1);
70   ASSERT (errno == ENOENT);
71   {
72     struct timespec ts[2] = { { Y2K, UTIME_BOGUS_POS }, { Y2K, 0 } };
73     errno = 0;
74     ASSERT (func (BASE "file", ts) == -1);
75     ASSERT (errno == EINVAL);
76   }
77   {
78     struct timespec ts[2] = { { Y2K, 0 }, { Y2K, UTIME_BOGUS_NEG } };
79     errno = 0;
80     ASSERT (func (BASE "file", ts) == -1);
81     ASSERT (errno == EINVAL);
82   }
83   ASSERT (stat (BASE "file", &st2) == 0);
84   ASSERT (st1.st_atime == st2.st_atime);
85   ASSERT (get_stat_atime_ns (&st1) == get_stat_atime_ns (&st2));
86   ASSERT (utimecmp (BASE "file", &st1, &st2, 0) == 0);
87
88   /* Set both times.  */
89   {
90     struct timespec ts[2] = { { Y2K, BILLION / 2 - 1 }, { Y2K, BILLION - 1 } };
91     ASSERT (func (BASE "file", ts) == 0);
92     ASSERT (stat (BASE "file", &st2) == 0);
93     ASSERT (st2.st_atime == Y2K);
94     ASSERT (0 <= get_stat_atime_ns (&st2));
95     ASSERT (get_stat_atime_ns (&st2) < BILLION / 2);
96     ASSERT (st2.st_mtime == Y2K);
97     ASSERT (0 <= get_stat_mtime_ns (&st2));
98     ASSERT (get_stat_mtime_ns (&st2) < BILLION);
99   }
100
101   /* Play with UTIME_OMIT, UTIME_NOW.  */
102   {
103     struct timespec ts[2] = { { BILLION, UTIME_OMIT }, { 0, UTIME_NOW } };
104     ASSERT (func (BASE "file", ts) == 0);
105     ASSERT (stat (BASE "file", &st2) == 0);
106     ASSERT (st2.st_atime == Y2K);
107     ASSERT (0 <= get_stat_atime_ns (&st2));
108     ASSERT (get_stat_atime_ns (&st2) < BILLION / 2);
109     /* See comment above about this utimecmp call.  */
110     ASSERT (0 <= utimecmp (BASE "file", &st2, &st1, UTIMECMP_TRUNCATE_SOURCE));
111   }
112
113   /* Cleanup.  */
114   ASSERT (unlink (BASE "file") == 0);
115   return 0;
116 }