fix(cmake): harden Path usage

Signed-off-by: Frederic Pillon <[email protected]>

Author: fpistm

cmake/scripts/ccwrapper.py

@@ -2,17 +2,15 @@
 
 import io
 import re
-import pathlib
+from pathlib import Path
 import subprocess
 import argparse
 
 parser = argparse.ArgumentParser()
 parser.add_argument(
-    "--source", "-i", type=pathlib.Path, required=True, help="input file being compiled"
-)
-parser.add_argument(
-    "--logdir", "-d", type=pathlib.Path, required=True, help="log directory"
+    "--source", "-i", type=Path, required=True, help="input file being compiled"
 )
+parser.add_argument("--logdir", "-d", type=Path, required=True, help="log directory")
 parser.add_argument(
     "cmd",
     action="extend",
@@ -29,7 +27,7 @@
 if proc.returncode != 0:
     exit(proc.returncode)
 
-with open(shargs.logdir / (shargs.source.name + ".log"), "w") as file:
+with open(shargs.logdir / f"{shargs.source.name}.log", "w") as file:
     print(" " + str(shargs.source), file=file)
     for line in io.StringIO(proc.stderr):
         if logline.match(line):

cmake/scripts/cmake_easy_setup.py

@@ -5,7 +5,7 @@
 import shutil
 import tempfile
 import os
-import pathlib
+from pathlib import Path
 import json
 from jinja2 import Environment, FileSystemLoader
 import difflib
@@ -16,7 +16,7 @@
 parser.add_argument(
     "--cli",
     "-x",
-    type=pathlib.Path,
+    type=Path,
     required=False,
     default=shutil.which("arduino-cli"),
     help="path to arduino-cli",
@@ -30,12 +30,12 @@
 )
 output_args = parser.add_mutually_exclusive_group(required=True)
 output_args.add_argument(
-    "--output", "-o", type=pathlib.Path, help="output file (CMake) with placeholders"
+    "--output", "-o", type=Path, help="output file (CMake) with placeholders"
 )
 output_args.add_argument(
     "--sketch",
     "-s",
-    type=pathlib.Path,
+    type=Path,
     help="output file (CMake) filled given a sketch folder",
 )
 
@@ -62,6 +62,13 @@
     exit(-1)
 
 
+# Path management
+scriptname = Path(__file__).resolve()
+corepath = scriptname.parent.parent.parent.resolve()
+boards_txt = corepath / "boards.txt"
+userhome = Path.home()
+
+
 def arduino(*args):
     # return (out.stdout, logfile)
     # raises an exception if the command fails
@@ -76,16 +83,23 @@ def arduino(*args):
     return (out, logfile)
 
 
+def userhome_process(path):
+    lpath = str(path)
+    if path.is_relative_to(userhome):
+        lpath = f"~/{str(path.relative_to(userhome))}"
+    return lpath
+
+
 def get_log(fname):
     with open(fname) as file:
         for line in file:
             yield json.loads(line)
 
 
-def get_boards(boardstxt):
+def get_boards():
 
-    # we "reject" everything because we don't care about the values, only the keys
-    families = parse_file(boardstxt, lambda x: True)
+    # "reject" everything because we don't care about the values, only the keys
+    families = parse_file(boards_txt, lambda x: True)
     del families["menu"]
 
     boards = set()
@@ -97,7 +111,7 @@ def get_boards(boardstxt):
 
 _, logf = arduino("lib", "list")
 
-allboards = get_boards(pathlib.Path(__file__).parent.parent.parent / "boards.txt")
+allboards = get_boards()
 
 
 if shargs.board and shargs.board not in allboards:
@@ -119,11 +133,11 @@ def get_boards(boardstxt):
 libpaths = dict()
 for line in get_log(logf):
     if line["msg"] == "Adding libraries dir":
-        libpaths[line["location"]] = pathlib.Path(line["dir"])
+        libpaths[line["location"]] = Path(line["dir"])
 
 # platform lib path is already known, obviously, since that's where this script resides
 if "user" in libpaths.keys():
-    userlibs = pathlib.Path(libpaths["user"])
+    userlibs = Path(libpaths["user"])
     if userlibs.exists():
         userlibs = userlibs.resolve()
         libs = [u.name for u in userlibs.iterdir() if u.is_dir()]
@@ -137,7 +151,7 @@ def get_boards(boardstxt):
         )
         libs = list()
 else:
-    userlibs = pathlib.Path.home() / "Arduino/libraries"
+    userlibs = Path.home() / "Arduino/libraries"
     print(
         f"""No user library path found through arduino-cli (falling back to {userlibs}).
     This has likely to do with your arduino-cli configuration.
@@ -147,22 +161,13 @@ def get_boards(boardstxt):
     )
     libs = list()
 
-corepath = pathlib.Path(__file__).parent.parent.parent.resolve()
-
 j2_env = Environment(
     loader=FileSystemLoader(str(corepath / "cmake" / "templates")),
     trim_blocks=True,
     lstrip_blocks=True,
 )
 cmake_template = j2_env.get_template("easy_cmake.cmake")
 
-
-userhome = pathlib.Path.home()
-if userlibs.is_relative_to(userhome):
-    userlibs = "~/" + str(userlibs.relative_to(userhome))
-if corepath.is_relative_to(userhome):
-    corepath = "~/" + str(corepath.relative_to(userhome))
-
 if shargs.sketch:
     SOURCEFILE_EXTS = (".c", ".cpp", ".S", ".ino")
     sources = {
@@ -180,19 +185,15 @@ def get_boards(boardstxt):
     tgtname = ""
     sources = set()
 
-scriptname = pathlib.Path(__file__)
-if scriptname.is_relative_to(userhome):
-    scriptname = "~/" + str(scriptname.relative_to(userhome))
-
 with open(shargs.output or shargs.sketch / "CMakeLists.txt", "w") as out:
     out.write(
         cmake_template.render(
-            corepath=str(corepath).replace(
+            corepath=userhome_process(corepath).replace(
                 "\\", "\\\\"
             ),  # escape backslashes for CMake
-            userlibs=str(userlibs).replace("\\", "\\\\"),
+            userlibs=userhome_process(userlibs).replace("\\", "\\\\"),
             libs=libs,
-            scriptfile=scriptname,
+            scriptfile=userhome_process(scriptname),
             tgtname=tgtname,
             scrcfiles=sources,
             boardname=shargs.board,

cmake/scripts/cmake_gen.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+from pathlib import Path
+
 SOURCEFILE_EXTS = (
     ".c",
     ".cpp",
@@ -20,7 +22,7 @@ def get_default_config():
     )
 
 
-def parse_configfile(file):
+def parse_configfile(file: Path):
     rawcfg = dict()
 
     for line in open(file):
@@ -42,7 +44,7 @@ def parse_configfile(file):
     return cfg
 
 
-def get_sources(dir, recursive=False, relative_to=None):
+def get_sources(dir: Path, recursive: bool = False, relative_to: Path = None):
     if relative_to is None:
         relative_to = dir
     if recursive:
@@ -57,12 +59,12 @@ def get_sources(dir, recursive=False, relative_to=None):
     }
 
 
-def render(dir, template, config):
+def render(dir: Path, template, config):
     with open(dir / "CMakeLists.txt", "w") as outfile:
         outfile.write(template.render(**config))
 
 
-def get_static_libs(dir):
+def get_static_libs(dir: Path):
     result = dict()
     cpu = ""
     fpconf = "-"  # format: f"{fpu}-{float_abi}"; this makes "-" by default
@@ -80,7 +82,7 @@ def get_static_libs(dir):
     return result
 
 
-def config_for_bareflat(dir, force_recurse=False):
+def config_for_bareflat(dir: Path, force_recurse: bool = False):
     # no library.properties
     config = get_default_config()
 
@@ -98,7 +100,7 @@ def config_for_bareflat(dir, force_recurse=False):
     return config
 
 
-def config_for_modern(dir):
+def config_for_modern(dir: Path):
     # library.properties present, src/ present
     config = get_default_config()
     config.update(parse_configfile(dir / "library.properties"))
@@ -111,7 +113,7 @@ def config_for_modern(dir):
     return config
 
 
-def autoconfig(libdir):
+def autoconfig(libdir: Path):
     conf_file = libdir / "library.properties"
     srcdir = libdir / "src"
     if (

cmake/scripts/cmake_updater_hook.py

@@ -8,15 +8,15 @@
 
 import argparse
 import subprocess
-import pathlib
+from pathlib import Path
 import sys
 
 parser = argparse.ArgumentParser(
     usage="updater hook for CMake files. Fully automatic, takes no argument."
 )
 shargs = parser.parse_args()
 
-script_dir = pathlib.Path(__file__).parent  # Arduino_Core_STM32/cmake/scripts
+script_dir = Path(__file__).parent.resolve()  # Arduino_Core_STM32/cmake/scripts
 base_dir = script_dir.parent.parent  # Arduino_Core_STM32
 templates_dir = base_dir / "cmake" / "templates"
 

cmake/scripts/generate_header.py

@@ -1,15 +1,11 @@
 #!/usr/bin/env python3
 
 import argparse
-import pathlib
+from pathlib import Path
 
 parser = argparse.ArgumentParser()
-parser.add_argument(
-    "--source", "-i", type=pathlib.Path, required=True, help="ctags's output"
-)
-parser.add_argument(
-    "--out", "-o", type=pathlib.Path, required=True, help="header to generate"
-)
+parser.add_argument("--source", "-i", type=Path, required=True, help="ctags's output")
+parser.add_argument("--out", "-o", type=Path, required=True, help="header to generate")
 
 shargs = parser.parse_args()
 

cmake/scripts/includes.py

@@ -1,18 +1,16 @@
 #!/usr/bin/env python3
 
-import pathlib
+from pathlib import Path
 import argparse
 
 import graphviz
 
 parser = argparse.ArgumentParser()
-parser.add_argument("-o", type=pathlib.Path, help="file to write the full graph to")
-parser.add_argument(
-    "-t", type=pathlib.Path, help="file to write the transitive graph to"
-)
+parser.add_argument("-o", type=Path, help="file to write the full graph to")
+parser.add_argument("-t", type=Path, help="file to write the transitive graph to")
 parser.add_argument(
     "logs",
-    type=pathlib.Path,
+    type=Path,
     nargs="*",
     action="extend",
     help="list of log files to parse",
@@ -39,7 +37,7 @@ def parse_output(log):
     for line in log:
         d, h = line.rstrip().split(" ", 1)
         d = d.count(".")
-        h = pathlib.Path(h)
+        h = Path(h)
 
         if d == 0:
             rootcause = h

cmake/scripts/sizereport.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-import pathlib
+from pathlib import Path
 import re
 import subprocess
 import argparse
@@ -9,14 +9,14 @@
 parser.add_argument(
     "-x",
     "--tool",
-    type=pathlib.Path,
+    type=Path,
     required=True,
     help="path to `arm-none-eabi-size`",
 )
 parser.add_argument(
     "-f",
     "--binfile",
-    type=pathlib.Path,
+    type=Path,
     required=True,
     help="path to the binary to analyze",
 )

cmake/scripts/syms.py

@@ -1,19 +1,17 @@
 #!/usr/bin/env python3
 
-import pathlib
+from pathlib import Path
 import argparse
 
 import graphviz
 
 parser = argparse.ArgumentParser()
 parser.add_argument(
-    "-m", "--mapfile", type=pathlib.Path, required=True, help="path to ld's map file"
+    "-m", "--mapfile", type=Path, required=True, help="path to ld's map file"
 )
+parser.add_argument("-f", "--fullgv", type=Path, help="file to write the full graph to")
 parser.add_argument(
-    "-f", "--fullgv", type=pathlib.Path, help="file to write the full graph to"
-)
-parser.add_argument(
-    "-s", "--summarygv", type=pathlib.Path, help="file to write the summarized graph to"
+    "-s", "--summarygv", type=Path, help="file to write the summarized graph to"
 )
 
 shargs = parser.parse_args()