Validate PR using a python script

Author: adamziel

.github/workflows/ships-blueprint-json.yml

@@ -1,4 +1,4 @@
-name: Ships Blueprint.json file?
+name: Ships a valid Blueprint.json file?
 
 on:
     pull_request:
@@ -11,32 +11,6 @@ jobs:
             - name: Checkout code
               uses: actions/checkout@v2
 
-            - name: Install jsonlint
+            - name: Run validate_pr.py
               run: |
-                sudo apt-get update
-                sudo apt-get install -y npm
-                npm install -g jsonlint
-
-            - name: Find updated directories
-              id: find_directories
-              run: |
-                  git diff --name-only origin/main...$GITHUB_SHA | grep '^blueprints/' | cut -d/ -f2 | sort -u > updated_directories.txt
-
-            - name: Check blueprint.json files
-              id: check_blueprints
-              run: |
-                  while IFS= read -r directory; do
-                      if [ ! -f "blueprints/$directory/blueprint.json" ]; then
-                          echo "Missing blueprint.json file in $directory"
-                          exit 1
-                      fi
-                  done < updated_directories.txt
-
-            - name: Validate blueprint.json files
-              run: |
-                while IFS= read -r directory; do
-                    if [ -f "blueprints/$directory/blueprint.json" ]; then
-                        echo "Validating blueprint.json file in $directory"
-                        jsonlint -q "blueprints/$directory/blueprint.json"
-                    fi
-                done < updated_directories.txt
+                  python validate_pr.py

validate_pr.py

@@ -0,0 +1,41 @@
+import os
+import re
+import json
+import sys
+
+def validate_blueprints():
+    # Get the list of directories touched in the current branch
+    touched_dirs = get_touched_directories()
+
+    for dir in touched_dirs:
+        if not re.match(r'^blueprints/[^/]+$', dir):
+            continue
+        blueprint_json_path = os.path.join(dir, 'blueprint.json')
+
+        # Check if blueprint.json file exists
+        if not os.path.exists(blueprint_json_path):
+            print(f"Error: {dir}/{blueprint_json_path} file does not exist in this PR.")
+            sys.exit(1)
+
+        # Read and validate the JSON file
+        try:
+            with open(blueprint_json_path, 'r') as f:
+                blueprint_json = json.load(f)
+        except json.JSONDecodeError as e:
+            print(f"Error: Invalid JSON in {blueprint_json_path}: {str(e)}")
+            sys.exit(1)
+
+
+def get_touched_directories():
+    # Run git diff command to get the list of directories touched in the current branch
+    diff_output = os.popen('git diff --name-only origin/trunk').read()
+    touched_dirs = set()
+
+    # Extract the directory paths from the diff output
+    for line in diff_output.splitlines():
+        dir_path = os.path.dirname(line)
+        touched_dirs.add(dir_path)
+
+    return touched_dirs
+# Call the function to validate blueprints
+validate_blueprints()