feat: abstract interactions with archive/store #311
+135
−65
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| package slicer | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "io" | ||
| "slices" | ||
|
|
||
| "github.com/canonical/chisel/internal/archive" | ||
| "github.com/canonical/chisel/internal/manifestutil" | ||
| "github.com/canonical/chisel/internal/setup" | ||
| ) | ||
|
|
||
| type Fetcher interface { | ||
| Arch() string | ||
| Fetch() (io.ReadSeekCloser, manifestutil.PackageInfo, error) | ||
| } | ||
|
|
||
| var ( | ||
| _ Fetcher = (*debFetcher)(nil) | ||
| _ Fetcher = (*binFetcher)(nil) | ||
| ) | ||
|
|
||
| // debFetcher fetches deb packages from an archive. | ||
| type debFetcher struct { | ||
| archive archive.Archive | ||
| name string | ||
| } | ||
|
|
||
| func (d *debFetcher) Arch() string { | ||
| return d.archive.Options().Arch | ||
| } | ||
|
|
||
| func (d *debFetcher) Fetch() (io.ReadSeekCloser, manifestutil.PackageInfo, error) { | ||
| return d.archive.Fetch(d.name) | ||
| } | ||
|
|
||
| // binFetcher fetches bin packages from a store. | ||
| type binFetcher struct { | ||
| arch string | ||
| name string | ||
| store string | ||
| } | ||
|
|
||
| func (b *binFetcher) Arch() string { | ||
| return b.arch | ||
| } | ||
|
|
||
| func (b *binFetcher) Fetch() (io.ReadSeekCloser, manifestutil.PackageInfo, error) { | ||
| return nil, nil, fmt.Errorf("cannot fetch package %q from store %q: not implemented", b.name, b.store) | ||
| } | ||
|
|
||
| // selectPkgFetchers determines the fetcher for each package in the selection. | ||
| // For packages from an archive it selects the highest priority archive | ||
| // containing the package unless a particular archive is pinned within the | ||
| // package slices file. For packages from a store it selects the store | ||
| // named in the package slices file. It returns a map of Fetcher indexed | ||
| // by package names. | ||
| func selectPkgFetchers(archives map[string]archive.Archive, selection *setup.Selection) (map[string]Fetcher, error) { | ||
|
Collaborator
Author
There was a problem hiding this comment. [Note to reviewer]: I think it makes sense to have this function here, but it is a refactor (and rename) of |
||
| sortedArchives := make([]*setup.Archive, 0, len(selection.Release.Archives)) | ||
| for _, archive := range selection.Release.Archives { | ||
| if archive.Priority < 0 { | ||
| // Ignore negative priority archives unless a package specifically | ||
| // asks for it with the "archive" field. | ||
| continue | ||
| } | ||
| sortedArchives = append(sortedArchives, archive) | ||
| } | ||
| slices.SortFunc(sortedArchives, func(a, b *setup.Archive) int { | ||
| return b.Priority - a.Priority | ||
| }) | ||
|
|
||
| fetchers := make(map[string]Fetcher) | ||
| for _, s := range selection.Slices { | ||
| if _, ok := fetchers[s.Package]; ok { | ||
| continue | ||
| } | ||
| pkg := selection.Release.Packages[s.Package] | ||
| if pkg.Store != "" { | ||
| fetchers[pkg.Name] = &binFetcher{ | ||
| name: pkg.Name, | ||
| store: pkg.Store, | ||
| // TODO: populate arch, track and risk when implementing | ||
| // fetching from the store. | ||
| } | ||
| continue | ||
| } | ||
|
|
||
| var candidates []*setup.Archive | ||
| if pkg.Archive == "" { | ||
| // If the package has not pinned any archive, choose the highest | ||
| // priority archive in which the package exists. | ||
| candidates = sortedArchives | ||
| } else { | ||
| candidates = []*setup.Archive{selection.Release.Archives[pkg.Archive]} | ||
| } | ||
|
|
||
| var chosen archive.Archive | ||
| for _, archiveInfo := range candidates { | ||
| archive := archives[archiveInfo.Name] | ||
| if archive != nil && archive.Exists(pkg.RealName) { | ||
| chosen = archive | ||
| break | ||
| } | ||
| } | ||
| if chosen == nil { | ||
| return nil, fmt.Errorf("cannot find package %q in archive(s)", pkg.RealName) | ||
| } | ||
| fetchers[pkg.Name] = &debFetcher{ | ||
| archive: chosen, | ||
| name: pkg.RealName, | ||
| } | ||
| } | ||
|
|
||
| return fetchers, nil | ||
| } | ||
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
Oops, something went wrong.
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.
[Note to reviewer]: This is a smell that having PackageInfo in manifestutil shows its limit, as already discussed.
I considered moving it to the
slicerpkg but that would be wrong becausemanifestutil(a leaf package) would need to import it.I also considered creating a standalone package with fetch.go and
PackageInfobut that would couple manifestutil with thisfetchpackage and it looks wrong too.So the next best solution looks to be a small
pkginfoleaf package, holding the interface. Let me know what you think about it and I will proceed with it in a follow-up PR (to not mix refactor and feature in this one) if we agree on a refactor.