test.sh

[詳解]

#!/bin/bash
## @file test.sh
# @brief Script to test the operation of the sedForLosers program.
#
# This script takes an input file, a search string, and a replace string
# as arguments and compares the output of the sedForLosers program
# with the output of the standard `sed` command.
 
# Define colors for OK and KO messages
GREEN="\033[0;32m"
RED="\033[0;31m"
YELLOW="\033[0;33m"
NC="\033[0m" # No color
# \e[1;31m: 赤色で強調表示 (1: 太字, 31: 赤)
# \e[m: 色をリセット
 
## @brief Checks if the number of arguments is correct.
# @param $# The number of arguments passed to the script.
function check_args() {
    if [ $# -ne 3 ]; then
        echo "Usage: $0 <input_file> <search_string> <replace_string>"
        exit 1
    fi
}
 
# Assign arguments to variables
input_file="$1"
search_string="$2"
replace_string="$3"
expected_file="${input_file}.expected"
actual_file="${input_file}.replace"
 
## @brief Checks if the input file exists.
function check_input_file() {
    if [ ! -f "$input_file" ]; then
        echo "Input file '$input_file' not found."
        echo ""
        return 1
    elif [[ "$search_string" == "" ]]; then
        echo "No previous regular expression. ( search string empty. )"
        echo ""
        return 1
    fi
    echo "Input file '$input_file' is exist."
    echo ""
    return 0
}
 
## @brief Removes the expected and actual output files.
function clear_files() {
    rm $expected_file $actual_file
}
 
## @brief Executes the standard `sed` command to generate the expected output.
function exec_sed_string() {
    echo "$ sed" "s/$search_string/$replace_string/g" "$input_file" ">" "$expected_file"
    sed "s/$search_string/$replace_string/g" "$input_file" > "$expected_file"
    echo ""
}
 
## @brief Displays the content of the input file, highlighting the search string.
function display_find_string() {
    printf "\n\`\`\`{$input_file}\n"
    while IFS= read -r line; do
        if [[ "$line" == *"$search_string"* ]]; then
            # Output in a different color when a string is found
            echo -e "${line//$search_string/$YELLOW$search_string$NC}"
            # -e オプション: エスケープシーケンスを解釈
        else
            # Output If not found, output as is
            echo "$line"
        fi
    done < "$input_file"
    printf "\`\`\`\n\n"
}
 
## @brief Executes the `sedForLosers` program.
function exec_sedForLosers() {
    echo "$ ./sedForLosers" "\"$input_file\"" "\"$search_string\"" "\"$replace_string\""
    ./sedForLosers "$input_file" "$search_string" "$replace_string"
    status=$?
    echo ""
    return $status
}
 
## @brief Compares the expected and actual output files using `diff`.
# @return 0 if the files are identical, 1 otherwise.
function diff_expected_actual() {
    local result
 
    # Comparison
    echo "$ diff $expected_file $actual_file"
    echo ""
    diff "$expected_file" "$actual_file"
 
    # 結果判定
    if [ $? -eq 0 ]; then
        echo -e "TEST ${GREEN}PASSED${NC}: Output matches expected result."
        result=$ture
    else
        echo -e "TEST ${RED}FAILED${NC}: Output differs from expected result."
        result=$false
    fi
    echo ""
    return $result
}
 
## @brief Assigns command-line arguments to variables.
# @param $1 The input file.
# @param $2 The string to search for.
# @param $3 The string to replace with.
function set_args() {
    input_file="$1"
    search_string="$2"
    replace_string="$3"
    expected_file="${input_file}.expected"
    actual_file="${input_file}.replace"
}
 
## @brief Runs a single test case.
# @param $1 The input file for the test.
# @param $2 The search string for the test.
# @param $3 The replace string for the test.
function test_script() {
    printf -- "--------------------------------------------\n"
    printf ">>> test [$1] [$2] [$3] <<<\n"
    set_args "$1" "$2" "$3"
    check_input_file
 
    if [ $? -eq 0 ]; then
        display_find_string
        exec_sed_string
    fi
 
    exec_sedForLosers
 
    if [ $? -eq 0 ]; then
        diff_expected_actual
        clear_files
    else
        echo "returned 1"
        if [[ "$2" == "" ]] || [[ "$1" ]]; then
            echo -e "TEST ${GREEN}PASSED${NC}: Error handle OK."
        else
            echo -e "TEST ${RED}FAILED${NC}: Error handle NG."
        fi
        echo ""
    fi
}
 
## @brief Main function to execute the test scripts and tee the output to a log file.
function main() {
    test_script "input.txt" "sed" "REPLACED"
    test_script "input.txt" "Sed" "REPLACED"
    test_script "input.txt" "is" "WAS"
    test_script "input.txt" "the" ""
    test_script "input.txt" "" "the"
    test_script "non_exist.txt" "the" "foo"
}
 
main | tee trace.log