[tools] Improve example check script and fix issues

Author: salkinium

.github/workflows/linux.yml

@@ -67,10 +67,10 @@ jobs:
         run: |
           python3 tools/scripts/synchronize_docs.py -d
           git checkout .
-      - name: Check for Unique Build Paths
+      - name: Check Examples
         if: always()
         run: |
-          python3 tools/scripts/examples_check.py examples
+          python3 tools/scripts/examples_check.py
 
   stm32-examples:
     runs-on: ubuntu-20.04
@@ -143,7 +143,7 @@ jobs:
       - name: Examples STM32F4 Without Discovery Board
         if: always()
         run: |
-          (cd examples && ../tools/scripts/examples_compile.py nucleo_f401re nucleo_f411re nucleo_f429zi nucleo_f446re black_pill_f401 black_pill_f411 stm32f407vet6_devebox stm32_f4ve)
+          (cd examples && ../tools/scripts/examples_compile.py nucleo_f401re nucleo_f411re nucleo_f429zi nucleo_f446re nucleo_f446ze nucleo_f439zi black_pill_f401 black_pill_f411 stm32f407vet6_devebox stm32_f4ve)
 
   avr-examples:
     runs-on: ubuntu-20.04

.travis.yml

@@ -19,5 +19,5 @@ before_install:
 script:
   - (cd test && make run-hosted-linux)
   - (cd examples && ../tools/scripts/examples_compile.py linux)
-  - (cd examples && ../tools/scripts/examples_compile.py stm32f1_discovery nucleo_f103rb olimexino_stm32 stm32f103c8t6_blue_pill stm32f103c8t6_black_pill)
+  - (cd examples && ../tools/scripts/examples_compile.py stm32f1_discovery nucleo_f103rb olimexino_stm32 blue_pill_f103 black_pill_f103)
   - (cd examples && ../tools/scripts/examples_compile.py rpi)

examples/arduino_nano/color/project.xml

@@ -1,7 +1,7 @@
 <library>
   <extends>modm:arduino-nano</extends>
   <options>
-    <option name="modm:build:build.path">../../../../build/arduino_nano/color</option>
+    <option name="modm:build:build.path">../../../build/arduino_nano/color</option>
   </options>
   <modules>
     <module>modm:build:scons</module>

examples/stm32_f4ve/gui/project.xml

@@ -1,7 +1,7 @@
 <library>
   <extends>modm:stm32_f4ve</extends>
   <options>
-    <option name="modm:build:build.path">../../../../build/stm32_f4ve/gui</option>
+    <option name="modm:build:build.path">../../../build/stm32_f4ve/gui</option>
     <option name="modm:build:image.source">images</option>
   </options>
   <modules>

tools/scripts/examples_check.py

@@ -11,38 +11,75 @@
 from pathlib import Path
 from collections import defaultdict
 
-def check_unique_paths(projects):
-	# build paths *must* be unique, otherwise parallel compilation will overwrite build artifacts
+repopath = lambda path: Path(__file__).parents[2] / path
+relpath = lambda path: os.path.relpath(path, repopath("."))
+
+def check_builds_paths(projects):
+	# Get all build paths
 	paths = defaultdict(list)
 	for project in projects:
 		match = re.search(r"<option name=\".*?:build.path\">(.*?)</option>", project.read_text())
 		if match:
-			match = match.group(1);
+			path = match.group(1)
+			match = (project.parent / match.group(1)).resolve();
 		else:
-			match = "build"
-		paths[match].append(project)
+			path = "build"
+			match = path
+		paths[match].append( (project, path) )
 
 	result = 0
 	for path, projects in paths.items():
+		# Check that all build paths are unique, otherwise parallel compilation will overwrite build artifacts
 		if path == "build":
-			for project in projects:
-				print("'{}' has no build path set!".format(project), file=sys.stderr)
+			for project, _ in projects:
+				print("\nProject '{}' has no build path set!".format(relpath(project)), file=sys.stderr)
 				result += 1
+		# Check that all build paths are unique
 		elif len(projects) > 1:
-			print("The build path '{}' is used by these projects:".format(path), file=sys.stderr)
-			for project in projects:
-				print(" - '{}'".format(project), file=sys.stderr)
+			print("\nThe build path '{}' is used by multiple projects:".format(path), file=sys.stderr)
+			for project, bpath in projects:
+				print(" - '{}': '{}'".format(relpath(project), bpath), file=sys.stderr)
+				result += 1
+		# Check that all build paths are actually inside the build folder
+		if len(projects):
+			relbuildpath = os.path.relpath(path, repopath("build"))
+			if relbuildpath.startswith(".."):
+				print("\nThe build path '{}' is outside of the 'modm/build' folder!"
+				      .format(relpath(path)), file=sys.stderr)
+				for project, bpath in projects:
+					print(" - '{}': '{}'".format(relpath(project), bpath), file=sys.stderr)
 				result += 1
 
 	return result
 
+def _get_paths_from_ci(files):
+	paths = set()
+	for file in files:
+		matches = re.findall(r"examples_compile.py (.*?)\)", file.read_text())
+		paths |= set(m  for match in matches  for m in match.split(" "))
+	return paths
 
-if __name__ == "__main__":
-	# Find all project files
-	projects = [p for path in sys.argv[1:] for p in Path(path).glob("**/project.xml")]
+def check_is_part_of_ci(projects):
+	folders = set(p.relative_to(repopath("examples")).parts[0] for p in projects)
+	result = 0
+	# Linux files
+	paths = _get_paths_from_ci([repopath(".github/workflows/linux.yml")])
+	paths = folders - paths - {'rpi'}
+	if paths:
+		print("\nLinux CI is missing examples: '{}'"
+		      .format("', '".join(sorted(list(paths)))), file=sys.stderr)
+		print("    Please add these example folders to the appropriate CI job in\n"
+		      "    '.github/workflows/linux.yml'!")
 
-	result = check_unique_paths(projects)
+	return len(paths)
 
+if __name__ == "__main__":
+	# Find all project files
+	projects = list(repopath("examples").rglob("*/project.xml"))
+	# Run a bunch of checks on them
+	result = check_builds_paths(projects)
+	result += check_is_part_of_ci(projects)
+	# Return code if any
 	exit(result)
 
 

tools/scripts/examples_compile.py

@@ -93,6 +93,10 @@ def compile_examples(paths, jobs, split, part):
     # Create build folder to prevent process race
     cache_dir.mkdir(exist_ok=True, parents=True)
     (cache_dir / "config").write_text('{"prefix_len": 2}')
+    # Validate that paths exist!
+    invalid_paths = [p for p in paths if not Path(p).exists()]
+    if invalid_paths: print("Invalid paths:\n- " + "\n- ".join(invalid_paths));
+    results = len(invalid_paths)
     # Find all project files
     projects = [p for path in paths for p in Path(path).glob("**/project.xml")]
     projects.sort()
@@ -103,7 +107,7 @@ def compile_examples(paths, jobs, split, part):
     # first generate all projects
     with multiprocessing.Pool(jobs) as pool:
         projects = pool.map(generate, projects)
-    results = projects.count(None)
+    results += projects.count(None)
 
     # Filter projects for successful generation
     projects = [p for p in projects if p is not None]