-
Notifications
You must be signed in to change notification settings - Fork 270
fix: skeleton packages drop non-host-arch components #5020
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.
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
Open
JeffResc
wants to merge
5
commits into
zarf-dev:main
Choose a base branch
from
JeffResc:fix/skeleton-arch
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ae13e0d
fix: skeleton packages drop non-host-arch components
JeffResc aebfb85
fix: retain all architecture variants in skeleton packages
JeffResc 9760ab8
test: cover multi-arch skeleton publish
JeffResc 61859b1
remove no-color in zarf e2e
JeffResc 09a5480
refactor: replace Skeleton option with SkipVariantFilters abstraction
JeffResc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ import ( | |
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "slices" | ||
| "time" | ||
|
|
||
| "github.com/zarf-dev/zarf/src/api/v1alpha1" | ||
|
|
@@ -26,6 +27,21 @@ import ( | |
| "github.com/zarf-dev/zarf/src/types" | ||
| ) | ||
|
|
||
| // VariantDimension is a dimension along which components of the same name may vary. | ||
| type VariantDimension string | ||
|
|
||
| const ( | ||
| // VariantArchitecture is the only.cluster.architecture dimension of a component. | ||
| VariantArchitecture VariantDimension = "architecture" | ||
| // VariantFlavor is the only.flavor dimension of a component. | ||
| VariantFlavor VariantDimension = "flavor" | ||
| ) | ||
|
|
||
| // AllVariantDimension returns every variant dimension. | ||
| func AllVariantDimension() []VariantDimension { | ||
| return []VariantDimension{VariantArchitecture, VariantFlavor} | ||
| } | ||
|
|
||
| // DefinitionOptions are the optional parameters to load.PackageDefinition | ||
| type DefinitionOptions struct { | ||
| Flavor string | ||
|
|
@@ -41,6 +57,10 @@ type DefinitionOptions struct { | |
| IsInteractive bool | ||
| // SkipVersionCheck skips version requirement validation | ||
| SkipVersionCheck bool | ||
| // SkipVariantFilters lists dimensions to retain instead of filtering out. | ||
| // e.g. VariantArchitecture retains every only.cluster.architecture variant of a | ||
| // component, as used when publishing skeletons. | ||
| SkipVariantFilters []VariantDimension | ||
| types.RemoteOptions | ||
| } | ||
|
|
||
|
|
@@ -75,7 +95,11 @@ func PackageDefinition(ctx context.Context, packagePath string, opts DefinitionO | |
| if err != nil { | ||
| return DefinedPackage{}, err | ||
| } | ||
| pkg.Metadata.Architecture = config.GetArch(pkg.Metadata.Architecture) | ||
| if slices.Contains(opts.SkipVariantFilters, VariantArchitecture) { | ||
| pkg.Metadata.Architecture = v1alpha1.SkeletonArch | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We still don't want the load package to know about skeletons, instead of setting the architecture, and checking for a skeleton architecture we should pass the variant dimensions into validate and import |
||
| } else { | ||
| pkg.Metadata.Architecture = config.GetArch(pkg.Metadata.Architecture) | ||
| } | ||
| opts.CachePath, err = utils.ResolveCachePath(opts.CachePath) | ||
| if err != nil { | ||
| return DefinedPackage{}, err | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
16 changes: 16 additions & 0 deletions
16
src/pkg/packager/testdata/skeleton-multiarch/sub/zarf.yaml
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| kind: ZarfPackageConfig | ||
| metadata: | ||
| name: skeleton-multiarch-sub | ||
| description: sub-package with a same-named component gated per architecture | ||
|
|
||
| components: | ||
| - name: shared | ||
| required: true | ||
| only: | ||
| cluster: | ||
| architecture: amd64 | ||
| - name: shared | ||
| required: true | ||
| only: | ||
| cluster: | ||
| architecture: arm64 |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| kind: ZarfPackageConfig | ||
| metadata: | ||
| name: skeleton-multiarch | ||
| description: package with same-named components gated per architecture, direct and imported | ||
| version: 0.0.1 | ||
|
|
||
| components: | ||
| - name: direct | ||
| required: true | ||
| only: | ||
| cluster: | ||
| architecture: amd64 | ||
| - name: direct | ||
| required: true | ||
| only: | ||
| cluster: | ||
| architecture: arm64 | ||
| - name: imported | ||
| required: true | ||
| import: | ||
| path: sub | ||
| name: shared |
This file contains hidden or 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test shouldn't be focused on skeletons (publish_test.go is handling that). Make this test ensure that the variant dimensions work separately and together