Skip to content

Refactor qmctl test scripts and improve test utilities #894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2025
Merged

Refactor qmctl test scripts and improve test utilities #894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 178 additions & 0 deletions tests/e2e/lib/utils
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,184 @@ info_message() {
echo -e "[ ${BLUE}INFO${ENDCOLOR} ] ${1}"
}

pass_message() {
###########################################################################
# Description: #
# show [PASS] in green and a message as the test passed. #
# #
# Arguments: #
# $1 - message to output #
###########################################################################
if [ -z "${1}" ]; then
echo "pass_message() requires a message"
exit 1
fi
GREEN="\033[92m"
ENDCOLOR="\033[0m"
echo -e "[ ${GREEN}PASS${ENDCOLOR} ] ${1}"
}

fail_message() {
###########################################################################
# Description: #
# show [FAIL] in red and a message as the test failed. #
# #
# Arguments: #
# $1 - message to output #
###########################################################################
if [ -z "${1}" ]; then
echo "fail_message() requires a message"
exit 1
fi
RED="\033[91m"
ENDCOLOR="\033[0m"
echo -e "[ ${RED}FAIL${ENDCOLOR} ] ${1}"
}

# Validation functions for run_test
validate_output_pattern() {
local test_name="$1"
local validation_value="$2"
local stdout_file="$3"

if [ -n "$validation_value" ] && grep -q "$validation_value" "$stdout_file"; then
pass_message "$test_name - Output contains expected pattern"
else
fail_message "$test_name - Output doesn't contain expected pattern '$validation_value'"
echo "Actual output (first 10 lines):"
head -10 < "$stdout_file"
exit 1
fi
}

validate_error_pattern() {
local test_name="$1"
local validation_value="$2"
local stderr_file="$3"

if [ -z "$stderr_file" ]; then
fail_message "$test_name - No error message captured"
exit 1
elif grep -q "$validation_value" "$stderr_file"; then
pass_message "$test_name - Error message contains expected pattern"
else
fail_message "$test_name - Error message doesn't contain expected pattern '$validation_value'"
echo "Actual stderr:"
cat "$stderr_file"
exit 1
fi
}

validate_json_valid() {
local test_name="$1"
local validation_value="$2"
local stdout_file="$3"

if python3 -m json.tool < "$stdout_file" > /dev/null 2>&1; then
pass_message "$test_name - Valid JSON output"
if grep -q '{' "$stdout_file" && grep -q '}' "$stdout_file"; then
pass_message "$test_name - JSON contains expected braces"
fi
if grep -q "$validation_value" "$stdout_file"; then
pass_message "$test_name - JSON contains expected content '$validation_value'"
else
fail_message "$test_name - JSON doesn't contain expected content '$validation_value'"
echo "Actual JSON output:"
cat "$stdout_file"
exit 1
fi
else
fail_message "$test_name - Invalid JSON output"
echo "Output:"
head -10 < "$stdout_file"
exit 1
fi
}

validate_none() {
# Only exit code check, no additional validation
:
}

run_test() {
###########################################################################
# Description: #
# General test function that runs commands and validates results #
# #
# Arguments: #
# $1 - test_name: Name of the test for output #
# $2 - expected_exit_code: Expected exit code (0, 1, 2, etc.) #
# $3 - validation_type: Type of validation to perform #
# "output_pattern" - Check for pattern in stdout #
# "error_pattern" - Check for pattern in stderr #
# "json_valid" - Validate JSON structure and content #
# "content_match" - Check if output contains data #
# "file_exists" - Check if file exists and has content #
# "none" - Only check exit code #
# $4 - validation_value: Pattern, content, or file path to validate #
# $@ - command: Command and arguments to execute #
###########################################################################
local test_name="$1"
local expected_exit_code="$2"
local validation_type="$3"
local validation_value="$4"
shift 4
local command=("$@")

info_message "Testing: $test_name"

# Create temp files for output
local stdout_file
local stderr_file
stdout_file=$(mktemp)
stderr_file=$(mktemp)

# Run command and capture exit code
if "${command[@]}" > "$stdout_file" 2> "$stderr_file"; then
local actual_exit_code=0
else
local actual_exit_code=$?
fi

# Check exit code
if [ "$actual_exit_code" -eq "$expected_exit_code" ]; then
pass_message "$test_name - Exit code correct ($expected_exit_code)"
else
fail_message "$test_name - Expected exit code $expected_exit_code, got $actual_exit_code"
echo " Command: ${command[*]}"
echo " stdout:"
head -5 < "$stdout_file"
echo " stderr:"
head -5 < "$stderr_file"
rm -f "$stdout_file" "$stderr_file"
exit 1
fi

# Perform validation based on type
case "$validation_type" in
"output_pattern")
validate_output_pattern "$test_name" "$validation_value" "$stdout_file"
;;
"error_pattern")
validate_error_pattern "$test_name" "$validation_value" "$stderr_file"
;;
"json_valid")
validate_json_valid "$test_name" "$validation_value" "$stdout_file"
;;
"none")
validate_none
;;
*)
fail_message "$test_name - Unknown validation type: $validation_type"
exit 1
;;
esac

# Cleanup
rm -f "$stdout_file" "$stderr_file"
return 0
}

exec_cmd() {
local cmd="$1"
eval "$cmd"
Expand Down
22 changes: 0 additions & 22 deletions tests/qmctl-test/scripts/qmctl_cp.sh
View file
Open in desktop

This file was deleted.

Loading
Loading