utimens: add test
authorEric Blake <ebb9@byu.net>
Wed, 7 Oct 2009 23:08:17 +0000 (17:08 -0600)
committerEric Blake <ebb9@byu.net>
Sat, 10 Oct 2009 14:27:25 +0000 (08:27 -0600)
Exposes holes in our API, and several platform bugs.

* modules/utimens-tests: New test.
* tests/test-utimens.h: New file.
* tests/test-futimens.h: Likewise.
* tests/test-utimens.c: Likewise.

Signed-off-by: Eric Blake <ebb9@byu.net>
ChangeLog
modules/utimens-tests [new file with mode: 0644]
tests/test-futimens.h [new file with mode: 0644]
tests/test-utimens.c [new file with mode: 0644]
tests/test-utimens.h [new file with mode: 0644]

index 8a34a5b..16e99df 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,11 @@
 2009-10-10  Eric Blake  <ebb9@byu.net>
 
+       utimens: add test
+       * modules/utimens-tests: New test.
+       * tests/test-utimens.h: New file.
+       * tests/test-futimens.h: Likewise.
+       * tests/test-utimens.c: Likewise.
+
        doc: mention timestamp portability issues
        * doc/glibc-functions/lutimes.texi (lutimes): Refer to utimensat
        instead.
diff --git a/modules/utimens-tests b/modules/utimens-tests
new file mode 100644 (file)
index 0000000..9163b04
--- /dev/null
@@ -0,0 +1,17 @@
+Files:
+tests/test-futimens.h
+tests/test-utimens.h
+tests/test-utimens.c
+
+Depends-on:
+stat-time
+stdbool
+timespec
+utimecmp
+
+configure.ac:
+
+Makefile.am:
+TESTS += test-utimens
+check_PROGRAMS += test-utimens
+test_utimens_LDADD = $(LDADD) @LIBINTL@
diff --git a/tests/test-futimens.h b/tests/test-futimens.h
new file mode 100644 (file)
index 0000000..0335845
--- /dev/null
@@ -0,0 +1,127 @@
+/* Test of file timestamp modification functions.
+   Copyright (C) 2009 Free Software Foundation, Inc.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+/* This file assumes that BASE and ASSERT are already defined.  */
+
+#ifndef GL_TEST_UTIMENS
+# define GL_TEST_UTIMENS
+
+#include <fcntl.h>
+#include <errno.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "stat-time.h"
+#include "timespec.h"
+#include "utimecmp.h"
+
+enum {
+  BILLION = 1000 * 1000 * 1000,
+
+  Y2K = 946684800, /* Jan 1, 2000, in seconds since epoch.  */
+
+  /* Bogus positive and negative tv_nsec values closest to valid
+     range, but without colliding with UTIME_NOW or UTIME_OMIT.  */
+  UTIME_BOGUS_POS = BILLION + ((UTIME_NOW == BILLION || UTIME_OMIT == BILLION)
+                               ? (1 + (UTIME_NOW == BILLION + 1)
+                                  + (UTIME_OMIT == BILLION + 1))
+                               : 0),
+  UTIME_BOGUS_NEG = -1 - ((UTIME_NOW == -1 || UTIME_OMIT == -1)
+                          ? (1 + (UTIME_NOW == -2) + (UTIME_OMIT == -2))
+                          : 0)
+};
+
+#endif /* GL_TEST_UTIMENS */
+
+/* This function is designed to test both gl_futimens(a,NULL,b) and
+   futimens(a,b).  FUNC is the function to test.  If PRINT, warn
+   before skipping tests with status 77.  */
+static int
+test_futimens (int (*func) (int, struct timespec const *),
+               bool print)
+{
+  int fd = creat (BASE "file", 0600);
+  int result;
+  struct stat st1;
+  struct stat st2;
+  ASSERT (0 <= fd);
+
+  /* Sanity check.  */
+  errno = 0;
+  result = func (fd, NULL);
+  if (result == -1 && errno == ENOSYS)
+    {
+      ASSERT (close (fd) == 0);
+      ASSERT (unlink (BASE "file") == 0);
+      if (print)
+        fputs ("skipping test: "
+               "setting fd time not supported on this file system\n",
+               stderr);
+      return 77;
+    }
+  ASSERT (!result);
+  ASSERT (fstat (fd, &st1) == 0);
+
+  /* Invalid arguments.  */
+  errno = 0;
+  ASSERT (func (AT_FDCWD, NULL) == -1);
+  ASSERT (errno == EBADF);
+  {
+    struct timespec ts[2] = { { Y2K, UTIME_BOGUS_POS }, { Y2K, 0 } };
+    errno = 0;
+    ASSERT (func (fd, ts) == -1);
+    ASSERT (errno == EINVAL);
+  }
+  {
+    struct timespec ts[2] = { { Y2K, 0 }, { Y2K, UTIME_BOGUS_NEG } };
+    errno = 0;
+    ASSERT (func (fd, ts) == -1);
+    ASSERT (errno == EINVAL);
+  }
+  ASSERT (fstat (fd, &st2) == 0);
+  ASSERT (st1.st_atime == st2.st_atime);
+  ASSERT (get_stat_atime_ns (&st1) == get_stat_atime_ns (&st2));
+  ASSERT (utimecmp (BASE "file", &st1, &st2, 0) == 0);
+
+  /* Set both times.  */
+  {
+    struct timespec ts[2] = { { Y2K, BILLION / 2 - 1 }, { Y2K, BILLION - 1 } };
+    ASSERT (func (fd, ts) == 0);
+    ASSERT (fstat (fd, &st2) == 0);
+    ASSERT (st2.st_atime == Y2K);
+    ASSERT (0 <= get_stat_atime_ns (&st2));
+    ASSERT (get_stat_atime_ns (&st2) < BILLION / 2);
+    ASSERT (st2.st_mtime == Y2K);
+    ASSERT (0 <= get_stat_mtime_ns (&st2));
+    ASSERT (get_stat_mtime_ns (&st2) < BILLION);
+  }
+
+  /* Play with UTIME_OMIT, UTIME_NOW.  */
+  {
+    struct timespec ts[2] = { { BILLION, UTIME_OMIT }, { 0, UTIME_NOW } };
+    ASSERT (func (fd, ts) == 0);
+    ASSERT (fstat (fd, &st2) == 0);
+    ASSERT (st2.st_atime == Y2K);
+    ASSERT (0 <= get_stat_atime_ns (&st2));
+    ASSERT (get_stat_atime_ns (&st2) <= BILLION / 2);
+    ASSERT (utimecmp (BASE "file", &st1, &st2, 0) <= 0);
+  }
+
+  /* Cleanup.  */
+  ASSERT (close (fd) == 0);
+  ASSERT (unlink (BASE "file") == 0);
+  return 0;
+}
diff --git a/tests/test-utimens.c b/tests/test-utimens.c
new file mode 100644 (file)
index 0000000..5734a57
--- /dev/null
@@ -0,0 +1,79 @@
+/* Tests of utimens.
+   Copyright (C) 2009 Free Software Foundation, Inc.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+/* Written by Eric Blake <ebb9@byu.net>, 2009.  */
+
+#include <config.h>
+
+#include "utimens.h"
+
+#include <stdbool.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#define ASSERT(expr) \
+  do                                                                         \
+    {                                                                        \
+      if (!(expr))                                                           \
+        {                                                                    \
+          fprintf (stderr, "%s:%d: assertion failed\n", __FILE__, __LINE__);  \
+          fflush (stderr);                                                   \
+          abort ();                                                          \
+        }                                                                    \
+    }                                                                        \
+  while (0)
+
+#define BASE "test-utimens.t"
+
+#include "test-futimens.h"
+#include "test-utimens.h"
+
+/* Wrap gl_futimens to behave like futimens.  */
+static int
+do_futimens (int fd, struct timespec const times[2])
+{
+  return gl_futimens (fd, NULL, times);
+}
+
+/* Test the use of file descriptors alongside a name.  */
+static int
+do_fdutimens (char const *name, struct timespec const times[2])
+{
+  int result;
+  int fd = open (name, O_WRONLY);
+  if (fd < 0)
+    fd = open (name, O_RDONLY);
+  errno = 0;
+  result = gl_futimens (fd, name, times);
+  if (0 <= fd)
+    {
+      int saved_errno = errno;
+      close (fd);
+      errno = saved_errno;
+    }
+  return result;
+}
+
+int
+main ()
+{
+  /* Clean up any trash from prior testsuite runs.  */
+  ASSERT (system ("rm -rf " BASE "*") == 0);
+
+  ASSERT (test_utimens (utimens) == 0);
+  ASSERT (test_utimens (do_fdutimens) == 0);
+  return test_futimens (do_futimens, true);
+}
diff --git a/tests/test-utimens.h b/tests/test-utimens.h
new file mode 100644 (file)
index 0000000..04131d3
--- /dev/null
@@ -0,0 +1,116 @@
+/* Test of file timestamp modification functions.
+   Copyright (C) 2009 Free Software Foundation, Inc.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+/* This file assumes that BASE and ASSERT are already defined.  */
+
+#ifndef GL_TEST_UTIMENS
+# define GL_TEST_UTIMENS
+
+#include <fcntl.h>
+#include <errno.h>
+#include <string.h>
+#include <unistd.h>
+
+#include "stat-time.h"
+#include "timespec.h"
+#include "utimecmp.h"
+
+enum {
+  BILLION = 1000 * 1000 * 1000,
+
+  Y2K = 946684800, /* Jan 1, 2000, in seconds since epoch.  */
+
+  /* Bogus positive and negative tv_nsec values closest to valid
+     range, but without colliding with UTIME_NOW or UTIME_OMIT.  */
+  UTIME_BOGUS_POS = BILLION + ((UTIME_NOW == BILLION || UTIME_OMIT == BILLION)
+                               ? (1 + (UTIME_NOW == BILLION + 1)
+                                  + (UTIME_OMIT == BILLION + 1))
+                               : 0),
+  UTIME_BOGUS_NEG = -1 - ((UTIME_NOW == -1 || UTIME_OMIT == -1)
+                          ? (1 + (UTIME_NOW == -2) + (UTIME_OMIT == -2))
+                          : 0)
+};
+
+#endif /* GL_TEST_UTIMENS */
+
+/* This function is designed to test both utimens(a,b) and
+   utimensat(AT_FDCWD,a,b,0).  FUNC is the function to test.  */
+static int
+test_utimens (int (*func) (char const *, struct timespec const *))
+{
+  struct stat st1;
+  struct stat st2;
+
+  ASSERT (close (creat (BASE "file", 0600)) == 0);
+  /* If utimens truncates to less resolution than the file system
+     supports, then time can appear to go backwards between now and
+     the follow-up utimens(file,NULL).  Use UTIMECMP_TRUNCATE_SOURCE
+     to compensate, with st1 as the source.  */
+  ASSERT (stat (BASE "file", &st1) == 0);
+
+  /* Invalid arguments.  */
+  errno = 0;
+  ASSERT (func ("no_such", NULL) == -1);
+  ASSERT (errno == ENOENT);
+  errno = 0;
+  ASSERT (func ("", NULL) == -1);
+  ASSERT (errno == ENOENT);
+  {
+    struct timespec ts[2] = { { Y2K, UTIME_BOGUS_POS }, { Y2K, 0 } };
+    errno = 0;
+    ASSERT (func (BASE "file", ts) == -1);
+    ASSERT (errno == EINVAL);
+  }
+  {
+    struct timespec ts[2] = { { Y2K, 0 }, { Y2K, UTIME_BOGUS_NEG } };
+    errno = 0;
+    ASSERT (func (BASE "file", ts) == -1);
+    ASSERT (errno == EINVAL);
+  }
+  ASSERT (stat (BASE "file", &st2) == 0);
+  ASSERT (st1.st_atime == st2.st_atime);
+  ASSERT (get_stat_atime_ns (&st1) == get_stat_atime_ns (&st2));
+  ASSERT (utimecmp (BASE "file", &st1, &st2, 0) == 0);
+
+  /* Set both times.  */
+  {
+    struct timespec ts[2] = { { Y2K, BILLION / 2 - 1 }, { Y2K, BILLION - 1 } };
+    ASSERT (func (BASE "file", ts) == 0);
+    ASSERT (stat (BASE "file", &st2) == 0);
+    ASSERT (st2.st_atime == Y2K);
+    ASSERT (0 <= get_stat_atime_ns (&st2));
+    ASSERT (get_stat_atime_ns (&st2) < BILLION / 2);
+    ASSERT (st2.st_mtime == Y2K);
+    ASSERT (0 <= get_stat_mtime_ns (&st2));
+    ASSERT (get_stat_mtime_ns (&st2) < BILLION);
+  }
+
+  /* Play with UTIME_OMIT, UTIME_NOW.  */
+  {
+    struct timespec ts[2] = { { BILLION, UTIME_OMIT }, { 0, UTIME_NOW } };
+    ASSERT (func (BASE "file", ts) == 0);
+    ASSERT (stat (BASE "file", &st2) == 0);
+    ASSERT (st2.st_atime == Y2K);
+    ASSERT (0 <= get_stat_atime_ns (&st2));
+    ASSERT (get_stat_atime_ns (&st2) < BILLION / 2);
+    /* See comment above about this utimecmp call.  */
+    ASSERT (0 <= utimecmp (BASE "file", &st2, &st1, UTIMECMP_TRUNCATE_SOURCE));
+  }
+
+  /* Cleanup.  */
+  ASSERT (unlink (BASE "file") == 0);
+  return 0;
+}