check: Add support for sections in config file

This patch add support for sections in the config file. Each section can
contain configuration options in the format

OPTION=value

when one section is processed xfstests will proceed to next section
until all secitons are processed, or an error occur.

The name of the section can consist of alphanumeric characters + '_',
nothing else is allowed. Name of the section is also used to create
results subdirectory for each section. After all the sections are
processed summary of all runs is printed out.

If the config file does not contain sections, or we're not using config
file at all, nothing is changed and xfstests will work the same way as
it used to.

This is very useful for testing file system with different options. Here
is an example of the config file with sections:

[ext4_4k_block_size]
TEST_DEV=/dev/sda
TEST_DIR=/mnt/test
SCRATCH_DEV=/dev/sdb
SCRATCH_MNT=/mnt/test1
MKFS_OPTIONS="-q -F -b4096"
FSTYP=ext4

[ext4_1k_block_size]
MKFS_OPTIONS="-q -F -b1024"

[ext4_nojournal]
MKFS_OPTIONS="-q -F -b4096 -O ^has_journal"

[ext4_discard_ssd]
MKFS_OPTIONS="-q -F -b4096"
TEST_DEV=/dev/sdc
SCRATCH_DEV=/dev/sdd
MOUNT_OPTIONS="-o discard"

Note that once the variable is set it remains set across the sections, so
you do not have to specify all the options in all sections. However one
have to make sure that unwanted options are not set from previous
sections.

Signed-off-by: Lukas Czerner <lczerner@redhat.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

diff --git a/README.config-sections b/README.config-sections
new file mode 100644 (file)
index 0000000..6d88a6f
--- /dev/null
+++ b/README.config-sections
@@ -0,0 +1,50 @@
+Configuration file with sections
+================================
+
+Configuration file with sections is useful for running xfstests on multiple
+file systems, or multiple file system setups in a single run without any
+help of external scripts.
+
+Syntax for defining a section is the following:
+
+[section_name]
+
+Section name should consist of alphanumeric characters and '_'. Anything
+else is forbidden and the section will not be recognised.
+
+Each section in the configuration file should contain options in the format
+
+OPTION=value
+
+'OPTION' must not contain any white space characters. 'value' can contain
+any character you want with one simple limitation - characters ' and " can
+only appear at the start and end of the 'value', however it is not required.
+
+Note that options are carried between sections so the same options does not
+have to be specified in each and every sections. However caution should be
+exercised not to leave unwanted options set from previous sections.
+
+For every section xfstests will run with specified options and will produce
+separate results in the '$RESULT_BASE/$section_name' directory.
+
+Here is an example of config file with sections:
+
+[ext4_4k_block_size]
+TEST_DEV=/dev/sda
+TEST_DIR=/mnt/test
+SCRATCH_DEV=/dev/sdb
+SCRATCH_MNT=/mnt/test1
+MKFS_OPTIONS="-q -F -b4096"
+FSTYP=ext4
+
+[ext4_1k_block_size]
+MKFS_OPTIONS="-q -F -b1024"
+
+[ext4_nojournal]
+MKFS_OPTIONS="-q -F -b4096 -O ^has_journal"
+
+[ext4_discard_ssd]
+MKFS_OPTIONS="-q -F -b4096"
+TEST_DEV=/dev/sdc
+SCRATCH_DEV=/dev/sdd
+MOUNT_OPTIONS="-o discard"

diff --git a/check b/check
index b33643c9e713d91af1d4ccf8fc916af0bd23962c..928c5f4cfbe8d1373e93b871463437e7dcd7cd8e 100755 (executable)
--- a/check
+++ b/check
@@ -22,9 +22,11 @@
 tmp=/tmp/$$
 status=0
 needwrap=true
 tmp=/tmp/$$
 status=0
 needwrap=true

+needsum=true

 n_try=0
 try=""
 n_bad=0
 n_try=0
 try=""
 n_bad=0

+sum_bad=0

 bad=""
 notrun=""
 interrupt=true
 bad=""
 notrun=""
 interrupt=true


@@ -296,7 +298,12 @@ then
     exit 1
 fi
 
     exit 1
 fi
 

-# Ok, time to start running...
+_wipe_counters()
+{
+       n_try="0"
+       n_bad="0"
+       unset try notrun bad
+}

 
 _wrapup()
 {
 
 _wrapup()
 {


@@ -325,16 +332,20 @@ END       { if (NR > 0) {
        date >>$check.log
        echo $list | fmt | sed -e 's/^/    /' -e "s;$SRC_DIR/;;g" >>$check.log
        $interrupt && echo "Interrupted!" >>$check.log
        date >>$check.log
        echo $list | fmt | sed -e 's/^/    /' -e "s;$SRC_DIR/;;g" >>$check.log
        $interrupt && echo "Interrupted!" >>$check.log

-        
+
+       echo "SECTION       -- $section" >>$tmp.summary
+       echo "=========================" >>$tmp.summary

         if [ ! -z "$n_try" -a $n_try != 0 ]
        then
            echo "Ran:$try"
         if [ ! -z "$n_try" -a $n_try != 0 ]
        then
            echo "Ran:$try"

+           echo "Ran:$try" >>$tmp.summary

        fi
 
        if [ ! -z "$notrun" ]
        then
            echo "Not run:$notrun"
            echo "Not run:$notrun" >>$check.log
        fi
 
        if [ ! -z "$notrun" ]
        then
            echo "Not run:$notrun"
            echo "Not run:$notrun" >>$check.log

+           echo "Not run:$notrun" >>$tmp.summary

        fi
 
         if [ ! -z "$n_bad" -a $n_bad != 0 ]
        fi
 
         if [ ! -z "$n_bad" -a $n_bad != 0 ]


@@ -343,20 +354,48 @@ END       { if (NR > 0) {
            echo "Failed $n_bad of $n_try tests"
            echo "Failures:$bad" | fmt >>$check.log
            echo "Failed $n_bad of $n_try tests" >>$check.log
            echo "Failed $n_bad of $n_try tests"
            echo "Failures:$bad" | fmt >>$check.log
            echo "Failed $n_bad of $n_try tests" >>$check.log

+           echo "Failures:$bad" >>$tmp.summary
+           echo "Failed $n_bad of $n_try tests" >>$tmp.summary

        else
            echo "Passed all $n_try tests"
            echo "Passed all $n_try tests" >>$check.log
        else
            echo "Passed all $n_try tests"
            echo "Passed all $n_try tests" >>$check.log

+           echo "Passed all $n_try tests" >>$tmp.summary

        fi
        fi

+       echo "" >>$tmp.summary

        needwrap=false
     fi
 
        needwrap=false
     fi
 

+    sum_bad=`expr $sum_bad + $n_bad`
+    _wipe_counters

     rm -f /tmp/*.rawout /tmp/*.out /tmp/*.err /tmp/*.time
     rm -f /tmp/*.rawout /tmp/*.out /tmp/*.err /tmp/*.time

-    rm -f $tmp.*
+    if ! $OPTIONS_HAVE_SECTIONS; then
+        rm -f $tmp.*
+    fi

 }
 
 }
 

-trap "_wrapup; exit \$status" 0 1 2 3 15
+_summary()
+{
+       _wrapup
+       if $showme; then
+               :
+       elif $needsum; then
+               count=`wc -L $tmp.summary | cut -f1 -d" "`
+               cat $tmp.summary
+               needsum=false
+       fi
+       rm -f $tmp.*
+}
+
+if $OPTIONS_HAVE_SECTIONS; then
+       trap "_summary; exit \$status" 0 1 2 3 15
+else
+       trap "_wrapup; exit \$status" 0 1 2 3 15
+fi
+
+for section in $HOST_OPTIONS_SECTIONS; do
+       get_next_config $section
+       init_rc

 
 

-if true; then

        mkdir -p $RESULT_BASE
        if [ ! -d $RESULT_BASE ]; then
                echo "failed to create results directory $RESULTS_BASE"
        mkdir -p $RESULT_BASE
        if [ ! -d $RESULT_BASE ]; then
                echo "failed to create results directory $RESULTS_BASE"


@@ -372,6 +411,9 @@ if true; then
        [ -f $check.time ] || touch $check.time
 
        # print out our test configuration
        [ -f $check.time ] || touch $check.time
 
        # print out our test configuration

+       if $OPTIONS_HAVE_SECTIONS; then
+               echo "SECTION       -- $section"
+       fi

        echo "FSTYP         -- `_full_fstyp_details`"
        echo "PLATFORM      -- `_full_platform_details`"
        if [ ! -z "$SCRATCH_DEV" ]; then
        echo "FSTYP         -- `_full_fstyp_details`"
        echo "PLATFORM      -- `_full_platform_details`"
        if [ ! -z "$SCRATCH_DEV" ]; then


@@ -379,7 +421,7 @@ if true; then
          echo "MOUNT_OPTIONS -- `_scratch_mount_options`"
        fi
        echo
          echo "MOUNT_OPTIONS -- `_scratch_mount_options`"
        fi
        echo

-
+       needwrap=true

 
        if [ ! -z "$SCRATCH_DEV" ]; then
          umount $SCRATCH_DEV 2>/dev/null
 
        if [ ! -z "$SCRATCH_DEV" ]; then
          umount $SCRATCH_DEV 2>/dev/null


@@ -419,9 +461,15 @@ if true; then
            # Similarly, the result directory needs to replace the tests/
            # part of the test location.
            group=`dirname $seq`
            # Similarly, the result directory needs to replace the tests/
            # part of the test location.
            group=`dirname $seq`

-           export RESULT_DIR=`echo $group | sed -e "s;$SRC_DIR;$RESULT_BASE;"`
+           if $OPTIONS_HAVE_SECTIONS; then
+               export RESULT_DIR=`echo $group | sed -e "s;$SRC_DIR;${RESULT_BASE}/$section;"`
+               seqres="$RESULT_BASE/$section/$seqnum"
+           else
+               export RESULT_DIR=`echo $group | sed -e "s;$SRC_DIR;$RESULT_BASE;"`
+               seqres="$RESULT_BASE/$seqnum"
+           fi
+

            mkdir -p $RESULT_DIR
            mkdir -p $RESULT_DIR

-           seqres="$RESULT_BASE/$seqnum"

 
            echo -n "$seqnum"
 
 
            echo -n "$seqnum"
 


@@ -541,8 +589,10 @@ if true; then
 
            seq="after_$seqnum"
        done
 
            seq="after_$seqnum"
        done

-fi
+       _wrapup
+       echo
+done

 
 interrupt=false
 
 interrupt=false

-status=`expr $n_bad`
+status=`expr $sum_bad`

 exit
 exit

diff --git a/common/config b/common/config
index 3a0208a677191bff07a42986d1ad9273dce4dcd3..5438ecff0bfa28d04275127cb279c1cdbc8335b8 100644 (file)
--- a/common/config
+++ b/common/config
@@ -224,15 +224,57 @@ known_hosts()
        [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
 }
 
        [ -f $HOST_CONFIG_DIR/$HOST.config ] && export HOST_OPTIONS=$HOST_CONFIG_DIR/$HOST.config
 }
 

+# Returns a list of sections in config file
+# Each section starts with the section name in the format
+# [section_name1]. Only alphanumeric characters and '_' is allowed
+# in the section name otherwise the section will not be resognised.
+# Section name must be contained between square brackets.
+get_config_sections() {
+       sed -n -e "s/^\[\([[:alnum:]_]*\)\]/\1/p" < $1
+}
+

 if [ ! -f "$HOST_OPTIONS" ]; then
        known_hosts
 fi
 
 if [ ! -f "$HOST_OPTIONS" ]; then
        known_hosts
 fi
 

+export HOST_OPTIONS_SECTIONS="-no-sections-"
+export OPTIONS_HAVE_SECTIONS=false

 if [ -f "$HOST_OPTIONS" ]; then
 if [ -f "$HOST_OPTIONS" ]; then

-       . $HOST_OPTIONS
+       export HOST_OPTIONS_SECTIONS=`get_config_sections $HOST_OPTIONS`
+       if [ -z "$HOST_OPTIONS_SECTIONS" ]; then
+               . $HOST_OPTIONS
+               export HOST_OPTIONS_SECTIONS="-no-sections-"
+       else
+               export OPTIONS_HAVE_SECTIONS=true
+       fi

 fi
 
 fi
 

+# Parse config section options. This function will parse all the configuration
+# within a single section which name is passed as an argument. For section
+# name format see comments in get_config_sections().
+# Empty lines and everything after '#' will be ignored.
+# Configuration options should be defined in the format
+#
+# CONFIG_OPTION=value
+#
+# This 'CONFIG_OPTION' variable and will be exported as an environment variable.
+parse_config_section() {
+       SECTION=$1
+       if ! $OPTIONS_HAVE_SECTIONS; then
+               return 0
+       fi
+       eval `sed -e 's/[[:space:]]*\=[[:space:]]*/=/g' \
+               -e 's/#.*$//' \
+               -e 's/[[:space:]]*$//' \
+               -e 's/^[[:space:]]*//' \
+               -e "s/^\(.*\)=\"\?'\?\([^\"']*\)\"\?'\?$/export \1=\"\2\"/" \
+               < $HOST_OPTIONS \
+               | sed -n -e "/^\[$SECTION\]/,/^\s*\[/{/^[^#].*\=.*/p;}"`
+}
+

 get_next_config() {
 get_next_config() {

+       parse_config_section $1
+

        # set default RESULT_BASE
        if [ -z "$RESULT_BASE" ]; then
                export RESULT_BASE="$here/results/"
        # set default RESULT_BASE
        if [ -z "$RESULT_BASE" ]; then
                export RESULT_BASE="$here/results/"


@@ -284,7 +326,10 @@ get_next_config() {
        fi
 }
 
        fi
 }
 

-get_next_config
+if [ -z "$CONFIG_INCLUDED" ]; then
+       get_next_config `echo $HOST_OPTIONS_SECTIONS | cut -f1 -d" "`
+       export CONFIG_INCLUDED=true
+fi

 
 # make sure this script returns success
 /bin/true
 
 # make sure this script returns success
 /bin/true