Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

kubelet: add unit tests for imagePullSecrets keyring #94974

Merged
merged 1 commit into from Sep 23, 2020
Merged

kubelet: add unit tests for imagePullSecrets keyring #94974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 11 additions & 1 deletion pkg/credentialprovider/secrets/BUILD
View file
Open in desktop
@@ -1,4 +1,4 @@
load("@io_bazel_rules_go//go:def.bzl", "go_library")
load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")

go_library(
name = "go_default_library",
Expand All @@ -24,3 +24,13 @@ filegroup(
tags = ["automanaged"],
visibility = ["//visibility:public"],
)

go_test(
name = "go_default_test",
srcs = ["secrets_test.go"],
embed = [":go_default_library"],
deps = [
"//pkg/credentialprovider:go_default_library",
"//staging/src/k8s.io/api/core/v1:go_default_library",
],
)
286 changes: 286 additions & 0 deletions pkg/credentialprovider/secrets/secrets_test.go
View file
Open in desktop
@@ -0,0 +1,286 @@
/*
Copyright 2020 The Kubernetes Authors.

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 secrets

import (
"reflect"
"testing"

"k8s.io/api/core/v1"
"k8s.io/kubernetes/pkg/credentialprovider"
)

// fakeKeyring is a fake docker auth config keyring
type fakeKeyring struct {
auth []credentialprovider.AuthConfig
ok bool
}

// Lookup implements the DockerKeyring method for fetching credentials based on image name.
// Returns fake results based on the auth and ok fields in fakeKeyring
func (f *fakeKeyring) Lookup(image string) ([]credentialprovider.AuthConfig, bool) {
return f.auth, f.ok
}

func Test_MakeDockerKeyring(t *testing.T) {
testcases := []struct {
name string
image string
defaultKeyring credentialprovider.DockerKeyring
pullSecrets []v1.Secret
authConfigs []credentialprovider.AuthConfig
found bool
}{
{
name: "with .dockerconfigjson and auth field",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockerConfigJson,
Data: map[string][]byte{
v1.DockerConfigJsonKey: []byte(`{"auths": {"test.registry.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "user",
Password: "password",
},
},
found: true,
},
{
name: "with .dockerconfig and auth field",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockercfg,
Data: map[string][]byte{
v1.DockerConfigKey: []byte(`{"test.registry.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "user",
Password: "password",
},
},
found: true,
},
{
name: "with .dockerconfigjson and username/password fields",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockerConfigJson,
Data: map[string][]byte{
v1.DockerConfigJsonKey: []byte(`{"auths": {"test.registry.io": {"username": "user", "password": "password"}}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "user",
Password: "password",
},
},
found: true,
},
{
name: "with .dockerconfig and username/password fields",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockercfg,
Data: map[string][]byte{
v1.DockerConfigKey: []byte(`{"test.registry.io": {"username": "user", "password": "password"}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "user",
Password: "password",
},
},
found: true,
},
{
name: "with .dockerconfigjson but with wrong Secret Type",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockercfg,
Data: map[string][]byte{
v1.DockerConfigJsonKey: []byte(`{"auths": {"test.registry.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}}`),
},
},
},
authConfigs: nil,
found: false,
},
{
name: "with .dockerconfig but with wrong Secret Type",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockerConfigJson,
Data: map[string][]byte{
v1.DockerConfigKey: []byte(`{"test.registry.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}`),
},
},
},
authConfigs: nil,
found: false,
},
{
name: "with not matcing .dockerconfigjson and default keyring",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{
auth: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockerConfigJson,
Data: map[string][]byte{
v1.DockerConfigJsonKey: []byte(`{"auths": {"foobar.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
found: true,
},
{
name: "with not matching .dockerconfig and default keyring",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{
auth: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockercfg,
Data: map[string][]byte{
v1.DockerConfigKey: []byte(`{"foobar.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
found: true,
},
{
name: "with no pull secrets but has default keyring",
image: "test.registry.io",
defaultKeyring: &fakeKeyring{
auth: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
},
pullSecrets: []v1.Secret{},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
found: false,
},
{
name: "with pull secrets and has default keyring",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens with default keyring and DockerConfigJsonKey or DockerConfigKey that doesn't match the given image?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this test case specifically, the default keyring would always return auth configs since the fake Lookup() call returns hardcoded auth configs. If we used a real keyring it would not return any auth configs if the image didn't match based on the check here:

kubernetes/pkg/credentialprovider/keyring.go

Lines 241 to 245 in 442a69c

// both k and image are schemeless URLs because even though schemes are allowed
// in the credential configurations, we remove them in Add.
if matched, _ := urlsMatchStr(k, image); matched {
ret = append(ret, dk.creds[k]...)
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was mostly looking for a test that exercised whether we fell back to the default or not for a DockerConfigJsonKey or DockerConfigKey that doesn't match the given image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good point. Updated to include tests that only return credentials from the default keyring if DockerConfigJsonKey or DockerConfigKey didn't have a matching image URL passed into Lookup.

image: "test.registry.io",
defaultKeyring: &fakeKeyring{
auth: []credentialprovider.AuthConfig{
{
Username: "default-user",
Password: "default-password",
},
},
},
pullSecrets: []v1.Secret{
{
Type: v1.SecretTypeDockerConfigJson,
Data: map[string][]byte{
v1.DockerConfigJsonKey: []byte(`{"auths": {"test.registry.io": {"auth": "dXNlcjpwYXNzd29yZA=="}}}`),
},
},
},
authConfigs: []credentialprovider.AuthConfig{
{
Username: "user",
Password: "password",
},
{
Username: "default-user",
Password: "default-password",
},
},
found: true,
},
}

for _, testcase := range testcases {
t.Run(testcase.name, func(t *testing.T) {
keyring, err := MakeDockerKeyring(testcase.pullSecrets, testcase.defaultKeyring)
if err != nil {
t.Fatalf("error creating secret-based docker keyring: %v", err)
}

authConfigs, found := keyring.Lookup(testcase.image)
if found != testcase.found {
t.Logf("actual lookup status: %v", found)
t.Logf("expected lookup status: %v", testcase.found)
t.Errorf("unexpected lookup for image: %s", testcase.image)
}

if !reflect.DeepEqual(authConfigs, testcase.authConfigs) {
t.Logf("actual auth configs: %#v", authConfigs)
t.Logf("expected auth configs: %#v", testcase.authConfigs)
t.Error("auth configs did not match")
}
})
}
}