fix: replace colons with hyphens in charm names #2060
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Multi-base charms may have colons in their platform name. These get converted to hyphens because some environments don't allow colons in filenames. Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
mr-cal
commented
Dec 20, 2024
charmcraft/services/package.py
Outdated
Comment on lines
127
to
144
| build_plan = models.CharmcraftBuildPlanner.model_validate( | ||
| self._project.marshal() | ||
| ).get_build_plan() | ||
| platform = utils.get_os_platform() | ||
| build_on_base = bases.BaseName(name=platform.system, version=platform.release) | ||
| host_platform = utils.get_os_platform() | ||
| build_on_base = bases.BaseName( | ||
| name=host_platform.system, version=host_platform.release | ||
| ) | ||
| host_arch = util.get_host_architecture() | ||
| for build_info in build_plan: | ||
| print(build_info) | ||
| if build_info.build_on != host_arch: | ||
| continue | ||
| if build_info.base == build_on_base: | ||
| return dest_dir / f"{self._project.name}_{build_info.platform}.charm" | ||
| platform = build_info.platform.replace(":", "-") | ||
| return dest_dir / f"{self._project.name}_{platform}.charm" | ||
|
|
||
| raise errors.CraftError( | ||
| "Current machine is not a valid build platform for this charm.", |
There was a problem hiding this comment.
Unless I am mistaken, we could delete everything after line 125 in this function.
I don't think there is a scenario where self._platform doesn't exist.
There was a problem hiding this comment.
This may well be true now. It wasn't true when I first implemented this service, but at that point we could have self._platform == None. I'd have to do a deep dive into craft-application to see if that's still valid in the PackageService.
There was a problem hiding this comment.
Makes sense, I was suspecting this was needed during the craft-application migration.
I poked around at the service factory and how charmcraft inits the pack service and dropping this appears safe.
The package service will always have a platform, so the code to generate the charm filenames can be simplified. Signed-off-by: Callahan Kovacs <callahan.kovacs@canonical.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Multi-base charms may have colons in their platform name. These get converted to hyphens because some environments don't allow colons in filenames.
Fixes #2057