Regression test portability: arequal-checksum

Building arequal-checksum on non Linux systems requires a few adjustments:
- use __builtin_alloca() on all platforms
- on systems without argp, get it from contrib/standalone-argp
  (this requires adding cflags support to the build_tester function)
- FTW_ACTIONRETVAL option to nftw(3) is GNU libc specific, work around
  if it does not exist.
- md5sum is Linux-specific. Use md5 -n on NetBSD and md5 -q on FreeBSD/Darwin
- Use 'cc' as synonymous for all compilers, it can behave as gcc/clang depending
  on which is default
- cleanup tabs/whitespaces

BUG: 764655
Change-Id: I9090c17da596fbf00fc1fbd7593163ce8cd3b84c
Signed-off-by: Emmanuel Dreyfus <manu@netbsd.org>
Signed-off-by: Harshavardhana <harsha@harshavardhana.net>
Reviewed-on: http://review.gluster.org/8283
Tested-by: Gluster Build System <jenkins@build.gluster.com>

7 files changed, 182 insertions, 157 deletions

diff --git a/tests/basic/afr/self-heal.t b/tests/basic/afr/self-heal.t
index 60e953b9996..98b4487af5b 100644
--- a/tests/basic/afr/self-heal.t
+++ b/tests/basic/afr/self-heal.t
@@ -7,7 +7,13 @@ cleanup;
 
 #Init
 AREQUAL_PATH=$(dirname $0)/../../utils
-build_tester $AREQUAL_PATH/arequal-checksum.c
+CFLAGS=""
+test "`uname -s`" != "Linux" && {
+    CFLAGS="$CFLAGS -I$(dirname $0)/../../../contrib/argp-standalone ";
+    CFLAGS="$CFLAGS -L$(dirname $0)/../../../contrib/argp-standalone -largp ";
+    CFLAGS="$CFLAGS -lintl";
+}
+build_tester $AREQUAL_PATH/arequal-checksum.c $CFLAGS
 TEST glusterd
 TEST pidof glusterd
 TEST $CLI volume create $V0 replica 2 $H0:$B0/brick{0,1}
diff --git a/tests/bugs/bug-1051896.t b/tests/bugs/bug-1051896.t
index 75859cbef0c..195602ec3a7 100644
--- a/tests/bugs/bug-1051896.t
+++ b/tests/bugs/bug-1051896.t
@@ -17,7 +17,7 @@ TEST glusterfs --entry-timeout=0 --attribute-timeout=0 --acl -s $H0 --volfile-id
 
 TEST touch $M0/file1;
 
-gcc -lacl $(dirname $0)/bug-1051896.c -o $(dirname $0)/bug-1051896
+$CC -lacl $(dirname $0)/bug-1051896.c -o $(dirname $0)/bug-1051896
 TEST ! $(dirname $0)/bug-1051896 $M0/file1 m 'u::r,u::w,g::r--,o::r--'
 rm -f $(dirname $0)/bug-1051896
 
diff --git a/tests/bugs/bug-1058663.t b/tests/bugs/bug-1058663.t
index bf8dc6cabca..168d18ad312 100644
--- a/tests/bugs/bug-1058663.t
+++ b/tests/bugs/bug-1058663.t
@@ -16,7 +16,7 @@ TEST $CLI volume start $V0;
 TEST glusterfs --entry-timeout=0 --attribute-timeout=0 -s $H0 --volfile-id $V0 $M0
 
 # compile the test program and run it
-gcc $(dirname $0)/bug-1058663.c -o $(dirname $0)/bug-1058663;
+$CC $(dirname $0)/bug-1058663.c -o $(dirname $0)/bug-1058663;
 TEST $(dirname $0)/bug-1058663 $M0/bug-1058663.bin;
 rm -f $(dirname $0)/M0/bug-1058663.bin;
 
@@ -26,4 +26,3 @@ TEST $CLI volume stop $V0;
 TEST $CLI volume delete $V0;
 
 cleanup;
-
diff --git a/tests/bugs/bug-824753.t b/tests/bugs/bug-824753.t
index 38f6bf6965f..772219a424b 100755
--- a/tests/bugs/bug-824753.t
+++ b/tests/bugs/bug-824753.t
@@ -30,7 +30,7 @@ EXPECT 'Started' volinfo_field $V0 'Status';
 TEST glusterfs -s $H0 --volfile-id=$V0 $M0
 touch $M0/file1;
 
-TEST gcc -g $(dirname $0)/bug-824753-file-locker.c -o $(dirname $0)/file-locker
+TEST $CC -g $(dirname $0)/bug-824753-file-locker.c -o $(dirname $0)/file-locker
 
 TEST $(dirname $0)/file-locker $V0 $H0 $B0 $M0 file1
 
diff --git a/tests/bugs/bug-905864.t b/tests/bugs/bug-905864.t
index 44bb469f288..cdc0cb71725 100644
--- a/tests/bugs/bug-905864.t
+++ b/tests/bugs/bug-905864.t
@@ -20,7 +20,7 @@ TEST touch $M0/file1;
 
 #following C program tries open up race(s) if any, in F_GETLK/F_SETLKW codepaths
 #of locks xlator
-gcc -lpthread -g3 $(dirname $0)/bug-905864.c -o $(dirname $0)/bug-905864
+$CC -lpthread -g3 $(dirname $0)/bug-905864.c -o $(dirname $0)/bug-905864
 $(dirname $0)/bug-905864 $M0/file1 &
 $(dirname $0)/bug-905864 $M1/file1;
 wait
@@ -29,4 +29,3 @@ rm -f $(dirname $0)/bug-905864
 EXPECT $(brick_count $V0) online_brick_count
 
 cleanup
-
diff --git a/tests/include.rc b/tests/include.rc
index 7f1dda8c53c..0638a22c7bd 100644
--- a/tests/include.rc
+++ b/tests/include.rc
@@ -6,6 +6,7 @@ N1=${N1:=/mnt/nfs/1};         # 1st mount point for NFS
 V0=${V0:=patchy};             # volume name to use in tests
 V1=${V1:=patchy1};            # volume name to use in tests
 B0=${B0:=/d/backends};        # top level of brick directories
+CC=cc
 case `uname -s` in
 Linux)
   H0=${H0:=`hostname --fqdn`}; # hostname
@@ -322,7 +323,9 @@ function build_tester ()
     local fname=$(basename "$cfile")
     local ext="${fname##*.}"
     local execname="${fname%.*}"
-    gcc -g -o $(dirname $cfile)/$execname $cfile
+    shift
+    local cflags=$*
+    $CC -g -o $(dirname $cfile)/$execname $cfile $cflags
 }
 
 function process_leak_count ()
diff --git a/tests/utils/arequal-checksum.c b/tests/utils/arequal-checksum.c
index bdc6af48464..d97c6d4f656 100644
--- a/tests/utils/arequal-checksum.c
+++ b/tests/utils/arequal-checksum.c
@@ -21,7 +21,7 @@
 #define _GNU_SOURCE
 #endif
 
-#define _XOPEN_SOURCE 600
+#define _XOPEN_SOURCE 500
 
 #include <ftw.h>
 #include <stdio.h>
@@ -35,10 +35,18 @@
 #include <stdlib.h>
 #include <libgen.h>
 #include <stdint.h>
-#include <alloca.h>
 #include <dirent.h>
 #include <argp.h>
 
+/*
+ * FTW_ACTIONRETVAL is a GNU libc extension. It is used here to skip
+ * hiearchies. On other systems we will still walk the tree, ignoring
+ * entries.
+ */
+#ifndef FTW_ACTIONRETVAL
+#define FTW_ACTIONRETVAL 0
+#define FTW_SKIP_SUBTREE 0
+#endif
 
 int debug = 0;
 
@@ -60,12 +68,12 @@ static struct argp_option arequal_options[] = {
         {0, 0, 0, 0, 0}
 };
 
-#define DBG(fmt ...) do {			\
-		if (debug) {			\
-			fprintf (stderr, "D "); \
-			fprintf (stderr, fmt);	\
-		}				\
-	} while (0)
+#define DBG(fmt ...) do {                       \
+                if (debug) {                    \
+                        fprintf (stderr, "D "); \
+                        fprintf (stderr, fmt);  \
+                }                               \
+        } while (0)
 
 void
 add_to_list (char *arg);
@@ -74,7 +82,7 @@ get_absolute_path (char directory[], char *arg);
 
 static inline int roof(int a, int b)
 {
-	return ((((a)+(b)-1)/((b)?(b):1))*(b));
+        return ((((a)+(b)-1)/((b)?(b):1))*(b));
 }
 
 void
@@ -194,25 +202,25 @@ unsigned long long      checksum_other   = 0;
 unsigned long long
 checksum_path (const char *path)
 {
-	unsigned long long   csum = 0;
-	unsigned long long  *nums = 0;
-	int                  len = 0;
-	int                  cnt = 0;
-
-	len = roof (strlen (path), sizeof (csum));
-	cnt = len / sizeof (csum);
-
-	nums = alloca (len);
-	memset (nums, 0, len);
-	strcpy ((char *)nums, path);
-
-	while (cnt) {
-		csum ^= *nums;
-		nums++;
-		cnt--;
-	}
+        unsigned long long   csum = 0;
+        unsigned long long  *nums = 0;
+        int                  len = 0;
+        int                  cnt = 0;
+
+        len = roof (strlen (path), sizeof (csum));
+        cnt = len / sizeof (csum);
+
+        nums = __builtin_alloca (len);
+        memset (nums, 0, len);
+        strcpy ((char *)nums, path);
+
+        while (cnt) {
+                csum ^= *nums;
+                nums++;
+                cnt--;
+        }
 
-	return csum;
+        return csum;
 }
 
 int
@@ -243,8 +251,18 @@ checksum_md5 (const char *path, const struct stat *sb)
         /* Now, build the command with single quotes escaped. */
 
         cpos = cmd;
+#if defined(linux)
         strcpy(cpos, "md5sum '");
         cpos += 8;
+#elif defined(__NetBSD__)
+        strcpy(cpos, "md5 -n '");
+        cpos += 8;
+#elif defined(__FreeBSD__) || defined(__APPLE__)
+        strcpy(cpos, "md5 -q '");
+        cpos += 8;
+#else
+#error "Please add system-specific md5 command"
+#endif
 
         /* Add the file path, with every single quotes replaced with this sequence:
          * '\''
@@ -307,20 +325,20 @@ out:
 int
 checksum_filenames (const char *path, const struct stat *sb)
 {
-	DIR                *dirp = NULL;
-	struct dirent      *entry = NULL;
-	unsigned long long  csum = 0;
+        DIR                *dirp = NULL;
+        struct dirent      *entry = NULL;
+        unsigned long long  csum = 0;
         int                 i = 0;
         int                 found = 0;
 
-	dirp = opendir (path);
-	if (!dirp) {
-		perror (path);
-		goto out;
-	}
+        dirp = opendir (path);
+        if (!dirp) {
+                perror (path);
+                goto out;
+        }
 
-	errno = 0;
-	while ((entry = readdir (dirp))) {
+        errno = 0;
+        while ((entry = readdir (dirp))) {
                 /* do not calculate the checksum of the entries which user has
                    told to ignore and proceed to other siblings.*/
                 if (arequal_config.ignored_directory) {
@@ -339,112 +357,112 @@ checksum_filenames (const char *path, const struct stat *sb)
                                 continue;
                         }
                 }
-		csum = checksum_path (entry->d_name);
-		checksum_dir ^= csum;
-	}
+                csum = checksum_path (entry->d_name);
+                checksum_dir ^= csum;
+        }
 
-	if (errno) {
-		perror (path);
-		goto out;
-	}
+        if (errno) {
+                perror (path);
+                goto out;
+        }
 
 out:
-	if (dirp)
-		closedir (dirp);
+        if (dirp)
+                closedir (dirp);
 
-	return 0;
+        return 0;
 }
 
 
 int
 process_file (const char *path, const struct stat *sb)
 {
-	int    ret = 0;
+        int    ret = 0;
 
-	count_file++;
+        count_file++;
 
-	avg_uid_file ^= sb->st_uid;
-	avg_gid_file ^= sb->st_gid;
-	avg_mode_file ^= sb->st_mode;
+        avg_uid_file ^= sb->st_uid;
+        avg_gid_file ^= sb->st_gid;
+        avg_mode_file ^= sb->st_mode;
 
-	ret = checksum_md5 (path, sb);
+        ret = checksum_md5 (path, sb);
 
-	return ret;
+        return ret;
 }
 
 
 int
 process_dir (const char *path, const struct stat *sb)
 {
-	unsigned long long csum = 0;
+        unsigned long long csum = 0;
 
-	count_dir++;
+        count_dir++;
 
-	avg_uid_dir ^= sb->st_uid;
-	avg_gid_dir ^= sb->st_gid;
-	avg_mode_dir ^= sb->st_mode;
+        avg_uid_dir ^= sb->st_uid;
+        avg_gid_dir ^= sb->st_gid;
+        avg_mode_dir ^= sb->st_mode;
 
-	csum = checksum_filenames (path, sb);
+        csum = checksum_filenames (path, sb);
 
-	checksum_dir ^= csum;
+        checksum_dir ^= csum;
 
-	return 0;
+        return 0;
 }
 
 
 int
 process_symlink (const char *path, const struct stat *sb)
 {
-	int                ret = 0;
-	char               buf[4096] = {0, };
-	unsigned long long csum = 0;
+        int                ret = 0;
+        char               buf[4096] = {0, };
+        unsigned long long csum = 0;
 
-	count_symlink++;
+        count_symlink++;
 
-	avg_uid_symlink ^= sb->st_uid;
-	avg_gid_symlink ^= sb->st_gid;
-	avg_mode_symlink ^= sb->st_mode;
+        avg_uid_symlink ^= sb->st_uid;
+        avg_gid_symlink ^= sb->st_gid;
+        avg_mode_symlink ^= sb->st_mode;
 
-	ret = readlink (path, buf, 4096);
-	if (ret < 0) {
-		perror (path);
-		goto out;
-	}
+        ret = readlink (path, buf, 4096);
+        if (ret < 0) {
+                perror (path);
+                goto out;
+        }
 
-	DBG ("readlink (%s) => %s\n", path, buf);
+        DBG ("readlink (%s) => %s\n", path, buf);
 
-	csum = checksum_path (buf);
+        csum = checksum_path (buf);
 
-	DBG ("checksum_path (%s) => %llx\n", buf, csum);
+        DBG ("checksum_path (%s) => %llx\n", buf, csum);
 
-	checksum_symlink ^= csum;
+        checksum_symlink ^= csum;
 
-	ret = 0;
+        ret = 0;
 out:
-	return ret;
+        return ret;
 }
 
 
 int
 process_other (const char *path, const struct stat *sb)
 {
-	count_other++;
+        count_other++;
 
-	avg_uid_other ^= sb->st_uid;
-	avg_gid_other ^= sb->st_gid;
-	avg_mode_other ^= sb->st_mode;
+        avg_uid_other ^= sb->st_uid;
+        avg_gid_other ^= sb->st_gid;
+        avg_mode_other ^= sb->st_mode;
 
-	checksum_other ^= sb->st_rdev;
+        checksum_other ^= sb->st_rdev;
 
-	return 0;
+        return 0;
 }
 
 
 int
 process_entry (const char *path, const struct stat *sb,
-	       int typeflag, struct FTW *ftwbuf)
+               int typeflag, struct FTW *ftwbuf)
 {
-	int ret = 0;
+        int ret = 0;
         char *name = NULL;
         char *bname = NULL;
         char *dname = NULL;
@@ -469,7 +487,7 @@ process_entry (const char *path, const struct stat *sb,
         if (arequal_config.ignored_directory) {
                 name = strdup (path);
 
-                name[strlen(name)] == '\0';
+                name[strlen(name)] = '\0';
 
                 bname = strrchr (name, '/');
                 if (bname)
@@ -489,22 +507,22 @@ process_entry (const char *path, const struct stat *sb,
                 }
         }
 
-	DBG ("processing entry %s\n", path);
-
-	switch ((S_IFMT & sb->st_mode)) {
-	case S_IFDIR:
-		ret = process_dir (path, sb);
-		break;
-	case S_IFREG:
-		ret = process_file (path, sb);
-		break;
-	case S_IFLNK:
-		ret = process_symlink (path, sb);
-		break;
-	default:
-		ret = process_other (path, sb);
-		break;
-	}
+        DBG ("processing entry %s\n", path);
+
+        switch ((S_IFMT & sb->st_mode)) {
+        case S_IFDIR:
+                ret = process_dir (path, sb);
+                break;
+        case S_IFREG:
+                ret = process_file (path, sb);
+                break;
+        case S_IFLNK:
+                ret = process_symlink (path, sb);
+                break;
+        default:
+                ret = process_other (path, sb);
+                break;
+        }
 
         if (name)
                 free (name);
@@ -515,69 +533,69 @@ process_entry (const char *path, const struct stat *sb,
 int
 display_counts (FILE *fp)
 {
-	fprintf (fp, "\n");
-	fprintf (fp, "Entry counts\n");
-	fprintf (fp, "Regular files   : %lld\n", count_file);
-	fprintf (fp, "Directories     : %lld\n", count_dir);
-	fprintf (fp, "Symbolic links  : %lld\n", count_symlink);
-	fprintf (fp, "Other           : %lld\n", count_other);
-	fprintf (fp, "Total           : %lld\n",
-		 (count_file + count_dir + count_symlink + count_other));
-
-	return 0;
+        fprintf (fp, "\n");
+        fprintf (fp, "Entry counts\n");
+        fprintf (fp, "Regular files   : %lld\n", count_file);
+        fprintf (fp, "Directories     : %lld\n", count_dir);
+        fprintf (fp, "Symbolic links  : %lld\n", count_symlink);
+        fprintf (fp, "Other           : %lld\n", count_other);
+        fprintf (fp, "Total           : %lld\n",
+                 (count_file + count_dir + count_symlink + count_other));
+
+        return 0;
 }
 
 
 int
 display_checksums (FILE *fp)
 {
-	fprintf (fp, "\n");
-	fprintf (fp, "Checksums\n");
-	fprintf (fp, "Regular files   : %llx%llx\n", checksum_file1, checksum_file2);
-	fprintf (fp, "Directories     : %llx\n", checksum_dir);
-	fprintf (fp, "Symbolic links  : %llx\n", checksum_symlink);
-	fprintf (fp, "Other           : %llx\n", checksum_other);
-	fprintf (fp, "Total           : %llx\n",
-		 (checksum_file1 ^ checksum_file2 ^ checksum_dir ^ checksum_symlink ^ checksum_other));
-
-	return 0;
+        fprintf (fp, "\n");
+        fprintf (fp, "Checksums\n");
+        fprintf (fp, "Regular files   : %llx%llx\n", checksum_file1, checksum_file2);
+        fprintf (fp, "Directories     : %llx\n", checksum_dir);
+        fprintf (fp, "Symbolic links  : %llx\n", checksum_symlink);
+        fprintf (fp, "Other           : %llx\n", checksum_other);
+        fprintf (fp, "Total           : %llx\n",
+                 (checksum_file1 ^ checksum_file2 ^ checksum_dir ^ checksum_symlink ^ checksum_other));
+
+        return 0;
 }
 
 
 int
 display_metadata (FILE *fp)
 {
-	fprintf (fp, "\n");
-	fprintf (fp, "Metadata checksums\n");
-	fprintf (fp, "Regular files   : %llx\n",
-		 (avg_uid_file + 13) * (avg_gid_file + 11) * (avg_mode_file + 7));
-	fprintf (fp, "Directories     : %llx\n",
-		 (avg_uid_dir + 13) * (avg_gid_dir + 11) * (avg_mode_dir + 7));
-	fprintf (fp, "Symbolic links  : %llx\n",
-		 (avg_uid_symlink + 13) * (avg_gid_symlink + 11) * (avg_mode_symlink + 7));
-	fprintf (fp, "Other           : %llx\n",
-		 (avg_uid_other + 13) * (avg_gid_other + 11) * (avg_mode_other + 7));
-
-	return 0;
+        fprintf (fp, "\n");
+        fprintf (fp, "Metadata checksums\n");
+        fprintf (fp, "Regular files   : %llx\n",
+                 (avg_uid_file + 13) * (avg_gid_file + 11) * (avg_mode_file + 7));
+        fprintf (fp, "Directories     : %llx\n",
+                 (avg_uid_dir + 13) * (avg_gid_dir + 11) * (avg_mode_dir + 7));
+        fprintf (fp, "Symbolic links  : %llx\n",
+                 (avg_uid_symlink + 13) * (avg_gid_symlink + 11) * (avg_mode_symlink + 7));
+        fprintf (fp, "Other           : %llx\n",
+                 (avg_uid_other + 13) * (avg_gid_other + 11) * (avg_mode_other + 7));
+
+        return 0;
 }
 
 int
 display_stats (FILE *fp)
 {
-	display_counts (fp);
+        display_counts (fp);
 
-	display_metadata (fp);
+        display_metadata (fp);
 
-	display_checksums (fp);
+        display_checksums (fp);
 
-	return 0;
+        return 0;
 }
 
 
 int
 main(int argc, char *argv[])
 {
-	int  ret = 0;
+        int  ret = 0;
         int  i = 0;
 
         ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
@@ -591,13 +609,13 @@ main(int argc, char *argv[])
          /* (process_entry in this case) */
         ret = nftw (arequal_config.test_directory, process_entry, 30,
                     FTW_ACTIONRETVAL|FTW_PHYS|FTW_MOUNT);
-	if (ret != 0) {
-		fprintf (stderr, "ftw (%s) returned %d (%s), terminating\n",
-			 argv[1], ret, strerror (errno));
-		return 1;
-	}
+        if (ret != 0) {
+                fprintf (stderr, "ftw (%s) returned %d (%s), terminating\n",
+                         argv[1], ret, strerror (errno));
+                return 1;
+        }
 
-	display_stats (stdout);
+        display_stats (stdout);
 
         if (arequal_config.ignored_directory) {
                 for (i = 0; i < arequal_config.directories_ignored; i++) {
@@ -607,5 +625,5 @@ main(int argc, char *argv[])
                 free (arequal_config.ignored_directory);
         }
 
-	return 0;
+        return 0;
 }