comments

Signed-off-by: Grant Linville <[email protected]>

Author: g-linville

pkg/credentials/dbstore.go

@@ -44,11 +44,16 @@ type DBStore struct {
 
 // GptscriptCredential is the struct we use to represent credentials in the database.
 type GptscriptCredential struct {
-	ID                      uint `gorm:"primarykey"`
-	CreatedAt               time.Time
-	UpdatedAt               time.Time
-	Context                 string `gorm:"index:contextname,unique"`
-	Name                    string `gorm:"index:contextname,unique"`
+	// We aren't using gorm.Model because we don't want a DeletedAt field.
+	// We want records to be fully deleted from the database.
+	ID        uint `gorm:"primarykey"`
+	CreatedAt time.Time
+	UpdatedAt time.Time
+
+	// We set up an extra index here to enforce a unique constraint on context+name.
+	Context string `gorm:"index:contextname,unique"`
+	Name    string `gorm:"index:contextname,unique"`
+
 	Type, Env, RefreshToken string
 	Ephemeral               bool
 	ExpiresAt               *time.Time
@@ -98,6 +103,7 @@ func NewDBStore(ctx context.Context, cfg *config.CLIConfig, credCtxs []string) (
 	if err != nil {
 		return nil, fmt.Errorf("failed to read encryption config: %w", err)
 	} else if encryptionConf != nil {
+		// The transformer that we get from the encryption configuration is the interface we use for encryption and decryption.
 		transformer, exists := encryptionConf.Transformers[groupResource]
 		if !exists {
 			return nil, fmt.Errorf("failed to find encryption transformer for %s", groupResource.String())
@@ -150,6 +156,7 @@ func readEncryptionConfig(ctx context.Context) (*encryptionconfig.EncryptionConf
 		return nil, fmt.Errorf("failed to stat encryption config file: %w", err)
 	}
 
+	// Use k8s libraries to load the encryption config from the file:
 	return encryptionconfig.LoadEncryptionConfig(ctx, encryptionConfigPath, false, "gptscript")
 }
 

pkg/credentials/dbstore_test.go

@@ -2,44 +2,61 @@ package credentials
 
 import (
 	"context"
+	"crypto/rand"
+	"fmt"
 	"testing"
 
 	"github.com/gptscript-ai/gptscript/pkg/config"
 	"github.com/stretchr/testify/require"
 )
 
 func TestDBStore(t *testing.T) {
-	const credCtx = "default"
+	const credCtx = "testing"
+
+	bytes := make([]byte, 16)
+	_, err := rand.Read(bytes)
+	require.NoError(t, err)
+
 	credential := Credential{
 		Context:      credCtx,
-		ToolName:     "mytestcred",
+		ToolName:     fmt.Sprintf("%x", bytes),
 		Type:         CredentialTypeTool,
-		Env:          map[string]string{"ASDF": "yeet"},
+		Env:          map[string]string{"ENV_VAR": "value"},
 		RefreshToken: "myrefreshtoken",
 	}
 
 	cfg, _ := config.ReadCLIConfig("")
 
+	// Set up the store
 	store, err := NewDBStore(context.Background(), cfg, []string{credCtx})
 	require.NoError(t, err)
 
+	// Create the credential
 	require.NoError(t, store.Add(context.Background(), credential))
 
+	// Get the credential
 	cred, found, err := store.Get(context.Background(), credential.ToolName)
 	require.NoError(t, err)
 	require.True(t, found)
 	require.Equal(t, credential.Env, cred.Env)
 	require.Equal(t, credential.RefreshToken, cred.RefreshToken)
 
+	// List credentials and check for it
 	list, err := store.List(context.Background())
 	require.NoError(t, err)
 	require.Greater(t, len(list), 0)
+
+	found = false
 	for _, c := range list {
 		if c.Context == credCtx && c.ToolName == credential.ToolName {
 			require.Equal(t, credential.Env, c.Env)
 			require.Equal(t, credential.RefreshToken, c.RefreshToken)
+			found = true
+			break
 		}
 	}
+	require.True(t, found)
 
+	// Delete the credential
 	require.NoError(t, store.Remove(context.Background(), credential.ToolName))
 }