mirror of
https://github.com/GoogleContainerTools/kaniko
synced 2026-10-04 10:51:53 +02:00
feat: cache dockerfile images through warmer (#2499)
* feat: cache dockerfile images through warmer * Fix logical error in conditional statement * Addressed review feedback 1. Updated help text for the --build-arg flag to indicate it should be used with the dockerfile flag. 2. Updated the documentation to include the optional --build-arg flag. 3. Added unit tests for `ParseDockerfile`, covering scenarios for missing Dockerfile, invalid Dockerfile, single stage Dockerfile, multi-stage Dockerfile and Args Dockerfile --------- Co-authored-by: 连奔驰 <benchi.lian@thoughtworks.com>
This commit is contained in:
alexezio
Vendored
+56
@@ -18,13 +18,18 @@ package cache
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"net/http"
|
||||
"os"
|
||||
"path"
|
||||
"regexp"
|
||||
|
||||
"github.com/GoogleContainerTools/kaniko/pkg/config"
|
||||
"github.com/GoogleContainerTools/kaniko/pkg/dockerfile"
|
||||
"github.com/GoogleContainerTools/kaniko/pkg/image/remote"
|
||||
"github.com/GoogleContainerTools/kaniko/pkg/util"
|
||||
"github.com/google/go-containerregistry/pkg/name"
|
||||
v1 "github.com/google/go-containerregistry/pkg/v1"
|
||||
"github.com/google/go-containerregistry/pkg/v1/tarball"
|
||||
@@ -34,8 +39,21 @@ import (
|
||||
|
||||
// WarmCache populates the cache
|
||||
func WarmCache(opts *config.WarmerOptions) error {
|
||||
var dockerfileImages []string
|
||||
cacheDir := opts.CacheDir
|
||||
images := opts.Images
|
||||
|
||||
// if opts.image is empty,we need to parse dockerfilepath to get images list
|
||||
if opts.DockerfilePath != "" {
|
||||
var err error
|
||||
if dockerfileImages, err = ParseDockerfile(opts); err != nil {
|
||||
return errors.Wrap(err, "failed to parse Dockerfile")
|
||||
}
|
||||
}
|
||||
|
||||
// TODO: Implement deduplication logic later.
|
||||
images = append(images, dockerfileImages...)
|
||||
|
||||
logrus.Debugf("%s\n", cacheDir)
|
||||
logrus.Debugf("%s\n", images)
|
||||
|
||||
@@ -157,3 +175,41 @@ func (w *Warmer) Warm(image string, opts *config.WarmerOptions) (v1.Hash, error)
|
||||
|
||||
return digest, nil
|
||||
}
|
||||
|
||||
func ParseDockerfile(opts *config.WarmerOptions) ([]string, error) {
|
||||
var err error
|
||||
var d []uint8
|
||||
var baseNames []string
|
||||
match, _ := regexp.MatchString("^https?://", opts.DockerfilePath)
|
||||
if match {
|
||||
response, e := http.Get(opts.DockerfilePath) //nolint:noctx
|
||||
if e != nil {
|
||||
return nil, e
|
||||
}
|
||||
d, err = ioutil.ReadAll(response.Body)
|
||||
} else {
|
||||
d, err = ioutil.ReadFile(opts.DockerfilePath)
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
return nil, errors.Wrap(err, fmt.Sprintf("reading dockerfile at path %s", opts.DockerfilePath))
|
||||
}
|
||||
|
||||
stages, _, err := dockerfile.Parse(d)
|
||||
if err != nil {
|
||||
return nil, errors.Wrap(err, "parsing dockerfile")
|
||||
}
|
||||
|
||||
for i, s := range stages {
|
||||
resolvedBaseName, err := util.ResolveEnvironmentReplacement(s.BaseName, opts.BuildArgs, false)
|
||||
if err != nil {
|
||||
return nil, errors.Wrap(err, fmt.Sprintf("resolving base name %s", s.BaseName))
|
||||
}
|
||||
if s.BaseName != resolvedBaseName {
|
||||
stages[i].BaseName = resolvedBaseName
|
||||
}
|
||||
baseNames = append(baseNames, resolvedBaseName)
|
||||
}
|
||||
return baseNames, nil
|
||||
|
||||
}
|
||||
|
||||
Vendored
+135
@@ -18,6 +18,8 @@ package cache
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"testing"
|
||||
|
||||
"github.com/GoogleContainerTools/kaniko/pkg/config"
|
||||
@@ -112,3 +114,136 @@ func Test_Warmer_Warm_in_cache_expired(t *testing.T) {
|
||||
t.Errorf("expected nothing to be written")
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDockerfile_SingleStageDockerfile(t *testing.T) {
|
||||
dockerfile := `FROM alpine:latest
|
||||
LABEL maintainer="alexezio"
|
||||
`
|
||||
tmpfile, err := ioutil.TempFile("", "example")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write([]byte(dockerfile)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
opts := &config.WarmerOptions{DockerfilePath: tmpfile.Name()}
|
||||
baseNames, err := ParseDockerfile(opts)
|
||||
if err != nil {
|
||||
t.Fatalf("expected no error, got %v", err)
|
||||
}
|
||||
if len(baseNames) != 1 {
|
||||
t.Fatalf("expected 1 base name, got %d", len(baseNames))
|
||||
}
|
||||
if baseNames[0] != "alpine:latest" {
|
||||
t.Fatalf("expected 'alpine:latest', got '%s'", baseNames[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDockerfile_MultiStageDockerfile(t *testing.T) {
|
||||
dockerfile := `FROM golang:1.20 as BUILDER
|
||||
LABEL maintainer="alexezio"
|
||||
|
||||
FROM alpine:latest as RUNNER
|
||||
LABEL maintainer="alexezio"
|
||||
`
|
||||
tmpfile, err := ioutil.TempFile("", "example")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write([]byte(dockerfile)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
opts := &config.WarmerOptions{DockerfilePath: tmpfile.Name()}
|
||||
baseNames, err := ParseDockerfile(opts)
|
||||
if err != nil {
|
||||
t.Fatalf("expected no error, got %v", err)
|
||||
}
|
||||
if len(baseNames) != 2 {
|
||||
t.Fatalf("expected 2 base name, got %d", len(baseNames))
|
||||
}
|
||||
if baseNames[0] != "golang:1.20" {
|
||||
t.Fatalf("expected 'golang:1.20', got '%s'", baseNames[0])
|
||||
}
|
||||
|
||||
if baseNames[1] != "alpine:latest" {
|
||||
t.Fatalf("expected 'alpine:latest', got '%s'", baseNames[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDockerfile_ArgsDockerfile(t *testing.T) {
|
||||
dockerfile := `ARG version=latest
|
||||
FROM golang:${version}
|
||||
`
|
||||
tmpfile, err := ioutil.TempFile("", "example")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write([]byte(dockerfile)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
opts := &config.WarmerOptions{DockerfilePath: tmpfile.Name(), BuildArgs: []string{"version=1.20"}}
|
||||
baseNames, err := ParseDockerfile(opts)
|
||||
if err != nil {
|
||||
t.Fatalf("expected no error, got %v", err)
|
||||
}
|
||||
if len(baseNames) != 1 {
|
||||
t.Fatalf("expected 1 base name, got %d", len(baseNames))
|
||||
}
|
||||
if baseNames[0] != "golang:1.20" {
|
||||
t.Fatalf("expected 'golang:1.20', got '%s'", baseNames[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDockerfile_MissingsDockerfile(t *testing.T) {
|
||||
opts := &config.WarmerOptions{DockerfilePath: "dummy-nowhere"}
|
||||
baseNames, err := ParseDockerfile(opts)
|
||||
if err == nil {
|
||||
t.Fatal("expected an error, got nil")
|
||||
}
|
||||
if len(baseNames) != 0 {
|
||||
t.Fatalf("expected no base names, got %d", len(baseNames))
|
||||
}
|
||||
}
|
||||
|
||||
func TestParseDockerfile_InvalidsDockerfile(t *testing.T) {
|
||||
dockerfile := "This is a invalid dockerfile"
|
||||
tmpfile, err := ioutil.TempFile("", "example")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.Remove(tmpfile.Name())
|
||||
|
||||
if _, err := tmpfile.Write([]byte(dockerfile)); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if err := tmpfile.Close(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
opts := &config.WarmerOptions{DockerfilePath: tmpfile.Name()}
|
||||
baseNames, err := ParseDockerfile(opts)
|
||||
if err == nil {
|
||||
t.Fatal("expected an error, got nil")
|
||||
}
|
||||
|
||||
if len(baseNames) != 0 {
|
||||
t.Fatalf("expected no base names, got %d", len(baseNames))
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user