project_tests.sh

#!/bin/bash
set -e

usage() {
    echo "Usage: $0 [-l|--log SESSION_LOG_FILE]"
    exit 1
}

TEST_FILE="$(mktemp)"
XSL_FILE=""
DOI=""
SESSION_LOG_FILE=""

while [[ "$#" -gt 0 ]]; do
    case $1 in
    -l | --log)
        SESSION_LOG_FILE="$2"
        shift 2
        ;;
    -h | --help)
        usage
        ;;
    -*)
        echo "Unknown option: $1" >&2
        usage
        ;;
    *)
        if [[ -z "$XSL_FILE" ]]; then
            XSL_FILE="$1"
        else
            echo "Unexpected parameter: $1" >&2
            usage
        fi
        shift
        ;;
    esac
done

# Get the directory where the script is located
SCRIPT_DIR="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"

if [[ -n "${SESSION_LOG_FILE}" ]]; then
    touch "${SESSION_LOG_FILE}"
    echo -n "" > "${SESSION_LOG_FILE}"
fi

function write_to_log() {
    if [[ -n "${SESSION_LOG_FILE}" ]]; then
        echo "${1}" >> "${SESSION_LOG_FILE}"
    fi
}

function write_to_log_comparison() {
    write_to_log "successful comparison with: ${1#*test/}"
    write_to_log ""
}

function section_title() {
    echo "${1}"
    printf '%*s\n' "${#1}" | tr ' ' '-'
}

function transform_xml() {
    if [ ! -s "${1}" ]; then
        echo "Error: XML file is empty (${1})" >&2
        exit 1
    fi

    if [[ -n "${SESSION_LOG_FILE}" ]]; then
        local debug=" --log ${SCRIPT_DIR}/project-tests.log --log-info ${1#*fixtures/} --log-noprefix"
    fi

    if [ "${2:-}" = "--doi" ]; then
        cat "${1}" | "${SCRIPT_DIR}/scripts/transform.sh" --doi "${3}"${debug:-}
    else
        if [ -n "$2" ] && [ ! -e "$2" ]; then
            echo "Error: XSLT file is empty (${2})" >&2
            exit 1
        fi

        cat "${1}" | "${SCRIPT_DIR}/scripts/transform.sh" "${2:-}"${debug:-}
    fi
}

function expected() {
    if diff -w -u "${1}" "${2}" >/dev/null; then
        echo "Output matches expected (${3#*test/})"
        write_to_log_comparison "${2#*test/}"
        echo ""
    else
        echo "Output does not match expected (${3#*test/})" >&2
        exit 1
    fi
}

# todo: allow XML to be only tested against a specific xslt

section_title "Checking fixtures that have all xslt transforms applied (no doi match)"
for xml_file in ${SCRIPT_DIR}/test/all/*.xml; do
    echo "Running test for (${xml_file#*test/})"
    transform_xml "${SCRIPT_DIR}/test/fixtures/$(basename ${xml_file})" > "${TEST_FILE}"

    expected "${TEST_FILE}" "${xml_file}" "${xml_file}"
done

section_title "Checking xslt files that apply to all manuscripts"
for xsl_file in ${SCRIPT_DIR}/src/*.xsl; do
    xsl_filename=$(basename "${xsl_file}")

    if [ -d "${SCRIPT_DIR}/test/${xsl_filename%.*}" ]; then
        echo "Running tests for (${xsl_file#*src/})"
        for xml_file in ${SCRIPT_DIR}/test/${xsl_filename%.*}/*.xml; do
            transform_xml "${SCRIPT_DIR}/test/fixtures/$(basename ${xml_file})" "${xsl_file}" > "${TEST_FILE}"

            expected "${TEST_FILE}" "${xml_file}" "$(basename ${xml_file}) - ${xsl_filename}"
        done
    else
        echo "No tests exist for (${xsl_file#*test/})" >&2
        exit 1
    fi
done

section_title "Checking fixtures that have all xslt transforms applied (doi match)"
for manuscript_dir in ${SCRIPT_DIR}/src/*/; do
    manuscript_doi=$(basename "${manuscript_dir}")
    for xml_file in ${SCRIPT_DIR}/test/all/${manuscript_doi}/*.xml; do
        echo "Running test for (${xml_file#*test/})"
        transform_xml "${SCRIPT_DIR}/test/fixtures/${manuscript_doi}/$(basename ${xml_file})" --doi "${manuscript_doi}" > "${TEST_FILE}"

        expected "${TEST_FILE}" "${xml_file}" "${xml_file}"
    done
done

section_title "Checking xslt files that apply to specific manuscripts"
for xsl_file in ${SCRIPT_DIR}/src/*/*.xsl; do
    xsl_filename=$(basename "${xsl_file}")
    xsl_file_dir=$(basename $(dirname "${xsl_file}"))

    if [ -d "${SCRIPT_DIR}/test/${xsl_file_dir}/${xsl_filename%.*}" ]; then
        echo "Running tests for (${xsl_file#*src/})"
        for xml_file in ${SCRIPT_DIR}/test/${xsl_file_dir}/${xsl_filename%.*}/*.xml; do
            transform_xml "${SCRIPT_DIR}/test/fixtures/${xsl_file_dir}/$(basename ${xml_file})" "${xsl_file}" > "${TEST_FILE}"

            expected "${TEST_FILE}" "${xml_file}" "$(basename ${xml_file}) - ${xsl_file_dir}/${xsl_filename}"
        done
    else
        echo "No tests exist for (${xsl_file#*test/})" >&2
        exit 1
    fi
done

rm "${TEST_FILE}"

if [[ -n "${SESSION_LOG_FILE}" ]]; then
    # Remove multiple empty lines from end of log file
    sed -i -e :a -e '/^\n*$/{$d;N;};/\n$/ba' "${SESSION_LOG_FILE}"

    expected_log=$(
        cat <<EOF
[info: kitchen-sink.xml] (DOI: N/A) change-label-and-title-elements.xsl changed
[info: kitchen-sink.xml] (DOI: N/A) convert-all-caps-title-to-title-case.xsl changed
[info: kitchen-sink.xml] (DOI: N/A) convert-doi-links-to-pub-id-elements.xsl changed
successful comparison with: all/kitchen-sink.xml

[info: kitchen-sink.xml] (DOI: N/A) change-label-and-title-elements.xsl changed
successful comparison with: change-label-and-title-elements/kitchen-sink.xml

[info: kitchen-sink.xml] (DOI: N/A) convert-all-caps-title-to-title-case.xsl changed
successful comparison with: convert-all-caps-title-to-title-case/kitchen-sink.xml

[info: kitchen-sink.xml] (DOI: N/A) convert-doi-links-to-pub-id-elements.xsl changed
successful comparison with: convert-doi-links-to-pub-id-elements/kitchen-sink.xml

[info: 2021.11.12.468444/2021.11.12.468444.xml] (DOI: 2021.11.12.468444) change-label-and-title-elements.xsl changed
[info: 2021.11.12.468444/2021.11.12.468444.xml] (DOI: 2021.11.12.468444) convert-all-caps-title-to-title-case.xsl changed
[info: 2021.11.12.468444/2021.11.12.468444.xml] (DOI: 2021.11.12.468444) convert-doi-links-to-pub-id-elements.xsl no change applied
[info: 2021.11.12.468444/2021.11.12.468444.xml] (DOI: 2021.11.12.468444) 2021.11.12.468444/remove-supplementary-materials.xsl changed
successful comparison with: all/2021.11.12.468444/2021.11.12.468444.xml

[info: 2022.05.30.22275761/2022.05.30.22275761.xml] (DOI: 2022.05.30.22275761) change-label-and-title-elements.xsl changed
[info: 2022.05.30.22275761/2022.05.30.22275761.xml] (DOI: 2022.05.30.22275761) convert-all-caps-title-to-title-case.xsl changed
[info: 2022.05.30.22275761/2022.05.30.22275761.xml] (DOI: 2022.05.30.22275761) convert-doi-links-to-pub-id-elements.xsl changed
[info: 2022.05.30.22275761/2022.05.30.22275761.xml] (DOI: 2022.05.30.22275761) 2022.05.30.22275761/remove-supplementary-materials.xsl changed
successful comparison with: all/2022.05.30.22275761/2022.05.30.22275761.xml

[info: 2022.07.26.501569/2022.07.26.501569.xml] (DOI: 2022.07.26.501569) change-label-and-title-elements.xsl changed
[info: 2022.07.26.501569/2022.07.26.501569.xml] (DOI: 2022.07.26.501569) convert-all-caps-title-to-title-case.xsl no change applied
[info: 2022.07.26.501569/2022.07.26.501569.xml] (DOI: 2022.07.26.501569) convert-doi-links-to-pub-id-elements.xsl changed
[info: 2022.07.26.501569/2022.07.26.501569.xml] (DOI: 2022.07.26.501569) 2022.07.26.501569/move-ecole-into-institution.xsl changed
successful comparison with: all/2022.07.26.501569/2022.07.26.501569.xml

[info: 2021.11.12.468444/2021.11.12.468444.xml] (DOI: N/A) 2021.11.12.468444/remove-supplementary-materials.xsl changed
successful comparison with: 2021.11.12.468444/remove-supplementary-materials/2021.11.12.468444.xml

[info: 2022.05.30.22275761/2022.05.30.22275761.xml] (DOI: N/A) 2022.05.30.22275761/remove-supplementary-materials.xsl changed
successful comparison with: 2022.05.30.22275761/remove-supplementary-materials/2022.05.30.22275761.xml

[info: 2022.07.26.501569/2022.07.26.501569.xml] (DOI: N/A) 2022.07.26.501569/move-ecole-into-institution.xsl changed
successful comparison with: 2022.07.26.501569/move-ecole-into-institution/2022.07.26.501569.xml
EOF
    )

    if ! diff "${SESSION_LOG_FILE}" <(echo "${expected_log}"); then
        echo "ERROR: Session log file differs from expected log."
        exit 1
    fi

    echo "Successful comparison with expected log"
    echo ""
fi

section_title "Verify ./scripts/process-folder.sh"

PROCESS_FOLDER_TMP=$(mktemp -d)

"${SCRIPT_DIR}/scripts/process-folder.sh" "${SCRIPT_DIR}/test/fixtures" "${PROCESS_FOLDER_TMP}"

rm -rf "${PROCESS_FOLDER_TMP}"

echo "All done!"