add test.sh

2 files changed, 197 insertions, 0 deletions

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..d76765e
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,3 @@
+* text=auto
+
+*.sh text eol=lf
diff --git a/test/test.sh b/test/test.sh
new file mode 100755
index 0000000..b7b6d10
--- /dev/null
+++ b/test/test.sh
@@ -0,0 +1,194 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021 Egor Tensin <Egor.Tensin@gmail.com>
+# This file is part of the "linux-status" project.
+# For details, see https://github.com/egor-tensin/linux-status.
+# Distributed under the MIT License.
+
+set -o errexit -o nounset -o pipefail
+
+script_dir="$( dirname -- "${BASH_SOURCE[0]}" )"
+script_dir="$( cd -- "$script_dir" && pwd )"
+readonly script_dir
+script_name="$( basename -- "${BASH_SOURCE[0]}" )"
+readonly script_name
+
+readonly server_port=18101
+server_pid=
+curl_header_file=
+curl_output_file=
+
+dump() {
+    local msg
+    for msg; do
+        echo "$script_name: $msg"
+    done
+}
+
+run_server() {
+    dump "Starting up server..."
+    "$script_dir/../server.py" --port 18101 &
+    server_pid="$!"
+    dump "Its PID is $server_pid"
+    sleep 3
+}
+
+kill_server() {
+    [ -z "$server_pid" ] && return
+    dump "Killing server with PID $server_pid..."
+    kill "$server_pid"
+    dump "Waiting for it to terminate..."
+    wait "$server_pid" || true
+    dump "Done"
+}
+
+create_files() {
+    curl_header_file="$( mktemp )"
+    curl_output_file="$( mktemp )"
+    dump "curl header file: $curl_header_file"
+    dump "curl output file: $curl_output_file"
+}
+
+cleanup_files() {
+    dump "Cleaning up curl files..."
+    [ -n "$curl_header_file" ] && rm -f -- "$curl_header_file"
+    [ -n "$curl_output_file" ] && rm -f -- "$curl_output_file"
+}
+
+prepare() {
+    run_server
+    create_files
+}
+
+cleanup() {
+    kill_server || true
+    cleanup_files || true
+}
+
+run_curl() {
+    if [ "$#" -ne 1 ]; then
+        echo "usage: ${FUNCNAME[0]} URL" >&2
+        return 1
+    fi
+    local url="$1"
+    curl \
+        --silent --show-error \
+        --fail \
+        --dump-header "$curl_header_file" \
+        --output "$curl_output_file" \
+        --connect-timeout 3 \
+        -- "http://localhost:$server_port$url"
+}
+
+curl_check_status() {
+    if [ "$#" -ne 1 ]; then
+        echo "usage: ${FUNCNAME[0]} HTTP_STATUS" >&2
+        return 1
+    fi
+
+    local expected="$1"
+    expected="HTTP/1.0 $expected"$'\r'
+    local actual
+    actual="$( head -n 1 -- "$curl_header_file" )"
+
+    [ "$expected" == "$actual" ] && return 0
+
+    dump "Actual HTTP response: $actual" >&2
+    dump "Expected:             $expected" >&2
+    return 1
+}
+
+curl_check_keyword() {
+    local keyword
+    for keyword; do
+        if ! grep --fixed-strings --quiet -- "$keyword" "$curl_output_file"; then
+            dump "The following pattern hasn't been found:"
+            dump "$keyword"
+        fi
+    done
+}
+
+run_curl_test() {
+    if [ "$#" -lt 1 ]; then
+        echo "usage: ${FUNCNAME[0]} URL [KEYWORD...]" >&2
+        return 1
+    fi
+
+    local url="$1"
+    shift
+    dump "Running test for URL: $url"
+
+    run_curl "$url"
+    curl_check_status '200 OK'
+
+    local keyword
+    for keyword; do
+        curl_check_keyword "$keyword"
+    done
+}
+
+run_curl_tests() {
+    # / and /index.html are identical:
+    run_curl_test '/'           '<link rel="stylesheet" href="css/bootstrap.min.css">' 'var status_refresh_interval_seconds'
+    run_curl_test '/index.html' '<link rel="stylesheet" href="css/bootstrap.min.css">' 'var status_refresh_interval_seconds'
+
+    # /status returns a JSON with a number of fields:
+    run_curl_test '/status' '"hostname":' '"system":' '"user":'
+
+    # /top is a `top` output:
+    run_curl_test '/top' 'load average:'
+}
+
+cgi_check_header() {
+    local expected='Content-Type: text/html; charset=utf-8'
+    local actual
+    actual="$( head -n 1 -- "$curl_output_file" )"
+
+    [ "$expected" == "$actual" ] && return 0
+
+    dump "Actual CGI header: $actual" >&2
+    dump "Expected:          $expected" >&2
+
+    diff <( echo "$actual" ) <( echo "$expected" ) | cat -te
+    return 1
+}
+
+run_cgi_test() {
+    if [ "$#" -lt 1 ]; then
+        echo "usage: ${FUNCNAME[0]} WHAT [KEYWORD...]" >&2
+        return 1
+    fi
+
+    local what="$1"
+    shift
+
+    local query_string="what=$what"
+    dump "Running CGI test for query string: $query_string"
+
+    QUERY_STRING="$query_string" "$script_dir/../app.py" > "$curl_output_file"
+
+    cgi_check_header
+
+    local keyword
+    for keyword; do
+        curl_check_keyword "$keyword"
+    done
+}
+
+run_cgi_tests() {
+    # Check that app.py still works as a CGI script.
+
+    # /status returns a JSON with a number of fields:
+    run_cgi_test 'status' '"hostname":' '"system":' '"user":'
+    # /top is a `top` output:
+    run_cgi_test 'top' 'load average:'
+}
+
+main() {
+    trap cleanup EXIT
+    prepare
+    run_curl_tests
+    run_cgi_tests
+}
+
+main "$@"