Add python style checking

Introduce a make recipe for flake8 to enable python
style checking. Ensure all python scripts pass flake8.
Return an error code of 0 for arcstat.py -v and
dbufstat.py -v.  Add test cases for python scripts.

Reviewed by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Richard Elling <Richard.Elling@RichardElling.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ian Lee <IanLee1521@gmail.com>
Closes #5230

tests/runfiles/linux.run

@@ -355,7 +355,8 @@ tests = ['zdb_001_neg', 'zfs_001_neg', 'zfs_allow_001_neg',
     'zpool_history_001_neg', 'zpool_import_001_neg', 'zpool_import_002_neg',
     'zpool_offline_001_neg', 'zpool_online_001_neg', 'zpool_remove_001_neg',
     'zpool_replace_001_neg', 'zpool_scrub_001_neg', 'zpool_set_001_neg',
-    'zpool_status_001_neg', 'zpool_upgrade_001_neg']
+    'zpool_status_001_neg', 'zpool_upgrade_001_neg', 'arcstat_001_pos',
+    'arc_summary_001_pos', 'dbufstat_001_pos']
 user =
 
 [tests/functional/cli_user/zfs_list]

tests/test-runner/cmd/test-runner.py

@@ -127,12 +127,12 @@ class Cmd(object):
         self.killed = False
         self.result = Result()
 
-        if self.timeout == None:
-	    self.timeout = 60
+        if self.timeout is None:
+            self.timeout = 60
 
     def __str__(self):
         return "Pathname: %s\nOutputdir: %s\nTimeout: %d\nUser: %s\n" % (
-                self.pathname, self.outputdir, self.timeout, self.user)
+            self.pathname, self.outputdir, self.timeout, self.user)
 
     def kill_cmd(self, proc):
         """
@@ -309,9 +309,10 @@ class Test(Cmd):
         if len(self.post_user):
             post_user = ' (as %s)' % (self.post_user)
         return "Pathname: %s\nOutputdir: %s\nTimeout: %d\nPre: %s%s\nPost: " \
-               "%s%s\nUser: %s\n" % (self.pathname, self.outputdir,
-                self.timeout, self.pre, pre_user, self.post, post_user,
-                self.user)
+               "%s%s\nUser: %s\n" % (
+                   self.pathname, self.outputdir,
+                   self.timeout, self.pre, pre_user, self.post, post_user,
+                   self.user)
 
     def verify(self, logger):
         """
@@ -384,9 +385,9 @@ class TestGroup(Test):
         if len(self.post_user):
             post_user = ' (as %s)' % (self.post_user)
         return "Pathname: %s\nOutputdir: %s\nTests: %s\nTimeout: %d\n" \
-               "Pre: %s%s\nPost: %s%s\nUser: %s\n" % (self.pathname,
-                self.outputdir, self.tests, self.timeout, self.pre, pre_user,
-                self.post, post_user, self.user)
+            "Pre: %s%s\nPost: %s%s\nUser: %s\n" % (
+                self.pathname, self.outputdir, self.tests, self.timeout,
+                self.pre, pre_user, self.post, post_user, self.user)
 
     def verify(self, logger):
         """
@@ -428,8 +429,8 @@ class TestGroup(Test):
             if not verify_file(os.path.join(self.pathname, test)):
                 del self.tests[self.tests.index(test)]
                 logger.info("Warning: Test '%s' removed from TestGroup '%s' "
-                            "because it failed verification." % (test,
-                            self.pathname))
+                            "because it failed verification." %
+                            (test, self.pathname))
 
         return len(self.tests) is not 0
 
@@ -634,7 +635,7 @@ class TestRun(object):
             components -= 1
             for testfile in tmp_dict.keys():
                 uniq = '/'.join(testfile.split('/')[components:]).lstrip('/')
-                if not uniq in l:
+                if uniq not in l:
                     l.append(uniq)
                     tmp_dict[testfile].outputdir = os.path.join(base, uniq)
                 else:
@@ -705,8 +706,8 @@ class TestRun(object):
         m, s = divmod(time() - self.starttime, 60)
         h, m = divmod(m, 60)
         print '\nRunning Time:\t%02d:%02d:%02d' % (h, m, s)
-        print 'Percent passed:\t%.1f%%' % ((float(Result.runresults['PASS']) /
-               float(Result.total)) * 100)
+        print 'Percent passed:\t%.1f%%' % (
+            (float(Result.runresults['PASS']) / float(Result.total)) * 100)
         print 'Log directory:\t%s' % self.outputdir
 
 
@@ -717,10 +718,10 @@ def verify_file(pathname):
     if os.path.isdir(pathname) or os.path.islink(pathname):
         return False
 
-    if (os.path.isfile(pathname) and os.access(pathname, os.X_OK)) or \
-            (os.path.isfile(pathname+'.ksh') and os.access(pathname+'.ksh', os.X_OK)) or \
-            (os.path.isfile(pathname+'.sh') and os.access(pathname+'.sh', os.X_OK)):
-        return True
+    for ext in '', '.ksh', '.sh':
+        script_path = pathname + ext
+        if os.path.isfile(script_path) and os.access(script_path, os.X_OK):
+            return True
 
     return False
 
@@ -731,15 +732,13 @@ def verify_user(user, logger):
     sudo without being prompted for a password.
     """
     testcmd = [SUDO, '-n', '-u', user, TRUE]
-    can_sudo = exists = True
 
     if user in Cmd.verified_users:
         return True
 
     try:
-        _ = getpwnam(user)
+        getpwnam(user)
     except KeyError:
-        exists = False
         logger.info("Warning: user '%s' does not exist.", user)
         return False
 
@@ -782,7 +781,7 @@ def options_cb(option, opt_str, value, parser):
     path_options = ['runfile', 'outputdir', 'template', 'testdir']
 
     if option.dest is 'runfile' and '-w' in parser.rargs or \
-        option.dest is 'template' and '-c' in parser.rargs:
+       option.dest is 'template' and '-c' in parser.rargs:
         fail('-c and -w are mutually exclusive.')
 
     if opt_str in parser.rargs:

tests/zfs-tests/include/default.cfg.in

@@ -43,6 +43,9 @@ export ZPOOL=${ZPOOL:-${sbindir}/zpool}
 export ZTEST=${ZTEST:-${sbindir}/ztest}
 export ZPIOS=${ZPIOS:-${sbindir}/zpios}
 export RAIDZ_TEST=${RAIDZ_TEST:-${bindir}/raidz_test}
+export ARC_SUMMARY=${ARC_SUMMARY:-${bindir}/arc_summary.py}
+export ARCSTAT=${ARCSTAT:-${bindir}/arcstat.py}
+export DBUFSTAT=${DBUFSTAT:-${bindir}/dbufstat.py}
 
 . $STF_SUITE/include/libtest.shlib
 

tests/zfs-tests/tests/functional/cli_user/misc/Makefile.am

@@ -43,4 +43,7 @@ dist_pkgdata_SCRIPTS = \
 	zpool_scrub_001_neg.ksh \
 	zpool_set_001_neg.ksh \
 	zpool_status_001_neg.ksh \
-	zpool_upgrade_001_neg.ksh
+	zpool_upgrade_001_neg.ksh \
+	arcstat_001_pos.ksh \
+	arc_summary_001_pos.ksh \
+	dbufstat_001_pos.ksh

tests/zfs-tests/tests/functional/cli_user/misc/arc_summary_001_pos.ksh

@@ -0,0 +1,40 @@
+#! /bin/ksh -p
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
+# or http://www.opensolaris.org/os/licensing.
+# See the License for the specific language governing permissions
+# and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2015 by Lawrence Livermore National Security, LLC.
+# All rights reserved.
+#
+
+. $STF_SUITE/include/libtest.shlib
+
+set -A args  "" "-a" "-d" "-p 1"
+
+log_assert "arc_summary.py generates output and doesn't return an error code"
+
+typeset -i i=0
+while [[ $i -lt ${#args[*]} ]]; do
+        log_must eval "$ARC_SUMMARY ${args[i]} > /dev/null"
+        ((i = i + 1))
+done
+
+log_pass "arc_summary.py generates output and doesn't return an error code"

tests/zfs-tests/tests/functional/cli_user/misc/arcstat_001_pos.ksh

@@ -0,0 +1,41 @@
+#! /bin/ksh -p
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
+# or http://www.opensolaris.org/os/licensing.
+# See the License for the specific language governing permissions
+# and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2015 by Lawrence Livermore National Security, LLC.
+# All rights reserved.
+#
+
+. $STF_SUITE/include/libtest.shlib
+
+set -A args  "" "-s \",\"" "-x" "-v" \
+    "-f time,hit%,dh%,ph%,mh%"
+
+log_assert "arcstat.py generates output and doesn't return an error code"
+
+typeset -i i=0
+while [[ $i -lt ${#args[*]} ]]; do
+        log_must eval "$ARCSTAT ${args[i]} > /dev/null"
+        ((i = i + 1))
+done
+log_pass "arcstat.py generates output and doesn't return an error code"
+

tests/zfs-tests/tests/functional/cli_user/misc/dbufstat_001_pos.ksh

@@ -0,0 +1,40 @@
+#! /bin/ksh -p
+#
+# CDDL HEADER START
+#
+# The contents of this file are subject to the terms of the
+# Common Development and Distribution License (the "License").
+# You may not use this file except in compliance with the License.
+#
+# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
+# or http://www.opensolaris.org/os/licensing.
+# See the License for the specific language governing permissions
+# and limitations under the License.
+#
+# When distributing Covered Code, include this CDDL HEADER in each
+# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
+# If applicable, add the following below this CDDL HEADER, with the
+# fields enclosed by brackets "[]" replaced with your own identifying
+# information: Portions Copyright [yyyy] [name of copyright owner]
+#
+# CDDL HEADER END
+#
+
+#
+# Copyright (c) 2015 by Lawrence Livermore National Security, LLC.
+# All rights reserved.
+#
+
+. $STF_SUITE/include/libtest.shlib
+
+set -A args  "" "-b" "-d" "-r" "-v" "-s \",\"" "-x"
+
+log_assert "dbufstat.py generates output and doesn't return an error code"
+
+typeset -i i=0
+while [[ $i -lt ${#args[*]} ]]; do
+        log_must eval "$DBUFSTAT ${args[i]} > /dev/null"
+        ((i = i + 1))
+done
+
+log_pass "dbufstat.py generates output and doesn't return an error code"