Merge pull request #30 from roleroz/master

Replace templating from bazel to Jinga2

Author: mum4k

BUILD

@@ -0,0 +1,15 @@
+load("@rules_python//python:pip.bzl", "compile_pip_requirements")
+
+exports_files([
+    "requirements.in",
+    "requirements_lock.txt",
+    "requirements_windows.txt",
+])
+
+compile_pip_requirements(
+    name = "requirements",
+    extra_args = ["--allow-unsafe"],
+    requirements_in = "requirements.in",
+    requirements_txt = "requirements_lock.txt",
+    requirements_windows = "requirements_windows.txt",
+)

WORKSPACE

@@ -31,3 +31,27 @@ git_repository(
 
 load("@io_bazel_stardoc//:setup.bzl", "stardoc_repositories")
 stardoc_repositories()
+
+# Python library manager (pip)
+http_archive(
+    name = "rules_python",
+    sha256 = "81cbfc16dd1c022c4761267fa8b2feb881aaea9c3e1143f2e64630a1ad18c347",
+    strip_prefix = "rules_python-0.16.1",
+    url = "https://github.com/bazelbuild/rules_python/archive/0.16.1.zip",
+)
+load("@rules_python//python:repositories.bzl", "python_register_toolchains")
+python_register_toolchains(
+    name = "python3_10_8",
+    # Available versions are listed in @rules_python//python:versions.bzl.
+    # We recommend using the same version your team is already standardized on.
+    python_version = "3.10.8",
+)
+load("@python3_10_8//:defs.bzl", "interpreter")
+load("@rules_python//python:pip.bzl", "pip_parse")
+pip_parse(
+    name = "py_deps",
+    python_interpreter_target = interpreter,
+    requirements_lock = "//:requirements_lock.txt",
+)
+load("@py_deps//:requirements.bzl", "install_deps")
+install_deps()

platformio/BUILD

@@ -1,7 +1,17 @@
+load("@py_deps//:requirements.bzl", "requirement")
+
 package(
     default_visibility = ["//visibility:public"],
 )
 
+py_binary(
+    name = "template_renderer",
+    srcs = ["template_renderer.py"],
+    deps = [
+        requirement("jinja2"),
+    ]
+)
+
 filegroup(
     name = "platformio_ini_tmpl",
     srcs = ["platformio.ini.tmpl"],

platformio/platformio.bzl

@@ -150,16 +150,22 @@ def _emit_ini_file_action(ctx):
       if flag == "":
           continue
       build_flags.append(flag)
-  ctx.actions.expand_template(
-      template=ctx.file._platformio_ini_tmpl,
-      output=ctx.outputs.platformio_ini,
-      substitutions={
-          "%board%": ctx.attr.board,
-          "%platform%": ctx.attr.platform,
-          "%framework%": ctx.attr.framework,
-          "%environment_kwargs%": "\n".join(environment_kwargs),
-          "%build_flags%": " ".join(build_flags),
-      },
+  substitutions = struct(
+    board=ctx.attr.board,
+    platform=ctx.attr.platform,
+    framework=ctx.attr.framework,
+    environment_kwargs=environment_kwargs,
+    build_flags=build_flags,
+  ).to_json()
+  ctx.actions.run(
+    outputs=[ctx.outputs.platformio_ini],
+    inputs=[ctx.file._platformio_ini_tmpl],
+    executable=ctx.executable._template_renderer,
+    arguments=[
+      ctx.file._platformio_ini_tmpl.path,
+      ctx.outputs.platformio_ini.path,
+      substitutions
+    ],
   )
 
 
@@ -356,6 +362,11 @@ platformio_project = rule(
         default=Label("//platformio:platformio_ini_tmpl"),
         allow_single_file=True,
       ),
+      "_template_renderer": attr.label(
+        default=Label("//platformio:template_renderer"),
+        executable=True,
+        cfg="exec",
+      ),
       "src": attr.label(
         allow_single_file=[".cc"],
         mandatory=True,

platformio/platformio.ini.tmpl

@@ -1,12 +1,24 @@
+{# The following comment applies to the generated file, not to the template.
+
+If you are working on the template, knock yourself out ;) #}
 ; This file was automatically generated by bazel.
 ; Do not edit.
 
 [platformio]
-default_envs = %board%
+default_envs = {{ board }}
 
-[env:%board%]
-build_flags = -Wall -DPLATFORMIO_BUILD %build_flags%
+[env:{{ board }}]
+build_flags =
+  -Wall
+  -DPLATFORMIO_BUILD
+{%- for flag in build_flags %}
+  {{ flag }}
+{%- endfor %}
 lib_ldf_mode = deep+
-platform = %platform%
-board = %board%
-framework = %framework%%environment_kwargs%
+platform = {{ platform }}
+board = {{ board }}
+framework = 
+  {{ framework }}
+{%- for kwarg in environment_kwargs %}
+  {{environment_kwargs}}
+{%- endfor %}

platformio/template_renderer.py

@@ -0,0 +1,55 @@
+# Utility that reads a template file in Jinja format, a substitutions dictionary
+# in json format, and writes the rendered text to a file.
+
+# To use, run
+# template_renderer <template file> <output file> <substitutions>
+
+
+import jinja2
+import json
+import sys
+
+
+# Reads a template, renders it, and writes the output to a file.
+#
+# The template is provided in a text file in Jinja format
+# (https://jinja.palletsprojects.com/), and the substitutions are provided in
+# json format.
+#
+# Crashes if either any of the required arguments is not provided in the command
+# line, or if anything else is provided in the command line.
+#
+# Args (these are taken from the command line, i.e. sys.argv):
+# - template_filename (sys.argv[1]): The name of the file that contains the
+#   template to be rendered
+# - output_filename (sys.argv[2]): The name of the file to which the rendered
+#   template will be written
+# - substitutions (sys.argv[3]): A json representation of a dictionary with the
+#   variables and names to be substituted while rendering the provided template
+def main() -> int:
+    # Read parameters
+    num_parameters = len(sys.argv)
+    assert num_parameters == 4
+    template_filename = sys.argv[1]
+    output_filename = sys.argv[2]
+    substitutions = json.loads(sys.argv[3])
+
+    # Read template file
+    template_file = open(template_filename, "r")
+    template_str = template_file.read()
+    template_file.close()
+
+    # Render template
+    template = jinja2.Environment().from_string(template_str)
+    rendered_str = template.render(substitutions)
+
+    # Write output to desired file
+    output_file = open(output_filename, "w")
+    output_file.write(rendered_str)
+    output_file.close()
+
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())

requirements.in

@@ -0,0 +1 @@
+jinja2

requirements_lock.txt

@@ -0,0 +1,52 @@
+#
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
+#
+#    bazel run //:requirements.update
+#
+jinja2==3.1.2 \
+    --hash=sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852 \
+    --hash=sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61
+    # via -r ./requirements.in
+markupsafe==2.1.1 \
+    --hash=sha256:0212a68688482dc52b2d45013df70d169f542b7394fc744c02a57374a4207003 \
+    --hash=sha256:089cf3dbf0cd6c100f02945abeb18484bd1ee57a079aefd52cffd17fba910b88 \
+    --hash=sha256:10c1bfff05d95783da83491be968e8fe789263689c02724e0c691933c52994f5 \
+    --hash=sha256:33b74d289bd2f5e527beadcaa3f401e0df0a89927c1559c8566c066fa4248ab7 \
+    --hash=sha256:3799351e2336dc91ea70b034983ee71cf2f9533cdff7c14c90ea126bfd95d65a \
+    --hash=sha256:3ce11ee3f23f79dbd06fb3d63e2f6af7b12db1d46932fe7bd8afa259a5996603 \
+    --hash=sha256:421be9fbf0ffe9ffd7a378aafebbf6f4602d564d34be190fc19a193232fd12b1 \
+    --hash=sha256:43093fb83d8343aac0b1baa75516da6092f58f41200907ef92448ecab8825135 \
+    --hash=sha256:46d00d6cfecdde84d40e572d63735ef81423ad31184100411e6e3388d405e247 \
+    --hash=sha256:4a33dea2b688b3190ee12bd7cfa29d39c9ed176bda40bfa11099a3ce5d3a7ac6 \
+    --hash=sha256:4b9fe39a2ccc108a4accc2676e77da025ce383c108593d65cc909add5c3bd601 \
+    --hash=sha256:56442863ed2b06d19c37f94d999035e15ee982988920e12a5b4ba29b62ad1f77 \
+    --hash=sha256:671cd1187ed5e62818414afe79ed29da836dde67166a9fac6d435873c44fdd02 \
+    --hash=sha256:694deca8d702d5db21ec83983ce0bb4b26a578e71fbdbd4fdcd387daa90e4d5e \
+    --hash=sha256:6a074d34ee7a5ce3effbc526b7083ec9731bb3cbf921bbe1d3005d4d2bdb3a63 \
+    --hash=sha256:6d0072fea50feec76a4c418096652f2c3238eaa014b2f94aeb1d56a66b41403f \
+    --hash=sha256:6fbf47b5d3728c6aea2abb0589b5d30459e369baa772e0f37a0320185e87c980 \
+    --hash=sha256:7f91197cc9e48f989d12e4e6fbc46495c446636dfc81b9ccf50bb0ec74b91d4b \
+    --hash=sha256:86b1f75c4e7c2ac2ccdaec2b9022845dbb81880ca318bb7a0a01fbf7813e3812 \
+    --hash=sha256:8dc1c72a69aa7e082593c4a203dcf94ddb74bb5c8a731e4e1eb68d031e8498ff \
+    --hash=sha256:8e3dcf21f367459434c18e71b2a9532d96547aef8a871872a5bd69a715c15f96 \
+    --hash=sha256:8e576a51ad59e4bfaac456023a78f6b5e6e7651dcd383bcc3e18d06f9b55d6d1 \
+    --hash=sha256:96e37a3dc86e80bf81758c152fe66dbf60ed5eca3d26305edf01892257049925 \
+    --hash=sha256:97a68e6ada378df82bc9f16b800ab77cbf4b2fada0081794318520138c088e4a \
+    --hash=sha256:99a2a507ed3ac881b975a2976d59f38c19386d128e7a9a18b7df6fff1fd4c1d6 \
+    --hash=sha256:a49907dd8420c5685cfa064a1335b6754b74541bbb3706c259c02ed65b644b3e \
+    --hash=sha256:b09bf97215625a311f669476f44b8b318b075847b49316d3e28c08e41a7a573f \
+    --hash=sha256:b7bd98b796e2b6553da7225aeb61f447f80a1ca64f41d83612e6139ca5213aa4 \
+    --hash=sha256:b87db4360013327109564f0e591bd2a3b318547bcef31b468a92ee504d07ae4f \
+    --hash=sha256:bcb3ed405ed3222f9904899563d6fc492ff75cce56cba05e32eff40e6acbeaa3 \
+    --hash=sha256:d4306c36ca495956b6d568d276ac11fdd9c30a36f1b6eb928070dc5360b22e1c \
+    --hash=sha256:d5ee4f386140395a2c818d149221149c54849dfcfcb9f1debfe07a8b8bd63f9a \
+    --hash=sha256:dda30ba7e87fbbb7eab1ec9f58678558fd9a6b8b853530e176eabd064da81417 \
+    --hash=sha256:e04e26803c9c3851c931eac40c695602c6295b8d432cbe78609649ad9bd2da8a \
+    --hash=sha256:e1c0b87e09fa55a220f058d1d49d3fb8df88fbfab58558f1198e08c1e1de842a \
+    --hash=sha256:e72591e9ecd94d7feb70c1cbd7be7b3ebea3f548870aa91e2732960fa4d57a37 \
+    --hash=sha256:e8c843bbcda3a2f1e3c2ab25913c80a3c5376cd00c6e8c4a86a89a28c8dc5452 \
+    --hash=sha256:efc1913fd2ca4f334418481c7e595c00aad186563bbc1ec76067848c7ca0a933 \
+    --hash=sha256:f121a1420d4e173a5d96e47e9a0c0dcff965afdf1626d28de1460815f7c4ee7a \
+    --hash=sha256:fc7b548b17d238737688817ab67deebb30e8073c95749d55538ed473130ec0c7
+    # via jinja2