[tools] Generate, build and run hosted examples

Author: salkinium

examples/linux/assert/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run fail -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../build/linux/assert</option>

examples/linux/block_device/file/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../../build/linux/block_device/file</option>

examples/linux/block_device/mirror/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../../build/linux/block_device/mirror</option>

examples/linux/block_device/ram/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../../build/linux/block_device/ram</option>

examples/linux/build_info/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../build/linux/build_info</option>

examples/linux/git/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../build/linux/git</option>

examples/linux/logger/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../build/linux/logger</option>

examples/linux/printf/project.xml

@@ -1,4 +1,5 @@
 <library>
+  <!-- CI: run -->
   <options>
     <option name="modm:target">hosted-linux</option>
     <option name="modm:build:build.path">../../../build/linux/printf</option>

tools/scripts/examples_compile.py

@@ -15,7 +15,9 @@
 import multiprocessing
 from pathlib import Path
 
-is_running_in_ci = os.getenv("CIRCLECI") is not None or os.getenv("TRAVIS") is not None
+is_running_in_ci = 	os.getenv("CIRCLECI") is not None or \
+					os.getenv("TRAVIS") is not None or \
+					os.getenv("GITHUB_ACTIONS") is not None
 cpus = 4 if is_running_in_ci else os.cpu_count()
 build_dir = (Path(os.path.abspath(__file__)).parents[2] / "build")
 cache_dir = build_dir / "cache"
@@ -24,10 +26,10 @@
 	global_options["::build.path"] = "build/"
 	global_options[":::cache_dir"] = str(cache_dir)
 
-def run(where, command):
+def run_command(where, command, all_output=False):
 	result = subprocess.run(command, shell=True, cwd=where, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 	output = ""
-	if result.returncode:
+	if result.returncode or all_output:
 		output += result.stdout.decode("utf-8").strip(" \n")
 	output += result.stderr.decode("utf-8").strip(" \n")
 	return (result.returncode, output)
@@ -37,9 +39,9 @@ def generate(project):
 	output = ["=" * 90, "Generating: {}".format(path)]
 	options = " ".join("-D{}={}".format(k, v) for k,v in global_options.items())
 	# Compile Linux examples under macOS with hosted-darwin target
-	if "Darwin" in platform.system() and "hosted-linux" in project.read_text():
-		options += " -D:target=hosted-darwin"
-	rc, ro = run(path, "lbuild {} build".format(options))
+	if "hosted-linux" in project.read_text():
+		options += " -D:target=hosted-{}".format(platform.system().lower())
+	rc, ro = run_command(path, "lbuild {} build".format(options))
 	print("\n".join(output + [ro]))
 	return None if rc else project
 
@@ -48,20 +50,36 @@ def build(project):
 	project_cfg = project.read_text()
 	commands = []
 	if ":build:scons" in project_cfg:
-		commands.append("python3 `which scons` build --cache-show --random")
+		if is_running_in_ci:
+			commands.append("scons build --cache-show --random")
+		else:
+			commands.append("python3 `which scons` build --cache-show --random")
 	if ":build:cmake" in project_cfg:
 		commands.append("make cmake && make build")
 
 	rcs = 0
 	for command in commands:
 		output = ["=" * 90, "Building: {} with {}".format(
 		          path / "main.cpp", "SCons" if "scons" in command else "CMake")]
-		rc, ro = run(path, command)
+		rc, ro = run_command(path, command)
 		rcs += rc
 		print("\n".join(output + [ro]))
 
 	return None if rcs else project
 
+def run(project):
+	path = project.parent
+	if is_running_in_ci:
+		command = "scons run"
+	else:
+		command = "python3 `which scons` run"
+	output = ["=" * 90, "Running: {} with {}".format(path / "main.cpp", "SCons" if "scons" in command else "CMake")]
+	rc, ro = run_command(path, command, all_output=True)
+	print("\n".join(output + [ro]))
+	if "CI: run fail" in project.read_text():
+		return None if not rc else project
+	return None if rc else project
+
 def compile_examples(paths):
 	print("Using {}x parallelism".format(cpus))
 	# Create build folder to prevent process race
@@ -81,8 +99,15 @@ def compile_examples(paths):
 		projects = pool.map(build, projects)
 	results += projects.count(None)
 
+	# Filter projects for successful compilation and runablity
+	projects = [p for p in projects if p is not None and "CI: run" in p.read_text()]
+	# Then run the successfully compiled ones
+	with multiprocessing.Pool(cpus) as pool:
+		projects = pool.map(run, projects)
+	results += projects.count(None)
+
 	return results
 
 
 if __name__ == '__main__':
-	exit(compile_examples(sys.argv[1:]))
+	exit(compile_examples(sys.argv[1:]))