Re: [PATCH 2/4] ptsname_r-tests: new test module

[Eric Blake]

On 11/08/2011 04:14 AM, Bruno Haible wrote:
> Eric Blake wrote:
> > +static int
> > +test_errors (int fd, char *slave)
>
> The parameter should be a 'const char *slave'.

Thanks for the feedback.  I think I incorporated it all, with this being 
what I pushed.  Now we get to work on addressing the platform fallout; 
I'll start by fixing ptsname_r.c to no longer blindly assume errno 
values after isatty (in the interest of fewer dependencies, ptsname_r 
need not depend on my proposed isatty-gnu), as well as convert existing 
clients of ptsname() to use ptsname_r().

Also, I wonder if we should refactor the code to share common features 
between test-ptsname{,_r}.c into test-ptsname.h.

From 588c36efa32e2786b19be2e7d53ad68a59b59f55 Mon Sep 17 00:00:00 2001
From: Eric Blake <address@hidden>
Date: Mon, 7 Nov 2011 16:01:36 -0700
Subject: [PATCH] ptsname_r-tests: new test module

For now, this tests glibc behavior of both returning an errno
value as well as setting errno; we may need to relax that.

* modules/ptsname_r-tests: New module.
* tests/test-ptsname_r.c: New file.

Signed-off-by: Eric Blake <address@hidden>
---
 ChangeLog               |    4 +
 modules/ptsname_r-tests |   14 +++
 tests/test-ptsname_r.c  |  230 
+++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 248 insertions(+), 0 deletions(-)
 create mode 100644 modules/ptsname_r-tests
 create mode 100644 tests/test-ptsname_r.c

diff --git a/ChangeLog b/ChangeLog
index 8aacfda..404b95d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2011-11-09  Eric Blake  <address@hidden>

+       ptsname_r-tests: new test module
+       * modules/ptsname_r-tests: New module.
+       * tests/test-ptsname_r.c: New file.
+
        ptsname_r: new module
        * modules/ptsname_r: New module.
        * m4/ptsname_r.m4 (gl_FUNC_PTSNAME_R): New file.
diff --git a/modules/ptsname_r-tests b/modules/ptsname_r-tests
new file mode 100644
index 0000000..50b3f81
--- /dev/null
+++ b/modules/ptsname_r-tests
@@ -0,0 +1,14 @@
+Files:
+tests/test-ptsname_r.c
+tests/signature.h
+tests/macros.h
+
+Depends-on:
+same-inode
+
+configure.ac:
+AC_CHECK_DECLS_ONCE([alarm])
+
+Makefile.am:
+TESTS += test-ptsname_r
+check_PROGRAMS += test-ptsname_r
diff --git a/tests/test-ptsname_r.c b/tests/test-ptsname_r.c
new file mode 100644
index 0000000..a97b179
--- /dev/null
+++ b/tests/test-ptsname_r.c
@@ -0,0 +1,230 @@
+/* Test of ptsname_r(3).
+   Copyright (C) 2010-2011 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/>.  */
+
+#include <config.h>
+
+#include <stdlib.h>
+
+#include "signature.h"
+SIGNATURE_CHECK (ptsname_r, int, (int, char *, size_t));
+
+#include <errno.h>
+#include <fcntl.h>
+#include <signal.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/stat.h>
+
+#include "same-inode.h"
+
+#include "macros.h"
+
+/* Compare two slave names.
+   On some systems, there are hard links in the /dev/ directory.
+   For example, on OSF/1 5.1,
+     /dev/ttyp0 == /dev/pts/0
+     /dev/ttyp9 == /dev/pts/9
+     /dev/ttypa == /dev/pts/10
+     /dev/ttype == /dev/pts/14
+ */
+static int
+same_slave (const char *slave_name1, const char *slave_name2)
+{
+  struct stat statbuf1;
+  struct stat statbuf2;
+
+  return (strcmp (slave_name1, slave_name2) == 0
+          || (stat (slave_name1, &statbuf1) >= 0
+              && stat (slave_name2, &statbuf2) >= 0
+              && SAME_INODE (statbuf1, statbuf2)));
+}
+
+static int
+test_errors (int fd, const char *slave)
+{
+  char buffer[256];
+  size_t len;
+  int result;
+  size_t buflen;
+
+  len = strlen (slave);
+  for (buflen = 0; buflen <= sizeof buffer; buflen++)
+    {
+      errno = 0;
+      memset (buffer, 'X', sizeof buffer);
+      result = ptsname_r (fd, buffer, len);
+      if (buflen > len)
+        {
+          ASSERT (result == 0);
+          ASSERT (buffer[0] == '/');
+        }
+      else
+        {
+          ASSERT (result != 0);
+          ASSERT (result == errno);
+          ASSERT (errno == ERANGE);
+          ASSERT (buffer[0] == 'X');
+        }
+    }
+
+  errno = 0;
+  result = ptsname_r (fd, NULL, 0);
+  ASSERT (result != 0);
+  ASSERT (result == errno);
+  ASSERT (errno == EINVAL);
+}
+
+int
+main (void)
+{
+#if HAVE_DECL_ALARM
+  /* Declare failure if test takes too long, by using default abort
+     caused by SIGALRM.  */
+  signal (SIGALRM, SIG_DFL);
+  alarm (5);
+#endif
+
+  {
+    char buffer[256];
+    int result;
+
+    errno = 0;
+    result = ptsname_r (-1, buffer, sizeof buffer);
+    ASSERT (result != 0);
+    ASSERT (result == errno);
+    ASSERT (errno == EBADF || errno == ENOTTY);
+  }
+
+  {
+    int fd;
+    char buffer[256];
+    int result;
+
+    /* Open the controlling tty of the current process.  */
+    fd = open ("/dev/tty", O_RDONLY);
+    if (fd < 0)
+      {
+        fprintf (stderr, "Skipping test: cannot open controlling tty\n");
+        return 77;
+      }
+
+    result = ptsname_r (fd, buffer, sizeof buffer);
+    /* The result is usually NULL, because /dev/tty is a slave, not a
+       master.  */
+    if (result == 0)
+      {
+        ASSERT (memcmp (buffer, "/dev/", 5) == 0);
+      }
+
+    close (fd);
+  }
+
+#if defined __sun
+  /* Solaris has BSD-style /dev/pty[p-r][0-9a-f] files, but the function
+     ptsname() does not work on them.  */
+  {
+    int fd;
+    char buffer[256];
+    int result;
+
+    /* Open the controlling tty of the current process.  */
+    fd = open ("/dev/ptmx", O_RDWR | O_NOCTTY);
+    if (fd < 0)
+      {
+        fprintf (stderr, "Skipping test: cannot open pseudo-terminal\n");
+        return 77;
+      }
+
+    result = ptsname_r (fd, buffer, sizeof buffer);
+    ASSERT (result == 0);
+    ASSERT (memcmp (buffer, "/dev/pts/", 9) == 0);
+
+    test_errors (fd, buffer);
+
+    close (fd);
+  }
+
+#else
+
+  /* Try various master names of MacOS X: /dev/pty[p-w][0-9a-f]  */
+  {
+    int char1;
+    int char2;
+
+    for (char1 = 'p'; char1 <= 'w'; char1++)
+      for (char2 = '0'; char2 <= 'f'; (char2 == '9' ? char2 = 'a' : 
char2++))
+        {
+          char master_name[32];
+          int fd;
+
+          sprintf (master_name, "/dev/pty%c%c", char1, char2);
+          fd = open (master_name, O_RDONLY);
+          if (fd >= 0)
+            {
+              char buffer[256];
+              int result;
+              char slave_name[32];
+
+              result = ptsname_r (fd, buffer, sizeof buffer);
+              ASSERT (result == 0);
+              sprintf (slave_name, "/dev/tty%c%c", char1, char2);
+              ASSERT (same_slave (buffer, slave_name));
+
+              test_errors (fd, buffer);
+
+              close (fd);
+            }
+        }
+  }
+
+  /* Try various master names of *BSD: /dev/pty[p-sP-S][0-9a-v]  */
+  {
+    int upper;
+    int char1;
+    int char2;
+
+    for (upper = 0; upper <= 1; upper++)
+      for (char1 = (upper ? 'P' : 'p'); char1 <= (upper ? 'S' : 's'); 
char1++)
+        for (char2 = '0'; char2 <= 'v'; (char2 == '9' ? char2 = 'a' : 
char2++))
+          {
+            char master_name[32];
+            int fd;
+
+            sprintf (master_name, "/dev/pty%c%c", char1, char2);
+            fd = open (master_name, O_RDONLY);
+            if (fd >= 0)
+              {
+                char buffer[256];
+                int result;
+                char slave_name[32];
+
+                result = ptsname_r (fd, buffer, sizeof buffer);
+                ASSERT (result == 0);
+                sprintf (slave_name, "/dev/tty%c%c", char1, char2);
+                ASSERT (same_slave (buffer, slave_name));
+
+                test_errors (fd, buffer);
+
+                close (fd);
+              }
+          }
+  }
+
+#endif
+
+  return 0;
+}
--
1.7.4.4



--
Eric Blake   address@hidden    +1-801-349-2682
Libvirt virtualization library http://libvirt.org