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

fix: handle repo creation when secret does not have proper label #7617

Merged
merged 3 commits into from
Nov 5, 2021
Merged

fix: handle repo creation when secret does not have proper label #7617

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55ad935
fix: handle repo creation when secret does not have proper label
leoluz Nov 4, 2021
293bd8e
address code review comments with linters
leoluz Nov 4, 2021
0064d8a
remove gpg test data refactoring code
leoluz Nov 4, 2021
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
30 changes: 15 additions & 15 deletions util/db/gpgkeys_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (
"k8s.io/client-go/kubernetes/fake"

"github.com/argoproj/argo-cd/v2/common"
"github.com/argoproj/argo-cd/v2/test"
"github.com/argoproj/argo-cd/v2/util/gpg/testdata"
"github.com/argoproj/argo-cd/v2/util/settings"
)

Expand All @@ -37,7 +37,7 @@ var gpgCMSingleGoodPubkey = v1.ConfigMap{
},
},
Data: map[string]string{
"4AEE18F83AFDEB23": test.MustLoadFileToString("../gpg/testdata/github.asc"),
"4AEE18F83AFDEB23": testdata.Github_asc,
},
}

Expand All @@ -51,8 +51,8 @@ var gpgCMMultiGoodPubkey = v1.ConfigMap{
},
},
Data: map[string]string{
"FDC79815400D88A9": test.MustLoadFileToString("../gpg/testdata/johndoe.asc"),
"F7842A5CEAA9C0B1": test.MustLoadFileToString("../gpg/testdata/janedoe.asc"),
"FDC79815400D88A9": testdata.Johndoe_asc,
"F7842A5CEAA9C0B1": testdata.Janedoe_asc,
},
}

Expand All @@ -66,7 +66,7 @@ var gpgCMSingleKeyWrongId = v1.ConfigMap{
},
},
Data: map[string]string{
"5AEE18F83AFDEB23": test.MustLoadFileToString("../gpg/testdata/github.asc"),
"5AEE18F83AFDEB23": testdata.Github_asc,
},
}

Expand All @@ -80,7 +80,7 @@ var gpgCMGarbagePubkey = v1.ConfigMap{
},
},
Data: map[string]string{
"4AEE18F83AFDEB23": test.MustLoadFileToString("../gpg/testdata/garbage.asc"),
"4AEE18F83AFDEB23": testdata.Garbage_asc,
},
}

Expand All @@ -94,7 +94,7 @@ var gpgCMGarbageCMKey = v1.ConfigMap{
},
},
Data: map[string]string{
"wullerosekaufe": test.MustLoadFileToString("../gpg/testdata/github.asc"),
"wullerosekaufe": testdata.Github_asc,
},
}

Expand All @@ -117,7 +117,7 @@ func getGPGKeysClientset(gpgCM v1.ConfigMap) *fake.Clientset {
func Test_ValidatePGPKey(t *testing.T) {
// Good case - single PGP key
{
key, err := validatePGPKey(test.MustLoadFileToString("../gpg/testdata/github.asc"))
key, err := validatePGPKey(testdata.Github_asc)
assert.NoError(t, err)
assert.NotNil(t, key)
assert.Equal(t, "4AEE18F83AFDEB23", key.KeyID)
Expand All @@ -127,13 +127,13 @@ func Test_ValidatePGPKey(t *testing.T) {
}
// Bad case - Garbage
{
key, err := validatePGPKey(test.MustLoadFileToString("../gpg/testdata/garbage.asc"))
key, err := validatePGPKey(testdata.Garbage_asc)
assert.Error(t, err)
assert.Nil(t, key)
}
// Bad case - more than one key
{
key, err := validatePGPKey(test.MustLoadFileToString("../gpg/testdata/multi.asc"))
key, err := validatePGPKey(testdata.Multi_asc)
assert.Error(t, err)
assert.Nil(t, key)
}
Expand Down Expand Up @@ -210,7 +210,7 @@ func Test_AddGPGPublicKey(t *testing.T) {
db := NewDB(testNamespace, settings, clientset)

// Key should be added
new, skipped, err := db.AddGPGPublicKey(context.Background(), test.MustLoadFileToString("../gpg/testdata/github.asc"))
new, skipped, err := db.AddGPGPublicKey(context.Background(), testdata.Github_asc)
assert.NoError(t, err)
assert.Len(t, new, 1)
assert.Len(t, skipped, 0)
Expand All @@ -219,7 +219,7 @@ func Test_AddGPGPublicKey(t *testing.T) {
assert.Len(t, cm.Data, 1)

// Same key should not be added, but skipped
new, skipped, err = db.AddGPGPublicKey(context.Background(), test.MustLoadFileToString("../gpg/testdata/github.asc"))
new, skipped, err = db.AddGPGPublicKey(context.Background(), testdata.Github_asc)
assert.NoError(t, err)
assert.Len(t, new, 0)
assert.Len(t, skipped, 1)
Expand All @@ -228,7 +228,7 @@ func Test_AddGPGPublicKey(t *testing.T) {
assert.Len(t, cm.Data, 1)

// New keys should be added
new, skipped, err = db.AddGPGPublicKey(context.Background(), test.MustLoadFileToString("../gpg/testdata/multi.asc"))
new, skipped, err = db.AddGPGPublicKey(context.Background(), testdata.Multi_asc)
assert.NoError(t, err)
assert.Len(t, new, 2)
assert.Len(t, skipped, 0)
Expand All @@ -237,7 +237,7 @@ func Test_AddGPGPublicKey(t *testing.T) {
assert.Len(t, cm.Data, 3)

// Same new keys should be skipped
new, skipped, err = db.AddGPGPublicKey(context.Background(), test.MustLoadFileToString("../gpg/testdata/multi.asc"))
new, skipped, err = db.AddGPGPublicKey(context.Background(), testdata.Multi_asc)
assert.NoError(t, err)
assert.Len(t, new, 0)
assert.Len(t, skipped, 2)
Expand All @@ -246,7 +246,7 @@ func Test_AddGPGPublicKey(t *testing.T) {
assert.Len(t, cm.Data, 3)

// Garbage input should result in error
new, skipped, err = db.AddGPGPublicKey(context.Background(), test.MustLoadFileToString("../gpg/testdata/garbage.asc"))
new, skipped, err = db.AddGPGPublicKey(context.Background(), testdata.Garbage_asc)
assert.Error(t, err)
assert.Nil(t, new)
assert.Nil(t, skipped)
Expand Down
34 changes: 31 additions & 3 deletions util/db/repository_secrets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,19 @@ func (s *secretsRepositoryBackend) CreateRepository(ctx context.Context, reposit
},
}

s.repositoryToSecret(repository, repositorySecret)
repositoryToSecret(repository, repositorySecret)

_, err := s.db.createSecret(ctx, repositorySecret)
if err != nil {
if apierr.IsAlreadyExists(err) {
hasLabel, err := s.hasRepoTypeLabel(secName)
if err != nil {
return nil, status.Errorf(codes.Internal, err.Error())
}
if !hasLabel {
msg := "secret %q doesn't have the proper %q label: please fix the secret or delete it"
return nil, status.Errorf(codes.InvalidArgument, msg, secName, common.LabelKeySecretType)
Copy link
Member

Choose a reason for hiding this comment

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

This is just a nitpick, but for the compiler (and/or linter) to catch issues with the format string, I think it would be wiser to either have msg := fmt.Sprintf(...) and use status.Error(), or just get rid of the intermediate variable msg and use status.Errorf() with the format string literal.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The reason why I did that was to avoid having a too long line and avoid scrolling. Too bad the linter is not smart enough to verify the code with variables as well. I picked your first suggestion as it has better code readability. 👍🏻

}
return nil, status.Errorf(codes.AlreadyExists, "repository %q already exists", repository.Repo)
}
return nil, err
Expand All @@ -44,6 +52,26 @@ func (s *secretsRepositoryBackend) CreateRepository(ctx context.Context, reposit
return repository, s.db.settingsMgr.ResyncInformers()
}

// hasRepoTypeLabel will verify if a secret with the given name exists. If so it will check if
// the secret has the proper label argocd.argoproj.io/secret-type defined. Will return true if
// the label is found and false otherwise. Will return false if no secret is found with the given
// name.
func (s *secretsRepositoryBackend) hasRepoTypeLabel(secretName string) (bool, error) {
noCache := make(map[string]*corev1.Secret)
sec, err := s.db.getSecret(secretName, noCache)
if err != nil {
if apierr.IsNotFound(err) {
return false, nil
}
return false, err
}
_, ok := sec.GetLabels()[common.LabelKeySecretType]
if ok {
return true, nil
}
return false, nil
}

func (s *secretsRepositoryBackend) GetRepository(ctx context.Context, repoURL string) (*appsv1.Repository, error) {
secret, err := s.getRepositorySecret(repoURL)
if err != nil {
Expand Down Expand Up @@ -104,7 +132,7 @@ func (s *secretsRepositoryBackend) UpdateRepository(ctx context.Context, reposit
return nil, err
}

s.repositoryToSecret(repository, repositorySecret)
repositoryToSecret(repository, repositorySecret)

_, err = s.db.kubeclientset.CoreV1().Secrets(s.db.ns).Update(ctx, repositorySecret, metav1.UpdateOptions{})
if err != nil {
Expand Down Expand Up @@ -317,7 +345,7 @@ func (s *secretsRepositoryBackend) secretToRepository(secret *corev1.Secret) (*a
return repository, nil
}

func (s *secretsRepositoryBackend) repositoryToSecret(repository *appsv1.Repository, secret *corev1.Secret) {
func repositoryToSecret(repository *appsv1.Repository, secret *corev1.Secret) {
if secret.Data == nil {
secret.Data = make(map[string][]byte)
}
Expand Down
153 changes: 123 additions & 30 deletions util/db/repository_secrets_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,53 +6,146 @@ import (

"github.com/stretchr/testify/assert"
"golang.org/x/net/context"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
corev1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/watch"

"github.com/argoproj/argo-cd/v2/common"
appsv1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
"github.com/argoproj/argo-cd/v2/util/settings"
"k8s.io/client-go/kubernetes/fake"
k8stesting "k8s.io/client-go/testing"
)

func TestSecretsRepositoryBackend_CreateRepository(t *testing.T) {
clientset := getClientset(map[string]string{})
testee := &secretsRepositoryBackend{db: &db{
ns: testNamespace,
kubeclientset: clientset,
settingsMgr: settings.NewSettingsManager(context.TODO(), clientset, testNamespace),
}}

input := &appsv1.Repository{
type fixture struct {
clientSet *fake.Clientset
repoBackend *secretsRepositoryBackend
}
repo := &appsv1.Repository{
Name: "ArgoCD",
Repo: "git@github.com:argoproj/argo-cd.git",
Username: "someUsername",
Password: "somePassword",
InsecureIgnoreHostKey: false,
EnableLFS: true,
}

output, err := testee.CreateRepository(context.TODO(), input)
assert.NoError(t, err)
assert.Same(t, input, output)

secret, err := clientset.CoreV1().Secrets(testNamespace).Get(
context.TODO(),
RepoURLToSecretName(repoSecretPrefix, input.Repo),
metav1.GetOptions{},
)
assert.NotNil(t, secret)
assert.NoError(t, err)

assert.Equal(t, common.AnnotationValueManagedByArgoCD, secret.Annotations[common.AnnotationKeyManagedBy])
assert.Equal(t, common.LabelValueSecretTypeRepository, secret.Labels[common.LabelKeySecretType])

assert.Equal(t, input.Name, string(secret.Data["name"]))
assert.Equal(t, input.Repo, string(secret.Data["url"]))
assert.Equal(t, input.Username, string(secret.Data["username"]))
assert.Equal(t, input.Password, string(secret.Data["password"]))
assert.Equal(t, "", string(secret.Data["insecureIgnoreHostKey"]))
assert.Equal(t, strconv.FormatBool(input.EnableLFS), string(secret.Data["enableLfs"]))
setupWithK8sObjects := func(objects ...runtime.Object) *fixture {

clientset := getClientset(map[string]string{}, objects...)
settingsMgr := settings.NewSettingsManager(context.Background(), clientset, testNamespace)
repoBackend := &secretsRepositoryBackend{db: &db{
ns: testNamespace,
kubeclientset: clientset,
settingsMgr: settingsMgr,
}}
return &fixture{
clientSet: clientset,
repoBackend: repoBackend,
}
}
t.Run("will create repository successfully", func(t *testing.T) {
// given
t.Parallel()
f := setupWithK8sObjects()

// when
output, err := f.repoBackend.CreateRepository(context.Background(), repo)

// then
assert.NoError(t, err)
assert.Same(t, repo, output)

secret, err := f.clientSet.CoreV1().Secrets(testNamespace).Get(
context.TODO(),
RepoURLToSecretName(repoSecretPrefix, repo.Repo),
metav1.GetOptions{},
)
assert.NotNil(t, secret)
assert.NoError(t, err)

assert.Equal(t, common.AnnotationValueManagedByArgoCD, secret.Annotations[common.AnnotationKeyManagedBy])
assert.Equal(t, common.LabelValueSecretTypeRepository, secret.Labels[common.LabelKeySecretType])

assert.Equal(t, repo.Name, string(secret.Data["name"]))
assert.Equal(t, repo.Repo, string(secret.Data["url"]))
assert.Equal(t, repo.Username, string(secret.Data["username"]))
assert.Equal(t, repo.Password, string(secret.Data["password"]))
assert.Equal(t, "", string(secret.Data["insecureIgnoreHostKey"]))
assert.Equal(t, strconv.FormatBool(repo.EnableLFS), string(secret.Data["enableLfs"]))
})
t.Run("will return proper error if secret does not have expected label", func(t *testing.T) {
// given
t.Parallel()
secret := &corev1.Secret{}
repositoryToSecret(repo, secret)
delete(secret.Labels, common.LabelKeySecretType)
f := setupWithK8sObjects(secret)
f.clientSet.ReactionChain = nil
f.clientSet.AddReactor("create", "secrets", func(action k8stesting.Action) (handled bool, ret runtime.Object, err error) {
gr := schema.GroupResource{
Group: "v1",
Resource: "secrets",
}
return true, nil, k8serrors.NewAlreadyExists(gr, "already exists")
})

// when
output, err := f.repoBackend.CreateRepository(context.Background(), repo)

// then
assert.Error(t, err)
assert.Nil(t, output)
status, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.InvalidArgument, status.Code())
})
t.Run("will return proper error if secret already exists", func(t *testing.T) {
// given
t.Parallel()
secName := RepoURLToSecretName(repoSecretPrefix, repo.Repo)
secret := &corev1.Secret{
TypeMeta: metav1.TypeMeta{
Kind: "Secret",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: secName,
Namespace: "default",
},
}
repositoryToSecret(repo, secret)
f := setupWithK8sObjects(secret)
f.clientSet.ReactionChain = nil
f.clientSet.WatchReactionChain = nil
f.clientSet.AddReactor("create", "secrets", func(action k8stesting.Action) (handled bool, ret runtime.Object, err error) {
gr := schema.GroupResource{
Group: "v1",
Resource: "secrets",
}
return true, nil, k8serrors.NewAlreadyExists(gr, "already exists")
})
watcher := watch.NewFakeWithChanSize(1, true)
watcher.Add(secret)
f.clientSet.AddWatchReactor("secrets", func(action k8stesting.Action) (handled bool, ret watch.Interface, err error) {
return true, watcher, nil
})

// when
output, err := f.repoBackend.CreateRepository(context.Background(), repo)

// then
assert.Error(t, err)
assert.Nil(t, output)
status, ok := status.FromError(err)
assert.True(t, ok)
assert.Equal(t, codes.AlreadyExists, status.Code())
})
}

func TestSecretsRepositoryBackend_GetRepository(t *testing.T) {
Expand Down