Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

partitions: validate usage of partitions in parts #493

Merged
merged 4 commits into from
Jul 17, 2023
Merged

partitions: validate usage of partitions in parts #493

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7c20f1
partitions: validate usage of partitions in parts
mr-cal Jul 12, 2023
4928552
feedback from PR: reword error message
mr-cal Jul 13, 2023
479df38
Merge remote-tracking branch 'origin/main' into partitions-part-2
mr-cal Jul 13, 2023
ab668f1
feedback from PR: reword error, compile regex, add comments, test cha…
mr-cal Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions craft_parts/parts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,12 +369,10 @@ def _check_partitions_in_filepaths(
partition = match.group("partition")
if partition not in partitions:
error_list.append(
f" unknown partition {partition!r} in {filepath!r}"
f"- unknown partition {partition!r} in {filepath!r} "
f"in field 'parts.{self.name}.{fileset_name}'"
)

if error_list:
error_list.insert(0, f" parts -> {self.name} -> {fileset_name}")

return error_list


Expand Down
3 changes: 1 addition & 2 deletions tests/unit/features/partitions/test_lifecycle_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@ def test_partitions_usage_invalid(self, new_dir, partition_list):
assert str(raised.value) == dedent(
"""\
Error: Invalid usage of partitions:
parts -> foo -> stage
unknown partition 'test' in '(test)/foo'
- unknown partition 'test' in '(test)/foo' in field 'parts.foo.stage'
Valid partitions are 'default' and 'kernel'."""
)
111 changes: 51 additions & 60 deletions tests/unit/features/partitions/test_parts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,9 @@ def test_part_invalid_partition_usage_simple(self, partition_list):
assert str(raised.value) == dedent(
"""\
Error: Invalid usage of partitions:
parts -> part-a -> organize
unknown partition 'foo' in '(foo)'
parts -> part-a -> stage
unknown partition 'bar' in '(bar)/test'
parts -> part-a -> prime
unknown partition 'baz' in '(baz)'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.organize'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.stage'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.prime'
Valid partitions are 'default' and 'kernel'."""
)

Expand All @@ -157,59 +154,53 @@ def test_part_invalid_partition_usage_complex(
assert str(raised.value) == dedent(
"""\
Error: Invalid usage of partitions:
mr-cal marked this conversation as resolved.
Show resolved Hide resolved
parts -> part-a -> organize
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-a -> stage
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-a -> prime
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> organize
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> stage
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> prime
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
- unknown partition '' in '()' in field 'parts.part-a.organize'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.organize'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.organize'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.organize'
- unknown partition '' in '()' in field 'parts.part-a.stage'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.stage'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.stage'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.stage'
- unknown partition '' in '()' in field 'parts.part-a.prime'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.prime'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.prime'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.prime'
- unknown partition '' in '()' in field 'parts.part-b.organize'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.organize'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.organize'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.organize'
- unknown partition '' in '()' in field 'parts.part-b.stage'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.stage'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.stage'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.stage'
- unknown partition '' in '()' in field 'parts.part-b.prime'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.prime'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.prime'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.prime'
lengau marked this conversation as resolved.
Show resolved Hide resolved
Valid partitions are 'default' and 'kernel'."""
)
148 changes: 68 additions & 80 deletions tests/unit/features/test_parts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,10 @@ def test_part_invalid_partition_usage_simple(self, partition_list):
assert str(raised.value) == dedent(
"""\
Error: Invalid usage of partitions:
parts -> part-a -> overlay
unknown partition 'bar' in '(bar)/test'
parts -> part-a -> organize
unknown partition 'foo' in '(foo)/test'
parts -> part-a -> stage
unknown partition 'baz' in '(baz)/test'
parts -> part-a -> prime
unknown partition '123' in '(123)/test'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.overlay'
- unknown partition 'foo' in '(foo)/test' in field 'parts.part-a.organize'
- unknown partition 'baz' in '(baz)/test' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.prime'
Valid partitions are 'default' and 'kernel'."""
)

Expand All @@ -139,77 +135,69 @@ def test_part_invalid_partition_usage_complex(
assert str(raised.value) == dedent(
"""\
Error: Invalid usage of partitions:
parts -> part-a -> overlay
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-a -> organize
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-a -> stage
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-a -> prime
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> overlay
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> organize
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> stage
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
parts -> part-b -> prime
unknown partition '' in '()'
unknown partition 'foo' in '(foo)'
unknown partition 'bar' in '(bar)/test'
unknown partition 'baz' in '(baz)'
unknown partition '123' in '(123)/test'
unknown partition '123' in '(123)/test/(456)'
unknown partition '123' in '(123)/test/(default)'
unknown partition '123' in '(123)/test/(kernel)'
- unknown partition '' in '()' in field 'parts.part-a.overlay'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.overlay'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.overlay'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.overlay'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.overlay'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.overlay'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.overlay'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.overlay'
- unknown partition '' in '()' in field 'parts.part-a.organize'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.organize'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.organize'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.organize'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.organize'
- unknown partition '' in '()' in field 'parts.part-a.stage'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.stage'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.stage'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.stage'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.stage'
- unknown partition '' in '()' in field 'parts.part-a.prime'
- unknown partition 'foo' in '(foo)' in field 'parts.part-a.prime'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-a.prime'
- unknown partition 'baz' in '(baz)' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-a.prime'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-a.prime'
- unknown partition '' in '()' in field 'parts.part-b.overlay'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.overlay'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.overlay'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.overlay'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.overlay'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.overlay'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.overlay'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.overlay'
- unknown partition '' in '()' in field 'parts.part-b.organize'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.organize'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.organize'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.organize'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.organize'
- unknown partition '' in '()' in field 'parts.part-b.stage'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.stage'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.stage'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.stage'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.stage'
- unknown partition '' in '()' in field 'parts.part-b.prime'
- unknown partition 'foo' in '(foo)' in field 'parts.part-b.prime'
- unknown partition 'bar' in '(bar)/test' in field 'parts.part-b.prime'
- unknown partition 'baz' in '(baz)' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test/(456)' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test/(default)' in field 'parts.part-b.prime'
- unknown partition '123' in '(123)/test/(kernel)' in field 'parts.part-b.prime'
Valid partitions are 'default' and 'kernel'."""
)