Allow [tool] or [tools] section Rust Env Checker

Currently, the plugin supports locating tools in a `[tool]` section. Other scripts and flows have been built around `[tools]`. This change finds tools from either section. Signed-off-by: Michael Kubacki <[email protected]>
tianocore · Feb 6, 2025 · f306834 · f306834
1 parent bd13a66
commit f306834
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/edk2toolext/environment/rust.py b/edk2toolext/environment/rust.py
@@ -159,7 +159,7 @@ def _get_required_tool_versions() -> Dict[str, str]:
     try:
         with open(WORKSPACE_TOOLCHAIN_FILE, "r") as toml_file:
             content = toml_file.read()
-            match = re.search(r"\[tool\]\n((?:.+\s*=\s*.+\n?)*)", content)
+            match = re.search(r"\[tool(?:s)?\]\n((?:.+\s*=\s*.+\n?)*)", content)
             if match:
                 for line in match.group(1).splitlines():
                     (tool, version) = line.split("=", maxsplit=1)

diff --git a/tests.unit/test_rust_environment.py b/tests.unit/test_rust_environment.py
@@ -312,18 +312,18 @@ def test_verify_rust_src_component_is_installed(
         self.assertTrue(result)
 
     def test_get_required_tool_versions(self):
-        # Test when the workspace toolchain file exists and contains valid tool versions
-        with patch(
-            "builtins.open",
-            mock_open(
-                read_data='[toolchain]\nchannel = "1.76.0"\n\n[tool]\ncargo-make = "0.37.9"\ncargo-tarpaulin = "0.27.3"'
-            ),
-        ):
-            tool_versions = _get_required_tool_versions()
-            assert tool_versions == {
-                "cargo-make": "0.37.9",
-                "cargo-tarpaulin": "0.27.3",
-            }
+        test_data = [
+            '[toolchain]\nchannel = "1.76.0"\n\n[tool]\ncargo-make = "0.37.9"\ncargo-tarpaulin = "0.27.3"',
+            '[toolchain]\nchannel = "1.76.0"\n\n[tools]\ncargo-make = "0.37.9"\ncargo-tarpaulin = "0.27.3"',
+        ]
+
+        for data in test_data:
+            with patch("builtins.open", mock_open(read_data=data)):
+                tool_versions = _get_required_tool_versions()
+                assert tool_versions == {
+                    "cargo-make": "0.37.9",
+                    "cargo-tarpaulin": "0.27.3",
+                }
 
         # Test when the workspace toolchain file does not exist
         with patch("builtins.open", side_effect=FileNotFoundError):