Expand the platformio dep installer to also install platforms and tools (#4716)

.github/workflows/ci-docker.yml

@@ -11,6 +11,7 @@ on:
       - ".github/workflows/**"
       - "requirements*.txt"
       - "platformio.ini"
+      - "script/platformio_install_deps.py"
 
   pull_request:
     paths:
@@ -18,6 +19,7 @@ on:
       - ".github/workflows/**"
       - "requirements*.txt"
       - "platformio.ini"
+      - "script/platformio_install_deps.py"
 
 permissions:
   contents: read

docker/Dockerfile

@@ -60,7 +60,7 @@ RUN \
 
 
 # First install requirements to leverage caching when requirements don't change
-COPY requirements.txt requirements_optional.txt docker/platformio_install_deps.py platformio.ini /
+COPY requirements.txt requirements_optional.txt script/platformio_install_deps.py platformio.ini /
 RUN \
     pip3 install --no-cache-dir -r /requirements.txt -r /requirements_optional.txt \
     && /platformio_install_deps.py /platformio.ini

docker/platformio_install_deps.py

@@ -1,30 +0,0 @@
-#!/usr/bin/env python3
-# This script is used in the docker containers to preinstall
-# all platformio libraries in the global storage
-
-import configparser
-import subprocess
-import sys
-
-config = configparser.ConfigParser(inline_comment_prefixes=(';', ))
-config.read(sys.argv[1])
-
-libs = []
-# Extract from every lib_deps key in all sections
-for section in config.sections():
-    conf = config[section]
-    if "lib_deps" not in conf:
-        continue
-    for lib_dep in conf["lib_deps"].splitlines():
-        if not lib_dep:
-            # Empty line or comment
-            continue
-        if lib_dep.startswith("${"):
-            # Extending from another section
-            continue
-        if "@" not in lib_dep:
-            # No version pinned, this is an internal lib
-            continue
-        libs.append(lib_dep)
-
-subprocess.check_call(['platformio', 'lib', '-g', 'install', *libs])

script/platformio_install_deps.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+# This script is used to preinstall
+# all platformio libraries in the global storage
+
+import configparser
+import subprocess
+import sys
+
+config = configparser.ConfigParser(inline_comment_prefixes=(";",))
+config.read(sys.argv[1])
+
+libs = []
+tools = []
+platforms = []
+# Extract from every lib_deps key in all sections
+for section in config.sections():
+    conf = config[section]
+    if "lib_deps" in conf:
+        for lib_dep in conf["lib_deps"].splitlines():
+            if not lib_dep:
+                # Empty line or comment
+                continue
+            if lib_dep.startswith("${"):
+                # Extending from another section
+                continue
+            if "@" not in lib_dep:
+                # No version pinned, this is an internal lib
+                continue
+            libs.append("-l")
+            libs.append(lib_dep)
+    if "platform" in conf:
+        platforms.append("-p")
+        platforms.append(conf["platform"])
+    if "platform_packages" in conf:
+        for tool in conf["platform_packages"].splitlines():
+            if not tool:
+                # Empty line or comment
+                continue
+            if tool.startswith("${"):
+                # Extending from another section
+                continue
+            if tool.find("https://github.com") != -1:
+                split = tool.find("@")
+                tool = tool[split + 1 :]
+            tools.append("-t")
+            tools.append(tool)
+
+subprocess.check_call(["platformio", "pkg", "install", "-g", *libs, *platforms, *tools])

script/setup

@@ -14,3 +14,5 @@ pip3 install -r requirements.txt -r requirements_optional.txt -r requirements_te
 pip3 install --no-use-pep517 -e .
 
 pre-commit install
+
+script/platformio_install_deps.py platformio.ini