From 3f8ac7cd516278ccbc15eed47f8520b045d044e3 Mon Sep 17 00:00:00 2001
From: Mounir IDRASSI <mounir.idrassi@idrix.fr>
Date: Wed, 25 Dec 2024 11:35:58 +0100
Subject: Add XML validation Github workflow (contributed by Jertzukka
 github.com/Jertzukka/VeraCrypt/tree/ci)

---
 .github/workflows/xmlvalidate.sh  | 42 +++++++++++++++++++++++++++++++++++++++
 .github/workflows/xmlvalidate.yml | 36 +++++++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+)
 create mode 100644 .github/workflows/xmlvalidate.sh
 create mode 100644 .github/workflows/xmlvalidate.yml

(limited to '.github/workflows')

diff --git a/.github/workflows/xmlvalidate.sh b/.github/workflows/xmlvalidate.sh
new file mode 100644
index 00000000..79d52c16
--- /dev/null
+++ b/.github/workflows/xmlvalidate.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+fail=false
+
+# Get all string keys
+KEYS=$(grep -oP '<entry[\ ]+lang="[^"]+"[\ ]+key="\K[^"]+' "$1"/src/Common/Language.xml)
+
+for file in {"$1"/Translations/Language.*.xml,"$1"/src/Common/Language.xml}; do
+  echo "$file"
+  passes=true
+  
+  # Validate xml
+  output=$(fxparser -V "$file")
+  returnvalue=$?
+
+  if [ "$returnvalue" -ne "0" ]; then
+    passes=false
+    fail=true
+    echo $output
+  fi
+
+  # Ensure each key found in common xml is found in translation xmls
+  for key in $KEYS; do
+    if ! grep -q "$key" "$file"; then
+      echo "Key $key not found in $file"
+      passes=false
+      fail=true
+    fi
+  done
+  
+  if [ "$passes" = true ]; then
+    echo -e "\e[32m$file passes xml validation.\e[0m"
+  else
+    echo -e "\e[31m$file fails xml validation.\e[0m"
+  fi
+  
+done
+
+if [ "$fail" = true ]; then
+  exit 1
+else
+  exit 0
+fi
diff --git a/.github/workflows/xmlvalidate.yml b/.github/workflows/xmlvalidate.yml
new file mode 100644
index 00000000..66389252
--- /dev/null
+++ b/.github/workflows/xmlvalidate.yml
@@ -0,0 +1,36 @@
+name: Validate XML
+
+on:
+  push:
+    branches: [ "ci" ]
+    paths:
+      - 'Translations/*'
+      - 'src/Common/Language.xml'
+      - '.github/workflows/xmlvalidate.*'
+  pull_request:
+    branches: [ "ci" ]
+    paths:
+      - 'Translations/*'
+      - 'src/Common/Language.xml'
+      - '.github/workflows/xmlvalidate.*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  validate:
+
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 'latest'
+    - name: Install fast-xml-parser
+      run: npm install fast-xml-parser -g
+    - name: Run XML validator script
+      run: ${{ github.workspace }}/.github/workflows/xmlvalidate.sh "${{ github.workspace }}"
-- 
cgit v1.2.3