From 202f5929eb7e4053a1890ba6e7e6f616c5b936d3 Mon Sep 17 00:00:00 2001
From: Fabian Keil <fk@fabiankeil.de>
Date: Sun, 10 Jan 2021 06:50:06 +0100
Subject: [PATCH] Add run-privoxy-tests.sh

... which takes care of starting Privoxy before running tests.

Sponsored by: Privoxy project funds collected at SPI
---
 tests/cts/run-privoxy-tests.sh | 158 +++++++++++++++++++++++++++++++++
 1 file changed, 158 insertions(+)
 create mode 100755 tests/cts/run-privoxy-tests.sh

diff --git a/tests/cts/run-privoxy-tests.sh b/tests/cts/run-privoxy-tests.sh
new file mode 100755
index 00000000..1b3e469f
--- /dev/null
+++ b/tests/cts/run-privoxy-tests.sh
@@ -0,0 +1,158 @@
+#!/bin/sh
+################################################################################
+#
+# run-privoxy-tests.sh
+#
+# Runs the Privoxy tests based on curl's runtests.pl framework.
+#
+# Copyright (c) 2021 Fabian Keil <fk@fabiankeil.de>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+################################################################################
+
+UPSTREAM_TEST_SCENARIO=upstream-tests
+
+# Delaying the test run by a whole second is annoying on fast systems
+# and may not be long enough on slow systems. There must be a more
+# elegant method to verify that Privoxy is running or failed to start.
+SECONDS_TO_WAIT_FOR_PRIVOXY_TO_START=1
+
+start_privoxy() {
+    local test_dir test_scenario
+    local privoxy_config privoxy_binary pid_file
+    test_dir="${1}"
+    test_scenario="${2}"
+
+    privoxy_config_dir="${test_dir}/${test_scenario}"
+    privoxy_binary="$(realpath "${test_dir}/../../privoxy")"
+    pid_file="${test_dir}/${test_scenario}/../privoxy.pid"
+    log_file="${test_dir}/logs/${test_scenario}.log"
+
+    (
+        cd "${privoxy_config_dir}" || exit 1
+        "${privoxy_binary}" --no-daemon \
+                            --pidfile "${pid_file}" \
+                            privoxy.conf > "${log_file}" 2>&1 || exit 1 &
+    )
+
+    sleep "${SECONDS_TO_WAIT_FOR_PRIVOXY_TO_START}"
+
+    if [ ! -f "${pid_file}" ]; then
+        echo "Privoxy failed to start or did not start in time"
+        if [ -f "${log_file}" ]; then
+            tail -n 1 "${log_file}"
+        fi
+        exit 1
+    fi
+}
+
+stop_privoxy() {
+    local test_dir test_scenario
+    local pid_file
+    test_dir="${1}"
+    test_scenario="${2}"
+    pid_file="${test_dir}/${test_scenario}/../privoxy.pid"
+    if [ -f "${pid_file}" ]; then
+        kill "$(cat "${pid_file}")"
+    fi
+}
+
+run_privoxy_tests() {
+    local start_privoxy="$1"
+    local test_scenario="$2"
+    local directory_name="$(dirname "$0")"
+    local test_dir="$(realpath "${directory_name}")"
+    local ret
+
+    echo "Test scenario: ${test_scenario}"
+    $start_privoxy && start_privoxy "${test_dir}" "${test_scenario}"
+
+    "${test_dir}/runtests-wrapper.sh" -A -E -t "${test_dir}/${test_scenario}/data" HTTP HTTPS
+    ret=$?
+
+    $start_privoxy && stop_privoxy "${test_dir}" "${test_scenario}"
+
+    return $ret
+}
+
+run_upstream_tests() {
+    local start_privoxy="$1"
+    local directory_name="$(dirname "$0")"
+    local test_dir="$(realpath "${directory_name}")"
+    local ret
+
+    echo "Test scenario: ${UPSTREAM_TEST_SCENARIO}"
+    $start_privoxy && start_privoxy "${test_dir}" "${UPSTREAM_TEST_SCENARIO}"
+
+    "${test_dir}/runtests-wrapper.sh" -A -T HTTP
+    ret=$?
+
+    $start_privoxy && stop_privoxy "${test_dir}" "${UPSTREAM_TEST_SCENARIO}"
+
+    return $ret
+}
+
+get_test_scenarios() {
+    local directory_name="$(dirname "$0")"
+    local test_dir="$(realpath "${directory_name}")"
+    local test_scenario
+    local privoxy_config
+
+    for privoxy_config in "${test_dir}"/*/privoxy.conf; do
+        test_scenario="${privoxy_config%%/privoxy.conf}"
+        test_scenario="${test_scenario##$test_dir/}"
+        echo "${test_scenario}"
+    done
+}
+
+main() {
+    local test_scenario=""
+    local test_scenarios=""
+    local start_privoxy=true
+
+    while [ -n "$1" ];
+    do
+        case "$1" in
+            "-r")
+                echo "Not starting privoxy."
+                start_privoxy=false
+                shift
+                ;;
+            "-t")
+                shift
+                test_scenarios="$1"
+                shift
+                ;;
+            *)
+                echo "Invalid parameter: $1"
+                exit 1
+                ;;
+        esac
+    done
+
+    if [ -z "${test_scenarios}" ]; then
+        test_scenarios="$(get_test_scenarios)"
+    fi
+
+    for test_scenario in ${test_scenarios}; do
+        if [ "${test_scenario}" = "${UPSTREAM_TEST_SCENARIO}" ]; then
+            run_upstream_tests ${start_privoxy} || exit 1
+        else
+            run_privoxy_tests ${start_privoxy} "${test_scenario}" || exit 1
+        fi
+    done
+
+    exit 0
+}
+
+main "$@"
-- 
2.39.2