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.

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

Add support for platform API 0.6 #796

Closed
wants to merge 1 commit into from
Closed

Add support for platform API 0.6 #796

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
14 changes: 10 additions & 4 deletions pkg/apis/build/v1alpha1/build_pod.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"strings"

"github.com/Masterminds/semver/v3"
"github.com/google/go-containerregistry/pkg/name"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -390,12 +391,17 @@ func (b *Build) BuildPod(images BuildPodImages, secrets []corev1.Secret, taints
"-project-metadata=/layers/project-metadata.toml"},
cacheArgs,
func() []string {
if platformAPI == "0.3" {
platformAPIVersion := semver.MustParse(platformAPI)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit concerned about the "MustParse" here a bad builder with an invalid metadata could lead to a panic.

if platformAPIVersion.LessThan(semver.MustParse("0.4")) {
return nil
} else if platformAPIVersion.LessThan(semver.MustParse("0.6")) {
return []string{
"-report=/var/report/report.toml",
"-process-type=web",
}
}
return []string{
"-report=/var/report/report.toml",
"-process-type=web",
}
}(),
b.Spec.Tags),
Expand Down Expand Up @@ -760,10 +766,10 @@ func (b *Build) setupBindings() ([]corev1.Volume, []corev1.VolumeMount) {

func (bc *BuildPodBuilderConfig) highestSupportedPlatformAPI(b *Build) (string, error) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we instead have this method return a parsed platform api?


var supportedPlatformAPIVersions = []string{"0.5", "0.4", "0.3"}
var supportedPlatformAPIVersions = []string{"0.6", "0.5", "0.4", "0.3"}
if b.NotaryV1Config() != nil || bc.OS == "windows" {
//windows and report.toml are only available in platform api 0.3
supportedPlatformAPIVersions = []string{"0.5", "0.4"}
supportedPlatformAPIVersions = []string{"0.6", "0.5", "0.4"}
}

for _, supportedVersion := range supportedPlatformAPIVersions {
Expand Down
18 changes: 8 additions & 10 deletions pkg/apis/build/v1alpha1/build_pod_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
RunImage: "builderregistry.io/run",
Uid: 2000,
Gid: 3000,
PlatformAPIs: []string{"0.2", "0.3", "0.4", "0.5"},
PlatformAPIs: []string{"0.2", "0.3", "0.4", "0.5", "0.6"},
OS: "linux",
}

Expand Down Expand Up @@ -506,7 +506,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[1].Name, "detect")
assert.Contains(t, pod.Spec.InitContainers[1].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[1].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[1].Image, builderImage)
assert.Equal(t, []string{
"layers-dir",
Expand All @@ -523,7 +523,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[2].Name, "analyze")
assert.Contains(t, pod.Spec.InitContainers[2].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[2].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[2].Image, builderImage)
assert.Equal(t, []string{
"layers-dir",
Expand Down Expand Up @@ -577,7 +577,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[3].Name, "restore")
assert.Contains(t, pod.Spec.InitContainers[3].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[3].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[3].Image, builderImage)
assert.Equal(t, []string{
"layers-dir",
Expand All @@ -596,7 +596,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[4].Name, "build")
assert.Contains(t, pod.Spec.InitContainers[4].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[4].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[4].Image, builderImage)
assert.Len(t, pod.Spec.InitContainers[4].VolumeMounts, len([]string{
"layers-dir",
Expand All @@ -614,7 +614,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {

assert.Equal(t, pod.Spec.InitContainers[5].Name, "export")
assert.Equal(t, pod.Spec.InitContainers[5].Image, builderImage)
assert.Contains(t, pod.Spec.InitContainers[5].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[5].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.ElementsMatch(t, names(pod.Spec.InitContainers[5].VolumeMounts), []string{
"layers-dir",
"workspace-dir",
Expand All @@ -630,7 +630,6 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
"-project-metadata=/layers/project-metadata.toml",
"-cache-dir=/cache",
"-report=/var/report/report.toml",
"-process-type=web",
build.Tag(),
"someimage/name:tag2",
"someimage/name:tag3",
Expand Down Expand Up @@ -758,11 +757,11 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
})

when("no supported platform apis are available", func() {
buildPodBuilderConfig.PlatformAPIs = []string{"0.2", "0.6"}
buildPodBuilderConfig.PlatformAPIs = []string{"0.2", "0.7"}

it("returns an error", func() {
_, err := build.BuildPod(config, secrets, nil, buildPodBuilderConfig)
require.EqualError(t, err, "unsupported builder platform API versions: 0.2,0.6")
require.EqualError(t, err, "unsupported builder platform API versions: 0.2,0.7")
})
})

Expand Down Expand Up @@ -1227,7 +1226,6 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
"-analyzed=/layers/analyzed.toml",
"-project-metadata=/layers/project-metadata.toml",
"-report=/var/report/report.toml",
"-process-type=web",
"someimage/name", "someimage/name:tag2", "someimage/name:tag3"},
exportContainer.Args)
})
Expand Down
14 changes: 10 additions & 4 deletions pkg/apis/build/v1alpha2/build_pod.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"strings"

"github.com/Masterminds/semver/v3"
"github.com/google/go-containerregistry/pkg/name"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -390,12 +391,17 @@ func (b *Build) BuildPod(images BuildPodImages, secrets []corev1.Secret, taints
"-project-metadata=/layers/project-metadata.toml"},
cacheArgs,
func() []string {
if platformAPI == "0.3" {
platformAPIVersion := semver.MustParse(platformAPI)
if platformAPIVersion.LessThan(semver.MustParse("0.4")) {
return nil
} else if platformAPIVersion.LessThan(semver.MustParse("0.6")) {
return []string{
"-report=/var/report/report.toml",
"-process-type=web",
}
}
return []string{
"-report=/var/report/report.toml",
"-process-type=web",
}
}(),
b.Spec.Tags),
Expand Down Expand Up @@ -760,10 +766,10 @@ func (b *Build) setupBindings() ([]corev1.Volume, []corev1.VolumeMount) {

func (bc *BuildPodBuilderConfig) highestSupportedPlatformAPI(b *Build) (string, error) {

var supportedPlatformAPIVersions = []string{"0.5", "0.4", "0.3"}
var supportedPlatformAPIVersions = []string{"0.6", "5", "0.4", "0.3"}
if b.NotaryV1Config() != nil || bc.OS == "windows" {
//windows and report.toml are only available in platform api 0.3
supportedPlatformAPIVersions = []string{"0.5", "0.4"}
supportedPlatformAPIVersions = []string{"0.6", "0.5", "0.4"}
}

for _, supportedVersion := range supportedPlatformAPIVersions {
Expand Down
18 changes: 8 additions & 10 deletions pkg/apis/build/v1alpha2/build_pod_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
RunImage: "builderregistry.io/run",
Uid: 2000,
Gid: 3000,
PlatformAPIs: []string{"0.2", "0.3", "0.4", "0.5"},
PlatformAPIs: []string{"0.2", "0.3", "0.4", "0.5", "0.6"},
OS: "linux",
}

Expand Down Expand Up @@ -506,7 +506,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[1].Name, "detect")
assert.Contains(t, pod.Spec.InitContainers[1].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[1].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[1].Image, builderImage)
assert.Equal(t, []string{
"layers-dir",
Expand All @@ -523,7 +523,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[2].Name, "analyze")
assert.Contains(t, pod.Spec.InitContainers[2].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[2].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[2].Image, builderImage)
assert.Equal(t, []string{
"layers-dir",
Expand Down Expand Up @@ -577,7 +577,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[3].Name, "restore")
assert.Contains(t, pod.Spec.InitContainers[3].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[3].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[3].Image, builderImage)
assert.Equal(t, []string{
"layers-dir",
Expand All @@ -596,7 +596,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
require.NoError(t, err)

assert.Equal(t, pod.Spec.InitContainers[4].Name, "build")
assert.Contains(t, pod.Spec.InitContainers[4].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[4].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.Equal(t, pod.Spec.InitContainers[4].Image, builderImage)
assert.Len(t, pod.Spec.InitContainers[4].VolumeMounts, len([]string{
"layers-dir",
Expand All @@ -614,7 +614,7 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {

assert.Equal(t, pod.Spec.InitContainers[5].Name, "export")
assert.Equal(t, pod.Spec.InitContainers[5].Image, builderImage)
assert.Contains(t, pod.Spec.InitContainers[5].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.5"})
assert.Contains(t, pod.Spec.InitContainers[5].Env, corev1.EnvVar{Name: "CNB_PLATFORM_API", Value: "0.6"})
assert.ElementsMatch(t, names(pod.Spec.InitContainers[5].VolumeMounts), []string{
"layers-dir",
"workspace-dir",
Expand All @@ -630,7 +630,6 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
"-project-metadata=/layers/project-metadata.toml",
"-cache-dir=/cache",
"-report=/var/report/report.toml",
"-process-type=web",
build.Tag(),
"someimage/name:tag2",
"someimage/name:tag3",
Expand Down Expand Up @@ -758,11 +757,11 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
})

when("no supported platform apis are available", func() {
buildPodBuilderConfig.PlatformAPIs = []string{"0.2", "0.6"}
buildPodBuilderConfig.PlatformAPIs = []string{"0.2", "0.7"}

it("returns an error", func() {
_, err := build.BuildPod(config, secrets, nil, buildPodBuilderConfig)
require.EqualError(t, err, "unsupported builder platform API versions: 0.2,0.6")
require.EqualError(t, err, "unsupported builder platform API versions: 0.2,0.7")
})
})

Expand Down Expand Up @@ -1227,7 +1226,6 @@ func testBuildPod(t *testing.T, when spec.G, it spec.S) {
"-analyzed=/layers/analyzed.toml",
"-project-metadata=/layers/project-metadata.toml",
"-report=/var/report/report.toml",
"-process-type=web",
"someimage/name", "someimage/name:tag2", "someimage/name:tag3"},
exportContainer.Args)
})
Expand Down
2 changes: 1 addition & 1 deletion pkg/cnb/builder_builder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const (

var (
normalizedTime = time.Date(1980, time.January, 1, 0, 0, 1, 0, time.UTC)
supportedPlatformApis = []string{"0.3", "0.4", "0.5"}
supportedPlatformApis = []string{"0.3", "0.4", "0.5", "0.6"}
)

type builderBlder struct {
Expand Down
4 changes: 2 additions & 2 deletions pkg/cnb/create_builder_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,7 @@ func testCreateBuilderOs(os string, t *testing.T, when spec.G, it spec.S) {
},
Platform: APIVersions{
Deprecated: []string{"0.1"},
Supported: []string{"0.2", "0.6", "0.7"},
Supported: []string{"0.2", "0.7"},
},
},
},
Expand All @@ -798,7 +798,7 @@ func testCreateBuilderOs(os string, t *testing.T, when spec.G, it spec.S) {
lifecycleProvider.image = lifecycleImg

_, err = subject.CreateBuilder(keychain, store, stack, clusterBuilderSpec)
require.EqualError(t, err, "unsupported platform apis in kpack lifecycle: 0.1, 0.2, 0.6, 0.7, expecting one of: 0.3, 0.4, 0.5")
require.EqualError(t, err, "unsupported platform apis in kpack lifecycle: 0.1, 0.2, 0.7, expecting one of: 0.3, 0.4, 0.5, 0.6")
})
})
})
Expand Down