Re: [Fuego] Patch for Functional.check_mounts

From dd8285cac45305f80a8d4d24c41e8debaa92c3f0 Mon Sep 17 00:00:00 2001
From: Kumar Thangavel <[email protected]>
Date: Thu, 9 Jan 2020 16:57:19 +0530
Subject: [PATCH] <check_mounts>:[PATCH 1/1]

This PATCH added test cases to check the expected mounts
with system mount points. If any mount point is not matched
test would fail. It has save_baseline spec to save the
system mount points as expected mount points.

Signed-off-by: Kumar Thangavel <[email protected]>
---
 tests/Functional.check_mounts/fuego_test.sh | 91 +++++++++++++++------
 tests/Functional.check_mounts/test.yaml     |  5 +-
 2 files changed, 70 insertions(+), 26 deletions(-)

diff --git a/tests/Functional.check_mounts/fuego_test.sh b/tests/Functional.check_mounts/fuego_test.sh
index 609999b..cd6fa62 100755
--- a/tests/Functional.check_mounts/fuego_test.sh
+++ b/tests/Functional.check_mounts/fuego_test.sh
@@ -1,41 +1,86 @@
-tarball=fs-test-1.1.tgz
+# Functional.check_mounts
+#  This test checks to see if the mount points is different from a 
+#  a baseline snapshot taken some time in the past.
+#
+#  The purpose of this test is to do a high-level comparison of the 
+#  mount points of filesystem, to see if anything has changed since
+#  the last baseline snapshot was made.
+#
+# Usage:
+#  preparation:
+#    Create 2 jobs:
+#     $ ftc add-job -b <brd> -t Functional.check_mounts -s default
+#     $ ftc add-job -b <brd> -t Functional.check_mounts -s save_baseline
+#    Save baseline reports
+#      If the filesystem mount points is in a known-good state that reflects "normal"
+#      status for a board,
+#      save the baseline data into a file by running run
+#      the 'save_baseline' job:
+#     $ ftc build-job <brd>.save_baseline.Functional.check_mounts
+#      This will create baseline report files in /fuego-rw/boards/<brd>
+# periodic usage:
+#     Check that the overall reports still match, by running the default job:
+#     $ ftc build-job <board>.default.Functional.check_mounts
+#
 
-function test_build {
-    make
-}
-
-function test_deploy {
+function test_pre_check {
+    # check_mounts dependencies
+    assert_has_program awk
 
-    EXPECTED_FILE=/fuego-rw/boards/$NODE_NAME/expected_mounts.txt
+    export board_rw_dir=$FUEGO_RW/boards/$NODE_NAME
+    export baseline_file=$board_rw_dir/$TESTDIR-baseline-data.txt
 
-    if [ "$TESTSPEC" = "default" ] ; then
+    mkdir -p $board_rw_dir
 
-    	if [ -f "${EXPECTED_FILE}" ] ; then
-      	    put "${EXPECTED_FILE}" $BOARD_TESTDIR/fuego.$TESTDIR/ 
-	else
-            abort_job "Please create file ${EXPECTED_FILE} with the list of expected mounts"
-        fi
+    # check for existence of baseline file
 
-        put fs_test $BOARD_TESTDIR/fuego.$TESTDIR/
+    # but don't check if we're doing the save operation
+    if [ "$TESTSPEC" = "save_baseline" ] ; then
+        return 0
     fi
 
+    if [ ! -f $baseline_file ] ; then
+        echo "Missing baseline results file: $baseline_file1"
+        echo "Maybe try running test with the 'save_baseline' spec?"
+        abort_job "Missing baseline results file"
+    fi
 }
- 
+
 function test_run {
+    echo "Getting mount points"
 
-    DATA_FILE=$LOGDIR/expected_mount_data.txt
+    DATA_FILE=$LOGDIR/mount_points.txt
 
+    # get the mounted points from system
+    cmd "cat /proc/mounts | awk '{print substr($1, 1, length($1))}'" >$DATA_FILE
+    #cat /proc/mounts | awk '{print substr($1, 1, length($1))}' >$DATA_FILE
+    log_this "echo \"Here is the current mounted points :\""
+    log_this "cat $DATA_FILE"
+    echo "--------"
+
+    # if we're doing the "save_baseline" spec, save the data
     if [ "$TESTSPEC" = "save_baseline" ] ; then
-        mount | awk '{print substr($1, 1, length($1))}'>$DATA_FILE
-	cp $DATA_FILE ${EXPECTED_FILE}
-        log_this "echo \"baseline file: ${EXPECTED_FILE} saved\""
+        cp $DATA_FILE $baseline_file
+        log_this "echo \"baseline file: $baseline_file saved\""
+        log_this "echo \"ok 1 compare system mounted points with baseline saved\""
         return 0
-    else
-        report "cd $BOARD_TESTDIR/fuego.$TESTDIR; \
-        ./fs_test"
+    fi
+
+    # check for differences from baseline
+    set +e
+    log_this "echo \"Checking for differences in mount points\""
+    log_this "diff -u $baseline_file $LOGDIR/mount_points.txt"
+    diff_rcode="$?"
+    log_this "echo ------------------------"
+    set -e
+
+    if [ $diff_rcode == "0" ] ; then
+        log_this "echo \"no changes found between current mount points and baseline\""
+	log_this "echo \"ok \""
     fi
 }
 
 function test_processing {
-    log_compare "$TESTDIR" "0" "FAIL" "n"
+    log_compare $TESTDIR 1 "^ok " "p"
 }
+
diff --git a/tests/Functional.check_mounts/test.yaml b/tests/Functional.check_mounts/test.yaml
index beaa67c..b1fc55a 100644
--- a/tests/Functional.check_mounts/test.yaml
+++ b/tests/Functional.check_mounts/test.yaml
@@ -1,8 +1,8 @@
 fuego_package_version: 1
 name: Functional.check_mounts
 description: |
-    Run fs_test, using an 'expected_mounts.txt' file, in order to verify
-    that the mouned filesystems on the target board are as expected.
+    This test checks to see if the mount points is different from a 
+    a baseline snapshot taken some time in the past.
 license: MIT
 author: Kumar Thangavel <[email protected]>
 maintainer: Kumar Thangavel <[email protected]>
@@ -11,5 +11,4 @@ fuego_release: 1
 type: Functional
 tags: ['example']
 data_files:
- - fs-test-1.1.tgz
  - spec.json
-- 
2.17.1

# Functional.check_mounts
#  This test checks to see if the mount points is different from a 
#  a baseline snapshot taken some time in the past.
#
#  The purpose of this test is to do a high-level comparison of the 
#  mount points of filesystem, to see if anything has changed since
#  the last baseline snapshot was made.
#
# Usage:
#  preparation:
#    Create 2 jobs:
#     $ ftc add-job -b <brd> -t Functional.check_mounts -s default
#     $ ftc add-job -b <brd> -t Functional.check_mounts -s save_baseline
#    Save baseline reports
#      If the filesystem mount points is in a known-good state that reflects "normal"
#      status for a board,
#      save the baseline data into a file by running run
#      the 'save_baseline' job:
#     $ ftc build-job <brd>.save_baseline.Functional.check_mounts
#      This will create baseline report files in /fuego-rw/boards/<brd>
# periodic usage:
#     Check that the overall reports still match, by running the default job:
#     $ ftc build-job <board>.default.Functional.check_mounts
#

function test_pre_check {
    # check_mounts dependencies
    assert_has_program awk

    export board_rw_dir=$FUEGO_RW/boards/$NODE_NAME
    export baseline_file=$board_rw_dir/$TESTDIR-baseline-data.txt

    mkdir -p $board_rw_dir

    # check for existence of baseline file

    # but don't check if we're doing the save operation
    if [ "$TESTSPEC" = "save_baseline" ] ; then
        return 0
    fi

    if [ ! -f $baseline_file ] ; then
        echo "Missing baseline results file: $baseline_file1"
        echo "Maybe try running test with the 'save_baseline' spec?"
        abort_job "Missing baseline results file"
    fi
}

function test_run {
    echo "Getting mount points"

    DATA_FILE=$LOGDIR/mount_points.txt

    # get the mounted points from system
    cmd "cat /proc/mounts | awk '{print substr($1, 1, length($1))}'" >$DATA_FILE
    #cat /proc/mounts | awk '{print substr($1, 1, length($1))}' >$DATA_FILE
    log_this "echo \"Here is the current mounted points :\""
    log_this "cat $DATA_FILE"
    echo "--------"

    # if we're doing the "save_baseline" spec, save the data
    if [ "$TESTSPEC" = "save_baseline" ] ; then
        cp $DATA_FILE $baseline_file
        log_this "echo \"baseline file: $baseline_file saved\""
        log_this "echo \"ok 1 compare system mounted points with baseline saved\""
        return 0
    fi

    # check for differences from baseline
    set +e
    log_this "echo \"Checking for differences in mount points\""
    log_this "diff -u $baseline_file $LOGDIR/mount_points.txt"
    diff_rcode="$?"
    log_this "echo ------------------------"
    set -e

    if [ $diff_rcode == "0" ] ; then
        log_this "echo \"no changes found between current mount points and baseline\""
	log_this "echo \"ok \""
    fi
}

function test_processing {
    log_compare $TESTDIR 1 "^ok " "p"
}