Merge pull request #150 from Azure/refactor-unit-tests

Agnostic Unit Test Script and Disk Test Fixes

Author: j-koreth

customTests/azure_nvme_count.nhc

@@ -1,6 +1,7 @@
 #!/bin/bash
 
-source /etc/nhc/scripts/azure_common.nhc
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+source "${SCRIPT_DIR}/azure_common.nhc"
 
 function get_device_count() {
       DIR="$1"

test/README.md

@@ -1,12 +1,20 @@
-# Unit Test Scripts #
+# Tests Scripts #
 
-The [run_tests script](./unit-tests/run_tests.sh) can be used to run unit tests. The unit test use [Bash Automated Testing System](https://github.com/bats-core/bats-core) or bats for short.
+| Test Suite      | Script Command      |
+| ------------- | ------------- |
+| Integration Tests | [./unit-tests/run_tests.sh](./unit-tests/run_tests.sh) |
+| Unit Tests | [./unit-tests/run_tests_agnostic.sh](./unit-tests/run_tests_agnostic.sh) |
 
-The run script will attempt to install bats if it is not found.
+The unit test use [Bash Automated Testing System](https://github.com/bats-core/bats-core) or bats for short.
+
+The [run_tests script](./unit-tests/run_tests.sh) can be used to run integration tests. These are expected to run on HPC hardware. The run_tests script will attempt to install bats if it is not found.
+
+The [run_tests_agnostic script](./unit-tests/run_tests_agnostic.sh) doesn't require HPC hardware.
 
 ## Usage ##
 
-- ```./unit-tests/run_tests.sh```
+- ```./unit-tests/run_tests.sh $NHC_PATH_OPTIONAL```
+- ```./unit-tests/run_tests_agnostic.sh -d $NHC_PATH_OPTIONAL``` 
 
 ## Expected output ##
 

test/unit-tests/nhc-hardware-test.sh

@@ -1,14 +1,29 @@
 #!/usr/bin/env bats
 
-source $AZ_NHC_ROOT/customTests/azure_common.nhc
-source $AZ_NHC_ROOT/test/unit-tests/nhc-test-common.sh
+# Hardware tests for Azure NHC that are not GPU or CPU specific
 
+source $NHC_DIR/customTests/azure_common.nhc
+source $NHC_DIR/test/unit-tests/nhc-test-common.sh
+
+# Enumerate over currently tested hardware checks
 hardware_test=( "azure_nvme_count.nhc" )
 
+# Load the hardware checks
 for check in "${hardware_test[@]}" ; do
-    source $AZ_NHC_ROOT/customTests/$check
+    source $NHC_DIR/customTests/$check
 done
 
+## NVME Count Unit Tests
+
+# Given a directory and a count, create mock NVMe devices as empty files
+# Ex - 
+# Input - /tmp/tmp.mNtJgqCZC5 4 
+# Output - 
+# /tmp/tmp.mNtJgqCZC5/dev/nvme3n1
+# /tmp/tmp.mNtJgqCZC5/dev/nvme1n1
+# /tmp/tmp.mNtJgqCZC5/dev/nvme0n1
+# /tmp/tmp.mNtJgqCZC5/dev/nvme2n1
+
 create_mock_nvme_devices() {
     DIR="$1"
     local count=$2

test/unit-tests/run_tests_agnostic.sh

@@ -0,0 +1,63 @@
+#!/bin/sh
+
+# SKU agnostic Unit Tests
+# This script is designed to run unit tests that are not specific to any SKU.
+
+print_help() {
+    echo "Usage: $0 [OPTIONS]"
+    echo "Options:"
+    echo "  -h, --help      Show this help message"
+    echo "  -d, --dir DIR   Set the NHC directory"
+}
+
+# Parse options using getopt
+options=$(getopt -o hd: -l help,dir: -- "$@")
+if [ $? -ne 0 ]; then
+    print_help
+    exit 1
+fi
+
+eval set -- "$options"
+
+while true; do
+    case "$1" in
+        -h|--help)
+            print_help
+            exit 0
+            ;;
+        -d|--dir)
+            NHC_DIR="$2"
+            shift 2
+            ;;
+        --)
+            shift
+            break
+            ;;
+        *)
+            echo "Unknown option: $1"
+            print_help
+            exit 1
+            ;;
+    esac
+done
+
+# Check if NHC_DIR is set and is a directory
+if [ -n "$NHC_DIR" ] && [ ! -d "$NHC_DIR" ]; then
+    echo "Error: Directory '$NHC_DIR' does not exist or is not a directory."
+    exit 1
+fi
+
+# Set NHC_DIR if empty
+script_path="$(realpath "$0")"
+parent_dir="$(dirname "$script_path")"
+if [ -z "$NHC_DIR" ]; then
+    NHC_DIR="$(realpath "$parent_dir/../..")"
+    echo "NHC_DIR not set. Using default: $NHC_DIR"
+fi
+
+# Get Common Functions for Testing
+export NHC_DIR
+source "$NHC_DIR/test/unit-tests/nhc-test-common.sh"
+
+# Run Unit Tests
+bats --pretty "$NHC_DIR/test/unit-tests/nhc-hardware-test.sh"