Skip to content
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

Validate buildpack API version #282

Merged
merged 3 commits into from
Sep 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 9 additions & 1 deletion acceptance/acceptance_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,15 @@ func TestAcceptance(t *testing.T) {

previousPackPath := os.Getenv(envPreviousPackPath)

lifecycleDescriptor := builder.AssumedLifecycleDescriptor
lifecycleDescriptor := builder.LifecycleDescriptor{
Info: builder.LifecycleInfo{
Version: builder.VersionMustParse(builder.DefaultLifecycleVersion),
},
API: builder.LifecycleAPI{
BuildpackVersion: api.MustParse(builder.DefaultBuildpackAPIVersion),
PlatformVersion: api.MustParse(builder.DefaultPlatformAPIVersion),
},
}
lifecyclePath := os.Getenv(envLifecyclePath)
if lifecyclePath != "" {
lifecyclePath, err = filepath.Abs(lifecyclePath)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
api = "0.2"

[buildpack]
id = "noop.buildpack"
version = "noop.buildpack.version"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
api = "0.2"

[buildpack]
id = "local/bp"
version = "local-bp-version"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
api = "0.2"

[buildpack]
id = "other/stack/bp"
version = "other-stack-version"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
api = "0.2"

[buildpack]
id = "read/env"
version = "read-env-version"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
api = "0.2"

[buildpack]
id = "simple/layers"
version = "simple-layers-version"
Expand Down
43 changes: 43 additions & 0 deletions api/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,46 @@ func (v *Version) UnmarshalText(text []byte) error {

return nil
}

// SupportsVersion determines whether this version supports a given version. If comparing two pre-stable (major == 0)
// versions, minors must match exactly. Otherwise, this minor must be greater than or equal to the given minor. Majors
// must always match.
func (v *Version) SupportsVersion(o *Version) bool {
if v.Equal(o) {
return true
}

if v.major != 0 {
return v.major == o.major && v.minor >= o.minor
}

return false
}

func (v *Version) Equal(o *Version) bool {
return v.Compare(o) == 0
}

func (v *Version) Compare(o *Version) int {
if v.major != o.major {
if v.major < o.major {
return -1
}

if v.major > o.major {
return 1
}
}

if v.minor != o.minor {
if v.minor < o.minor {
return -1
}

if v.minor > o.minor {
return 1
}
}

return 0
}
95 changes: 95 additions & 0 deletions api/version_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
package api_test

import (
"testing"

"github.com/sclevine/spec"
"github.com/sclevine/spec/report"

"github.com/buildpack/pack/api"
h "github.com/buildpack/pack/testhelpers"
)

func TestAPIVersion(t *testing.T) {
spec.Run(t, "APIVersion", testAPIVersion, spec.Parallel(), spec.Report(report.Terminal{}))
}

func testAPIVersion(t *testing.T, when spec.G, it spec.S) {
when("#Equal", func() {
it("is equal to comparison", func() {
subject := api.MustParse("0.2")
comparison := api.MustParse("0.2")

h.AssertEq(t, subject.Equal(comparison), true)
})

it("is not equal to comparison", func() {
subject := api.MustParse("0.2")
comparison := api.MustParse("0.3")

h.AssertEq(t, subject.Equal(comparison), false)
})
})

when("#SupportsVersion", func() {
when("pre-stable", func() {
it("matching minor value", func() {
subject := api.MustParse("0.2")
comparison := api.MustParse("0.2")

h.AssertEq(t, subject.SupportsVersion(comparison), true)
})

it("subject minor > comparison minor", func() {
subject := api.MustParse("0.2")
comparison := api.MustParse("0.1")

h.AssertEq(t, subject.SupportsVersion(comparison), false)
})

it("subject minor < comparison minor", func() {
subject := api.MustParse("0.1")
comparison := api.MustParse("0.2")

h.AssertEq(t, subject.SupportsVersion(comparison), false)
})
})

when("stable", func() {
it("matching major and minor", func() {
subject := api.MustParse("1.2")
comparison := api.MustParse("1.2")

h.AssertEq(t, subject.SupportsVersion(comparison), true)
})

it("matching major but minor > comparison minor", func() {
subject := api.MustParse("1.2")
comparison := api.MustParse("1.1")

h.AssertEq(t, subject.SupportsVersion(comparison), true)
})

it("matching major but minor < comparison minor", func() {
subject := api.MustParse("1.1")
comparison := api.MustParse("1.2")

h.AssertEq(t, subject.SupportsVersion(comparison), false)
})

it("major < comparison major", func() {
subject := api.MustParse("1.0")
comparison := api.MustParse("2.0")

h.AssertEq(t, subject.SupportsVersion(comparison), false)
})

it("major > comparison major", func() {
subject := api.MustParse("2.0")
comparison := api.MustParse("1.0")

h.AssertEq(t, subject.SupportsVersion(comparison), false)
})
})
})
}
5 changes: 3 additions & 2 deletions build.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ func (c *Client) Build(ctx context.Context, opts BuildOptions) error {
return errors.Wrapf(err, "invalid run-image '%s'", runImage)
}

extraBuildpacks, group, err := c.processBuildpacks(opts.Buildpacks)
fetchedBps, group, err := c.processBuildpacks(opts.Buildpacks)
if err != nil {
return errors.Wrap(err, "invalid buildpack")
}

ephemeralBuilder, err := c.createEphemeralBuilder(rawBuilderImage, opts.Env, group, extraBuildpacks)
ephemeralBuilder, err := c.createEphemeralBuilder(rawBuilderImage, opts.Env, group, fetchedBps)
if err != nil {
return err
}
Expand Down Expand Up @@ -240,6 +240,7 @@ func (c *Client) processBuildpacks(buildpacks []string) ([]builder.Buildpack, bu
}

bps = append(bps, fetchedBP)

group.Group = append(group.Group, builder.BuildpackRef{
BuildpackInfo: fetchedBP.Descriptor().Info,
})
Expand Down
8 changes: 2 additions & 6 deletions build/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ import (
"github.com/buildpack/pack/style"
)

const (
DefaultLifecycleVersion = "0.3.0"
)

type Lifecycle struct {
builder *builder.Builder
logger logging.Logger
Expand Down Expand Up @@ -75,8 +71,8 @@ func (l *Lifecycle) Execute(ctx context.Context, opts LifecycleOptions) error {

lifecycleVersion := l.builder.GetLifecycleDescriptor().Info.Version
if lifecycleVersion == nil {
l.logger.Warn("lifecycle version unknown")
lifecycleVersion = builder.AssumedLifecycleDescriptor.Info.Version
l.logger.Warnf("lifecycle version unknown, assuming %s", style.Symbol(builder.AssumedLifecycleVersion))
lifecycleVersion = builder.VersionMustParse(builder.AssumedLifecycleVersion)
} else {
l.logger.Debugf("Executing lifecycle version %s", style.Symbol(lifecycleVersion.String()))
}
Expand Down
68 changes: 49 additions & 19 deletions build_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ import (
"testing"
"time"

"github.com/Masterminds/semver"
"github.com/buildpack/imgutil/fakes"
"github.com/docker/docker/client"
"github.com/fatih/color"
"github.com/onsi/gomega/ghttp"
"github.com/sclevine/spec"
"github.com/sclevine/spec/report"

"github.com/buildpack/pack/api"
"github.com/buildpack/pack/blob"
"github.com/buildpack/pack/builder"
ifakes "github.com/buildpack/pack/internal/fakes"
Expand Down Expand Up @@ -49,30 +51,51 @@ func testBuild(t *testing.T, when spec.G, it spec.S) {
outBuf bytes.Buffer
)
it.Before(func() {
var err error

fakeImageFetcher = ifakes.NewFakeImageFetcher()
fakeLifecycle = &ifakes.FakeLifecycle{}

tmpDir, err = ioutil.TempDir("", "build-test")
h.AssertNil(t, err)

builderName = "example.com/default/builder:tag"
defaultBuilderStackID = "some.stack.id"
defaultBuilderImage = ifakes.NewFakeBuilderImage(t,
builderName,
[]builder.BuildpackMetadata{
{
BuildpackInfo: builder.BuildpackInfo{ID: "buildpack.id", Version: "buildpack.version"},
Latest: true,
defaultBuilderStackID,
"1234",
"5678",
builder.Metadata{
Buildpacks: []builder.BuildpackMetadata{
{
BuildpackInfo: builder.BuildpackInfo{ID: "buildpack.id", Version: "buildpack.version"},
Latest: true,
},
},
},
builder.Config{
Stack: builder.StackConfig{
ID: defaultBuilderStackID,
RunImage: "default/run",
RunImageMirrors: []string{
"registry1.example.com/run/mirror",
"registry2.example.com/run/mirror",
Stack: builder.StackMetadata{
RunImage: builder.RunImageMetadata{
Image: "default/run",
Mirrors: []string{
"registry1.example.com/run/mirror",
"registry2.example.com/run/mirror",
},
},
},
Lifecycle: builder.LifecycleMetadata{
LifecycleInfo: builder.LifecycleInfo{
Version: &builder.Version{
Version: *semver.MustParse("0.3.0"),
},
},
API: builder.LifecycleAPI{
BuildpackVersion: api.MustParse("0.3"),
PlatformVersion: api.MustParse("0.2"),
},
},
},
)

fakeImageFetcher.LocalImages[defaultBuilderImage.Name()] = defaultBuilderImage

fakeDefaultRunImage = fakes.NewImage("default/run", "", "")
Expand All @@ -86,19 +109,19 @@ func testBuild(t *testing.T, when spec.G, it spec.S) {
fakeMirror2 = fakes.NewImage("registry2.example.com/run/mirror", "", "")
h.AssertNil(t, fakeMirror2.SetLabel("io.buildpacks.stack.id", defaultBuilderStackID))
fakeImageFetcher.LocalImages[fakeMirror2.Name()] = fakeMirror2
var err error
tmpDir, err = ioutil.TempDir("", "build-test-bp-fetch-cache")
h.AssertNil(t, err)

docker, err := client.NewClientWithOpts(client.FromEnv, client.WithVersion("1.38"))
h.AssertNil(t, err)

logger := ifakes.NewFakeLogger(&outBuf)

dlCacheDir, err := ioutil.TempDir(tmpDir, "dl-cache")
h.AssertNil(t, err)

subject = &Client{
logger: logger,
imageFetcher: fakeImageFetcher,
downloader: blob.NewDownloader(logger, tmpDir),
downloader: blob.NewDownloader(logger, dlCacheDir),
lifecycle: fakeLifecycle,
docker: docker,
}
Expand Down Expand Up @@ -304,10 +327,17 @@ func testBuild(t *testing.T, when spec.G, it spec.S) {
it.Before(func() {
customBuilderImage = ifakes.NewFakeBuilderImage(t,
builderName,
[]builder.BuildpackMetadata{},
builder.Config{
Stack: builder.StackConfig{ID: "some.stack.id", RunImage: "some/run"},
"some.stack.id",
"1234",
"5678",
builder.Metadata{
Stack: builder.StackMetadata{
RunImage: builder.RunImageMetadata{
Image: "some/run",
},
},
})

fakeImageFetcher.LocalImages[customBuilderImage.Name()] = customBuilderImage

fakeRunImage = fakes.NewImage("some/run", "", "")
Expand Down
Loading