Add the ZFS Test Suite

Add the ZFS Test Suite and test-runner framework from illumos.
This is a continuation of the work done by Turbo Fredriksson to
port the ZFS Test Suite to Linux.  While this work was originally
conceived as a stand alone project integrating it directly with
the ZoL source tree has several advantages:

  * Allows the ZFS Test Suite to be packaged in zfs-test package.
    * Facilitates easy integration with the CI testing.
    * Users can locally run the ZFS Test Suite to validate ZFS.
      This testing should ONLY be done on a dedicated test system
      because the ZFS Test Suite in its current form is destructive.
  * Allows the ZFS Test Suite to be run directly in the ZoL source
    tree enabled developers to iterate quickly during development.
  * Developers can easily add/modify tests in the framework as
    features are added or functionality is changed.  The tests
    will then always be in sync with the implementation.

Full documentation for how to run the ZFS Test Suite is available
in the tests/README.md file.

Warning: This test suite is designed to be run on a dedicated test
system.  It will make modifications to the system including, but
not limited to, the following.

  * Adding new users
  * Adding new groups
  * Modifying the following /proc files:
    * /proc/sys/kernel/core_pattern
    * /proc/sys/kernel/core_uses_pid
  * Creating directories under /

Notes:
  * Not all of the test cases are expected to pass and by default
    these test cases are disabled.  The failures are primarily due
    to assumption made for illumos which are invalid under Linux.
  * When updating these test cases it should be done in as generic
    a way as possible so the patch can be submitted back upstream.
    Most existing library functions have been updated to be Linux
    aware, and the following functions and variables have been added.
    * Functions:
      * is_linux          - Used to wrap a Linux specific section.
      * block_device_wait - Waits for block devices to be added to /dev/.
    * Variables:            Linux          Illumos
      * ZVOL_DEVDIR         "/dev/zvol"    "/dev/zvol/dsk"
      * ZVOL_RDEVDIR        "/dev/zvol"    "/dev/zvol/rdsk"
      * DEV_DSKDIR          "/dev"         "/dev/dsk"
      * DEV_RDSKDIR         "/dev"         "/dev/rdsk"
      * NEWFS_DEFAULT_FS    "ext2"         "ufs"
  * Many of the disabled test cases fail because 'zfs/zpool destroy'
    returns EBUSY.  This is largely causes by the asynchronous nature
    of device handling on Linux and is expected, the impacted test
    cases will need to be updated to handle this.
  * There are several test cases which have been disabled because
    they can trigger a deadlock.  A primary example of this is to
    recursively create zpools within zpools.  These tests have been
    disabled until the root issue can be addressed.
  * Illumos specific utilities such as (mkfile) should be added to
    the tests/zfs-tests/cmd/ directory.  Custom programs required by
    the test scripts can also be added here.
  * SELinux should be either is permissive mode or disabled when
    running the tests.  The test cases should be updated to conform
    to a standard policy.
  * Redundant test functionality has been removed (zfault.sh).
  * Existing test scripts (zconfig.sh) should be migrated to use
    the framework for consistency and ease of testing.
  * The DISKS environment variable currently only supports loopback
    devices because of how the ZFS Test Suite expects partitions to
    be named (p1, p2, etc).  Support must be added to generate the
    correct partition name based on the device location and name.
  * The ZFS Test Suite is part of the illumos code base at:
    https://github.com/illumos/illumos-gate/tree/master/usr/src/test

Original-patch-by: Turbo Fredriksson <[email protected]>
Signed-off-by: Brian Behlendorf <[email protected]>
Signed-off-by: Olaf Faaland <[email protected]>
Closes #6
Closes #1534

1 files changed, 62 insertions, 37 deletions

diff --git a/zfs-script-config.sh.in b/zfs-script-config.sh.in
index 10d24f027..51871b545 100644
--- a/zfs-script-config.sh.in
+++ b/zfs-script-config.sh.in
@@ -1,54 +1,79 @@
-#!/bin/bash
+export KERNELSRC=@LINUX@
+export KERNELBUILD=@LINUX_OBJ@
+export KERNELSRCVER=@LINUX_VERSION@
+export KERNELMOD=/lib/modules/${KERNELSRCVER}/kernel
 
-KERNELSRC=@LINUX@
-KERNELBUILD=@LINUX_OBJ@
-KERNELSRCVER=@LINUX_VERSION@
-KERNELMOD=/lib/modules/${KERNELSRCVER}/kernel
+export SPLSRC=@SPL@
+export SPLBUILD=@SPL_OBJ@
+export SPLSRCVER=@SPL_VERSION@
 
-SPLSRC=@SPL@
-SPLBUILD=@SPL_OBJ@
-SPLSRCVER=@SPL_VERSION@
+export SRCDIR=@abs_top_srcdir@
+export BUILDDIR=@abs_top_builddir@
+export LIBDIR=${BUILDDIR}/lib
+export CMDDIR=${BUILDDIR}/cmd
+export MODDIR=${BUILDDIR}/module
+export SCRIPTDIR=${BUILDDIR}/scripts
+export ZPOOLDIR=${BUILDDIR}/scripts/zpool-config
+export ZPIOSDIR=${BUILDDIR}/scripts/zpios-test
+export ZPIOSPROFILEDIR=${BUILDDIR}/scripts/zpios-profile
+export ETCDIR=${SRCDIR}/etc
+export TESTSDIR=${SRCDIR}/tests
+export RUNFILEDIR=${TESTSDIR}/runfiles
 
-SRCDIR=@abs_top_srcdir@
-BUILDDIR=@abs_top_builddir@
-LIBDIR=${BUILDDIR}/lib
-CMDDIR=${BUILDDIR}/cmd
-MODDIR=${BUILDDIR}/module
-SCRIPTDIR=${BUILDDIR}/scripts
-ZPOOLDIR=${BUILDDIR}/scripts/zpool-config
-ZPIOSDIR=${BUILDDIR}/scripts/zpios-test
-ZPIOSPROFILEDIR=${BUILDDIR}/scripts/zpios-profile
-ETCDIR=${SRCDIR}/etc
+export ZDB=${CMDDIR}/zdb/zdb
+export ZFS=${CMDDIR}/zfs/zfs
+export ZINJECT=${CMDDIR}/zinject/zinject
+export ZPOOL=${CMDDIR}/zpool/zpool
+export ZTEST=${CMDDIR}/ztest/ztest
+export ZPIOS=${CMDDIR}/zpios/zpios
 
-ZDB=${CMDDIR}/zdb/zdb
-ZFS=${CMDDIR}/zfs/zfs
-ZINJECT=${CMDDIR}/zinject/zinject
-ZPOOL=${CMDDIR}/zpool/zpool
-ZTEST=${CMDDIR}/ztest/ztest
-ZPIOS=${CMDDIR}/zpios/zpios
+export COMMON_SH=${SCRIPTDIR}/common.sh
+export ZFS_SH=${SCRIPTDIR}/zfs.sh
+export ZPOOL_CREATE_SH=${SCRIPTDIR}/zpool-create.sh
+export ZPIOS_SH=${SCRIPTDIR}/zpios.sh
+export ZPIOS_SURVEY_SH=${SCRIPTDIR}/zpios-survey.sh
 
-COMMON_SH=${SCRIPTDIR}/common.sh
-ZFS_SH=${SCRIPTDIR}/zfs.sh
-ZPOOL_CREATE_SH=${SCRIPTDIR}/zpool-create.sh
-ZPIOS_SH=${SCRIPTDIR}/zpios.sh
-ZPIOS_SURVEY_SH=${SCRIPTDIR}/zpios-survey.sh
+# Test Suite Specific Commands
+export TEST_RUNNER=${TESTSDIR}/test-runner/cmd/test-runner.py
+export STF_TOOLS=${TESTSDIR}/test-runner
+export STF_SUITE=${TESTSDIR}/zfs-tests
 
-INTREE=1
-LDMOD=/sbin/insmod
+export CHG_USR_EXEC=${TESTSDIR}/zfs-tests/cmd/chg_usr_exec/chg_usr_exec
+export DEVNAME2DEVID=${TESTSDIR}/zfs-tests/cmd/devname2devid/devname2devid
+export DIR_RD_UPDATE=${TESTSDIR}/zfs-tests/cmd/dir_rd_update/dir_rd_update
+export FILE_CHECK=${TESTSDIR}/zfs-tests/cmd/file_check/file_check
+export FILE_TRUNC=${TESTSDIR}/zfs-tests/cmd/file_trunc/file_trunc
+export FILE_WRITE=${TESTSDIR}/zfs-tests/cmd/file_write/file_write
+export LARGEST_FILE=${TESTSDIR}/zfs-tests/cmd/largest_file/largest_file
+export MKBUSY=${TESTSDIR}/zfs-tests/cmd/mkbusy/mkbusy
+export MKFILE=${TESTSDIR}/zfs-tests/cmd/mkfile/mkfile
+export MKFILES=${TESTSDIR}/zfs-tests/cmd/mkfile/mkfiles
+export MKTREE=${TESTSDIR}/zfs-tests/cmd/mktree/mktree
+export MMAP_EXEC=${TESTSDIR}/zfs-tests/cmd/mmap_exec/mmap_exec
+export MMAPWRITE=${TESTSDIR}/zfs-tests/cmd/mmapwrite/mmapwrite
+export RANDFREE_FILE=${TESTSDIR}/zfs-tests/cmd/randfree_file/randfree_file
+export READMMAP=${TESTSDIR}/zfs-tests/cmd/readmmap/readmmap
+export RENAME_DIR=${TESTSDIR}/zfs-tests/cmd/rename_dir/rename_dir
+export RM_LNKCNT_ZERO_FILE=${TESTSDIR}/zfs-tests/cmd/rm_lnkcnt_zero_file/rm_lnkcnt_zero_file
+export THREADSAPPEND=${TESTSDIR}/zfs-tests/cmd/threadsappend/threadsappend
+export XATTRTEST=${TESTDIR}/zfs-tests/cmd/xattrtest
 
-ZED_PIDFILE=@runstatedir@/zed.pid
+export INTREE=1
+export LDMOD=/sbin/insmod
 
-KERNEL_MODULES=(                                      \
+export ZED_PIDFILE=@runstatedir@/zed.pid
+
+export KERNEL_MODULES=(                               \
         ${KERNELMOD}/lib/zlib_deflate/zlib_deflate.ko \
         ${KERNELMOD}/lib/zlib_inflate/zlib_inflate.ko \
 )
 
-SPL_MODULES=(                                         \
+export SPL_MODULES=(                                  \
         ${SPLBUILD}/module/spl/spl.ko                 \
         ${SPLBUILD}/module/splat/splat.ko             \
 )
 
-ZFS_MODULES=(                                         \
+export ZFS_MODULES=(                                  \
         ${MODDIR}/avl/zavl.ko                         \
         ${MODDIR}/nvpair/znvpair.ko                   \
         ${MODDIR}/unicode/zunicode.ko                 \
@@ -56,11 +81,11 @@ ZFS_MODULES=(                                         \
         ${MODDIR}/zfs/zfs.ko                          \
 )
 
-ZPIOS_MODULES=(                                       \
+export ZPIOS_MODULES=(                                \
         ${MODDIR}/zpios/zpios.ko                      \
 )
 
-MODULES=(                                             \
+export MODULES=(                                      \
         ${SPL_MODULES[*]}                             \
         ${ZFS_MODULES[*]}                             \
 )