Merge branch 'master' into fix-toc-in-readme

.golangci.yaml

@@ -0,0 +1,191 @@
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  deadline: 1m
+
+  # exit code when at least one issue was found, default is 1
+  issues-exit-code: 1
+
+  # include test files or not, default is true
+  tests: true
+
+  # list of build tags, all linters use it. Default is empty list.
+  build-tags:
+
+  # which dirs to skip: they won't be analyzed;
+  # can use regexp here: generated.*, regexp is applied on full path;
+  # default value is empty list, but next dirs are always skipped independently
+  # from this option's value:
+  #   	vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+  skip-dirs:
+
+  # which files to skip: they will be analyzed, but issues from them
+  # won't be reported. Default value is empty list, but there is
+  # no need to include all autogenerated files, we confidently recognize
+  # autogenerated files. If it's not please let us know.
+  skip-files:
+
+# output configuration options
+output:
+  # colored-line-number|line-number|json|tab|checkstyle, default is "colored-line-number"
+  format: colored-line-number
+
+  # print lines of code with issue, default is true
+  print-issued-lines: true
+
+  # print linter name in the end of issue text, default is true
+  print-linter-name: true
+
+
+# all available settings of specific linters
+linters-settings:
+  errcheck:
+    # report about not checking of errors in type assetions: `a := b.(MyStruct)`;
+    # default is false: such cases aren't reported by default.
+    check-type-assertions: false
+
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
+    # default is false: such cases aren't reported by default.
+    check-blank: false
+  govet:
+    # report about shadowed variables
+    #check-shadowing: true
+
+    # Obtain type information from installed (to $GOPATH/pkg) package files:
+    # golangci-lint will execute `go install -i` and `go test -i` for analyzed packages
+    # before analyzing them.
+    # By default this option is disabled and govet gets type information by loader from source code.
+    # Loading from source code is slow, but it's done only once for all linters.
+    # Go-installing of packages first time is much slower than loading them from source code,
+    # therefore this option is disabled by default.
+    # But repeated installation is fast in go >= 1.10 because of build caching.
+    # Enable this option only if all conditions are met:
+    #  1. you use only "fast" linters (--fast e.g.): no program loading occurs
+    #  2. you use go >= 1.10
+    #  3. you do repeated runs (false for CI) or cache $GOPATH/pkg or `go env GOCACHE` dir in CI.
+    #use-installed-packages: false
+  golint:
+    # minimal confidence for issues, default is 0.8
+    min-confidence: 0.8
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
+  #gocyclo:
+  #  # minimal code complexity to report, 30 by default (but we recommend 10-20)
+  #  min-complexity: 10
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
+  #dupl:
+  #  # tokens count to trigger issue, 150 by default
+  #  threshold: 100
+  goconst:
+    # minimal length of string constant, 3 by default
+    min-len: 3
+    # minimal occurrences count to trigger, 3 by default
+    min-occurrences: 3
+  #depguard:
+  #  list-type: blacklist
+  #  include-go-root: false
+  #  packages:
+  #    - github.com/davecgh/go-spew/spew
+  misspell:
+    # Correct spellings using locale preferences for US or UK.
+    # Default is to use a neutral variety of English.
+    # Setting locale to US will correct the British spelling of 'colour' to 'color'.
+    locale: US
+  #lll:
+  #  # max line length, lines longer will be reported. Default is 120.
+  #  # '\t' is counted as 1 character by default, and can be changed with the tab-width option
+  #  line-length: 120
+  #  # tab width in spaces. Default to 1.
+  #  tab-width: 1
+  unused:
+    # treat code as a program (not a library) and report unused exported identifiers; default is false.
+    # XXX: if you enable this setting, unused will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find funcs usages. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+  unparam:
+    # call graph construction algorithm (cha, rta). In general, use cha for libraries,
+    # and rta for programs with main packages. Default is cha.
+    algo: cha
+
+    # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
+    # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
+    # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
+    # with golangci-lint call it on a directory with the changed file.
+    check-exported: false
+  #nakedret:
+  #  # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
+  #  max-func-lines: 30
+  #prealloc:
+  #  # XXX: we don't recommend using this linter before doing performance profiling.
+  #  # For most programs usage of prealloc will be a premature optimization.
+
+  #  # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them.
+  #  # True by default.
+  #  simple: true
+  #  range-loops: true # Report preallocation suggestions on range loops, true by default
+  #  for-loops: false # Report preallocation suggestions on for loops, false by default
+
+
+linters:
+  enable:
+    - goconst
+    - goimports
+    - golint
+    - interfacer
+    - maligned
+    - misspell
+    - unconvert
+    - unparam
+  enable-all: false
+  disable:
+    - errcheck
+    - gas
+  disable-all: false
+  presets:
+    - bugs
+    - unused
+  fast: false
+
+
+issues:
+  # List of regexps of issue texts to exclude, empty list by default.
+  # But independently from this option we use default exclude patterns,
+  # it can be disabled by `exclude-use-default: false`. To list all
+  # excluded by default patterns execute `golangci-lint run --help`
+  exclude:
+
+  # Independently from option `exclude` we use default exclude patterns,
+  # it can be disabled by this option. To list all
+  # excluded by default patterns execute `golangci-lint run --help`.
+  # Default value for this option is true.
+  exclude-use-default: true
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-per-linter: 50
+
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same: 3
+
+  # Show only new issues: if there are unstaged changes or untracked files,
+  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
+  # It's a super-useful option for integration of golangci-lint into existing
+  # large codebase. It's not practical to fix all existing issues at the moment
+  # of integration: much better don't allow issues in new code.
+  # Default is false.
+  new: false
+
+  ## Show only new issues created after git revision `REV`
+  #new-from-rev: REV
+
+  ## Show only new issues created in git patch with set file path.
+  #new-from-patch: path/to/patch/file

README.md

@@ -88,7 +88,10 @@ After each command, we append a layer of changed files to the base image (if the
 
 ## Known Issues
 
-kaniko does not support building Windows containers.
+* kaniko does not support building Windows containers.
+* Running kaniko in any Docker image other than the official kaniko image is not supported (ie YMMV).
+  * This includes copying the kaniko executables from the official image into another image.
+* kaniko does not support the v1 Registry API ([Registry v1 API Deprecation](https://engineering.docker.com/2019/03/registry-v1-api-deprecation/))
 
 ## Demo
 
@@ -285,7 +288,7 @@ as a remote image destination:
 ### Caching
 
 #### Caching Layers
-kaniko currently can cache layers created by `RUN` commands in a remote repository.
+kaniko can cache layers created by `RUN` commands in a remote repository.
 Before executing a command, kaniko checks the cache for the layer.
 If it exists, kaniko will pull and extract the cached layer instead of executing the command.
 If not, kaniko will execute the command and then push the newly created layer to the cache.
@@ -296,7 +299,7 @@ If this flag isn't provided, a cached repo will be inferred from the `--destinat
 
 #### Caching Base Images
 
-kaniko can cache images in a local directory that can be volume mounted into the kaniko image.
+kaniko can cache images in a local directory that can be volume mounted into the kaniko pod.
 To do so, the cache must first be populated, as it is read-only. We provide a kaniko cache warming
 image at `gcr.io/kaniko-project/warmer`:
 
@@ -307,7 +310,7 @@ docker run -v $(pwd):/workspace gcr.io/kaniko-project/warmer:latest --cache-dir=
 `--image` can be specified for any number of desired images.
 This command will cache those images by digest in a local directory named `cache`.
 Once the cache is populated, caching is opted into with the same `--cache=true` flag as above.
-The location of the local cache is provided via the `--cache-dir` flag, defaulting at `/cache` as with the cache warmer.
+The location of the local cache is provided via the `--cache-dir` flag, defaulting to `/cache` as with the cache warmer.
 See the `examples` directory for how to use with kubernetes clusters and persistent cache volumes.
 
 ### Pushing to Different Registries
@@ -343,7 +346,7 @@ Run kaniko with the `config.json` inside `/kaniko/.docker/config.json`
 The Amazon ECR [credential helper](https://github.com/awslabs/amazon-ecr-credential-helper) is built in to the kaniko executor image.
 To configure credentials, you will need to do the following:
 
-1. Update the `credHelpers` section of [config.json](https://github.com/GoogleContainerTools/kaniko/blob/master/files/config.json) with the specific URI of your ECR registry:
+1. Update the `credHelpers` section of [config.json](https://github.com/awslabs/amazon-ecr-credential-helper#configuration) with the specific URI of your ECR registry:
 
   ```json
   {

hack/linter.sh

@@ -23,15 +23,4 @@ if ! [ -x "$(command -v golangci-lint)" ]; then
 	${DIR}/install_golint.sh -b $GOPATH/bin v1.9.3
 fi
 
-golangci-lint run \
-	--no-config \
-	-E goconst \
-	-E goimports \
-	-E golint \
-	-E interfacer \
-	-E maligned \
-	-E misspell \
-	-E unconvert \
-	-E unparam \
-	-D errcheck \
-	-D gas
+golangci-lint run

integration/dockerfiles/Dockerfile_test_add_dest_symlink_dir

@@ -0,0 +1,2 @@
+FROM phusion/baseimage:0.11
+ADD context/foo /etc/service/foo

integration/dockerfiles/Dockerfile_test_add_url_with_arg

@@ -0,0 +1,6 @@
+FROM busybox:1.31
+
+ARG REPO=kaniko
+ARG VERSION=v0.14.0
+
+ADD https://github.com/GoogleContainerTools/$REPO/archive/$VERSION.tar.gz /tmp/release.tar.gz

pkg/cache/cache.go

@@ -28,7 +28,7 @@ import (
 	"github.com/GoogleContainerTools/kaniko/pkg/config"
 	"github.com/GoogleContainerTools/kaniko/pkg/creds"
 	"github.com/google/go-containerregistry/pkg/name"
-	"github.com/google/go-containerregistry/pkg/v1"
+	v1 "github.com/google/go-containerregistry/pkg/v1"
 	"github.com/google/go-containerregistry/pkg/v1/remote"
 	"github.com/google/go-containerregistry/pkg/v1/tarball"
 	"github.com/pkg/errors"
@@ -124,7 +124,8 @@ func LocalSource(opts *config.CacheOptions, cacheKey string) (v1.Image, error) {
 
 	fi, err := os.Stat(path)
 	if err != nil {
-		return nil, errors.Wrap(err, "getting file info")
+		logrus.Debugf("No file found for cache key %v %v", cacheKey, err)
+		return nil, nil
 	}
 
 	// A stale cache is a bad cache

pkg/commands/add.go

@@ -141,3 +141,7 @@ func (a *AddCommand) FilesUsedFromContext(config *v1.Config, buildArgs *dockerfi
 func (a *AddCommand) MetadataOnly() bool {
 	return false
 }
+
+func (a *AddCommand) RequiresUnpackedFS() bool {
+	return true
+}

pkg/commands/commands.go

@@ -17,13 +17,20 @@ limitations under the License.
 package commands
 
 import (
+	"github.com/GoogleContainerTools/kaniko/pkg/constants"
 	"github.com/GoogleContainerTools/kaniko/pkg/dockerfile"
 	v1 "github.com/google/go-containerregistry/pkg/v1"
 	"github.com/moby/buildkit/frontend/dockerfile/instructions"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 )
 
+var RootDir string
+
+func init() {
+	RootDir = constants.RootDir
+}
+
 type CurrentCacheKey func() (string, error)
 
 type DockerCommand interface {

pkg/commands/copy.go

@@ -66,6 +66,14 @@ func (c *CopyCommand) ExecuteCommand(config *v1.Config, buildArgs *dockerfile.Bu
 		if err != nil {
 			return err
 		}
+
+		// If the destination dir is a symlink we need to resolve the path and use
+		// that instead of the symlink path
+		destPath, err = resolveIfSymlink(destPath)
+		if err != nil {
+			return err
+		}
+
 		if fi.IsDir() {
 			if !filepath.IsAbs(dest) {
 				// we need to add '/' to the end to indicate the destination is a directory
@@ -163,7 +171,7 @@ type CachingCopyCommand struct {
 func (cr *CachingCopyCommand) ExecuteCommand(config *v1.Config, buildArgs *dockerfile.BuildArgs) error {
 	logrus.Infof("Found cached layer, extracting to filesystem")
 	var err error
-	cr.extractedFiles, err = util.GetFSFromImage(constants.RootDir, cr.img)
+	cr.extractedFiles, err = util.GetFSFromImage(RootDir, cr.img)
 	logrus.Infof("extractedFiles: %s", cr.extractedFiles)
 	if err != nil {
 		return errors.Wrap(err, "extracting fs from image")
@@ -178,3 +186,21 @@ func (cr *CachingCopyCommand) FilesToSnapshot() []string {
 func (cr *CachingCopyCommand) String() string {
 	return cr.cmd.String()
 }
+
+func resolveIfSymlink(destPath string) (string, error) {
+	baseDir := filepath.Dir(destPath)
+	if info, err := os.Lstat(baseDir); err == nil {
+		switch mode := info.Mode(); {
+		case mode&os.ModeSymlink != 0:
+			linkPath, err := os.Readlink(baseDir)
+			if err != nil {
+				return "", errors.Wrap(err, "error reading symlink")
+			}
+			absLinkPath := filepath.Join(filepath.Dir(baseDir), linkPath)
+			newPath := filepath.Join(absLinkPath, filepath.Base(destPath))
+			logrus.Tracef("Updating destination path from %v to %v due to symlink", destPath, newPath)
+			return newPath, nil
+		}
+	}
+	return destPath, nil
+}