craft-application 2.6.0__tar.gz → 2.6.2__tar.gz

{craft_application-2.6 → craft_application-2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 2.6.0
+Version: 2.6.2
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{craft_application-2.6 → craft_application-2.6.2}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.6.0'
-__version_tuple__ = version_tuple = (2, 6, 0)
+__version__ = version = '2.6.2'
+__version_tuple__ = version_tuple = (2, 6, 2)

{craft_application-2.6 → craft_application-2.6.2}/craft_application/grammar.py

@@ -22,6 +22,7 @@ from craft_grammar import GrammarProcessor  # type: ignore[import-untyped]
 from craft_grammar.errors import GrammarSyntaxError  # type: ignore[import-untyped]
 
 from craft_application.errors import CraftValidationError
+from craft_application.models import get_grammar_aware_part_keywords
 
 # Values that should return as a single object / list / dict.
 _NON_SCALAR_VALUES = [
@@ -53,17 +54,33 @@ def process_part(
     """Process grammar for a given part."""
     for key in part_yaml_data:
         unprocessed_grammar = part_yaml_data[key]
-        craft_cli.emit.debug(f"Processing grammar for {key}: {unprocessed_grammar}")
 
-        # grammar aware models can only be a string or list of dict, skip any other type.
+        # ignore non-grammar keywords
+        if key not in get_grammar_aware_part_keywords():
+            craft_cli.emit.debug(
+                f"Not processing grammar for non-grammar enabled keyword {key}"
+            )
+            continue
+
+        craft_cli.emit.debug(f"Processing grammar for {key}: {unprocessed_grammar}")
+        # grammar aware models can be strings or list of dicts and strings
         if isinstance(unprocessed_grammar, list):
-            if any(not isinstance(d, dict) for d in unprocessed_grammar):  # type: ignore[reportUnknownVariableType]
+            # all items in the list must be a dict or a string
+            if any(not isinstance(d, dict | str) for d in unprocessed_grammar):  # type: ignore[reportUnknownVariableType]
                 continue
-            if any(not isinstance(k, str) for d in unprocessed_grammar for k in d):  # type: ignore[reportUnknownVariableType]
-                continue
-            unprocessed_grammar = cast(list[dict[str, Any]], unprocessed_grammar)
+
+            # all keys in the dictionary must be a string
+            for item in unprocessed_grammar:  # type: ignore[reportUnknownVariableType]
+                if isinstance(item, dict) and any(
+                    not isinstance(key, str) for key in item  # type: ignore[reportUnknownVariableType]
+                ):
+                    continue
+
+            unprocessed_grammar = cast(list[dict[str, Any] | str], unprocessed_grammar)
+        # grammar aware models can be a string
         elif isinstance(unprocessed_grammar, str):
             unprocessed_grammar = [unprocessed_grammar]
+        # skip all other data types
         else:
             continue
 
@@ -74,9 +91,9 @@ def process_part(
                 f"Invalid grammar syntax while processing '{key}' in '{part_yaml_data}': {e}"
             ) from e
 
-        # special cases
-        # scalar values should return as a single object, not in a list.
-        # dict values should return as a dict, not in a list.
+        # special cases:
+        # - scalar values should return as a single object, not in a list.
+        # - dict values should return as a dict, not in a list.
         if key not in _NON_SCALAR_VALUES or key in _DICT_ONLY_VALUES:
             processed_grammar = processed_grammar[0] if processed_grammar else None
 

{craft_application-2.6 → craft_application-2.6.2}/craft_application/models/__init__.py

@@ -23,7 +23,10 @@ from craft_application.models.constraints import (
     UniqueStrList,
     VersionStr,
 )
-from craft_application.models.grammar import GrammarAwareProject
+from craft_application.models.grammar import (
+    GrammarAwareProject,
+    get_grammar_aware_part_keywords,
+)
 from craft_application.models.metadata import BaseMetadata
 from craft_application.models.project import BuildInfo, BuildPlanner, Project
 
@@ -33,6 +36,7 @@ __all__ = [
     "BuildInfo",
     "CraftBaseConfig",
     "CraftBaseModel",
+    "get_grammar_aware_part_keywords",
     "GrammarAwareProject",
     "Project",
     "BuildPlanner",

{craft_application-2.6 → craft_application-2.6.2}/craft_application/models/grammar.py

@@ -1,6 +1,6 @@
 # This file is part of craft_application.
 #
-# Copyright 2023 Canonical Ltd.
+# Copyright 2023-2024 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Lesser General Public License version 3, as
@@ -61,10 +61,10 @@ class _GrammarAwarePart(_GrammarAwareModel):
     build_packages: GrammarStrList | None
     build_environment: GrammarSingleEntryDictList | None
     build_attributes: GrammarStrList | None
-    organize_files: GrammarDict | None
-    overlay_files: GrammarStrList | None
-    stage_files: GrammarStrList | None
-    prime_files: GrammarStrList | None
+    organize_files: GrammarDict | None = pydantic.Field(alias="organize")
+    overlay_files: GrammarStrList | None = pydantic.Field(alias="overlay")
+    stage_files: GrammarStrList | None = pydantic.Field(alias="stage")
+    prime_files: GrammarStrList | None = pydantic.Field(alias="prime")
     override_pull: GrammarStr | None
     overlay_script: GrammarStr | None
     override_build: GrammarStr | None
@@ -74,6 +74,12 @@ class _GrammarAwarePart(_GrammarAwareModel):
     parse_info: GrammarStrList | None
 
 
+def get_grammar_aware_part_keywords() -> list[str]:
+    """Return all supported grammar keywords for a part."""
+    keywords: list[str] = [item.alias for item in _GrammarAwarePart.__fields__.values()]
+    return keywords
+
+
 class GrammarAwareProject(_GrammarAwareModel):
     """Project definition containing grammar-aware components."""
 

{craft_application-2.6 → craft_application-2.6.2}/craft_application.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 2.6.0
+Version: 2.6.2
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{craft_application-2.6 → craft_application-2.6.2}/craft_application.egg-info/SOURCES.txt

@@ -132,6 +132,7 @@ tests/unit/launchpad/models/test_base.py
 tests/unit/launchpad/models/test_code.py
 tests/unit/models/__init__.py
 tests/unit/models/test_constraints.py
+tests/unit/models/test_grammar.py
 tests/unit/models/test_project.py
 tests/unit/models/project_models/basic_project.yaml
 tests/unit/models/project_models/full_project.yaml

{craft_application-2.6 → craft_application-2.6.2}/tests/integration/data/valid_projects/grammar/testcraft.yaml

@@ -15,6 +15,7 @@ parts:
       - on amd64 to arm64:
           hello.txt: hello-arm64.txt
     build-environment:
+      - HELLO: hello
       - on amd64 to amd64:
           - MY_VAR: amd64
       - on amd64 to arm64:

craft_application-2.6.2/tests/unit/models/test_grammar.py

@@ -0,0 +1,55 @@
+# This file is part of craft_application.
+#
+# Copyright 2024 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License version 3, as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranties of MERCHANTABILITY,
+# SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Tests for grammar-aware project models."""
+
+from craft_application.models import get_grammar_aware_part_keywords
+
+
+def test_get_grammar_aware_part_keywords():
+    """Test get_grammar_aware_part_keywords."""
+    assert get_grammar_aware_part_keywords() == [
+        "plugin",
+        "source",
+        "source-checksum",
+        "source-branch",
+        "source-commit",
+        "source-depth",
+        "source-subdir",
+        "source-submodules",
+        "source-tag",
+        "source-type",
+        "disable-parallel",
+        "after",
+        "overlay-packages",
+        "stage-snaps",
+        "stage-packages",
+        "build-snaps",
+        "build-packages",
+        "build-environment",
+        "build-attributes",
+        "organize",
+        "overlay",
+        "stage",
+        "prime",
+        "override-pull",
+        "overlay-script",
+        "override-build",
+        "override-stage",
+        "override-prime",
+        "permissions",
+        "parse-info",
+    ]

{craft_application-2.6 → craft_application-2.6.2}/tests/unit/test_application.py

@@ -1341,10 +1341,26 @@ def grammar_project_mini(tmp_path):
     version: 1.0
     parts:
       mypart:
-        plugin: nil
+        plugin: meson
+
+        # grammar-only string
         source:
         - on amd64 to riscv64: on-amd64-to-riscv64
         - on amd64 to s390x: on-amd64-to-s390x
+        - else: other
+
+        # list of grammar and non-grammar data
+        build-packages:
+        - test-package
+        - on amd64 to riscv64:
+          - on-amd64-to-riscv64
+        - on amd64 to s390x:
+          - on-amd64-to-s390x
+
+        # non-grammar data in a non-grammar keyword
+        meson-parameters:
+        - foo
+        - bar
     """
     )
     project_file = tmp_path / "testcraft.yaml"
@@ -1446,26 +1462,46 @@ def test_process_grammar_build_for(grammar_app_mini):
     """Test that a provided build-for is used to process the grammar."""
     project = grammar_app_mini.get_project(build_for="s390x")
     assert project.parts["mypart"]["source"] == "on-amd64-to-s390x"
+    assert project.parts["mypart"]["build-packages"] == [
+        "test-package",
+        "on-amd64-to-s390x",
+    ]
 
 
 def test_process_grammar_platform(grammar_app_mini):
     """Test that a provided platform is used to process the grammar."""
     project = grammar_app_mini.get_project(platform="platform-riscv64")
     assert project.parts["mypart"]["source"] == "on-amd64-to-riscv64"
+    assert project.parts["mypart"]["build-packages"] == [
+        "test-package",
+        "on-amd64-to-riscv64",
+    ]
+
+
+def test_process_grammar_non_grammar(grammar_app_mini):
+    """Non-grammar keywords should not be modified."""
+    project = grammar_app_mini.get_project(platform="platform-riscv64")
+
+    assert project.parts["mypart"]["meson-parameters"] == ["foo", "bar"]
 
 
 def test_process_grammar_default(grammar_app_mini):
     """Test that if nothing is provided the first BuildInfo is used by the grammar."""
     project = grammar_app_mini.get_project()
     assert project.parts["mypart"]["source"] == "on-amd64-to-riscv64"
+    assert project.parts["mypart"]["build-packages"] == [
+        "test-package",
+        "on-amd64-to-riscv64",
+    ]
 
 
 def test_process_grammar_no_match(grammar_app_mini, mocker):
     """Test that if the build plan is empty, the grammar uses the host as target arch."""
     mocker.patch("craft_application.util.get_host_architecture", return_value="i386")
     project = grammar_app_mini.get_project()
-    # "source" is empty because "i386" doesn't match any of the grammar statements.
-    assert project.parts["mypart"]["source"] is None
+
+    assert project.parts["mypart"]["source"] == "other"
+    assert project.parts["mypart"]["build-packages"] == ["test-package"]
 
 
 class FakeApplicationWithYamlTransform(FakeApplication):