kaniko/pkg/util/command_util_test.go

/*
Copyright 2018 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package util

import (
	"fmt"
	"os/user"
	"reflect"
	"sort"
	"strconv"
	"testing"

	"github.com/GoogleContainerTools/kaniko/testutil"
	v1 "github.com/google/go-containerregistry/pkg/v1"
	"github.com/moby/buildkit/frontend/dockerfile/instructions"
)

var testURL = "https://github.com/GoogleContainerTools/runtimes-common/blob/master/LICENSE"

var testEnvReplacement = []struct {
	path         string
	envs         []string
	isFilepath   bool
	expectedPath string
}{
	{
		path: "/simple/path",
		envs: []string{
			"simple=/path/",
		},
		isFilepath:   true,
		expectedPath: "/simple/path",
	},
	{
		path: "/simple/path/",
		envs: []string{
			"simple=/path/",
		},
		isFilepath:   true,
		expectedPath: "/simple/path/",
	},
	{
		path: "$simple",
		envs: []string{
			"simple=/path/",
		},
		isFilepath:   true,
		expectedPath: "/path/",
	},
	{
		path: "${a}/b",
		envs: []string{
			"a=/path/",
			"b=/path2/",
		},
		isFilepath:   true,
		expectedPath: "/path/b",
	},
	{
		path: "/$a/b",
		envs: []string{
			"a=/path/",
			"b=/path2/",
		},
		isFilepath:   true,
		expectedPath: "/path/b",
	},
	{
		path: "/$a/b/",
		envs: []string{
			"a=/path/",
			"b=/path2/",
		},
		isFilepath:   true,
		expectedPath: "/path/b/",
	},
	{
		path: "\\$foo",
		envs: []string{
			"foo=/path/",
		},
		isFilepath:   true,
		expectedPath: "$foo",
	},
	{
		path: "8080/$protocol",
		envs: []string{
			"protocol=udp",
		},
		expectedPath: "8080/udp",
	},
	{
		path: "8080/$protocol",
		envs: []string{
			"protocol=udp",
		},
		expectedPath: "8080/udp",
	},
	{
		path: "$url",
		envs: []string{
			"url=http://example.com",
		},
		isFilepath:   true,
		expectedPath: "http://example.com",
	},
	{
		path: "$url",
		envs: []string{
			"url=http://example.com",
		},
		isFilepath:   false,
		expectedPath: "http://example.com",
	},
}

func Test_EnvReplacement(t *testing.T) {
	for _, test := range testEnvReplacement {
		actualPath, err := ResolveEnvironmentReplacement(test.path, test.envs, test.isFilepath)
		testutil.CheckErrorAndDeepEqual(t, false, err, test.expectedPath, actualPath)

	}
}

var buildContextPath = "../../integration/"

var destinationFilepathTests = []struct {
	src              string
	dest             string
	cwd              string
	expectedFilepath string
}{
	{
		src:              "context/foo",
		dest:             "/foo",
		cwd:              "/",
		expectedFilepath: "/foo",
	},
	{
		src:              "context/foo",
		dest:             "/foodir/",
		cwd:              "/",
		expectedFilepath: "/foodir/foo",
	},
	{
		src:              "context/foo",
		cwd:              "/",
		dest:             "foo",
		expectedFilepath: "/foo",
	},
	{
		src:              "context/bar/",
		cwd:              "/",
		dest:             "pkg/",
		expectedFilepath: "/pkg/",
	},
	{
		src:              "context/bar/",
		cwd:              "/newdir",
		dest:             "pkg/",
		expectedFilepath: "/newdir/pkg/",
	},
	{
		src:              "./context/empty",
		cwd:              "/",
		dest:             "/empty",
		expectedFilepath: "/empty",
	},
	{
		src:              "./context/empty",
		cwd:              "/dir",
		dest:             "/empty",
		expectedFilepath: "/empty",
	},
	{
		src:              "./",
		cwd:              "/",
		dest:             "/dir",
		expectedFilepath: "/dir/",
	},
	{
		src:              "context/foo",
		cwd:              "/test",
		dest:             ".",
		expectedFilepath: "/test/foo",
	},
}

func Test_DestinationFilepath(t *testing.T) {
	for _, test := range destinationFilepathTests {
		actualFilepath, err := DestinationFilepath(test.src, test.dest, test.cwd)
		testutil.CheckErrorAndDeepEqual(t, false, err, test.expectedFilepath, actualFilepath)
	}
}

var urlDestFilepathTests = []struct {
	url          string
	cwd          string
	dest         string
	expectedDest string
	envs         []string
}{
	{
		url:          "https://something/something",
		cwd:          "/test",
		dest:         ".",
		expectedDest: "/test/something",
	},
	{
		url:          "https://something/something",
		cwd:          "/cwd",
		dest:         "/test",
		expectedDest: "/test",
	},
	{
		url:          "https://something/something",
		cwd:          "/test",
		dest:         "/dest/",
		expectedDest: "/dest/something",
	},
	{
		url:          "https://something/$foo.tar.gz",
		cwd:          "/test",
		dest:         "/foo/",
		expectedDest: "/foo/bar.tar.gz",
		envs:         []string{"foo=bar"},
	},
}

func Test_UrlDestFilepath(t *testing.T) {
	for _, test := range urlDestFilepathTests {
		actualDest, err := URLDestinationFilepath(test.url, test.dest, test.cwd, test.envs)
		testutil.CheckErrorAndDeepEqual(t, false, err, test.expectedDest, actualDest)
	}
}

var matchSourcesTests = []struct {
	srcs          []string
	files         []string
	expectedFiles []string
}{
	{
		srcs: []string{
			"pkg/*",
			"/root/dir?",
			testURL,
		},
		files: []string{
			"pkg/a",
			"pkg/b",
			"/pkg/d",
			"pkg/b/d/",
			"dir/",
			"root/dir1",
		},
		expectedFiles: []string{
			"/root/dir1",
			"pkg/a",
			"pkg/b",
			testURL,
		},
	},
}

func Test_MatchSources(t *testing.T) {
	for _, test := range matchSourcesTests {
		actualFiles, err := matchSources(test.srcs, test.files)
		sort.Strings(actualFiles)
		sort.Strings(test.expectedFiles)
		testutil.CheckErrorAndDeepEqual(t, false, err, test.expectedFiles, actualFiles)
	}
}

var updateConfigEnvTests = []struct {
	name            string
	envVars         []instructions.KeyValuePair
	config          *v1.Config
	replacementEnvs []string
	expectedEnv     []string
}{
	{
		name: "test env config update",
		envVars: []instructions.KeyValuePair{
			{
				Key:   "key",
				Value: "var",
			},
			{
				Key:   "foo",
				Value: "baz",
			}},
		config:          &v1.Config{},
		replacementEnvs: []string{},
		expectedEnv:     []string{"key=var", "foo=baz"},
	}, {
		name: "test env config update with replacmenets",
		envVars: []instructions.KeyValuePair{
			{
				Key:   "key",
				Value: "/var/run",
			},
			{
				Key:   "env",
				Value: "$var",
			},
			{
				Key:   "foo",
				Value: "$argarg",
			}},
		config:          &v1.Config{},
		replacementEnvs: []string{"var=/test/with'chars'/", "not=used", "argarg=\"a\"b\""},
		expectedEnv:     []string{"key=/var/run", "env=/test/with'chars'/", "foo=\"a\"b\""},
	}, {
		name: "test env config update replacing existing variable",
		envVars: []instructions.KeyValuePair{
			{
				Key:   "alice",
				Value: "nice",
			},
			{
				Key:   "bob",
				Value: "cool",
			}},
		config:          &v1.Config{Env: []string{"bob=used", "more=test"}},
		replacementEnvs: []string{},
		expectedEnv:     []string{"bob=cool", "more=test", "alice=nice"},
	},
}

func Test_UpdateConfigEnvTests(t *testing.T) {
	for _, test := range updateConfigEnvTests {
		t.Run(test.name, func(t *testing.T) {
			if err := UpdateConfigEnv(test.envVars, test.config, test.replacementEnvs); err != nil {
				t.Fatalf("error updating config with env vars: %s", err)
			}
			testutil.CheckDeepEqual(t, test.expectedEnv, test.config.Env)
		})
	}
}

var isSrcValidTests = []struct {
	name            string
	srcsAndDest     []string
	resolvedSources []string
	shouldErr       bool
}{
	{
		name: "dest isn't directory",
		srcsAndDest: []string{
			"context/foo",
			"context/bar",
			"dest",
		},
		resolvedSources: []string{
			"context/foo",
			"context/bar",
		},
		shouldErr: true,
	},
	{
		name: "dest is directory",
		srcsAndDest: []string{
			"context/foo",
			"context/bar",
			"dest/",
		},
		resolvedSources: []string{
			"context/foo",
			"context/bar",
		},
		shouldErr: false,
	},
	{
		name: "copy file to file",
		srcsAndDest: []string{
			"context/bar/bam",
			"dest",
		},
		resolvedSources: []string{
			"context/bar/bam",
		},
		shouldErr: false,
	},
	{
		name: "copy files with wildcards to dir",
		srcsAndDest: []string{
			"context/foo",
			"context/b*",
			"dest/",
		},
		resolvedSources: []string{
			"context/foo",
			"context/bar",
		},
		shouldErr: false,
	},
	{
		name: "copy multilple files with wildcards to file",
		srcsAndDest: []string{
			"context/foo",
			"context/b*",
			"dest",
		},
		resolvedSources: []string{
			"context/foo",
			"context/bar",
		},
		shouldErr: true,
	},
	{
		name: "copy two files to file, one of which doesn't exist",
		srcsAndDest: []string{
			"context/foo",
			"context/doesntexist*",
			"dest",
		},
		resolvedSources: []string{
			"context/foo",
		},
		shouldErr: false,
	},
	{
		name: "copy dir to dest not specified as dir",
		srcsAndDest: []string{
			"context/",
			"dest",
		},
		resolvedSources: []string{
			"context/",
		},
		shouldErr: false,
	},
	{
		name: "copy url to file",
		srcsAndDest: []string{
			testURL,
			"dest",
		},
		resolvedSources: []string{
			testURL,
		},
		shouldErr: false,
	},
	{
		name: "copy two srcs, one excluded, to file",
		srcsAndDest: []string{
			"ignore/foo",
			"ignore/bar",
			"dest",
		},
		resolvedSources: []string{
			"ignore/foo",
			"ignore/bar",
		},
		shouldErr: false,
	},
	{
		name: "copy two srcs, both excluded, to file",
		srcsAndDest: []string{
			"ignore/baz",
			"ignore/bar",
			"dest",
		},
		resolvedSources: []string{
			"ignore/baz",
			"ignore/bar",
		},
		shouldErr: true,
	},
}

func Test_IsSrcsValid(t *testing.T) {
	for _, test := range isSrcValidTests {
		t.Run(test.name, func(t *testing.T) {
			fileContext, err := NewFileContextFromDockerfile("", buildContextPath)
			if err != nil {
				t.Fatalf("error creating file context: %v", err)
			}
			err = IsSrcsValid(instructions.SourcesAndDest{SourcePaths: test.srcsAndDest[0 : len(test.srcsAndDest)-1], DestPath: test.srcsAndDest[len(test.srcsAndDest)-1]}, test.resolvedSources, fileContext)
			testutil.CheckError(t, test.shouldErr, err)
		})
	}
}

var testResolveSources = []struct {
	srcsAndDest  []string
	expectedList []string
}{
	{
		srcsAndDest: []string{
			"context/foo",
			"context/b*",
			testURL,
		},
		expectedList: []string{
			"context/foo",
			"context/bar",
			testURL,
		},
	},
}

func Test_ResolveSources(t *testing.T) {
	for _, test := range testResolveSources {
		actualList, err := ResolveSources(test.srcsAndDest, buildContextPath)
		testutil.CheckErrorAndDeepEqual(t, false, err, test.expectedList, actualList)
	}
}

func TestGetUserGroup(t *testing.T) {
	tests := []struct {
		description  string
		chown        string
		env          []string
		mockIDGetter func(userStr string, groupStr string, fallbackToUID bool) (uint32, uint32, error)
		// needed, in case uid is a valid number, but group is a name
		mockGroupIDGetter func(groupStr string) (*user.Group, error)
		expectedU         int64
		expectedG         int64
		shdErr            bool
	}{
		{
			description: "non empty chown",
			chown:       "some:some",
			env:         []string{},
			mockIDGetter: func(string, string, bool) (uint32, uint32, error) {
				return 100, 1000, nil
			},
			expectedU: 100,
			expectedG: 1000,
		},
		{
			description: "non empty chown with env replacement",
			chown:       "some:$foo",
			env:         []string{"foo=key"},
			mockIDGetter: func(userStr string, groupStr string, fallbackToUID bool) (uint32, uint32, error) {
				if userStr == "some" && groupStr == "key" {
					return 10, 100, nil
				}
				return 0, 0, fmt.Errorf("did not resolve environment variable")
			},
			expectedU: 10,
			expectedG: 100,
		},
		{
			description: "empty chown string",
			mockIDGetter: func(string, string, bool) (uint32, uint32, error) {
				return 0, 0, fmt.Errorf("should not be called")
			},
			expectedU: -1,
			expectedG: -1,
		},
	}
	for _, tc := range tests {
		t.Run(tc.description, func(t *testing.T) {
			originalIDGetter := getUIDAndGIDFunc
			defer func() {
				getUIDAndGIDFunc = originalIDGetter
			}()
			getUIDAndGIDFunc = tc.mockIDGetter
			uid, gid, err := GetUserGroup(tc.chown, tc.env)
			testutil.CheckErrorAndDeepEqual(t, tc.shdErr, err, uid, tc.expectedU)
			testutil.CheckErrorAndDeepEqual(t, tc.shdErr, err, gid, tc.expectedG)
		})
	}
}

func TestResolveEnvironmentReplacementList(t *testing.T) {
	type args struct {
		values     []string
		envs       []string
		isFilepath bool
	}
	tests := []struct {
		name    string
		args    args
		want    []string
		wantErr bool
	}{
		{
			name: "url",
			args: args{
				values: []string{
					"https://google.com/$foo", "$bar", "$url",
				},
				envs: []string{
					"foo=baz",
					"bar=bat",
					"url=https://google.com",
				},
			},
			want: []string{"https://google.com/baz", "bat", "https://google.com"},
		},
		{
			name: "mixed",
			args: args{
				values: []string{
					"$foo", "$bar$baz", "baz",
				},
				envs: []string{
					"foo=FOO",
					"bar=BAR",
					"baz=BAZ",
				},
			},
			want: []string{"FOO", "BARBAZ", "baz"},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := ResolveEnvironmentReplacementList(tt.args.values, tt.args.envs, tt.args.isFilepath)
			if (err != nil) != tt.wantErr {
				t.Errorf("ResolveEnvironmentReplacementList() error = %v, wantErr %v", err, tt.wantErr)
				return
			}
			if !reflect.DeepEqual(got, tt.want) {
				t.Errorf("ResolveEnvironmentReplacementList() = %v, want %v", got, tt.want)
			}
		})
	}
}

func Test_GetUIDAndGIDFromString(t *testing.T) {
	currentUser := testutil.GetCurrentUser(t)

	type args struct {
		userGroupStr  string
		fallbackToUID bool
	}

	type expected struct {
		userID  uint32
		groupID uint32
	}

	currentUserUID, _ := strconv.ParseUint(currentUser.Uid, 10, 32)
	currentUserGID, _ := strconv.ParseUint(currentUser.Gid, 10, 32)
	expectedCurrentUser := expected{
		userID:  uint32(currentUserUID),
		groupID: uint32(currentUserGID),
	}

	testCases := []struct {
		testname string
		args     args
		expected expected
		wantErr  bool
	}{
		{
			testname: "current user uid and gid",
			args: args{
				userGroupStr: fmt.Sprintf("%d:%d", currentUserUID, currentUserGID),
			},
			expected: expectedCurrentUser,
		},
		{
			testname: "current user username and gid",
			args: args{
				userGroupStr: fmt.Sprintf("%s:%d", currentUser.Username, currentUserGID),
			},
			expected: expectedCurrentUser,
		},
		{
			testname: "current user username and primary group",
			args: args{
				userGroupStr: fmt.Sprintf("%s:%s", currentUser.Username, currentUser.PrimaryGroup),
			},
			expected: expectedCurrentUser,
		},
		{
			testname: "current user uid and primary group",
			args: args{
				userGroupStr: fmt.Sprintf("%d:%s", currentUserUID, currentUser.PrimaryGroup),
			},
			expected: expectedCurrentUser,
		},
		{
			testname: "non-existing valid uid and gid",
			args: args{
				userGroupStr: fmt.Sprintf("%d:%d", 1001, 50000),
			},
			expected: expected{
				userID:  1001,
				groupID: 50000,
			},
		},
		{
			testname: "uid and existing group",
			args: args{
				userGroupStr: fmt.Sprintf("%d:%s", 1001, currentUser.PrimaryGroup),
			},
			expected: expected{
				userID:  1001,
				groupID: uint32(currentUserGID),
			},
		},
		{
			testname: "uid and non existing group-name with fallbackToUID",
			args: args{
				userGroupStr:  fmt.Sprintf("%d:%s", 1001, "hello-world-group"),
				fallbackToUID: true,
			},
			expected: expected{
				userID:  1001,
				groupID: 1001,
			},
		},
		{
			testname: "uid and non existing group-name",
			args: args{
				userGroupStr: fmt.Sprintf("%d:%s", 1001, "hello-world-group"),
			},
			wantErr: true,
		},
		{
			testname: "name and non existing gid",
			args: args{
				userGroupStr: fmt.Sprintf("%s:%d", currentUser.Username, 50000),
			},
			expected: expected{
				userID:  expectedCurrentUser.userID,
				groupID: 50000,
			},
		},
		{
			testname: "only uid and fallback is false",
			args: args{
				userGroupStr:  fmt.Sprintf("%d", currentUserUID),
				fallbackToUID: false,
			},
			wantErr: true,
		},
		{
			testname: "only uid and fallback is true",
			args: args{
				userGroupStr:  fmt.Sprintf("%d", currentUserUID),
				fallbackToUID: true,
			},
			expected: expected{
				userID:  expectedCurrentUser.userID,
				groupID: expectedCurrentUser.userID,
			},
		},
		{
			testname: "non-existing user without group",
			args: args{
				userGroupStr: "helloworlduser",
			},
			wantErr: true,
		},
	}
	for _, tt := range testCases {
		uid, gid, err := getUIDAndGIDFromString(tt.args.userGroupStr, tt.args.fallbackToUID)
		testutil.CheckError(t, tt.wantErr, err)
		if uid != tt.expected.userID || gid != tt.expected.groupID {
			t.Errorf("%v failed. Could not correctly decode %s to uid/gid %d:%d. Result: %d:%d",
				tt.testname,
				tt.args.userGroupStr,
				tt.expected.userID, tt.expected.groupID,
				uid, gid)
		}
	}
}

func TestLookupUser(t *testing.T) {
	currentUser := testutil.GetCurrentUser(t)

	type args struct {
		userStr string
	}
	tests := []struct {
		testname string
		args     args
		expected *user.User
		wantErr  bool
	}{
		{
			testname: "non-existing user",
			args: args{
				userStr: "foobazbar",
			},
			wantErr: true,
		},
		{
			testname: "uid",
			args: args{
				userStr: "30000",
			},
			expected: &user.User{
				Uid:     "30000",
				HomeDir: "/",
			},
			wantErr: false,
		},
		{
			testname: "current user",
			args: args{
				userStr: currentUser.Username,
			},
			expected: currentUser.User,
			wantErr:  false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.testname, func(t *testing.T) {
			got, err := LookupUser(tt.args.userStr)
			testutil.CheckErrorAndDeepEqual(t, tt.wantErr, err, tt.expected, got)
		})
	}

}

func TestIsSrcRemoteFileURL(t *testing.T) {
	type args struct {
		rawurl string
	}
	tests := []struct {
		name string
		args args
		want bool
	}{
		{
			name: "valid https url",
			args: args{rawurl: "https://google.com?foo=bar"},
			want: true,
		},
		{
			name: "valid http url",
			args: args{rawurl: "http://example.com/foobar.tar.gz"},
			want: true,
		},
		{
			name: "invalid url",
			args: args{rawurl: "http:/not-a-url.com"},
			want: false,
		},
		{
			name: "invalid url filepath",
			args: args{rawurl: "/is/a/filepath"},
			want: false,
		},
	}
	for _, tt := range tests {
		t.Run(
			tt.name, func(t *testing.T) {
				if got := IsSrcRemoteFileURL(tt.args.rawurl); got != tt.want {
					t.Errorf("IsSrcRemoteFileURL() = %v, want %v", got, tt.want)
				}
			},
		)
	}
}