Skip to content

Commit

Permalink
Merge pull request #1381 from SaschaSchwarze0/sascha-dockerfile
Browse files Browse the repository at this point in the history 
Handle dockerfile in build strategy conversion
  • Loading branch information
@openshift-merge-robot
openshift-merge-robot authored Sep 19, 2023
2 parents 71ff0bb + 153784d commit ed489b6
Show file tree
Hide file tree
Showing 8 changed files with 156 additions and 43 deletions.
4 changes: 2 additions & 2 deletions hack/generate-cert.sh
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/bin/bash

# Copyright The Shipwright Contributors
#
# SPDX-License-Identifier: Apache-2.0

#!/bin/bash

set -euo pipefail

DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
Expand Down
4 changes: 2 additions & 2 deletions hack/patch-crds-with-conversion.sh
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/bin/bash

# Copyright The Shipwright Contributors
#
# SPDX-License-Identifier: Apache-2.0

#!/bin/bash

set -euo pipefail

DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)"
Expand Down
19 changes: 14 additions & 5 deletions pkg/apis/build/v1beta1/build_conversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ var _ webhook.Conversion = (*Build)(nil)

// ConvertTo converts this Build object to v1alpha1 format.
func (src *Build) ConvertTo(ctx context.Context, obj *unstructured.Unstructured) error {
ctxlog.Debug(ctx, "Converting Build from beta to alpha", "namespace", src.Namespace, "name", src.Name)

var alphaBuild v1alpha1.Build

alphaBuild.TypeMeta = src.TypeMeta
Expand All @@ -38,8 +40,10 @@ func (src *Build) ConvertTo(ctx context.Context, obj *unstructured.Unstructured)

// convert annotation-controlled features
if src.Spec.Retention != nil && src.Spec.Retention.AtBuildDeletion != nil {
if alphaBuild.ObjectMeta.Annotations == nil {
alphaBuild.ObjectMeta.Annotations = make(map[string]string, 1)
// We must create a new Map as otherwise the addition is not kept
alphaBuild.ObjectMeta.Annotations = map[string]string{}
for k, v := range src.Annotations {
alphaBuild.ObjectMeta.Annotations[k] = v
}
alphaBuild.ObjectMeta.Annotations[v1alpha1.AnnotationBuildRunDeletion] = strconv.FormatBool(*src.Spec.Retention.AtBuildDeletion)
}
Expand All @@ -64,6 +68,9 @@ func (src *Build) ConvertFrom(ctx context.Context, obj *unstructured.Unstructure
if err != nil {
ctxlog.Error(ctx, err, "failed unstructuring the convertedObject")
}

ctxlog.Debug(ctx, "Converting Build from alpha to beta", "namespace", alphaBuild.Namespace, "name", alphaBuild.Name)

src.ObjectMeta = alphaBuild.ObjectMeta
src.TypeMeta = alphaBuild.TypeMeta
src.TypeMeta.APIVersion = betaGroupVersion
Expand Down Expand Up @@ -217,12 +224,14 @@ func (dest *BuildSpec) ConvertTo(bs *v1alpha1.BuildSpec) error {
// Handle BuildSpec ParamValues
bs.ParamValues = nil
for _, p := range dest.ParamValues {
if p.Name == "dockerfile" && p.SingleValue != nil {
bs.Dockerfile = p.SingleValue.Value
continue
}

param := v1alpha1.ParamValue{}
p.convertToAlpha(&param)
bs.ParamValues = append(bs.ParamValues, param)
if param.Name == "dockerfile" {
bs.Dockerfile = param.Value
}
}

// Handle BuildSpec Output
Expand Down
3 changes: 3 additions & 0 deletions pkg/apis/build/v1beta1/buildrun_conversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ var _ webhook.Conversion = (*BuildRun)(nil)

// To Alpha
func (src *BuildRun) ConvertTo(ctx context.Context, obj *unstructured.Unstructured) error {
ctxlog.Debug(ctx, "Converting BuildRun from beta to alpha", "namespace", src.Namespace, "name", src.Name)

var alphaBuildRun v1alpha1.BuildRun

Expand Down Expand Up @@ -110,6 +111,8 @@ func (src *BuildRun) ConvertFrom(ctx context.Context, obj *unstructured.Unstruct
ctxlog.Error(ctx, err, "failed unstructuring the buildrun convertedObject")
}

ctxlog.Debug(ctx, "Converting BuildRun from alpha to beta", "namespace", alphaBuildRun.Namespace, "name", alphaBuildRun.Name)

src.ObjectMeta = alphaBuildRun.ObjectMeta
src.TypeMeta = alphaBuildRun.TypeMeta
src.TypeMeta.APIVersion = betaGroupVersion
Expand Down
117 changes: 99 additions & 18 deletions pkg/apis/build/v1beta1/buildstrategy_conversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,24 @@ package v1beta1

import (
"context"
"strings"

"github.com/shipwright-io/build/pkg/apis/build/v1alpha1"
"github.com/shipwright-io/build/pkg/ctxlog"
"github.com/shipwright-io/build/pkg/webhook"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
runtime "k8s.io/apimachinery/pkg/runtime"
"k8s.io/utils/pointer"
)

// ensure v1beta1 implements the Conversion interface
var _ webhook.Conversion = (*BuildStrategy)(nil)

// ConvertTo converts this object to its v1alpha1 equivalent
func (src *BuildStrategy) ConvertTo(ctx context.Context, obj *unstructured.Unstructured) error {
ctxlog.Debug(ctx, "Converting BuildStrategy from beta to alpha", "namespace", src.Namespace, "name", src.Name)

var bs v1alpha1.BuildStrategy
bs.TypeMeta = src.TypeMeta
bs.TypeMeta.APIVersion = alphaGroupVersion
Expand All @@ -37,6 +41,23 @@ func (src *BuildStrategy) ConvertTo(ctx context.Context, obj *unstructured.Unstr
}

func (src *BuildStrategySpec) ConvertTo(bs *v1alpha1.BuildStrategySpec) {
usesMigratedDockerfileArg := false

bs.Parameters = []v1alpha1.Parameter{}
for _, param := range src.Parameters {
if param.Name == "dockerfile" && param.Type == ParameterTypeString && param.Default != nil && *param.Default == "Dockerfile" {
usesMigratedDockerfileArg = true
continue
}

bs.Parameters = append(bs.Parameters, v1alpha1.Parameter{
Name: param.Name,
Description: param.Description,
Type: v1alpha1.ParameterType(param.Type),
Default: param.Default,
Defaults: param.Defaults,
})
}

bs.BuildSteps = []v1alpha1.BuildStep{}
for _, step := range src.Steps {
Expand All @@ -52,27 +73,35 @@ func (src *BuildStrategySpec) ConvertTo(bs *v1alpha1.BuildStrategySpec) {
Resources: step.Resources,
VolumeMounts: step.VolumeMounts,
ImagePullPolicy: step.ImagePullPolicy,
SecurityContext: step.SecurityContext,
},
}

if step.SecurityContext != nil {
buildStep.SecurityContext = step.SecurityContext
if usesMigratedDockerfileArg {
// Migrate to legacy argument

for commandIndex, command := range buildStep.Command {
if strings.Contains(command, "$(params.dockerfile)") {
buildStep.Command[commandIndex] = strings.ReplaceAll(command, "$(params.dockerfile)", "$(params.DOCKERFILE)")
}
}

for argIndex, arg := range buildStep.Args {
if strings.Contains(arg, "$(params.dockerfile)") {
buildStep.Args[argIndex] = strings.ReplaceAll(arg, "$(params.dockerfile)", "$(params.DOCKERFILE)")
}
}

for envIndex, env := range buildStep.Env {
if strings.Contains(env.Value, "$(params.dockerfile)") {
buildStep.Env[envIndex].Value = strings.ReplaceAll(env.Value, "$(params.dockerfile)", "$(params.DOCKERFILE)")
}
}
}

bs.BuildSteps = append(bs.BuildSteps, buildStep)
}

bs.Parameters = []v1alpha1.Parameter{}
for _, param := range src.Parameters {
bs.Parameters = append(bs.Parameters, v1alpha1.Parameter{
Name: param.Name,
Description: param.Description,
Type: v1alpha1.ParameterType(param.Type),
Default: param.Default,
Defaults: param.Defaults,
})
}

if src.SecurityContext != nil {
bs.SecurityContext = (*v1alpha1.BuildStrategySecurityContext)(src.SecurityContext)
}
Expand All @@ -90,25 +119,30 @@ func (src *BuildStrategySpec) ConvertTo(bs *v1alpha1.BuildStrategySpec) {

// ConvertFrom converts from v1alpha1.BuildStrategy into this object.
func (src *BuildStrategy) ConvertFrom(ctx context.Context, obj *unstructured.Unstructured) error {
var br v1alpha1.BuildStrategy
var bs v1alpha1.BuildStrategy

unstructured := obj.UnstructuredContent()
err := runtime.DefaultUnstructuredConverter.FromUnstructured(unstructured, &br)
err := runtime.DefaultUnstructuredConverter.FromUnstructured(unstructured, &bs)
if err != nil {
ctxlog.Error(ctx, err, "failed unstructuring the buildrun convertedObject")
}

src.ObjectMeta = br.ObjectMeta
src.TypeMeta = br.TypeMeta
ctxlog.Debug(ctx, "Converting BuildStrategy from alpha to beta", "namespace", bs.Namespace, "name", bs.Name)

src.ObjectMeta = bs.ObjectMeta
src.TypeMeta = bs.TypeMeta
src.TypeMeta.APIVersion = betaGroupVersion

src.Spec.ConvertFrom(br.Spec)
src.Spec.ConvertFrom(bs.Spec)

return nil
}

func (src *BuildStrategySpec) ConvertFrom(bs v1alpha1.BuildStrategySpec) {
src.Steps = []Step{}

usesDockerfile := false

for _, brStep := range bs.BuildSteps {
step := Step{
Name: brStep.Name,
Expand All @@ -122,6 +156,42 @@ func (src *BuildStrategySpec) ConvertFrom(bs v1alpha1.BuildStrategySpec) {
ImagePullPolicy: brStep.ImagePullPolicy,
SecurityContext: brStep.SecurityContext,
}

// Migrate legacy argument usage

for commandIndex, command := range step.Command {
if strings.Contains(command, "$(params.DOCKERFILE)") {
usesDockerfile = true
step.Command[commandIndex] = strings.ReplaceAll(command, "$(params.DOCKERFILE)", "$(params.dockerfile)")
}
if strings.Contains(command, "$(build.dockerfile)") {
usesDockerfile = true
step.Command[commandIndex] = strings.ReplaceAll(command, "$(build.dockerfile)", "$(params.dockerfile)")
}
}

for argIndex, arg := range step.Args {
if strings.Contains(arg, "$(params.DOCKERFILE)") {
usesDockerfile = true
step.Args[argIndex] = strings.ReplaceAll(arg, "$(params.DOCKERFILE)", "$(params.dockerfile)")
}
if strings.Contains(arg, "$(build.dockerfile)") {
usesDockerfile = true
step.Args[argIndex] = strings.ReplaceAll(arg, "$(build.dockerfile)", "$(params.dockerfile)")
}
}

for envIndex, env := range step.Env {
if strings.Contains(env.Value, "$(params.DOCKERFILE)") {
usesDockerfile = true
step.Env[envIndex].Value = strings.ReplaceAll(env.Value, "$(params.DOCKERFILE)", "$(params.dockerfile)")
}
if strings.Contains(env.Value, "$(build.dockerfile)") {
usesDockerfile = true
step.Env[envIndex].Value = strings.ReplaceAll(env.Value, "$(build.dockerfile)", "$(params.dockerfile)")
}
}

src.Steps = append(src.Steps, step)
}

Expand All @@ -136,6 +206,17 @@ func (src *BuildStrategySpec) ConvertFrom(bs v1alpha1.BuildStrategySpec) {
})
}

// Add replacement for legacy arguments

if usesDockerfile {
src.Parameters = append(src.Parameters, Parameter{
Name: "dockerfile",
Description: "The Dockerfile to be built.",
Type: ParameterTypeString,
Default: pointer.String("Dockerfile"),
})
}

src.SecurityContext = (*BuildStrategySecurityContext)(bs.SecurityContext)

src.Volumes = []BuildStrategyVolume{}
Expand Down
14 changes: 9 additions & 5 deletions pkg/apis/build/v1beta1/clusterbuildstrategy_conversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ var _ webhook.Conversion = (*ClusterBuildStrategy)(nil)

// ConvertTo converts this object to its v1alpha1 equivalent
func (src *ClusterBuildStrategy) ConvertTo(ctx context.Context, obj *unstructured.Unstructured) error {
ctxlog.Debug(ctx, "Converting ClusterBuildStrategy from beta to alpha", "namespace", src.Namespace, "name", src.Name)

var bs v1alpha1.ClusterBuildStrategy
bs.TypeMeta = src.TypeMeta
bs.TypeMeta.APIVersion = alphaGroupVersion
Expand All @@ -37,19 +39,21 @@ func (src *ClusterBuildStrategy) ConvertTo(ctx context.Context, obj *unstructure

// ConvertFrom converts v1alpha1.ClusterBuildStrategy into this object
func (src *ClusterBuildStrategy) ConvertFrom(ctx context.Context, obj *unstructured.Unstructured) error {
var br v1alpha1.ClusterBuildStrategy
var cbs v1alpha1.ClusterBuildStrategy

unstructured := obj.UnstructuredContent()
err := runtime.DefaultUnstructuredConverter.FromUnstructured(unstructured, &br)
err := runtime.DefaultUnstructuredConverter.FromUnstructured(unstructured, &cbs)
if err != nil {
ctxlog.Error(ctx, err, "failed unstructuring the buildrun convertedObject")
}

src.ObjectMeta = br.ObjectMeta
src.TypeMeta = br.TypeMeta
ctxlog.Debug(ctx, "Converting ClusterBuildStrategy from alpha to beta", "namespace", cbs.Namespace, "name", cbs.Name)

src.ObjectMeta = cbs.ObjectMeta
src.TypeMeta = cbs.TypeMeta
src.TypeMeta.APIVersion = betaGroupVersion

src.Spec.ConvertFrom(br.Spec)
src.Spec.ConvertFrom(cbs.Spec)

return nil
}
2 changes: 1 addition & 1 deletion pkg/webhook/conversion/converter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func convertSHPCR(ctx context.Context, Object *unstructured.Unstructured, toVers
}
clusterBuildStrategy.ConvertTo(ctx, convertedObject)
} else {
return nil, statusErrorWithMessage("unsupporteddda skdksdjkjsd Kind")
return nil, statusErrorWithMessage("unsupported Kind")
}
default:
return nil, statusErrorWithMessage("unexpected conversion version to %q", toVersion)
Expand Down
Loading

0 comments on commit ed489b6

Please sign in to comment.