[public api] personal access token db model

Author: Laurie T. Malau

components/common-go/db/dbtest/conn.go

@@ -0,0 +1,43 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package dbtest
+
+import (
+	"sync"
+	"testing"
+
+	common_db "github.com/gitpod-io/gitpod/common-go/db"
+	"github.com/stretchr/testify/require"
+	"gorm.io/gorm"
+)
+
+var (
+	connLock = sync.Mutex{}
+	conn     *gorm.DB
+)
+
+func ConnectForTests(t *testing.T) *gorm.DB {
+	t.Helper()
+
+	connLock.Lock()
+	defer connLock.Unlock()
+
+	if conn != nil {
+		return conn
+	}
+
+	// These are static connection details for tests, started by `leeway components/usage:init-testdb`.
+	// We use the same static credentials for CI & local instance of MySQL Server.
+	var err error
+	conn, err = common_db.Connect(common_db.ConnectionParams{
+		User:     "root",
+		Password: "test",
+		Host:     "localhost:23306",
+		Database: "gitpod",
+	})
+	require.NoError(t, err, "Failed to establish connection to DB. In a workspace, run `leeway build components/usage:init-testdb` once to bootstrap the DB.")
+
+	return conn
+}

components/common-go/db/dbtest/personal_access_token.go

@@ -0,0 +1,102 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package dbtest
+
+import (
+	"context"
+	"database/sql/driver"
+	"errors"
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/google/uuid"
+	"gorm.io/gorm"
+)
+
+type PersonalAccessToken struct {
+	ID             uuid.UUID `gorm:"primary_key;column:id;type:varchar;size:255;" json:"id"`
+	UserID         uuid.UUID `gorm:"column:userId;type:varchar;size:255;" json:"userId"`
+	Hash           string    `gorm:"column:hash;type:varchar;size:255;" json:"hash"`
+	Name           string    `gorm:"column:name;type:varchar;size:255;" json:"name"`
+	Description    string    `gorm:"column:description;type:varchar;size:255;" json:"description"`
+	Scopes         Scopes    `gorm:"column:scopes;type:text;size:65535;" json:"scopes"`
+	ExpirationTime time.Time `gorm:"column:expirationTime;type:timestamp;" json:"expirationTime"`
+	CreatedAt      time.Time `gorm:"column:createdAt;type:timestamp;default:CURRENT_TIMESTAMP(6);" json:"createdAt"`
+	LastModified   time.Time `gorm:"column:_lastModified;type:timestamp;default:CURRENT_TIMESTAMP(6);" json:"_lastModified"`
+
+	// deleted is reserved for use by db-sync.
+	_ bool `gorm:"column:deleted;type:tinyint;default:0;" json:"deleted"`
+}
+
+type Scopes []string
+
+// TableName sets the insert table name for this struct type
+func (d *PersonalAccessToken) TableName() string {
+	return "d_b_personal_access_token"
+}
+
+func GetToken(ctx context.Context, conn *gorm.DB, id uuid.UUID) (PersonalAccessToken, error) {
+	var token PersonalAccessToken
+
+	db := conn.WithContext(ctx)
+
+	db = db.Where("id = ?", id).First(&token)
+	if db.Error != nil {
+		return PersonalAccessToken{}, fmt.Errorf("Failed to retrieve token: %w", db.Error)
+	}
+
+	return token, nil
+}
+
+func CreateToken(ctx context.Context, conn *gorm.DB, req PersonalAccessToken) (PersonalAccessToken, error) {
+	if req.UserID == uuid.Nil {
+		return PersonalAccessToken{}, fmt.Errorf("Invalid or empty userID")
+	}
+	if req.Hash == "" {
+		return PersonalAccessToken{}, fmt.Errorf("Token hash required")
+	}
+	if req.Name == "" {
+		return PersonalAccessToken{}, fmt.Errorf("Token name required")
+	}
+	if req.ExpirationTime.IsZero() {
+		return PersonalAccessToken{}, fmt.Errorf("Expiration time required")
+	}
+
+	token := PersonalAccessToken{
+		ID:             req.ID,
+		UserID:         req.UserID,
+		Hash:           req.Hash,
+		Name:           req.Name,
+		Description:    req.Description,
+		Scopes:         req.Scopes,
+		ExpirationTime: req.ExpirationTime,
+		CreatedAt:      time.Now().UTC(),
+		LastModified:   time.Now().UTC(),
+	}
+
+	db := conn.WithContext(ctx).Create(req)
+	if db.Error != nil {
+		return PersonalAccessToken{}, fmt.Errorf("Failed to create token for user %s", req.UserID)
+	}
+
+	return token, nil
+}
+
+// Scan() and Value() allow having a list of strings as a type for Scopes
+func (s *Scopes) Scan(src any) error {
+	bytes, ok := src.([]byte)
+	if !ok {
+		return errors.New("src value cannot cast to []byte")
+	}
+	*s = strings.Split(string(bytes), ",")
+	return nil
+}
+func (s Scopes) Value() (driver.Value, error) {
+	if len(s) == 0 {
+		return nil, nil
+	}
+	return strings.Join(s, ","), nil
+}

components/common-go/db/dbtest/personal_access_token_test.go

@@ -0,0 +1,58 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License-AGPL.txt in the project root for license information.
+
+package dbtest
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/require"
+)
+
+func TestPersonalAccessToken_Get(t *testing.T) {
+	conn := ConnectForTests(t)
+
+	token := PersonalAccessToken{
+		ID:             uuid.New(),
+		UserID:         uuid.New(),
+		Hash:           "some-secure-hash",
+		Name:           "some-name",
+		Description:    "some-description",
+		Scopes:         []string{"read", "write"},
+		ExpirationTime: time.Now().Add(5),
+		CreatedAt:      time.Now(),
+		LastModified:   time.Now(),
+	}
+
+	tx := conn.Create(token)
+	require.NoError(t, tx.Error)
+
+	result, err := GetToken(context.Background(), conn, token.ID)
+	require.NoError(t, err)
+	require.Equal(t, token.ID, result.ID)
+}
+
+func TestPersonalAccessToken_Create(t *testing.T) {
+	conn := ConnectForTests(t)
+
+	request := PersonalAccessToken{
+		ID:             uuid.New(),
+		UserID:         uuid.New(),
+		Hash:           "another-secure-hash",
+		Name:           "another-name",
+		Description:    "another-description",
+		Scopes:         []string{"read", "write"},
+		ExpirationTime: time.Now().Add(5),
+		CreatedAt:      time.Now(),
+		LastModified:   time.Now(),
+	}
+
+	result, err := CreateToken(context.Background(), conn, request)
+	require.NoError(t, err)
+
+	require.Equal(t, request.ID, result.ID)
+}

components/common-go/go.mod

@@ -36,6 +36,7 @@ require (
 
 require (
 	github.com/go-sql-driver/mysql v1.6.0
+	github.com/google/uuid v1.1.2
 	github.com/relvacode/iso8601 v1.1.0
 	gorm.io/driver/mysql v1.4.4
 	gorm.io/gorm v1.24.1