[#71185] Support choosing a portable and locally built Renode

JanOlencki · JanOlencki · commit acf6b422b579 · 2025-02-03T12:33:56.000+01:00
diff --git a/.ci.yml b/.ci.yml
@@ -15,36 +15,52 @@ variables:
   wget -nv "$BAZELISK_URL" -O /usr/local/bin/bazelisk && \
   chmod +x /usr/local/bin/bazelisk
 
+.examples_artifacts: &examples_artifacts
+  after_script:
+    - mkdir artifacts
+    - cp -LR examples/*/bazel-testlogs/* artifacts
+  artifacts:
+      when:
+        always
+      paths:
+        - artifacts
+
 .default_bazel_version: &default_bazel_version
-  USE_BAZEL_VERSION: 7.4.1
+  variables:
+    USE_BAZEL_VERSION: 7.4.1
 
 test_examples:
   image: debian:12-slim
   stage: test
   <<: *common_triggers
-  variables:
-    <<: *default_bazel_version
+  <<: *default_bazel_version
   before_script:
     - *install_bazelisk
   script:
-    - useradd -m non_root
-    - chmod a+w -R .
     - pushd examples/cortex-r52
-    # rules_python doesn't support a hermetic toolchain run by root
-    - su non_root -c "bazelisk test //:all"
-    - ls bazel-testlogs/*/test.outputs/outputs.zip
+    - bazelisk test //:all
     - popd
     - pushd examples/failing-test
-    - su non_root -c "! bazelisk test //:all > test.log || exit 1"
-    - ls bazel-testlogs/*/test.outputs/outputs.zip
+    - "! bazelisk test //:all > test.log || exit 1"
     - grep -E "//:success-test +PASSED" test.log
     - grep -E "//:failing-test +FAILED" test.log
     - popd
-  after_script:
-    - mkdir artifacts
-    - cp -LR examples/*/bazel-testlogs/* artifacts
-  artifacts:
-      when:
-        always
-      paths:
-        - artifacts
+  <<: *examples_artifacts
+
+test_local_renode:
+  image: mcr.microsoft.com/dotnet/sdk:8.0
+  stage: test
+  <<: *common_triggers
+  <<: *default_bazel_version
+  before_script:
+    - *install_bazelisk
+  script:
+    - apt -y install git automake cmake autoconf libtool g++ coreutils policykit-1
+    - pushd examples/local-renode
+    - git clone --no-progress https://github.com/renode/renode.git
+    - pushd renode
+    - ./build.sh --net
+    - popd
+    - bazelisk test //:all
+    - popd
+  <<: *examples_artifacts
diff --git a/.github/workflows/bazel_test.yml b/.github/workflows/bazel_test.yml
@@ -26,6 +26,13 @@ jobs:
           grep -E "//:success-test +PASSED" test.log
           grep -E "//:failing-test +FAILED" test.log
           popd
+          pushd examples/local-renode
+          git clone --no-progress https://github.com/renode/renode.git
+          pushd renode
+          ./build.sh --net
+          popd
+          bazelisk test //:all
+          popd
 
       - name: Upload Bazel artifacts
         uses: actions/upload-artifact@v4
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -19,5 +19,7 @@ pip.parse(
 )
 use_repo(pip, "renode_test_python_deps")
 
-renode = use_extension("@rules_renode//renode:extensions.bzl", "renode")
+renode = use_extension("@rules_renode//renode:extensions.bzl", "renode",
+    dev_dependency = True
+)
 use_repo(renode, "renode_default_toolchain")
diff --git a/examples/cortex-r52/MODULE.bazel b/examples/cortex-r52/MODULE.bazel
@@ -3,6 +3,16 @@ module(
     version = "0.0.0",
 )
 
+# Override Python to set ignore_root
+bazel_dep(name = "rules_python", version = "0.36.0")
+
+python = use_extension("@rules_python//python/extensions:python.bzl", "python")
+python.toolchain(
+    ignore_root_user_error = True,  # It allows usage in containers with the root user
+    python_version = "3.11",
+)
+use_repo(python)
+
 bazel_dep(name = "rules_renode", version = "0.0.0")
 local_path_override(
     module_name = "rules_renode",
@@ -12,6 +22,13 @@ local_path_override(
 renode = use_extension("@rules_renode//renode:extensions.bzl", "renode")
 use_repo(renode, "renode_toolchains")
 
+# Use non-default version of Renode
+renode.download_portable(
+    name = "renode_toolchain",
+    sha256 = "73fe07a8fd0849a9f30c02bd7ce7c7dd67d11070365f41ddd6145a477ebdea65",
+    url = "https://builds.renode.io/renode-1.15.3+20250128git85f0aac72.linux-portable-dotnet.tar.gz",
+)
+
 register_toolchains("@renode_toolchains//:all")
 
 http_file = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")
diff --git a/examples/failing-test/MODULE.bazel b/examples/failing-test/MODULE.bazel
@@ -3,6 +3,16 @@ module(
     version = "0.0.0",
 )
 
+# Override Python to set ignore_root
+bazel_dep(name = "rules_python", version = "0.36.0")
+python = use_extension("@rules_python//python/extensions:python.bzl", "python")
+python.toolchain(
+    ignore_root_user_error = True,  # It allows usage in containers with the root user
+    python_version = "3.11",
+)
+use_repo(python)
+
+
 bazel_dep(name = "rules_renode", version = "0.0.0")
 local_path_override(
     module_name = "rules_renode",
@@ -15,9 +25,3 @@ use_repo(renode, "renode_toolchains")
 register_toolchains("@renode_toolchains//:all")
 
 http_file = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")
-
-http_file(
-    name = "cortex-r52-hirtos-hello",
-    sha256 = "73d6dea92d5bcff9c29b4e5c76aba5a691797cd68d458c243855055756f8093c",
-    url = "https://dl.antmicro.com/projects/renode/cortex-r52--hirtos-hello.elf-s_140356-d44a0b48e22a17fa8cb83ef08243ec23942812c0",
-)
diff --git a/examples/local-renode/BUILD.bazel b/examples/local-renode/BUILD.bazel
@@ -0,0 +1,11 @@
+load("@rules_renode//renode:defs.bzl", "renode_test")
+
+renode_test(
+    name = "success-test",
+    timeout = "short",
+    robot_test = "test.robot",
+    tags = [
+        # Local build of Renode requires CLR to be available
+        "local",
+    ],
+)
diff --git a/examples/local-renode/MODULE.bazel b/examples/local-renode/MODULE.bazel
@@ -0,0 +1,31 @@
+module(
+    name = "renode_bazel_examples",
+    version = "0.0.0",
+)
+
+# Override Python to set ignore_root
+bazel_dep(name = "rules_python", version = "0.36.0")
+
+python = use_extension("@rules_python//python/extensions:python.bzl", "python")
+python.toolchain(
+    ignore_root_user_error = True,  # It allows usage in containers with the root user
+    python_version = "3.11",
+)
+use_repo(python)
+
+bazel_dep(name = "rules_renode", version = "0.0.0")
+local_path_override(
+    module_name = "rules_renode",
+    path = "../..",
+)
+
+renode = use_extension("@rules_renode//renode:extensions.bzl", "renode")
+renode.local_build(
+    name = "renode_toolchain",
+    path = "./renode",
+)
+use_repo(renode, "renode_toolchains")
+
+register_toolchains("@renode_toolchains//:all")
+
+http_file = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_file")
diff --git a/examples/local-renode/test.robot b/examples/local-renode/test.robot
@@ -0,0 +1,3 @@
+*** Test Cases ***
+Should Succeed
+    Execute Command                 mach create
diff --git a/renode/extensions.bzl b/renode/extensions.bzl
@@ -1,23 +1,68 @@
+load("@bazel_tools//tools/build_defs/repo:local.bzl", "new_local_repository")
+
+_DEFAULT_PORTABLE_RENODE = {
+    "name": "renode_default_toolchain",
+    "url":  "https://builds.renode.io/renode-1.15.3+20250113gite77cf1237.linux-portable-dotnet.tar.gz",
+    "sha256":  "a6242b628b49b8a254358fe399ad49f0838c708abe44c551321c9555b7bff873",
+}
+
 def _portable_renode_toolchain_repository_impl(repository_ctx):
     """Creates a repository with a single Renode runtime"""
     repository_ctx.report_progress("Downloading Renode...")
     repository_ctx.download_and_extract(
         repository_ctx.attr.url,
         sha256 = repository_ctx.attr.sha256,
     )
-    repository_ctx.template("BUILD.bazel", Label("//renode:renode.BUILD.bazel"))
+    repository_ctx.file("BUILD.bazel",
+        content = repository_ctx.attr.build_file_content)
+
+def _renode_build_file_variables(renode_dir, cosimulation_dir):
+    return """\
+_RENODE_DIRECTORY = "%s"
+_COSIMULATION_DIRECTORY = "%s"
+""" % (renode_dir, cosimulation_dir)
 
 def _renode_impl(module_ctx):
-    default_toolchain = "renode_default_toolchain"
-    portable_renode_repository(
-        name = default_toolchain,
-        url = "https://builds.renode.io/renode-1.15.3+20250113gite77cf1237.linux-portable-dotnet.tar.gz",
-        sha256 = "a6242b628b49b8a254358fe399ad49f0838c708abe44c551321c9555b7bff873",
-    )
+    toolchains = []
+    build_file = module_ctx.read(Label("//renode:renode.BUILD.bazel"))
+    
+    build_file_portable = _renode_build_file_variables(
+        "renode_*/",
+        "renode_*/plugins/**/IntegrationLibrary/"
+    ) + build_file
+    for mod in module_ctx.modules:
+        for tag in mod.tags.download_portable:
+            toolchains.append(tag.name)
+            portable_renode_repository(
+                name = tag.name,
+                url = tag.url,
+                sha256 = tag.sha256,
+                build_file_content = build_file_portable,
+            )
+
+    build_file_local_build = _renode_build_file_variables(
+        "",
+        "src/Plugins/**/IntegrationLibrary/"
+    ) + build_file
+    for mod in module_ctx.modules:
+        for tag in mod.tags.local_build:
+            toolchains.append(tag.name)
+            new_local_repository(
+                name = tag.name,
+                path = tag.path,
+                build_file_content = build_file_local_build,
+            )
+
+    if len(toolchains) == 0:
+        toolchains.append(_DEFAULT_PORTABLE_RENODE["name"])
+        portable_renode_repository(
+            build_file_content = build_file_portable,
+            **_DEFAULT_PORTABLE_RENODE,
+        )
 
     renode_toolchains_repository(
         name = "renode_toolchains",
-        toolchains = [default_toolchain],
+        toolchains = toolchains,
     )
 
 _RENODE_TOOLCHAIN_TEMPLATE = """\
@@ -38,7 +83,7 @@ def _renode_toolchains_repository(repository_ctx):
     for toolchain_repo in repository_ctx.attr.toolchains:
         build_file.append(_RENODE_TOOLCHAIN_TEMPLATE.format(
             name = toolchain_repo,
-            impl = Label("@%s//:toolchain_impl" % toolchain_repo),
+            impl = "@%s//:toolchain_impl" % toolchain_repo,
         ))
 
     repository_ctx.file("BUILD.bazel", "\n".join(build_file))
@@ -50,6 +95,7 @@ portable_renode_repository = repository_rule(
             mandatory = True,
         ),
         "sha256": attr.string(),
+        "build_file_content": attr.string(),
     },
 )
 
@@ -62,7 +108,28 @@ renode_toolchains_repository = repository_rule(
     },
 )
 
+_download_portable = tag_class(
+    doc = "Downloads a portable Renode to a repository of the passed name",
+    attrs = {
+        "name": attr.string(),
+        "url": attr.string(),
+        "sha256": attr.string(),
+    }
+)
+        
+_local_build = tag_class(
+    doc = "Copies a localy built Renode to a repository of the passed name, it isn't hermetic",
+    attrs = {
+        "name": attr.string(),
+        "path": attr.string(),
+    }
+)
+        
 renode = module_extension(
     implementation = _renode_impl,
     doc = "Extension used to manage Renode runtimes available as toolchains",
+    tag_classes = {
+        "download_portable": _download_portable,
+        "local_build": _local_build,
+    }
 )
diff --git a/renode/renode.BUILD.bazel b/renode/renode.BUILD.bazel
@@ -2,12 +2,9 @@ load("@rules_renode//renode:toolchain.bzl", "renode_toolchain")
 
 package(default_visibility = ["//visibility:public"])
 
-_RENODE_DIRECTORY = "renode_*/"
-_COSIMULATION_DIRECTORY = _RENODE_DIRECTORY + "**/plugins/**/IntegrationLibrary/"
-
 filegroup(
     name = "runtime",
-    srcs = glob([_RENODE_DIRECTORY + "*"]),
+    srcs = glob([_RENODE_DIRECTORY + "*"], allow_empty=False),
 )
 renode_toolchain(
     name = "toolchain_impl",
@@ -16,11 +13,11 @@ renode_toolchain(
 
 filegroup(
     name = "python_requirements",
-    srcs = glob([_RENODE_DIRECTORY + "tests/requirements.txt"]),
+    srcs = glob([_RENODE_DIRECTORY + "tests/requirements.txt"], allow_empty=False),
 )
 filegroup(
     name = "python_requirements_dependencies",
-    srcs = glob([_RENODE_DIRECTORY + "tools/**/requirements.txt"]),
+    srcs = glob([_RENODE_DIRECTORY + "tools/**/requirements.txt"], allow_empty=False),
 )
 
 filegroup(
@@ -36,7 +33,7 @@ filegroup(
                 "src/communication/*.h",
                 "src/*.h",
             ]
-        ]),
+        ], allow_empty=False),
 )
 filegroup(
     name = "renode_dpi_cc_library_hdrs",
@@ -47,18 +44,18 @@ filegroup(
                 "src/renode_dpi.h",
                 "hdl/includes/*",
             ]
-        ]),
+        ], allow_empty=False),
 )
 
 # There are no Verilog rules that supports bzlmod.
 # These filegroups below can be used to create a relevant target in your project.
 filegroup(
     name = "renode_dpi_verilog_library_srcs",
-    srcs = glob([_COSIMULATION_DIRECTORY + "hdl/renode_pkg.sv"]) +
-           glob([_COSIMULATION_DIRECTORY + "hdl/imports/*.sv"]) +
-           glob([_COSIMULATION_DIRECTORY + "hdl/modules/**/*.sv"]),
+    srcs = glob([_COSIMULATION_DIRECTORY + "hdl/renode_pkg.sv"], allow_empty=False) +
+           glob([_COSIMULATION_DIRECTORY + "hdl/imports/*.sv"], allow_empty=False) +
+           glob([_COSIMULATION_DIRECTORY + "hdl/modules/**/*.sv"], allow_empty=False),
 )
 filegroup(
     name = "renode_dpi_verilog_library_hdrs",
-    srcs = glob([_COSIMULATION_DIRECTORY + "hdl/includes/*.svh"]),
+    srcs = glob([_COSIMULATION_DIRECTORY + "hdl/includes/*.svh"], allow_empty=False),
 )

Original file line number	Diff line number	Diff line change
`@@ -19,5 +19,7 @@ pip.parse(`
`19`	`19`	`)`
`20`	`20`	`use_repo(pip, "renode_test_python_deps")`
`21`	`21`
`22`		`-renode = use_extension("@rules_renode//renode:extensions.bzl", "renode")`
	`22`	`+renode = use_extension("@rules_renode//renode:extensions.bzl", "renode",`
	`23`	`+ dev_dependency = True`
	`24`	`+)`
`23`	`25`	`use_repo(renode, "renode_default_toolchain")`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+* Test Cases *`
	`2`	`+Should Succeed`
	`3`	`+ Execute Command mach create`