From 39a20d43673262dd87f4b5e12ea98abd1c9bd7b5 Mon Sep 17 00:00:00 2001
From: Phil Davis <phil@jankaritech.com>
Date: Thu, 10 Feb 2022 17:53:30 +0545
Subject: [PATCH] Lint expected-failures files

---
 tests/acceptance/lint-expected-failures.sh | 86 ++++++++++++++++++++++
 tests/acceptance/run.sh                    | 21 ++----
 2 files changed, 92 insertions(+), 15 deletions(-)
 create mode 100755 tests/acceptance/lint-expected-failures.sh

diff --git a/tests/acceptance/lint-expected-failures.sh b/tests/acceptance/lint-expected-failures.sh
new file mode 100755
index 000000000000..5cc0ea859fea
--- /dev/null
+++ b/tests/acceptance/lint-expected-failures.sh
@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+if [ -n "${EXPECTED_FAILURES_FILE}" ]
+then
+	if [ -f "${EXPECTED_FAILURES_FILE}" ]
+	then
+		echo "Checking expected failures in ${EXPECTED_FAILURES_FILE}"
+	else
+		echo "Expected failures file ${EXPECTED_FAILURES_FILE} not found"
+		echo "Check the setting of EXPECTED_FAILURES_FILE environment variable"
+		exit 1
+	fi
+	FINAL_EXIT_STATUS=0
+	# If the last line of the expected-failures file ends without a newline character
+	# then that line may not get processed by some of the bash code in this script
+	# So check that the last character in the file is a newline
+	if [ $(tail -c1 "${EXPECTED_FAILURES_FILE}" | wc -l) -eq 0 ]
+	then
+		echo "Expected failures file ${EXPECTED_FAILURES_FILE} must end with a newline"
+		echo "Put a newline at the end of the last line and try again"
+		FINAL_EXIT_STATUS=1
+	fi
+	# Check the expected-failures file to ensure that the lines are self-consistent
+	# In most cases the features that are being run are in owncloud/core,
+	# so assume that by default.
+	FEATURE_FILE_REPO="owncloud/core"
+	while read INPUT_LINE
+		do
+			# Ignore comment lines (starting with hash)
+			if [[ "${INPUT_LINE}" =~ ^# ]]
+			then
+				continue
+			fi
+			# A line of text in the feature file can be used to indicate that the
+			# features being run are actually from some other repo. For example:
+			# "The expected failures in this file are from features in the owncloud/ocis repo."
+			# Write a line near the top of the expected-failures file to "declare" this,
+			# overriding the default "owncloud/core"
+			if [[ "${INPUT_LINE}" =~ features[[:blank:]]in[[:blank:]]the[[:blank:]]([a-zA-Z0-9-]+/[a-zA-Z0-9-]+)[[:blank:]]repo ]]; then
+				FEATURE_FILE_REPO="${BASH_REMATCH[1]}"
+				echo "Features are expected to be in the ${FEATURE_FILE_REPO} repo"
+				continue
+			fi
+			# Match lines that have [someSuite/someName.feature:n] - the part inside the
+			# brackets is the suite, feature and line number of the expected failure.
+			# Else ignore the line.
+			if [[ "${INPUT_LINE}" =~ \[([a-zA-Z0-9-]+/[a-zA-Z0-9-]+\.feature:[0-9]+)] ]]; then
+				SUITE_SCENARIO_LINE="${BASH_REMATCH[1]}"
+			else
+				continue
+			fi
+			# Find the link in round-brackets that should be after the SUITE_SCENARIO_LINE
+			if [[ "${INPUT_LINE}" =~ \(([a-zA-Z0-9:/.#-]+)\) ]]; then
+				ACTUAL_LINK="${BASH_REMATCH[1]}"
+			else
+				echo "Link not found in ${INPUT_LINE}"
+				FINAL_EXIT_STATUS=1
+				continue
+			fi
+			OLD_IFS=${IFS}
+			IFS=':'
+			read -ra FEATURE_PARTS <<< "${SUITE_SCENARIO_LINE}"
+			IFS=${OLD_IFS}
+			SUITE_FEATURE="${FEATURE_PARTS[0]}"
+			FEATURE_LINE="${FEATURE_PARTS[1]}"
+			EXPECTED_LINK="https://github.com/${FEATURE_FILE_REPO}/blob/master/tests/acceptance/features/${SUITE_FEATURE}#L${FEATURE_LINE}"
+			if [[ "${ACTUAL_LINK}" != "${EXPECTED_LINK}" ]]; then
+				echo "Link is not correct for ${SUITE_SCENARIO_LINE}"
+				echo "  Actual link: ${ACTUAL_LINK}"
+				echo "Expected link: ${EXPECTED_LINK}"
+				FINAL_EXIT_STATUS=1
+			fi
+
+		done < ${EXPECTED_FAILURES_FILE}
+else
+	echo "Environment variable EXPECTED_FAILURES_FILE must be defined to be the file to check"
+	exit 1
+fi
+
+if [ ${FINAL_EXIT_STATUS} == 1 ]
+then
+	echo "Errors were found in the expected failures file - see the messages above"
+else
+	echo "No problems were found in the expected failures file"
+fi
+exit ${FINAL_EXIT_STATUS}
diff --git a/tests/acceptance/run.sh b/tests/acceptance/run.sh
index 1f2f7d6f9709..61cc0dbea12a 100755
--- a/tests/acceptance/run.sh
+++ b/tests/acceptance/run.sh
@@ -42,22 +42,13 @@ fi
 
 if [ -n "${EXPECTED_FAILURES_FILE}" ]
 then
-	if [ -f "${EXPECTED_FAILURES_FILE}" ]
+	# Check the expected-failures file
+	${SCRIPT_PATH}/lint-expected-failures.sh
+	LINT_STATUS=$?
+	if [ ${LINT_STATUS} -ne 0 ]
 	then
-		echo "Checking expected failures in ${EXPECTED_FAILURES_FILE}"
-	else
-		echo "Expected failures file ${EXPECTED_FAILURES_FILE} not found"
-		echo "Check the setting of EXPECTED_FAILURES_FILE environment variable"
-		exit 1
-	fi
-	# If the last line of the expected-failures file ends without a newline character
-	# then that line may not get processed by some of the bash code in this script
-	# So check that the last character in the file is a newline
-	if [ $(tail -c1 "${EXPECTED_FAILURES_FILE}" | wc -l) -eq 0 ]
-	then
-		echo "Expected failures file ${EXPECTED_FAILURES_FILE} must end with a newline"
-		echo "Put a newline at the end of the last line and try again"
-		exit 1
+		echo "Error: expected failures file ${EXPECTED_FAILURES_FILE} is invalid"
+		exit ${LINT_STATUS}
 	fi
 fi