Skip to content

fix: sanitize summary for OCI annotation #845

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

Merged
merged 3 commits into from
Mar 26, 2025
Merged

fix: sanitize summary for OCI annotation #845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
680e1e9
fix: sanitize summary for OCI annotation
cjdcordeiro Mar 26, 2025
72ef4c0
fix: use multi_line_summary in test assertion
cjdcordeiro Mar 26, 2025
3074109
fix: sub by newline instead of space
cjdcordeiro Mar 26, 2025
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
5 changes: 4 additions & 1 deletion rockcraft/models/project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,10 @@ def generate_metadata(
"org.opencontainers.image.ref.name": self.name,
"org.opencontainers.image.created": generation_time,
"org.opencontainers.image.base.digest": base_digest.hex(),
"org.opencontainers.image.description": f"{self.summary}\n\n{self.description}",
"org.opencontainers.image.description": re.sub(
r"\n{2,}", "\n", self.summary
)
+ f"\n\n{self.description}",
}
if self.license:
annotations["org.opencontainers.image.licenses"] = self.license
Expand Down
14 changes: 14 additions & 0 deletions tests/unit/test_project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,20 @@ def test_project_generate_metadata(yaml_loaded_data):
"base-digest": digest,
}

# Redo test with multi-line summary
multi_line_summary = "one\n\ntwo\n\n\n\n\nthree"
project = Project.unmarshal({**yaml_loaded_data, **{"summary": multi_line_summary}})
sanitized_summary = "one\ntwo\nthree"

oci_annotations, rock_metadata = project.generate_metadata(
now, bytes.fromhex(digest)
)
assert oci_annotations["org.opencontainers.image.description"] == (
f"{sanitized_summary}\n\n{yaml_loaded_data['description']}"
)

assert rock_metadata["summary"] == multi_line_summary


def test_metadata_base_devel(yaml_loaded_data):
yaml_loaded_data["base"] = "ubuntu@24.04"
Expand Down