run-vmtest: add path normalization script

actions/upload-artifacts has restrictions on what characters can be
used in uploaded paths.

Add a script that replaces forbidden characters in all paths under a
specified directory.

We ran into this problem when trying to upload traffic monitor
logs (which may contain a colon `:`). But since it's a github-specific
restriction, it doesn't make sense to enforce it upstream.

Signed-off-by: Ihor Solodrai <[email protected]>

Author: theihor

run-vmtest/normalize-paths-for-github.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Github's actions/upload-artifact has restriction on the characters that can be used in a path.
+# Invalid characters include:
+#   Double quote ",
+#   Colon :,
+#   Less than <,
+#   Greater than >,
+#   Vertical bar |,
+#   Asterisk *,
+#   Question mark ?,
+#   Carriage return \r,
+#   Line feed \n
+
+DIR=$1
+if [[ ! -d "$DIR" ]]; then
+    exit 0
+fi
+
+normalize() {
+    local path="$1"
+    echo -n "$path" | tr '":><|*?\r\n' '_________'
+}
+
+find "$DIR" -depth | while read -r path; do
+    if [[ "$path" == "$DIR" ]]; then
+        continue
+    fi
+    dirname=$(dirname "$path")
+    basename=$(basename "$path")
+    new_basename=$(normalize "$basename")
+    if [[ "$basename" != "$new_basename" ]]; then
+        new_path="${dirname}/${new_basename}"
+        mv -v "$path" "$new_path"
+    fi
+done

run-vmtest/run.sh

@@ -91,6 +91,10 @@ vmtest -k "${VMLINUZ}" --kargs "panic=-1 sysctl.vm.panic_on_oom=1" \
         cd '${GITHUB_WORKSPACE}'             && \
         ${VMTEST_SCRIPT} ${TEST_RUNNERS}"
 
+# fixup traffic montioring log paths if present
+PCAP_DIR=/tmp/tmon_pcap
+${GITHUB_ACTION_PATH}/normalize-paths-for-github.sh "$PCAP_DIR"
+
 foldable end vmtest
 
 foldable start collect_status "Collecting exit status"