Files
cd/util/db/gpgkeys_test.go
zeekayandHanzo Dev cbf668a980 Build on Go 1.27
go fix applied the modernizers: promoted-field keys in struct literals,
strings.Cut, SplitSeq, new(expr), slices and maps helpers, wg.Go, reflect.TypeFor
and errors.AsType. omitzero is left out, since omitting a zero struct such as
time.Time{} is a per-field wire decision and not a mechanical one.

Two changes the modernizers could not make for themselves. AsType needs its type
argument to be an error, so the git exit-status reader embeds error in the
interface it asks for. And an error built by concatenating a tag list into its
own format string now says so with a verb, which is what vet was pointing at.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-17 01:47:46 -07:00

288 lines
8.2 KiB
Go

package db
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/kubernetes/fake"
"github.com/hanzoai/cd/common"
"github.com/hanzoai/cd/util/settings"
"github.com/hanzoai/cd/util/sourceintegrity/testdata"
)
// GPG config map with a single key and good mapping
var gpgCMEmpty = corev1.ConfigMap{
Name: common.GPGKeysConfigMapName,
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
}
// GPG config map with a single key and good mapping
var gpgCMSingleGoodPubkey = corev1.ConfigMap{
Name: common.GPGKeysConfigMapName,
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
Data: map[string]string{
"4AEE18F83AFDEB23": testdata.Github_asc,
},
}
// GPG config map with two keys and good mapping
var gpgCMMultiGoodPubkey = corev1.ConfigMap{
Name: common.GPGKeysConfigMapName,
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
Data: map[string]string{
"FDC79815400D88A9": testdata.Johndoe_asc,
"F7842A5CEAA9C0B1": testdata.Janedoe_asc,
},
}
// GPG config map with a single key and bad mapping
var gpgCMSingleKeyWrongId = corev1.ConfigMap{
Name: common.GPGKeysConfigMapName,
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
Data: map[string]string{
"5AEE18F83AFDEB23": testdata.Github_asc,
},
}
// GPG config map with a garbage pub key
var gpgCMGarbagePubkey = corev1.ConfigMap{
Name: common.GPGKeysConfigMapName,
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
Data: map[string]string{
"4AEE18F83AFDEB23": testdata.Garbage_asc,
},
}
// GPG config map with a wrong key
var gpgCMGarbageCMKey = corev1.ConfigMap{
Name: common.GPGKeysConfigMapName,
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
Data: map[string]string{
"wullerosekaufe": testdata.Github_asc,
},
}
// Returns a fake client set for use in tests
func getGPGKeysClientset(gpgCM corev1.ConfigMap) *fake.Clientset {
cm := corev1.ConfigMap{
Name: "cd-cm",
Namespace: testNamespace,
Labels: map[string]string{
"app.kubernetes.io/part-of": "cd",
},
Data: nil,
}
return fake.NewClientset([]runtime.Object{&cm, &gpgCM}...)
}
func Test_ValidatePGPKey(t *testing.T) {
// Good case - single PGP key
{
key, err := validatePGPKey(testdata.Github_asc)
require.NoError(t, err)
assert.NotNil(t, key)
assert.Equal(t, "4AEE18F83AFDEB23", key.KeyID)
assert.NotEmpty(t, key.Owner)
assert.NotEmpty(t, key.KeyData)
assert.NotEmpty(t, key.SubType)
}
// Bad case - Garbage
{
key, err := validatePGPKey(testdata.Garbage_asc)
require.Error(t, err)
assert.Nil(t, key)
}
// Bad case - more than one key
{
key, err := validatePGPKey(testdata.Multi_asc)
require.Error(t, err)
assert.Nil(t, key)
}
}
func Test_ListConfiguredGPGPublicKeys(t *testing.T) {
// Good case. Single key in input, right mapping to Key ID in CM
{
clientset := getGPGKeysClientset(gpgCMSingleGoodPubkey)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
if db == nil {
panic("could not get database")
}
keys, err := db.ListConfiguredGPGPublicKeys(t.Context())
require.NoError(t, err)
assert.Len(t, keys, 1)
}
// Good case. No certificates in ConfigMap
{
clientset := getGPGKeysClientset(gpgCMEmpty)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
if db == nil {
panic("could not get database")
}
keys, err := db.ListConfiguredGPGPublicKeys(t.Context())
require.NoError(t, err)
assert.Empty(t, keys)
}
// Bad case. Single key in input, wrong mapping to Key ID in CM
{
clientset := getGPGKeysClientset(gpgCMSingleKeyWrongId)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
if db == nil {
panic("could not get database")
}
keys, err := db.ListConfiguredGPGPublicKeys(t.Context())
require.Error(t, err)
assert.Empty(t, keys)
}
// Bad case. Garbage public key
{
clientset := getGPGKeysClientset(gpgCMGarbagePubkey)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
if db == nil {
panic("could not get database")
}
keys, err := db.ListConfiguredGPGPublicKeys(t.Context())
require.Error(t, err)
assert.Empty(t, keys)
}
// Bad case. Garbage ConfigMap key in data
{
clientset := getGPGKeysClientset(gpgCMGarbageCMKey)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
if db == nil {
panic("could not get database")
}
keys, err := db.ListConfiguredGPGPublicKeys(t.Context())
require.Error(t, err)
assert.Empty(t, keys)
}
}
func Test_AddGPGPublicKey(t *testing.T) {
// Good case
{
clientset := getGPGKeysClientset(gpgCMEmpty)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
// Key should be added
keys, skipped, err := db.AddGPGPublicKey(t.Context(), testdata.Github_asc)
require.NoError(t, err)
assert.Len(t, keys, 1)
assert.Empty(t, skipped)
cm, err := settings.GetConfigMapByName(common.GPGKeysConfigMapName)
require.NoError(t, err)
assert.Len(t, cm.Data, 1)
// Same key should not be added, but skipped
keys, skipped, err = db.AddGPGPublicKey(t.Context(), testdata.Github_asc)
require.NoError(t, err)
assert.Empty(t, keys)
assert.Len(t, skipped, 1)
cm, err = settings.GetConfigMapByName(common.GPGKeysConfigMapName)
require.NoError(t, err)
assert.Len(t, cm.Data, 1)
// New keys should be added
keys, skipped, err = db.AddGPGPublicKey(t.Context(), testdata.Multi_asc)
require.NoError(t, err)
assert.Len(t, keys, 2)
assert.Empty(t, skipped)
cm, err = settings.GetConfigMapByName(common.GPGKeysConfigMapName)
require.NoError(t, err)
assert.Len(t, cm.Data, 3)
// Same new keys should be skipped
keys, skipped, err = db.AddGPGPublicKey(t.Context(), testdata.Multi_asc)
require.NoError(t, err)
assert.Empty(t, keys)
assert.Len(t, skipped, 2)
cm, err = settings.GetConfigMapByName(common.GPGKeysConfigMapName)
require.NoError(t, err)
assert.Len(t, cm.Data, 3)
// Garbage input should result in error
keys, skipped, err = db.AddGPGPublicKey(t.Context(), testdata.Garbage_asc)
require.Error(t, err)
assert.Nil(t, keys)
assert.Nil(t, skipped)
cm, err = settings.GetConfigMapByName(common.GPGKeysConfigMapName)
require.NoError(t, err)
assert.Len(t, cm.Data, 3)
}
}
func Test_DeleteGPGPublicKey(t *testing.T) {
defer t.Setenv("GNUPGHOME", "")
t.Run("good case", func(t *testing.T) {
clientset := getGPGKeysClientset(gpgCMMultiGoodPubkey)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
// Key should be removed
err := db.DeleteGPGPublicKey(t.Context(), "FDC79815400D88A9")
require.NoError(t, err)
// Key should not exist anymore, therefore can't be deleted again
err = db.DeleteGPGPublicKey(t.Context(), "FDC79815400D88A9")
require.Error(t, err)
// One key left in configuration
n, err := db.ListConfiguredGPGPublicKeys(t.Context())
require.NoError(t, err)
assert.Len(t, n, 1)
// Key should be removed
err = db.DeleteGPGPublicKey(t.Context(), "F7842A5CEAA9C0B1")
require.NoError(t, err)
// Key should not exist anymore, therefore can't be deleted again
err = db.DeleteGPGPublicKey(t.Context(), "F7842A5CEAA9C0B1")
require.Error(t, err)
// No key left in configuration
n, err = db.ListConfiguredGPGPublicKeys(t.Context())
require.NoError(t, err)
assert.Empty(t, n)
})
t.Run("bad case - empty ConfigMap", func(t *testing.T) {
clientset := getGPGKeysClientset(gpgCMEmpty)
settings := settings.NewSettingsManager(t.Context(), clientset, testNamespace)
db := NewDB(testNamespace, settings, clientset)
// Key should be removed
err := db.DeleteGPGPublicKey(t.Context(), "F7842A5CEAA9C0B1")
require.Error(t, err)
})
}