Refactor build into stageBuilder type #343
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,6 +30,7 @@ import ( | |
| "github.com/google/go-containerregistry/pkg/v1" | ||
| "github.com/google/go-containerregistry/pkg/v1/mutate" | ||
| "github.com/google/go-containerregistry/pkg/v1/tarball" | ||
| "github.com/pkg/errors" | ||
| "github.com/sirupsen/logrus" | ||
|
|
||
| "github.com/GoogleContainerTools/kaniko/pkg/commands" | ||
|
|
@@ -40,112 +41,160 @@ import ( | |
| "github.com/GoogleContainerTools/kaniko/pkg/util" | ||
| ) | ||
|
|
||
| // stageBuilder contains all fields necessary to build one stage of a Dockerfile | ||
| type stageBuilder struct { | ||
| stage config.KanikoStage | ||
| v1.Image | ||
| *v1.ConfigFile | ||
| *snapshot.Snapshotter | ||
| baseImageDigest string | ||
| } | ||
|
|
||
| // newStageBuilder returns a new type stageBuilder which contains all the information required to build the stage | ||
| func newStageBuilder(opts *config.KanikoOptions, stage config.KanikoStage) (*stageBuilder, error) { | ||
| sourceImage, err := util.RetrieveSourceImage(stage, opts.BuildArgs) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| imageConfig, err := util.RetrieveConfigFile(sourceImage) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if err := resolveOnBuild(&stage, &imageConfig.Config); err != nil { | ||
| return nil, err | ||
| } | ||
| hasher, err := getHasher(opts.SnapshotMode) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| l := snapshot.NewLayeredMap(hasher) | ||
| snapshotter := snapshot.NewSnapshotter(l, constants.RootDir) | ||
|
|
||
| digest, err := sourceImage.Digest() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &stageBuilder{ | ||
| stage: stage, | ||
| Image: sourceImage, | ||
| ConfigFile: imageConfig, | ||
| Snapshotter: snapshotter, | ||
| baseImageDigest: digest.String(), | ||
| }, nil | ||
| } | ||
|
|
||
| // key will return a string representation of the build at the cmd | ||
| // TODO: priyawadhwa@ to fill this out when implementing caching | ||
| func (s *stageBuilder) key(cmd string) (string, error) { | ||
| return "", nil | ||
| } | ||
|
|
||
| // extractCachedLayer will extract the cached layer and append it to the config file | ||
| // TODO: priyawadhwa@ to fill this out when implementing caching | ||
| func (s *stageBuilder) extractCachedLayer(layer v1.Image, createdBy string) error { | ||
| return nil | ||
| } | ||
|
|
||
| func (s *stageBuilder) buildStage(opts *config.KanikoOptions) error { | ||
| // Unpack file system to root | ||
| if err := util.GetFSFromImage(constants.RootDir, s.Image); err != nil { | ||
| return err | ||
| } | ||
| // Take initial snapshot | ||
| if err := s.Snapshotter.Init(); err != nil { | ||
| return err | ||
| } | ||
| buildArgs := dockerfile.NewBuildArgs(opts.BuildArgs) | ||
|
There was a problem hiding this comment. use shorter names when possible https://github.com/golang/go/wiki/CodeReviewComments#variable-names |
||
| for index, cmd := range s.stage.Commands { | ||
| finalCmd := index == len(s.stage.Commands)-1 | ||
| dockerCommand, err := commands.GetCommand(cmd, opts.SrcContext) | ||
|
There was a problem hiding this comment. cmd is being used as the iterator here, maybe command if we really want to shorten it? |
||
| if err != nil { | ||
| return err | ||
| } | ||
| if dockerCommand == nil { | ||
| continue | ||
| } | ||
| logrus.Info(dockerCommand.String()) | ||
| if err := dockerCommand.ExecuteCommand(&s.ConfigFile.Config, buildArgs); err != nil { | ||
| return err | ||
| } | ||
| snapshotFiles := dockerCommand.FilesToSnapshot() | ||
|
There was a problem hiding this comment. nit: use shorter variables names wherever possible. |
||
| var contents []byte | ||
|
|
||
| // If this is an intermediate stage, we only snapshot for the last command and we | ||
| // want to snapshot the entire filesystem since we aren't tracking what was changed | ||
| // by previous commands. | ||
| if !s.stage.FinalStage { | ||
|
There was a problem hiding this comment.
|
||
| if finalCmd { | ||
| contents, err = s.Snapshotter.TakeSnapshotFS() | ||
| } | ||
| } else { | ||
| // If we are in single snapshot mode, we only take a snapshot once, after all | ||
| // commands have completed. | ||
| if opts.SingleSnapshot { | ||
| if finalCmd { | ||
| contents, err = s.Snapshotter.TakeSnapshotFS() | ||
| } | ||
| } else { | ||
| // Otherwise, in the final stage we take a snapshot at each command. If we know | ||
| // the files that were changed, we'll snapshot those explicitly, otherwise we'll | ||
| // check if anything in the filesystem changed. | ||
| if snapshotFiles != nil { | ||
| contents, err = s.Snapshotter.TakeSnapshot(snapshotFiles) | ||
| } else { | ||
| contents, err = s.Snapshotter.TakeSnapshotFS() | ||
| } | ||
| } | ||
| } | ||
| if err != nil { | ||
| return fmt.Errorf("Error taking snapshot of files for command %s: %s", dockerCommand, err) | ||
| } | ||
|
|
||
| util.MoveVolumeWhitelistToWhitelist() | ||
| if contents == nil { | ||
| logrus.Info("No files were changed, appending empty layer to config. No layer added to image.") | ||
| continue | ||
| } | ||
| // Append the layer to the image | ||
| opener := func() (io.ReadCloser, error) { | ||
| return ioutil.NopCloser(bytes.NewReader(contents)), nil | ||
| } | ||
| layer, err := tarball.LayerFromOpener(opener) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| s.Image, err = mutate.Append(s.Image, | ||
| mutate.Addendum{ | ||
| Layer: layer, | ||
| History: v1.History{ | ||
| Author: constants.Author, | ||
| CreatedBy: dockerCommand.String(), | ||
| }, | ||
| }, | ||
| ) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // DoBuild executes building the Dockerfile | ||
| func DoBuild(opts *config.KanikoOptions) (v1.Image, error) { | ||
| // Parse dockerfile and unpack base image to root | ||
| stages, err := dockerfile.Stages(opts) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| for index, stage := range stages { | ||
| stageBuilder, err := newStageBuilder(opts, stage) | ||
|
There was a problem hiding this comment. |
||
| if err != nil { | ||
| return nil, errors.Wrap(err, fmt.Sprintf("getting stage builder for stage %d", index)) | ||
| } | ||
| if err := stageBuilder.buildStage(opts); err != nil { | ||
| return nil, errors.Wrap(err, "error building stage") | ||
| } | ||
| sourceImage, err := mutate.Config(stageBuilder.Image, stageBuilder.ConfigFile.Config) | ||
|
There was a problem hiding this comment. if this is the only image. Use |
||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid Stuttering stageBuilder.buildStage().
Just
stageBuilder.build()suffix