Standardise copying code and clean test environment

Author: will-v-pi

scripts/genExamples.py

@@ -8,7 +8,7 @@
 import configparser
 import platform
 
-from pico_project import GenerateCMake
+from pico_project import GenerateCMake, copyExampleConfigs
 
 # This script is designed to be run on Linux
 assert platform.system() == "Linux"
@@ -164,13 +164,16 @@
 os.system(
     f"git -c advice.detachedHead=false clone https://github.com/raspberrypi/pico-examples.git --depth=1 --branch {EXAMPLES_BRANCH}"
 )
-os.environ["PICO_SDK_PATH"] = f"~/.pico-sdk/sdk/{SDK_VERSION}"
-os.environ["WIFI_SSID"] = "Your Wi-Fi SSID"
-os.environ["WIFI_PASSWORD"] = "Your Wi-Fi Password"
-os.environ["TEST_TCP_SERVER_IP"] = (
-    "192.168.1.100"  # This isn't read from environment variables, so also needs to be passed to cmake
-)
-os.environ["MQTT_SERVER"] = "myMQTTserver"
+
+PICO_SDK_PATH = f"~/.pico-sdk/sdk/{SDK_VERSION}"
+configure_env = {
+    "PICO_SDK_PATH": PICO_SDK_PATH,
+    "WIFI_SSID": "Your Wi-Fi SSID",
+    "WIFI_PASSWORD": "Your Wi-Fi Password",
+    "TEST_TCP_SERVER_IP": "192.168.1.100",  # This isn't read from environment variables, so also needs to be passed to cmake
+    "MQTT_SERVER": "myMQTTserver",
+}
+
 os.environ["CFLAGS"] = "-Werror=cpp"
 os.environ["CXXFLAGS"] = "-Werror=cpp"
 
@@ -187,12 +190,21 @@
         )
         toolchainPath = f"~/.pico-sdk/toolchain/{toolchainVersion}"
         picotoolDir = f"~/.pico-sdk/picotool/{SDK_VERSION}/picotool"
+
+        # Setup env to find targets
+        for k, v in configure_env.items():
+            os.environ[k] = v
+
         os.system(
             f"cmake -S pico-examples -B build -DPICO_BOARD={board} -DPICO_PLATFORM={platform} -DPICO_TOOLCHAIN_PATH={toolchainPath} -Dpicotool_DIR={picotoolDir} -DTEST_TCP_SERVER_IP=$TEST_TCP_SERVER_IP"
         )
 
         os.system("cmake --build build --target help > targets.txt")
 
+        # Clear env for clean tests
+        for k in configure_env.keys():
+            del os.environ[k]
+
         targets = []
 
         with open("targets.txt", "r") as f:
@@ -295,24 +307,12 @@ def test_build(target, v):
                 "exampleLibs": v["libs"],
             }
             GenerateCMake(dir, params)
-            if os.path.exists(f"{dir}/lwipopts.h"):
-                with open(f"{dir}/lwipopts.h", "r") as f:
-                    if "lwipopts_examples_common.h" in f.read():
-                        # Write lwipopts for examples
-                        shutil.copy(
-                            f"{os.path.dirname(os.path.realpath(__file__))}/lwipopts.h",
-                            f"{dir}/lwipopts_examples_common.h",
-                        )
-
-            if os.path.exists(f"{dir}/mbedtls_config.h"):
-                with open(f"{dir}/mbedtls_config.h", "r") as f:
-                    if "mbedtls_config_examples_common.h" in f.read():
-                        # Write mbedtls_config for examples
-                        shutil.copy(
-                            f"{os.path.dirname(os.path.realpath(__file__))}/mbedtls_config.h",
-                            f"{dir}/mbedtls_config_examples_common.h",
-                        )
-            shutil.copy("pico-examples/pico_sdk_import.cmake", f"{dir}/")
+            copyExampleConfigs(dir)
+
+            shutil.copy(
+                os.path.expanduser(f"{PICO_SDK_PATH}/external/pico_sdk_import.cmake"),
+                f"{dir}/",
+            )
 
             retcmake = os.system(f"cmake -S {dir} -B {dir}-build -GNinja")
             retbuild = os.system(f"cmake --build {dir}-build")

scripts/pico_project.py

@@ -22,6 +22,8 @@
 import csv
 import json
 
+sourcefolder = os.path.dirname(os.path.abspath(__file__))
+
 CMAKELIST_FILENAME = "CMakeLists.txt"
 CMAKECACHE_FILENAME = "CMakeCache.txt"
 
@@ -1322,6 +1324,28 @@ def generateProjectFiles(
     os.chdir(oldCWD)
 
 
+def copyExampleConfigs(projectPath):
+    lwipopts_path = os.path.join(projectPath, "lwipopts.h")
+    if os.path.exists(lwipopts_path):
+        with open(lwipopts_path, "r") as f:
+            if "lwipopts_examples_common.h" in f.read():
+                # Write lwipopts for examples
+                shutil.copy(
+                    os.path.join(sourcefolder, "lwipopts.h"),
+                    os.path.join(projectPath, "lwipopts_examples_common.h"),
+                )
+
+    mbedtls_config_path = os.path.join(projectPath, "mbedtls_config.h")
+    if os.path.exists(mbedtls_config_path):
+        with open(mbedtls_config_path, "r") as f:
+            if "mbedtls_config_examples_common.h" in f.read():
+                # Write mbedtls_config for examples
+                shutil.copy(
+                    os.path.join(sourcefolder, "mbedtls_config.h"),
+                    os.path.join(projectPath, "mbedtls_config_examples_common.h"),
+                )
+
+
 def DoEverything(params):
     if not os.path.exists(params["projectRoot"]):
         print("Invalid project path")
@@ -1464,8 +1488,6 @@ def DoEverything(params):
 # main execution starteth here
 
 if __name__ == "__main__":
-    sourcefolder = os.path.dirname(os.path.abspath(__file__))
-
     args = ParseCommandLine()
 
     if args.nouart: