unstructured/test_unstructured_ingest/check-diff-expected-output-html.sh
Marek Połom f333d7fe7f
feat: Json elements to HTML converter (#3936)
## NOTE
`test_unstructured_ingest/expected-structured-output-html` contains all
test HTML fixtures. Original JSON files, from which these HTML fixtures
are generated, were taken from
`test_unstructured_ingest/expected-structured-output`
2025-03-04 13:57:35 +00:00

63 lines
2.1 KiB
Bash
Executable File

#!/usr/bin/env bash
# Description: Compare the structured output HTML files to the expected output html files and exit
# with an error if they are different. If the environment variable OVERWRITE_FIXTURES
# is not "false", then this script will instead copy the output files to the expected
# output directory.
#
# Environment Variables:
# - OVERWRITE_FIXTURES: Controls whether to overwrite HTML fixtures or not. default: "false"
set +e
SCRIPT_DIR=$(dirname "$(realpath "$0")")
OVERWRITE_FIXTURES=${OVERWRITE_FIXTURES:-false}
TMP_DIRECTORY_CLEANUP=${TMP_DIRECTORY_CLEANUP:-true}
OUTPUT_ROOT=${OUTPUT_ROOT:-$SCRIPT_DIR}
OUTPUT_DIR_HTML=$OUTPUT_ROOT/structured-html-output
EXPECTED_OUTPUT_DIR_HTML=$OUTPUT_ROOT/expected-structured-output-html
DIFF_OUTPUT_FILE="outputhtmldiff.txt"
# shellcheck disable=SC1091
source "$SCRIPT_DIR"/cleanup.sh
function cleanup() {
if [ "$TMP_DIRECTORY_CLEANUP" == "true" ]; then
cleanup_dir "$OUTPUT_DIR_HTML"
else
echo "skipping tmp directory cleanup"
fi
}
trap cleanup EXIT
# Generate structured HTML output
"$SCRIPT_DIR"/structured-json-to-html.sh "$OUTPUT_DIR_HTML"
# To update ingest test HTML fixtures, run 'make html-fixtures-update' on x86_64
if [ "$OVERWRITE_FIXTURES" != "false" ]; then
# remove folder if it exists
if [ -d "$EXPECTED_OUTPUT_DIR_HTML" ]; then
rm -rf "$EXPECTED_OUTPUT_DIR_HTML"
fi
mkdir -p "$EXPECTED_OUTPUT_DIR_HTML"
cp -rf "$OUTPUT_DIR_HTML"/* "$EXPECTED_OUTPUT_DIR_HTML"
elif ! diff -ru "$EXPECTED_OUTPUT_DIR_HTML" "$OUTPUT_DIR_HTML"; then
diff -ru "$EXPECTED_OUTPUT_DIR_HTML" "$OUTPUT_DIR_HTML" >"$DIFF_OUTPUT_FILE"
cat "$DIFF_OUTPUT_FILE"
diffstat -c "$DIFF_OUTPUT_FILE"
echo
echo "There are differences from the previously checked-in structured HTML outputs."
echo
echo "If these differences are acceptable, overwrite by the fixtures by setting the env var:"
echo
echo " export OVERWRITE_FIXTURES=true"
echo
echo "and then rerun this script."
echo
echo "NOTE: You'll likely just want to run 'make html-fixtures-update' on x86_64 hardware"
echo "to update fixtures for CI."
echo
exit 1
fi