* chore: Add new dbw dependency * refactor: Convert to use dbw.DB * refactor (db): Change GetTicket(...) signature * feature (db tests): Added TestDeleteWhere(...) Adding this allows us to eliminate a leak of the gorm library * refactor: Add ctx to ScanRows(...) signature This is required to refactor all the deprecated errors pkg calls. This refactor required adding a context to quite a few call chains and in particular the job scheduler bits * feature (db/tests): Add support for test opt: WithTestLogLevel(...) This test only option allows callers to specify a log level for the underlying db package (where supported/applicable) when calling TestSetup(...) * refactor (db): Simplify Db type Only store the underlying *DB and create the *RW on demand when needed. * refactor (oplog): Port to using dbw pkg for db operations * refactor (db): Remove gormDB(...) func * tests (db): Add unit tests for TestDeleteWhere(...) * chore: make fmt changes to formatting
368 lines
9.9 KiB
Go
368 lines
9.9 KiB
Go
package kms_test
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/hashicorp/boundary/internal/db"
|
|
"github.com/hashicorp/boundary/internal/errors"
|
|
"github.com/hashicorp/boundary/internal/iam"
|
|
"github.com/hashicorp/boundary/internal/kms"
|
|
"github.com/hashicorp/boundary/internal/oplog"
|
|
wrapping "github.com/hashicorp/go-kms-wrapping"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"google.golang.org/protobuf/proto"
|
|
)
|
|
|
|
func TestRepository_CreateTokenKeyVersion(t *testing.T) {
|
|
t.Parallel()
|
|
conn, _ := db.TestSetup(t, "postgres")
|
|
rw := db.New(conn)
|
|
wrapper := db.TestWrapper(t)
|
|
repo, err := kms.NewRepository(rw, rw)
|
|
require.NoError(t, err)
|
|
org, _ := iam.TestScopes(t, iam.TestRepo(t, conn, wrapper))
|
|
db.TestDeleteWhere(t, conn, func() interface{} { i := kms.AllocRootKey(); return &i }(), "1=1")
|
|
rk := kms.TestRootKey(t, conn, org.PublicId)
|
|
_, rkvWrapper := kms.TestRootKeyVersion(t, conn, wrapper, rk.PrivateId)
|
|
dk := kms.TestTokenKey(t, conn, rk.PrivateId)
|
|
|
|
type args struct {
|
|
key []byte
|
|
tokenKeyId string
|
|
keyWrapper wrapping.Wrapper
|
|
opt []kms.Option
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
wantErr bool
|
|
wantIsError errors.Code
|
|
}{
|
|
{
|
|
name: "valid",
|
|
args: args{
|
|
key: []byte("test key"),
|
|
keyWrapper: rkvWrapper,
|
|
tokenKeyId: dk.PrivateId,
|
|
},
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "invalid-rkv-wrapper",
|
|
args: args{
|
|
key: []byte("test key"),
|
|
keyWrapper: wrapper,
|
|
tokenKeyId: dk.PrivateId,
|
|
},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "empty-key",
|
|
args: args{
|
|
key: nil,
|
|
keyWrapper: wrapper,
|
|
tokenKeyId: dk.PrivateId,
|
|
},
|
|
wantErr: true,
|
|
wantIsError: errors.InvalidParameter,
|
|
},
|
|
{
|
|
name: "nil-wrapper",
|
|
args: args{
|
|
key: []byte("test key"),
|
|
keyWrapper: nil,
|
|
},
|
|
wantErr: true,
|
|
wantIsError: errors.InvalidParameter,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert, require := assert.New(t), require.New(t)
|
|
k, err := repo.CreateTokenKeyVersion(context.Background(), tt.args.keyWrapper, tt.args.tokenKeyId, tt.args.key, tt.args.opt...)
|
|
if tt.wantErr {
|
|
assert.Error(err)
|
|
assert.Nil(k)
|
|
assert.True(errors.Match(errors.T(tt.wantIsError), err))
|
|
return
|
|
}
|
|
require.NoError(err)
|
|
assert.NotNil(k.CreateTime)
|
|
foundKey, err := repo.LookupTokenKeyVersion(context.Background(), tt.args.keyWrapper, k.PrivateId)
|
|
assert.NoError(err)
|
|
assert.True(proto.Equal(foundKey, k))
|
|
|
|
// make sure there was no oplog written
|
|
err = db.TestVerifyOplog(t, rw, k.PrivateId, db.WithOperation(oplog.OpType_OP_TYPE_CREATE), db.WithCreateNotBefore(10*time.Second))
|
|
assert.Error(err)
|
|
assert.True(errors.IsNotFoundError(err))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRepository_DeleteTokenKeyVersion(t *testing.T) {
|
|
t.Parallel()
|
|
conn, _ := db.TestSetup(t, "postgres")
|
|
rw := db.New(conn)
|
|
wrapper := db.TestWrapper(t)
|
|
repo, err := kms.NewRepository(rw, rw)
|
|
require.NoError(t, err)
|
|
org, _ := iam.TestScopes(t, iam.TestRepo(t, conn, wrapper))
|
|
db.TestDeleteWhere(t, conn, func() interface{} { i := kms.AllocRootKey(); return &i }(), "1=1")
|
|
rk := kms.TestRootKey(t, conn, org.PublicId)
|
|
_, rkvWrapper := kms.TestRootKeyVersion(t, conn, wrapper, rk.PrivateId)
|
|
dk := kms.TestTokenKey(t, conn, rk.PrivateId)
|
|
|
|
type args struct {
|
|
key *kms.TokenKeyVersion
|
|
opt []kms.Option
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
args args
|
|
wantRowsDeleted int
|
|
wantErr bool
|
|
wantIsError errors.Code
|
|
}{
|
|
{
|
|
name: "valid",
|
|
args: args{
|
|
key: kms.TestTokenKeyVersion(t, conn, rkvWrapper, dk.PrivateId, []byte("token key")),
|
|
},
|
|
wantRowsDeleted: 1,
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "no-private-id",
|
|
args: args{
|
|
key: func() *kms.TokenKeyVersion {
|
|
k := kms.AllocTokenKeyVersion()
|
|
return &k
|
|
}(),
|
|
},
|
|
wantRowsDeleted: 0,
|
|
wantErr: true,
|
|
wantIsError: errors.InvalidParameter,
|
|
},
|
|
{
|
|
name: "not-found",
|
|
args: args{
|
|
key: func() *kms.TokenKeyVersion {
|
|
id, err := db.NewPublicId(kms.TokenKeyPrefix)
|
|
require.NoError(t, err)
|
|
k := kms.AllocTokenKeyVersion()
|
|
k.PrivateId = id
|
|
require.NoError(t, err)
|
|
return &k
|
|
}(),
|
|
},
|
|
wantRowsDeleted: 0,
|
|
wantErr: true,
|
|
wantIsError: errors.RecordNotFound,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert, require := assert.New(t), require.New(t)
|
|
deletedRows, err := repo.DeleteTokenKeyVersion(context.Background(), tt.args.key.PrivateId, tt.args.opt...)
|
|
if tt.wantErr {
|
|
require.Error(err)
|
|
assert.Equal(0, deletedRows)
|
|
assert.True(errors.Match(errors.T(tt.wantIsError), err))
|
|
err = db.TestVerifyOplog(t, rw, tt.args.key.PrivateId, db.WithOperation(oplog.OpType_OP_TYPE_DELETE), db.WithCreateNotBefore(10*time.Second))
|
|
assert.Error(err)
|
|
assert.True(errors.IsNotFoundError(err))
|
|
return
|
|
}
|
|
require.NoError(err)
|
|
assert.Equal(tt.wantRowsDeleted, deletedRows)
|
|
foundKey, err := repo.LookupTokenKeyVersion(context.Background(), wrapper, tt.args.key.PrivateId)
|
|
assert.Error(err)
|
|
assert.Nil(foundKey)
|
|
assert.True(errors.IsNotFoundError(err))
|
|
|
|
// make sure there was no oplog written
|
|
err = db.TestVerifyOplog(t, rw, tt.args.key.PrivateId, db.WithOperation(oplog.OpType_OP_TYPE_DELETE), db.WithCreateNotBefore(10*time.Second))
|
|
assert.Error(err)
|
|
assert.True(errors.IsNotFoundError(err))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRepository_LatestTokenKeyVersion(t *testing.T) {
|
|
t.Parallel()
|
|
conn, _ := db.TestSetup(t, "postgres")
|
|
rw := db.New(conn)
|
|
wrapper := db.TestWrapper(t)
|
|
repo, err := kms.NewRepository(rw, rw)
|
|
require.NoError(t, err)
|
|
org, _ := iam.TestScopes(t, iam.TestRepo(t, conn, wrapper))
|
|
db.TestDeleteWhere(t, conn, func() interface{} { i := kms.AllocRootKey(); return &i }(), "1=1")
|
|
rk := kms.TestRootKey(t, conn, org.PublicId)
|
|
_, rkvWrapper := kms.TestRootKeyVersion(t, conn, wrapper, rk.PrivateId)
|
|
dk := kms.TestTokenKey(t, conn, rk.PrivateId)
|
|
|
|
tests := []struct {
|
|
name string
|
|
createCnt int
|
|
keyWrapper wrapping.Wrapper
|
|
wantVersion uint32
|
|
wantErr bool
|
|
wantIsError errors.Code
|
|
}{
|
|
{
|
|
name: "5",
|
|
createCnt: 5,
|
|
keyWrapper: rkvWrapper,
|
|
wantVersion: 5,
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "1",
|
|
createCnt: 1,
|
|
keyWrapper: rkvWrapper,
|
|
wantVersion: 1,
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "0",
|
|
createCnt: 0,
|
|
keyWrapper: rkvWrapper,
|
|
wantErr: true,
|
|
wantIsError: errors.RecordNotFound,
|
|
},
|
|
{
|
|
name: "nil-wrapper",
|
|
createCnt: 5,
|
|
keyWrapper: nil,
|
|
wantErr: true,
|
|
wantIsError: errors.InvalidParameter,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert, require := assert.New(t), require.New(t)
|
|
db.TestDeleteWhere(t, conn, func() interface{} { i := kms.AllocTokenKeyVersion(); return &i }(), "1=1")
|
|
testKeys := []*kms.TokenKeyVersion{}
|
|
for i := 0; i < tt.createCnt; i++ {
|
|
k := kms.TestTokenKeyVersion(t, conn, rkvWrapper, dk.PrivateId, []byte("test key"))
|
|
testKeys = append(testKeys, k)
|
|
}
|
|
assert.Equal(tt.createCnt, len(testKeys))
|
|
got, err := repo.LatestTokenKeyVersion(context.Background(), tt.keyWrapper, dk.PrivateId)
|
|
if tt.wantErr {
|
|
require.Error(err)
|
|
assert.Nil(got)
|
|
assert.True(errors.Match(errors.T(tt.wantIsError), err))
|
|
return
|
|
}
|
|
require.NoError(err)
|
|
require.NotNil(got)
|
|
assert.Equal(tt.wantVersion, got.Version)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRepository_ListTokenKeyVersions(t *testing.T) {
|
|
t.Parallel()
|
|
conn, _ := db.TestSetup(t, "postgres")
|
|
const testLimit = 10
|
|
rw := db.New(conn)
|
|
wrapper := db.TestWrapper(t)
|
|
repo, err := kms.NewRepository(rw, rw, kms.WithLimit(testLimit))
|
|
require.NoError(t, err)
|
|
org, _ := iam.TestScopes(t, iam.TestRepo(t, conn, wrapper))
|
|
db.TestDeleteWhere(t, conn, func() interface{} { i := kms.AllocRootKey(); return &i }(), "1=1")
|
|
rk := kms.TestRootKey(t, conn, org.PublicId)
|
|
_, rkvWrapper := kms.TestRootKeyVersion(t, conn, wrapper, rk.PrivateId)
|
|
dk := kms.TestTokenKey(t, conn, rk.PrivateId)
|
|
|
|
type args struct {
|
|
tokenKeyId string
|
|
keyWrapper wrapping.Wrapper
|
|
opt []kms.Option
|
|
}
|
|
tests := []struct {
|
|
name string
|
|
createCnt int
|
|
args args
|
|
wantCnt int
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "no-limit",
|
|
createCnt: repo.DefaultLimit() + 1,
|
|
args: args{
|
|
tokenKeyId: dk.PrivateId,
|
|
keyWrapper: rkvWrapper,
|
|
opt: []kms.Option{kms.WithLimit(-1)},
|
|
},
|
|
wantCnt: repo.DefaultLimit() + 1,
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "default-limit",
|
|
createCnt: repo.DefaultLimit() + 1,
|
|
args: args{
|
|
keyWrapper: rkvWrapper,
|
|
tokenKeyId: dk.PrivateId,
|
|
},
|
|
wantCnt: repo.DefaultLimit(),
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "custom-limit",
|
|
createCnt: repo.DefaultLimit() + 1,
|
|
args: args{
|
|
keyWrapper: rkvWrapper,
|
|
tokenKeyId: dk.PrivateId,
|
|
opt: []kms.Option{kms.WithLimit(3)},
|
|
},
|
|
wantCnt: 3,
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "bad-org",
|
|
createCnt: 1,
|
|
args: args{
|
|
keyWrapper: rkvWrapper,
|
|
tokenKeyId: "bad-id",
|
|
},
|
|
wantCnt: 0,
|
|
wantErr: false,
|
|
},
|
|
{
|
|
name: "nil-wrapper",
|
|
createCnt: 1,
|
|
args: args{
|
|
keyWrapper: nil,
|
|
tokenKeyId: dk.PrivateId,
|
|
},
|
|
wantCnt: 0,
|
|
wantErr: true,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert, require := assert.New(t), require.New(t)
|
|
db.TestDeleteWhere(t, conn, func() interface{} { i := kms.AllocTokenKeyVersion(); return &i }(), "1=1")
|
|
keyVersions := []*kms.TokenKeyVersion{}
|
|
for i := 0; i < tt.createCnt; i++ {
|
|
k := kms.TestTokenKeyVersion(t, conn, rkvWrapper, dk.PrivateId, []byte("token key"))
|
|
keyVersions = append(keyVersions, k)
|
|
}
|
|
assert.Equal(tt.createCnt, len(keyVersions))
|
|
got, err := repo.ListTokenKeyVersions(context.Background(), tt.args.keyWrapper, tt.args.tokenKeyId, tt.args.opt...)
|
|
if tt.wantErr {
|
|
require.Error(err)
|
|
return
|
|
}
|
|
require.NoError(err)
|
|
assert.Equal(tt.wantCnt, len(got))
|
|
})
|
|
}
|
|
}
|