change: Make it possible to read [workspace.project] in cargo.toml

y0urself · greenbonebot · commit 57ca3c2c7d07 · 2025-08-12T10:00:01.000+02:00
diff --git a/pontos/version/commands/_cargo.py b/pontos/version/commands/_cargo.py
@@ -3,9 +3,10 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from pathlib import Path
-from typing import Iterator, Literal, Tuple, Union
+from typing import Any, Iterator, Literal, Tuple, Union
 
 import tomlkit
+from tomlkit.items import Table
 
 from .._errors import VersionError
 from .._version import Version, VersionUpdate
@@ -20,25 +21,31 @@ def __as_project_document(
     ) -> Iterator[Tuple[Path, tomlkit.TOMLDocument],]:
         """
         Parse the given origin and yields a tuple of path to a
-        cargo toml that contains a version
+        Cargo.toml that contains a version
+        Version should be in the table package or workspace.package
 
         If the origin is invalid toml than it will raise a VersionError.
         """
+        version: Any = None
         content = origin.read_text(encoding="utf-8")
         content = tomlkit.parse(content)
         package = content.get("package")
-        if package:
-            version = package.get("version")
-            if version:
-                yield (origin, content)
+        workspace = content.get("workspace")
+        if not isinstance(package, Table) and isinstance(workspace, Table):
+            package = workspace.get("package")
+        if isinstance(package, Table):
+            version = package.get("version", "")
+        if version:
+            yield (origin, content)
         else:
-            workspace = content.get("workspace")
-            if workspace:
+            # check sub directories for toml files with version
+            if isinstance(workspace, Table):
                 members = workspace.get("members")
-                for member in members:
-                    yield from self.__as_project_document(
-                        origin.parent / member / self.project_file_name
-                    )
+                if members:
+                    for member in members:
+                        yield from self.__as_project_document(
+                            origin.parent / member / self.project_file_name
+                        )
         return None
 
     def update_version(
@@ -68,9 +75,12 @@ def update_version(
 
     def get_current_version(self) -> Version:
         (_, document) = next(self.__as_project_document(self.project_file_path))
-        current_version = self.versioning_scheme.parse_version(
-            document["package"]["version"]  # type: ignore[index, arg-type]
-        )
+        try:
+            version = document["package"]["version"]  # type: ignore[index, arg-type]
+        except KeyError:
+            version = document["workspace"]["package"]["version"]  # type: ignore[index, arg-type]
+        if isinstance(version, str):
+            current_version = self.versioning_scheme.parse_version(version)
         return self.versioning_scheme.from_version(current_version)
 
     def verify_version(
diff --git a/tests/version/commands/test_cargo.py b/tests/version/commands/test_cargo.py
@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2023 Greenbone AG
+# SPDX-FileCopyrightText: 2023-2025 Greenbone AG
 #
 # SPDX-License-Identifier: GPL-3.0-or-later
 
@@ -21,6 +21,13 @@
 edition = "2021"
 license = "GPL-2.0-or-later"
 """
+VERSION_WITH_WORKSPACE_EXAMPLE = """
+[workspace.package]
+name = "nasl-syntax"
+version = "1.1.1"
+edition = "2025"
+license = "GPL-2.0-or-later"
+"""
 WORKSPACE_EXAMPLE = """
 [workspace]
 members = [
@@ -42,16 +49,18 @@ def __create_cargo_layout(self) -> Iterator[Path]:
         with temp_directory(change_into=True) as temporary_dir:
             workspace = temporary_dir / "Cargo.toml"
             workspace.write_text(WORKSPACE_EXAMPLE)
-            members = tomlkit.parse(WORKSPACE_EXAMPLE)["workspace"]["members"]
-            for cargo_workspace_member in members:
-                npath = temporary_dir / f"{cargo_workspace_member}"
-                npath.mkdir()
-                pf = npath / "Cargo.toml"
-                pf.write_text(
-                    VERSION_EXAMPLE.replace(
-                        "nasl-syntax", cargo_workspace_member
+            toml_file = tomlkit.parse(WORKSPACE_EXAMPLE)
+            members = toml_file["workspace"]["members"]  # type: ignore[index, arg-type]
+            if isinstance(members, tomlkit.items.Table):
+                for cargo_workspace_member in members:
+                    npath = temporary_dir / f"{cargo_workspace_member}"
+                    npath.mkdir()
+                    pf = npath / "Cargo.toml"
+                    pf.write_text(
+                        VERSION_EXAMPLE.replace(
+                            "nasl-syntax", cargo_workspace_member
+                        )
                     )
-                )
             yield temporary_dir
         return None
 
@@ -115,3 +124,13 @@ def test_success(self):
             version = PEP440VersioningScheme.parse_version("0.1.0")
             cargo = CargoVersionCommand(PEP440VersioningScheme)
             cargo.verify_version(version)
+
+    def test_success_with_workspace(self):
+        with temp_file(
+            VERSION_WITH_WORKSPACE_EXAMPLE,
+            name="Cargo.toml",
+            change_into=True,
+        ):
+            version = PEP440VersioningScheme.parse_version("1.1.1")
+            cargo = CargoVersionCommand(PEP440VersioningScheme)
+            cargo.verify_version(version)
