Skip to content

189 refactor new code imported from gl workflow scripts #232

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 6 commits into from
Oct 24, 2025
Merged

189 refactor new code imported from gl workflow scripts #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0ece6ec
not using _bucket property anymore
vivus-ignis Oct 23, 2025
f085996
release notes mock fixed to support quoted version numbers
vivus-ignis Oct 23, 2025
7f5a5b4
calling CName constructor with the commit parameter
vivus-ignis Oct 23, 2025
f237e18
replaced unneeded short commit
vivus-ignis Oct 23, 2025
4b8b44b
using cname.cname in download_metadata
vivus-ignis Oct 24, 2025
80e2761
reverted release notes test data update to push it in a separate PR
vivus-ignis Oct 24, 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
26 changes: 12 additions & 14 deletions src/gardenlinux/github/release_notes/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,9 @@ def download_all_metadata_files(version, commitish, s3_bucket_name):

s3_artifacts = S3Artifacts(s3_bucket_name)

commitish_short = commitish[:8]

for flavor in flavors:
cname = CName(flavor[1], flavor[0], "{0}-{1}".format(version, commitish_short))
LOGGER.debug(f"{flavor=} {version=} {commitish=}")
cname = CName(flavor[1], flavor[0], commitish)
# Filter by image variants - only download if the flavor matches one of the variants
flavor_matches_variant = False
for variant_suffix in IMAGE_VARIANTS:
Expand All @@ -86,8 +84,9 @@ def download_all_metadata_files(version, commitish, s3_bucket_name):
continue

try:
commit_short = commitish[:8]
download_metadata_file(
s3_artifacts, cname.cname, version, commitish_short, local_dest_path
s3_artifacts, cname, version, commit_short, local_dest_path
)
except IndexError:
LOGGER.warn(f"No artifacts found for flavor {cname.cname}, skipping...")
Expand All @@ -96,24 +95,23 @@ def download_all_metadata_files(version, commitish, s3_bucket_name):
return [str(artifact) for artifact in local_dest_path.iterdir()]


def download_metadata_file(
s3_artifacts, cname, version, commitish_short, artifacts_dir
):
def download_metadata_file(s3_artifacts, cname, version, commit_short, artifacts_dir):
"""
Download metadata file (s3_metadata.yaml)
"""
LOGGER.debug(
f"{s3_artifacts=} | {cname=} | {version=} | {commitish_short=} | {artifacts_dir=}"
f"{s3_artifacts=} | {cname.cname=} | {version=} | {cname.commit_id=} | {commit_short=} | {artifacts_dir=}"
)
maybe_release_objects = s3_artifacts.bucket.objects.filter(
Prefix=f"meta/singles/{cname.cname}-{version}-{commit_short}"
)
release_object = list(
s3_artifacts._bucket.objects.filter(
Prefix=f"meta/singles/{cname}-{version}-{commitish_short}"
)
)[0]

release_object = list(maybe_release_objects)[0]
LOGGER.debug(f"{release_object.bucket_name=} | {release_object.key=}")

s3_artifacts.bucket.download_file(
release_object.key, artifacts_dir.joinpath(f"{cname}.s3_metadata.yaml")
release_object.key,
artifacts_dir.joinpath(f"{cname.cname}.s3_metadata.yaml"),
)


Expand Down
42 changes: 25 additions & 17 deletions tests/github/test_download_metadata_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

from ..constants import (
RELEASE_NOTES_S3_ARTIFACTS_DIR,
TEST_GARDENLINUX_COMMIT,
TEST_GARDENLINUX_COMMIT_SHORT,
TEST_GARDENLINUX_RELEASE,
TEST_GARDENLINUX_RELEASE_BUCKET_NAME,
Expand All @@ -17,20 +16,16 @@
def test_download_metadata_file(downloads_dir, release_s3_bucket):
release_s3_bucket.upload_file(
RELEASE_NOTES_S3_ARTIFACTS_DIR / "aws-gardener_prod-amd64.s3_metadata.yaml",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT}",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT_SHORT}",
)

s3_artifacts = S3Artifacts(TEST_GARDENLINUX_RELEASE_BUCKET_NAME)
s3_artifacts._bucket = release_s3_bucket

cname = CName(
"test-aws-gardener_prod",
"amd64",
"{0}-{1}".format(TEST_GARDENLINUX_RELEASE, TEST_GARDENLINUX_COMMIT_SHORT),
)
cname = CName("test-aws-gardener_prod", "amd64", TEST_GARDENLINUX_COMMIT_SHORT)
download_metadata_file(
s3_artifacts,
cname.cname,
cname,
TEST_GARDENLINUX_RELEASE,
TEST_GARDENLINUX_COMMIT_SHORT,
S3_DOWNLOADS_DIR,
Expand All @@ -41,18 +36,22 @@ def test_download_metadata_file(downloads_dir, release_s3_bucket):
def test_download_metadata_file_no_such_release(downloads_dir, release_s3_bucket):
release_s3_bucket.upload_file(
RELEASE_NOTES_S3_ARTIFACTS_DIR / "aws-gardener_prod-amd64.s3_metadata.yaml",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT}",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT_SHORT}",
)
s3_artifacts = S3Artifacts(TEST_GARDENLINUX_RELEASE_BUCKET_NAME)
s3_artifacts._bucket = release_s3_bucket

release = "0000.0"
commit = TEST_GARDENLINUX_COMMIT_SHORT
cname = CName("aws-gardener_prod", "amd64", "{0}-{1}".format(release, commit))
cname = CName("aws-gardener_prod", "amd64", commit)

with pytest.raises(IndexError):
download_metadata_file(
s3_artifacts, cname.cname, release, commit, S3_DOWNLOADS_DIR
s3_artifacts,
cname,
release,
TEST_GARDENLINUX_COMMIT_SHORT,
S3_DOWNLOADS_DIR,
)
assert not (
S3_DOWNLOADS_DIR / "test-aws-gardener_prod-amd64.s3_metadata.yaml"
Expand All @@ -62,19 +61,23 @@ def test_download_metadata_file_no_such_release(downloads_dir, release_s3_bucket
def test_download_metadata_file_no_such_commit(downloads_dir, release_s3_bucket):
release_s3_bucket.upload_file(
RELEASE_NOTES_S3_ARTIFACTS_DIR / "aws-gardener_prod-amd64.s3_metadata.yaml",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT}",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT_SHORT}",
)

s3_artifacts = S3Artifacts(TEST_GARDENLINUX_RELEASE_BUCKET_NAME)
s3_artifacts._bucket = release_s3_bucket

release = TEST_GARDENLINUX_RELEASE
commit = "deadbeef"
cname = CName("test-aws-gardener_prod", "amd64", "{0}-{1}".format(release, commit))
cname = CName("test-aws-gardener_prod", "amd64", commit)

with pytest.raises(IndexError):
download_metadata_file(
s3_artifacts, cname.cname, release, commit, S3_DOWNLOADS_DIR
s3_artifacts,
cname,
release,
commit,
S3_DOWNLOADS_DIR,
)
assert not (
S3_DOWNLOADS_DIR / "test-aws-gardener_prod-amd64.s3_metadata.yaml"
Expand All @@ -86,19 +89,24 @@ def test_download_metadata_file_no_such_release_and_commit(
):
release_s3_bucket.upload_file(
RELEASE_NOTES_S3_ARTIFACTS_DIR / "aws-gardener_prod-amd64.s3_metadata.yaml",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT}",
f"meta/singles/test-aws-gardener_prod-amd64-{TEST_GARDENLINUX_RELEASE}-{TEST_GARDENLINUX_COMMIT_SHORT}",
)

s3_artifacts = S3Artifacts(TEST_GARDENLINUX_RELEASE_BUCKET_NAME)
s3_artifacts._bucket = release_s3_bucket

release = "0000.0"
commit = "deadbeef"
cname = CName("test-aws-gardener_prod", "amd64", "{0}-{1}".format(release, commit))
cname = CName("test-aws-gardener_prod", "amd64", commit)
print(f"{cname.cname=}")

with pytest.raises(IndexError):
download_metadata_file(
s3_artifacts, cname.cname, release, commit, S3_DOWNLOADS_DIR
s3_artifacts,
cname,
release,
TEST_GARDENLINUX_COMMIT_SHORT,
S3_DOWNLOADS_DIR,
)
assert not (
S3_DOWNLOADS_DIR / "test-aws-gardener_prod-amd64.s3_metadata.yaml"
Expand Down
Loading