From f4ac6194b0c5a18bba7c4c60148ff61e483e9a16 Mon Sep 17 00:00:00 2001
From: Sagar Gurung <46086950+SagarGi@users.noreply.github.com>
Date: Thu, 2 Nov 2023 17:53:33 +0545
Subject: [PATCH] [tests-only][full-ci]Added script to check the deleted suites
 in the expected to failure (#7639)

* Added script to check the deleted suites in the expected to failure files

* Added drone pipeline

* Refactor script in loop
---
 .drone.star                                   | 22 ++++++
 ...heck-deleted-suites-in-expected-failure.sh | 67 +++++++++++++++++++
 2 files changed, 89 insertions(+)
 create mode 100755 tests/acceptance/check-deleted-suites-in-expected-failure.sh

diff --git a/.drone.star b/.drone.star
index 49c389c6a..be730039c 100644
--- a/.drone.star
+++ b/.drone.star
@@ -232,6 +232,7 @@ def main(ctx):
 
     test_pipelines = \
         codestyle(ctx) + \
+        checkTestSuitesInExpectedFailures(ctx) + \
         buildWebCache(ctx) + \
         getGoBinForTesting(ctx) + \
         [buildOcisBinaryForTesting(ctx)] + \
@@ -635,6 +636,27 @@ def vendorbinCodesniffer(phpVersion):
         ],
     }]
 
+def checkTestSuitesInExpectedFailures(ctx):
+    return [{
+        "kind": "pipeline",
+        "type": "docker",
+        "name": "check-suites-in-expected-failures",
+        "steps": [
+            {
+                "name": "check-suites",
+                "image": OC_CI_ALPINE,
+                "commands": [
+                    "%s/tests/acceptance/check-deleted-suites-in-expected-failure.sh" % dirs["base"],
+                ],
+            },
+        ],
+        "trigger": {
+            "ref": [
+                "refs/pull/**",
+            ],
+        },
+    }]
+
 def codestyle(ctx):
     pipelines = []
 
diff --git a/tests/acceptance/check-deleted-suites-in-expected-failure.sh b/tests/acceptance/check-deleted-suites-in-expected-failure.sh
new file mode 100755
index 000000000..86e49c435
--- /dev/null
+++ b/tests/acceptance/check-deleted-suites-in-expected-failure.sh
@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+# when deleting the tests suites from /features there might be the tests scenarios that might be in the expected to failure file
+# this script checks if there are such scenarios in the expected to failure file which needs to be deleted
+
+# helper functions
+log_error() {
+  echo -e "\e[31m$1\e[0m"
+}
+
+log_info() {
+  echo -e "\e[37m$1\e[0m"
+}
+
+log_success() {
+  echo -e "\e[32m$1\e[0m"
+}
+
+SCRIPT_PATH=$(dirname "$0")
+PATH_TO_SUITES="${SCRIPT_PATH}/features"
+EXPECTED_FAILURE_FILES=("expected-failures-localAPI-on-OCIS-storage.md" "expected-failures-API-on-OCIS-storage.md")
+# contains all the suites names inside tests/acceptance/features
+AVAILABLE_SUITES=($(ls -l "$PATH_TO_SUITES" | grep '^d' | awk '{print $NF}'))
+
+# regex to match [someSuites/someFeatureFile.feature:lineNumber]
+SCENARIO_REGEX="\[([a-zA-Z0-9]+/[a-zA-Z0-9]+\.feature:[0-9]+)]"
+
+# contains all those suites available in the expected to failure files in pattern [someSuites/someFeatureFile.feature:lineNumber]
+EXPECTED_FAILURE_SCENARIOS=()
+EXIT_CODE=0
+for expected_failure_file in "${EXPECTED_FAILURE_FILES[@]}"; do
+  PATH_TO_EXPECTED_FAILURE_FILE="${SCRIPT_PATH}/${expected_failure_file}"
+  EXPECTED_FAILURE_SCENARIOS=($(grep -Eo ${SCENARIO_REGEX} ${PATH_TO_EXPECTED_FAILURE_FILE}))
+  # get and store only the suites names from EXPECTED_FAILURE_SCENARIOS
+  EXPECTED_FAILURE_SUITES=()
+  for scenario in "${EXPECTED_FAILURE_SCENARIOS[@]}"; do
+    if [[ $scenario =~ \[([a-zA-Z0-9]+) ]]; then
+      suite="${BASH_REMATCH[1]}"
+      EXPECTED_FAILURE_SUITES+=("$suite")
+   fi
+  done
+  # also filter the duplicated suites name
+  EXPECTED_FAILURE_SUITES=($(echo "${EXPECTED_FAILURE_SUITES[@]}" | tr ' ' '\n' | sort | uniq))
+  # Check the existence of the suite
+  NONEXISTING_SCENARIOS=()
+  for suite in "${EXPECTED_FAILURE_SUITES[@]}"; do
+    if [[ " ${AVAILABLE_SUITES[*]} " != *" $suite "* ]]; then
+      pattern="(${suite}/[a-zA-Z0-9]+\\.feature:[0-9]+)"
+      NONEXISTING_SCENARIOS+=($(grep -Eo ${pattern} ${PATH_TO_EXPECTED_FAILURE_FILE}))
+    fi
+  done
+
+  count="${#NONEXISTING_SCENARIOS[@]}"
+  if [ "$count" -gt 0 ]; then
+    EXIT_CODE=1
+    log_info "The following test scenarios do not exist anymore:"
+    log_info "They can be deleted from the '${expected_failure_file}'"
+    for scenario_path in "${NONEXISTING_SCENARIOS[@]}"; do
+      log_error "$scenario_path"
+    done
+  else
+    log_success "All the suites in the expected failure file '${expected_failure_file}' exist!"
+  fi
+  log_info "\n"
+done
+
+exit "$EXIT_CODE"