Skip to content

Commit

Permalink
fix(docker-instructions): exactOptionValues option to fix docker-serv…
Browse files Browse the repository at this point in the history 
…er backend options evaluation

Signed-off-by: Timofey Kirillov <timofey.kirillov@flant.com>

Signed-off-by: Timofey Kirillov <timofey.kirillov@flant.com>
  • Loading branch information
@distorhead
distorhead committed Jun 29, 2022
1 parent 6dcbd3e commit 9b3dbf9
Show file tree
Hide file tree
Showing 9 changed files with 291 additions and 33 deletions.
12 changes: 11 additions & 1 deletion pkg/build/stage/docker_instructions.go
View file
Expand Up @@ -30,9 +30,15 @@ type DockerInstructionsStage struct {
instructions *config.Docker
}

func (s *DockerInstructionsStage) GetDependencies(_ context.Context, _ Conveyor, _ container_backend.ContainerBackend, _, _ *StageImage) (string, error) {
func (s *DockerInstructionsStage) GetDependencies(_ context.Context, c Conveyor, backend container_backend.ContainerBackend, _, _ *StageImage) (string, error) {
var args []string

// FIXME: add to digest if option set, keep current compatible digest otherwise

if c.UseLegacyStapelBuilder(backend) && s.instructions.ExactValues {
args = append(args, "exact-values:::")
}

args = append(args, s.instructions.Volume...)
args = append(args, s.instructions.Expose...)
args = append(args, mapToSortedArgs(s.instructions.Env)...)
Expand Down Expand Up @@ -61,6 +67,10 @@ func mapToSortedArgs(h map[string]string) (result []string) {
}

func (s *DockerInstructionsStage) PrepareImage(ctx context.Context, c Conveyor, cr container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage) error {
if c.UseLegacyStapelBuilder(cr) {
stageImage.Image.SetCommitChangeOptions(container_backend.LegacyCommitChangeOptions{ExactValues: s.instructions.ExactValues})
}

if err := s.BaseStage.PrepareImage(ctx, c, cr, prevBuiltImage, stageImage); err != nil {
return err
}
Expand Down
2 changes: 2 additions & 0 deletions pkg/config/docker.go
View file
Expand Up @@ -11,6 +11,8 @@ type Docker struct {
Entrypoint string
HealthCheck string

ExactValues bool

raw *rawDocker
}

Expand Down
3 changes: 3 additions & 0 deletions pkg/config/raw_docker.go
View file
Expand Up @@ -16,6 +16,8 @@ type rawDocker struct {
Entrypoint interface{} `yaml:"ENTRYPOINT,omitempty"`
HealthCheck string `yaml:"HEALTHCHECK,omitempty"`

ExactValues bool `yaml:"exactValues,omitempty"`

rawStapelImage *rawStapelImage `yaml:"-"` // parent

UnsupportedAttributes map[string]interface{} `yaml:",inline"`
Expand Down Expand Up @@ -76,6 +78,7 @@ func (c *rawDocker) toDirective() (docker *Docker, err error) {
}

docker.HealthCheck = c.HealthCheck
docker.ExactValues = c.ExactValues

docker.raw = c

Expand Down
1 change: 1 addition & 0 deletions pkg/container_backend/legacy_interface.go
View file
Expand Up @@ -37,6 +37,7 @@ type LegacyImageInterface interface {

SetStageDescription(stage *image.StageDescription)
GetStageDescription() *image.StageDescription
SetCommitChangeOptions(opts LegacyCommitChangeOptions)

GetCopy() LegacyImageInterface
}
Expand Down
13 changes: 9 additions & 4 deletions pkg/container_backend/legacy_stage_image.go
View file
Expand Up @@ -15,10 +15,11 @@ import (

type LegacyStageImage struct {
*legacyBaseImage
fromImage *LegacyStageImage
container *LegacyStageImageContainer
buildImage *legacyBaseImage
builtID string
fromImage *LegacyStageImage
container *LegacyStageImageContainer
buildImage *legacyBaseImage
builtID string
commitChangeOptions LegacyCommitChangeOptions
}

func NewLegacyStageImage(fromImage *LegacyStageImage, name string, containerBackend ContainerBackend) *LegacyStageImage {
Expand All @@ -42,6 +43,10 @@ func (i *LegacyStageImage) GetCopy() LegacyImageInterface {
return ni
}

func (i *LegacyStageImage) SetCommitChangeOptions(opts LegacyCommitChangeOptions) {
i.commitChangeOptions = opts
}

func (i *LegacyStageImage) BuilderContainer() LegacyBuilderContainer {
return &LegacyStageImageBuilderContainer{i}
}
Expand Down
10 changes: 6 additions & 4 deletions pkg/container_backend/legacy_stage_image_container.go
View file
Expand Up @@ -40,7 +40,7 @@ func (c *LegacyStageImageContainer) Name() string {
}

func (c *LegacyStageImageContainer) UserCommitChanges() []string {
return c.commitChangeOptions.toCommitChanges()
return c.commitChangeOptions.toCommitChanges(c.image.commitChangeOptions)
}

func (c *LegacyStageImageContainer) UserRunCommands() []string {
Expand Down Expand Up @@ -201,13 +201,13 @@ func (c *LegacyStageImageContainer) prepareIntrospectOptions(ctx context.Context
return c.prepareRunOptions(ctx)
}

func (c *LegacyStageImageContainer) prepareCommitChanges(ctx context.Context) ([]string, error) {
func (c *LegacyStageImageContainer) prepareCommitChanges(ctx context.Context, opts LegacyCommitChangeOptions) ([]string, error) {
commitOptions, err := c.prepareCommitOptions(ctx)
if err != nil {
return nil, err
}

commitChanges, err := commitOptions.prepareCommitChanges(ctx)
commitChanges, err := commitOptions.prepareCommitChanges(ctx, opts)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -324,11 +324,13 @@ func IsStartContainerErr(err error) bool {
func (c *LegacyStageImageContainer) commit(ctx context.Context) (string, error) {
_ = c.image.ContainerBackend.(*DockerServerBackend)

commitChanges, err := c.prepareCommitChanges(ctx)
commitChanges, err := c.prepareCommitChanges(ctx, c.image.commitChangeOptions)
if err != nil {
return "", err
}

fmt.Printf("!!! LegacyStageImageContainer.commit Changes:%#v\n", commitChanges)

commitOptions := types.ContainerCommitOptions{Changes: commitChanges}
id, err := docker.ContainerCommit(ctx, c.name, commitOptions)
if err != nil {
Expand Down
100 changes: 76 additions & 24 deletions pkg/container_backend/legacy_stage_image_container_options.go
View file
Expand Up @@ -3,13 +3,20 @@ package container_backend
import (
"context"
"fmt"
"sort"

"github.com/hashicorp/go-version"

"github.com/werf/werf/pkg/docker"
)

type LegacyCommitChangeOptions struct {
ExactValues bool
}

type LegacyStageImageContainerOptions struct {
dockerServerVersion string

Volume []string
VolumesFrom []string
Expose []string
Expand Down Expand Up @@ -132,6 +139,19 @@ func (co *LegacyStageImageContainerOptions) merge(co2 *LegacyStageImageContainer
return mergedCo
}

func getKeys(m map[string]string) []string {
keys := make([]string, 0, len(m))
for k := range m {
keys = append(keys, k)
}
return keys
}

func sortStrings(arr []string) []string {
sort.Strings(arr)
return arr
}

func (co *LegacyStageImageContainerOptions) toRunArgs() ([]string, error) {
var args []string

Expand All @@ -143,12 +163,12 @@ func (co *LegacyStageImageContainerOptions) toRunArgs() ([]string, error) {
args = append(args, fmt.Sprintf("--volumes-from=%s", volumesFrom))
}

for key, value := range co.Env {
args = append(args, fmt.Sprintf("--env=%s=%v", key, value))
for _, k := range sortStrings(getKeys(co.Env)) {
args = append(args, fmt.Sprintf("--env=%s=%v", k, co.Env[k]))
}

for key, value := range co.Label {
args = append(args, fmt.Sprintf("--label=%s=%v", key, value))
for _, k := range sortStrings(getKeys(co.Label)) {
args = append(args, fmt.Sprintf("--label=%s=%v", k, co.Label[k]))
}

if co.User != "" {
Expand All @@ -166,23 +186,23 @@ func (co *LegacyStageImageContainerOptions) toRunArgs() ([]string, error) {
return args, nil
}

func (co *LegacyStageImageContainerOptions) toCommitChanges() []string {
func (co *LegacyStageImageContainerOptions) toCommitChanges(opts LegacyCommitChangeOptions) []string {
var args []string

for _, volume := range co.Volume {
args = append(args, fmt.Sprintf("VOLUME %s", volume))
args = append(args, fmt.Sprintf("VOLUME %s", escapeVolume(volume, opts.ExactValues)))
}

for _, expose := range co.Expose {
args = append(args, fmt.Sprintf("EXPOSE %s", expose))
args = append(args, fmt.Sprintf("EXPOSE %s", defaultEscape(expose, opts.ExactValues)))
}

for key, value := range co.Env {
args = append(args, fmt.Sprintf("ENV %s=%v", key, value))
for _, k := range sortStrings(getKeys(co.Env)) {
args = append(args, fmt.Sprintf("ENV %s=%s", k, defaultEscape(co.Env[k], opts.ExactValues)))
}

for key, value := range co.Label {
args = append(args, fmt.Sprintf("LABEL %s=%v", key, value))
for _, k := range sortStrings(getKeys(co.Label)) {
args = append(args, fmt.Sprintf("LABEL %s=%s", k, defaultEscape(co.Label[k], opts.ExactValues)))
}

if co.Cmd != "" {
Expand All @@ -208,23 +228,25 @@ func (co *LegacyStageImageContainerOptions) toCommitChanges() []string {
return args
}

func (co *LegacyStageImageContainerOptions) prepareCommitChanges(ctx context.Context) ([]string, error) {
func (co *LegacyStageImageContainerOptions) prepareCommitChanges(ctx context.Context, opts LegacyCommitChangeOptions) ([]string, error) {
var args []string

fmt.Printf("-- LegacyStageImageContainerOptions.prepareCommitChanges opts.ExactValues=%v\n", opts.ExactValues)

for _, volume := range co.Volume {
args = append(args, fmt.Sprintf("VOLUME %s", volume))
args = append(args, fmt.Sprintf("VOLUME %s", escapeVolume(volume, opts.ExactValues)))
}

for _, expose := range co.Expose {
args = append(args, fmt.Sprintf("EXPOSE %s", expose))
args = append(args, fmt.Sprintf("EXPOSE %s", defaultEscape(expose, opts.ExactValues)))
}

for key, value := range co.Env {
args = append(args, fmt.Sprintf("ENV %s=%v", key, value))
for _, k := range sortStrings(getKeys(co.Env)) {
args = append(args, fmt.Sprintf("ENV %s=%s", k, defaultEscape(co.Env[k], opts.ExactValues)))
}

for key, value := range co.Label {
args = append(args, fmt.Sprintf("LABEL %s=%v", key, value))
for _, k := range sortStrings(getKeys(co.Label)) {
args = append(args, fmt.Sprintf("LABEL %s=%s", k, defaultEscape(co.Label[k], opts.ExactValues)))
}

if co.Workdir != "" {
Expand All @@ -240,7 +262,7 @@ func (co *LegacyStageImageContainerOptions) prepareCommitChanges(ctx context.Con
if co.Entrypoint != "" {
entrypoint = co.Entrypoint
} else {
entrypoint, err = getEmptyEntrypointInstructionValue(ctx)
entrypoint, err = getEmptyEntrypointInstructionValue(ctx, co.dockerServerVersion)
if err != nil {
return nil, fmt.Errorf("container options preparing failed: %w", err)
}
Expand All @@ -261,13 +283,20 @@ func (co *LegacyStageImageContainerOptions) prepareCommitChanges(ctx context.Con
return args, nil
}

func getEmptyEntrypointInstructionValue(ctx context.Context) (string, error) {
v, err := docker.ServerVersion(ctx)
if err != nil {
return "", err
func getEmptyEntrypointInstructionValue(ctx context.Context, dockerServerVersion string) (string, error) {
var rawServerVersion string

if dockerServerVersion == "" {
v, err := docker.ServerVersion(ctx)
if err != nil {
return "", fmt.Errorf("unable to query docker server version: %w", err)
}
rawServerVersion = v.Version
} else {
rawServerVersion = dockerServerVersion
}

serverVersion, err := version.NewVersion(v.Version)
serverVersion, err := version.NewVersion(rawServerVersion)
if err != nil {
return "", err
}
Expand All @@ -283,3 +312,26 @@ func getEmptyEntrypointInstructionValue(ctx context.Context) (string, error) {

return "[\"\"]", nil
}

// FIXME: remove escaping in 2.0 or 1.3
func escapeVolume(volume string, exactValues bool) string {
if exactValues {
return fmt.Sprintf("[%s]", quoteValue(volume))
}
return volume
}

func defaultEscape(value string, exactValues bool) string {
return doEscape(value, exactValues, quoteValue)
}

func doEscape(value string, exactValues bool, escaper func(string) string) string {
if exactValues {
return escaper(value)
}
return value
}

func quoteValue(value string) string {
return fmt.Sprintf("%q", value)
}

0 comments on commit 9b3dbf9

Please sign in to comment.