Skip to content

Dynamically determine valid lifecycle #2328

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

Open
modulo11 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Dynamically determine valid lifecycle #2328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 30 additions & 14 deletions pkg/client/create_builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (

pubbldr "github.com/buildpacks/pack/builder"
"github.com/buildpacks/pack/internal/builder"
"github.com/buildpacks/pack/internal/config"
"github.com/buildpacks/pack/internal/paths"
"github.com/buildpacks/pack/internal/style"
"github.com/buildpacks/pack/pkg/buildpack"
Expand Down Expand Up @@ -301,14 +302,20 @@ func (c *Client) fetchLifecycle(ctx context.Context, opts CreateBuilderOptions,
return nil, errors.Wrapf(err, "%s must be a valid semver", style.Symbol("lifecycle.version"))
}

uri = c.uriFromLifecycleVersion(*v, os, architecture)
uri, err = c.uriFromLifecycleVersion(*v, os, architecture)
if err != nil {
return nil, errors.Wrap(err, "determine lifecycle")
}
case config.URI != "":
uri, err = paths.FilePathToURI(config.URI, opts.RelativeBaseDir)
if err != nil {
return nil, err
return nil, errors.Wrap(err, "determine lifecycle")
}
default:
uri = c.uriFromLifecycleVersion(*semver.MustParse(builder.DefaultLifecycleVersion), os, architecture)
uri, err = c.uriFromLifecycleVersion(*semver.MustParse(builder.DefaultLifecycleVersion), os, architecture)
if err != nil {
return nil, errors.Wrap(err, "determine lifecycle")
}
}

blob, err := c.downloader.Download(ctx, uri)
Expand Down Expand Up @@ -451,21 +458,30 @@ func validateModule(kind string, module buildpack.BuildModule, source, expectedI
return nil
}

func (c *Client) uriFromLifecycleVersion(version semver.Version, os string, architecture string) string {
arch := "x86-64"

if os == "windows" {
return fmt.Sprintf("https://github.com/buildpacks/lifecycle/releases/download/v%s/lifecycle-v%s+windows.%s.tgz", version.String(), version.String(), arch)
func (c *Client) uriFromLifecycleVersion(version semver.Version, os string, architecture string) (string, error) {
image, err := c.indexFactory.FetchIndex(config.DefaultLifecycleImageRepo, imgutil.FromBaseIndex(config.DefaultLifecycleImageRepo))
if err != nil {
return "", err
}
manifest, err := image.IndexManifest()
if err != nil {
return "", err
}

if builder.SupportedLinuxArchitecture(architecture) {
arch = architecture
} else {
// FIXME: this should probably be an error case in the future, see https://github.com/buildpacks/pack/issues/2163
c.logger.Warnf("failed to find a lifecycle binary for requested architecture %s, defaulting to %s", style.Symbol(architecture), style.Symbol(arch))
for _, m := range manifest.Manifests {
if m.Platform.OS == os && m.Platform.Architecture == architecture {
return lifecycleDownloadURL(version, os, architecture), nil
}
}

return fmt.Sprintf("https://github.com/buildpacks/lifecycle/releases/download/v%s/lifecycle-v%s+linux.%s.tgz", version.String(), version.String(), arch)
return "", fmt.Errorf("could not determine lifecyle, unsupported os/arch: %s/%s", os, architecture)
}

func lifecycleDownloadURL(version semver.Version, os, architecture string) string {
if architecture == "amd64" {
architecture = "x86-64"
}
return fmt.Sprintf("https://github.com/buildpacks/lifecycle/releases/download/v%s/lifecycle-v%s+%s.%s.tgz", version.String(), version.String(), os, architecture)
}

func stripTopDirAndWrite(layerReader io.ReadCloser, outputPath string) (*OS.File, error) {
Expand Down
41 changes: 41 additions & 0 deletions pkg/client/create_builder_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/system"
"github.com/golang/mock/gomock"
v1 "github.com/google/go-containerregistry/pkg/v1"
"github.com/heroku/color"
"github.com/pkg/errors"
"github.com/sclevine/spec"
Expand Down Expand Up @@ -53,10 +54,12 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
mockBuildpackDownloader *testmocks.MockBuildpackDownloader
mockImageFactory *testmocks.MockImageFactory
mockImageFetcher *testmocks.MockImageFetcher
mockIndexFactory *testmocks.MockIndexFactory
mockDockerClient *testmocks.MockCommonAPIClient
fakeBuildImage *fakes.Image
fakeRunImage *fakes.Image
fakeRunImageMirror *fakes.Image
fakeLifecycleImage *fakes.ImageIndex
opts client.CreateBuilderOptions
subject *client.Client
logger logging.Logger
Expand All @@ -72,6 +75,10 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
mockImageFetcher.EXPECT().Fetch(gomock.Any(), "some/build-image", gomock.Any()).Return(fakeBuildImage, nil)
}

var prepareIndexFetcherWithLifecycleImage = func() {
mockIndexFactory.EXPECT().FetchIndex(gomock.Any(), gomock.Any()).Return(fakeLifecycleImage, nil)
}

var createBuildpack = func(descriptor dist.BuildpackDescriptor) buildpack.BuildModule {
buildpack, err := ifakes.NewFakeBuildpack(descriptor, 0644)
h.AssertNil(t, err)
Expand All @@ -93,6 +100,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
mockDownloader = testmocks.NewMockBlobDownloader(mockController)
mockImageFetcher = testmocks.NewMockImageFetcher(mockController)
mockImageFactory = testmocks.NewMockImageFactory(mockController)
mockIndexFactory = testmocks.NewMockIndexFactory(mockController)
mockDockerClient = testmocks.NewMockCommonAPIClient(mockController)
mockBuildpackDownloader = testmocks.NewMockBuildpackDownloader(mockController)

Expand All @@ -105,6 +113,29 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
fakeRunImage = fakes.NewImage("some/run-image", "", nil)
h.AssertNil(t, fakeRunImage.SetLabel("io.buildpacks.stack.id", "some.stack.id"))

fakeLifecycleImage = &fakes.ImageIndex{
Manifests: []v1.Descriptor{
{
Platform: &v1.Platform{
OS: "linux",
Architecture: "amd64",
},
},
{
Platform: &v1.Platform{
OS: "linux",
Architecture: "arm64",
},
},
{
Platform: &v1.Platform{
OS: "windows",
Architecture: "amd64",
},
},
},
}

fakeRunImageMirror = fakes.NewImage("localhost:5000/some/run-image", "", nil)
h.AssertNil(t, fakeRunImageMirror.SetLabel("io.buildpacks.stack.id", "some.stack.id"))

Expand All @@ -128,6 +159,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
client.WithDownloader(mockDownloader),
client.WithImageFactory(mockImageFactory),
client.WithFetcher(mockImageFetcher),
client.WithIndexFactory(mockIndexFactory),
client.WithDockerClient(mockDockerClient),
client.WithBuildpackDownloader(mockBuildpackDownloader),
)
Expand Down Expand Up @@ -456,6 +488,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
client.WithDownloader(mockDownloader),
client.WithImageFactory(mockImageFactory),
client.WithFetcher(mockImageFetcher),
client.WithIndexFactory(mockIndexFactory),
client.WithExperimental(true),
)
h.AssertNil(t, err)
Expand Down Expand Up @@ -520,6 +553,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
it("should download from predetermined uri", func() {
prepareFetcherWithBuildImage()
prepareFetcherWithRunImages()
prepareIndexFetcherWithLifecycleImage()
opts.Config.Lifecycle.URI = ""
opts.Config.Lifecycle.Version = "3.4.5"

Expand All @@ -537,6 +571,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
it("should download from predetermined uri for arm64", func() {
prepareFetcherWithBuildImage()
prepareFetcherWithRunImages()
prepareIndexFetcherWithLifecycleImage()
opts.Config.Lifecycle.URI = ""
opts.Config.Lifecycle.Version = "3.4.5"
h.AssertNil(t, fakeBuildImage.SetArchitecture("arm64"))
Expand All @@ -561,12 +596,14 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
client.WithDownloader(mockDownloader),
client.WithImageFactory(mockImageFactory),
client.WithFetcher(mockImageFetcher),
client.WithIndexFactory(mockIndexFactory),
client.WithExperimental(true),
)
h.AssertNil(t, err)

prepareFetcherWithBuildImage()
prepareFetcherWithRunImages()
prepareIndexFetcherWithLifecycleImage()
opts.Config.Lifecycle.URI = ""
opts.Config.Lifecycle.Version = "3.4.5"
h.AssertNil(t, fakeBuildImage.SetOS("windows"))
Expand All @@ -588,6 +625,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
it("should download default lifecycle", func() {
prepareFetcherWithBuildImage()
prepareFetcherWithRunImages()
prepareIndexFetcherWithLifecycleImage()
opts.Config.Lifecycle.URI = ""
opts.Config.Lifecycle.Version = ""

Expand All @@ -609,6 +647,7 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
it("should download default lifecycle on arm64", func() {
prepareFetcherWithBuildImage()
prepareFetcherWithRunImages()
prepareIndexFetcherWithLifecycleImage()
opts.Config.Lifecycle.URI = ""
opts.Config.Lifecycle.Version = ""
h.AssertNil(t, fakeBuildImage.SetArchitecture("arm64"))
Expand Down Expand Up @@ -637,12 +676,14 @@ func testCreateBuilder(t *testing.T, when spec.G, it spec.S) {
client.WithDownloader(mockDownloader),
client.WithImageFactory(mockImageFactory),
client.WithFetcher(mockImageFetcher),
client.WithIndexFactory(mockIndexFactory),
client.WithExperimental(true),
)
h.AssertNil(t, err)

prepareFetcherWithBuildImage()
prepareFetcherWithRunImages()
prepareIndexFetcherWithLifecycleImage()
opts.Config.Lifecycle.URI = ""
opts.Config.Lifecycle.Version = ""
h.AssertNil(t, fakeBuildImage.SetOS("windows"))
Expand Down
Loading