mirror of
https://github.com/usememos/memos.git
synced 2025-11-01 17:29:24 +08:00
chore: add server tests
This commit is contained in:
parent
dac059a7f7
commit
8e8e246ab2
3 changed files with 369 additions and 2 deletions
81
server/router/api/v1/test_helper.go
Normal file
81
server/router/api/v1/test_helper.go
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
package v1
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/usememos/memos/internal/profile"
|
||||
"github.com/usememos/memos/store"
|
||||
teststore "github.com/usememos/memos/store/test"
|
||||
)
|
||||
|
||||
// TestService holds the test service setup for API v1 services.
|
||||
type TestService struct {
|
||||
Service *APIV1Service
|
||||
Store *store.Store
|
||||
Profile *profile.Profile
|
||||
Secret string
|
||||
}
|
||||
|
||||
// NewTestService creates a new test service with SQLite database.
|
||||
func NewTestService(t *testing.T) *TestService {
|
||||
ctx := context.Background()
|
||||
|
||||
// Create a test store with SQLite
|
||||
testStore := teststore.NewTestingStore(ctx, t)
|
||||
|
||||
// Create a test profile
|
||||
testProfile := &profile.Profile{
|
||||
Mode: "dev",
|
||||
Version: "test-1.0.0",
|
||||
InstanceURL: "http://localhost:8080",
|
||||
Driver: "sqlite",
|
||||
DSN: ":memory:",
|
||||
}
|
||||
|
||||
// Create APIV1Service with nil grpcServer since we're testing direct calls
|
||||
secret := "test-secret"
|
||||
service := &APIV1Service{
|
||||
Secret: secret,
|
||||
Profile: testProfile,
|
||||
Store: testStore,
|
||||
}
|
||||
|
||||
return &TestService{
|
||||
Service: service,
|
||||
Store: testStore,
|
||||
Profile: testProfile,
|
||||
Secret: secret,
|
||||
}
|
||||
}
|
||||
|
||||
// Cleanup clears caches and closes resources after test.
|
||||
func (ts *TestService) Cleanup() {
|
||||
ts.Store.Close()
|
||||
// Clear the global owner cache for test isolation
|
||||
ownerCache = nil
|
||||
}
|
||||
|
||||
// CreateHostUser creates a host user for testing.
|
||||
func (ts *TestService) CreateHostUser(ctx context.Context, username string) (*store.User, error) {
|
||||
return ts.Store.CreateUser(ctx, &store.User{
|
||||
Username: username,
|
||||
Role: store.RoleHost,
|
||||
Email: username + "@example.com",
|
||||
})
|
||||
}
|
||||
|
||||
// CreateRegularUser creates a regular user for testing.
|
||||
func (ts *TestService) CreateRegularUser(ctx context.Context, username string) (*store.User, error) {
|
||||
return ts.Store.CreateUser(ctx, &store.User{
|
||||
Username: username,
|
||||
Role: store.RoleUser,
|
||||
Email: username + "@example.com",
|
||||
})
|
||||
}
|
||||
|
||||
// CreateUserContext creates a context with the given username for authentication.
|
||||
func (ts *TestService) CreateUserContext(ctx context.Context, username string) context.Context {
|
||||
_ = ts // Silence unused receiver warning - method is part of TestService interface
|
||||
return context.WithValue(ctx, ContextKey(0), username) // usernameContextKey = 0
|
||||
}
|
||||
286
server/router/api/v1/workspace_service_test.go
Normal file
286
server/router/api/v1/workspace_service_test.go
Normal file
|
|
@ -0,0 +1,286 @@
|
|||
package v1
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
v1pb "github.com/usememos/memos/proto/gen/api/v1"
|
||||
)
|
||||
|
||||
func TestGetWorkspaceProfile(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
t.Run("GetWorkspaceProfile returns workspace profile", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Call GetWorkspaceProfile directly
|
||||
req := &v1pb.GetWorkspaceProfileRequest{}
|
||||
resp, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
|
||||
// Verify response
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
|
||||
// Verify the response contains expected data
|
||||
require.Equal(t, "test-1.0.0", resp.Version)
|
||||
require.Equal(t, "dev", resp.Mode)
|
||||
require.Equal(t, "http://localhost:8080", resp.InstanceUrl)
|
||||
|
||||
// Owner should be empty since no users are created
|
||||
require.Empty(t, resp.Owner)
|
||||
})
|
||||
|
||||
t.Run("GetWorkspaceProfile with owner", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Create a host user in the store
|
||||
hostUser, err := ts.CreateHostUser(ctx, "admin")
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, hostUser)
|
||||
|
||||
// Call GetWorkspaceProfile directly
|
||||
req := &v1pb.GetWorkspaceProfileRequest{}
|
||||
resp, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
|
||||
// Verify response
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
|
||||
// Verify the response contains expected data including owner
|
||||
require.Equal(t, "test-1.0.0", resp.Version)
|
||||
require.Equal(t, "dev", resp.Mode)
|
||||
require.Equal(t, "http://localhost:8080", resp.InstanceUrl)
|
||||
|
||||
// User name should be "users/{id}" format where id is the user's ID
|
||||
expectedOwnerName := fmt.Sprintf("users/%d", hostUser.ID)
|
||||
require.Equal(t, expectedOwnerName, resp.Owner)
|
||||
})
|
||||
}
|
||||
|
||||
func TestGetWorkspaceProfile_ErrorCases(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
t.Run("Service handles multiple calls correctly", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Make multiple calls to ensure consistency
|
||||
for i := 0; i < 5; i++ {
|
||||
req := &v1pb.GetWorkspaceProfileRequest{}
|
||||
resp, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
require.Equal(t, "test-1.0.0", resp.Version)
|
||||
require.Equal(t, "dev", resp.Mode)
|
||||
require.Equal(t, "http://localhost:8080", resp.InstanceUrl)
|
||||
require.Empty(t, resp.Owner)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Multiple users, only host is returned as owner", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Create a regular user first
|
||||
_, err := ts.CreateRegularUser(ctx, "user1")
|
||||
require.NoError(t, err)
|
||||
|
||||
// Create another regular user
|
||||
_, err = ts.CreateRegularUser(ctx, "user2")
|
||||
require.NoError(t, err)
|
||||
|
||||
// Create a host user
|
||||
hostUser, err := ts.CreateHostUser(ctx, "admin")
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, hostUser)
|
||||
|
||||
// Call GetWorkspaceProfile
|
||||
req := &v1pb.GetWorkspaceProfileRequest{}
|
||||
resp, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
|
||||
// Verify response
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
|
||||
// Should return the host user as owner, not any of the regular users
|
||||
expectedOwnerName := fmt.Sprintf("users/%d", hostUser.ID)
|
||||
require.Equal(t, expectedOwnerName, resp.Owner)
|
||||
})
|
||||
|
||||
t.Run("Cache behavior - owner cached after first lookup", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Create a host user
|
||||
hostUser, err := ts.CreateHostUser(ctx, "admin")
|
||||
require.NoError(t, err)
|
||||
expectedOwnerName := fmt.Sprintf("users/%d", hostUser.ID)
|
||||
|
||||
// First call should query the database
|
||||
req := &v1pb.GetWorkspaceProfileRequest{}
|
||||
resp1, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, expectedOwnerName, resp1.Owner)
|
||||
|
||||
// Create another host user (this shouldn't change the result due to caching)
|
||||
_, err = ts.CreateHostUser(ctx, "admin2")
|
||||
require.NoError(t, err)
|
||||
|
||||
// Second call should return cached result (first host user)
|
||||
resp2, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, expectedOwnerName, resp2.Owner) // Should still be the first host user
|
||||
})
|
||||
}
|
||||
|
||||
func TestGetWorkspaceProfile_Concurrency(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
t.Run("Concurrent access to service", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Create a host user
|
||||
hostUser, err := ts.CreateHostUser(ctx, "admin")
|
||||
require.NoError(t, err)
|
||||
expectedOwnerName := fmt.Sprintf("users/%d", hostUser.ID)
|
||||
|
||||
// Make concurrent requests
|
||||
numGoroutines := 10
|
||||
results := make(chan *v1pb.WorkspaceProfile, numGoroutines)
|
||||
errors := make(chan error, numGoroutines)
|
||||
|
||||
for i := 0; i < numGoroutines; i++ {
|
||||
go func() {
|
||||
req := &v1pb.GetWorkspaceProfileRequest{}
|
||||
resp, err := ts.Service.GetWorkspaceProfile(ctx, req)
|
||||
if err != nil {
|
||||
errors <- err
|
||||
return
|
||||
}
|
||||
results <- resp
|
||||
}()
|
||||
}
|
||||
|
||||
// Collect all results
|
||||
for i := 0; i < numGoroutines; i++ {
|
||||
select {
|
||||
case err := <-errors:
|
||||
t.Fatalf("Goroutine returned error: %v", err)
|
||||
case resp := <-results:
|
||||
require.NotNil(t, resp)
|
||||
require.Equal(t, "test-1.0.0", resp.Version)
|
||||
require.Equal(t, "dev", resp.Mode)
|
||||
require.Equal(t, "http://localhost:8080", resp.InstanceUrl)
|
||||
require.Equal(t, expectedOwnerName, resp.Owner)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestGetWorkspaceSetting(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
t.Run("GetWorkspaceSetting - general setting", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Call GetWorkspaceSetting for general setting
|
||||
req := &v1pb.GetWorkspaceSettingRequest{
|
||||
Name: "workspace/settings/GENERAL",
|
||||
}
|
||||
resp, err := ts.Service.GetWorkspaceSetting(ctx, req)
|
||||
|
||||
// Verify response
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
require.Equal(t, "workspace/settings/GENERAL", resp.Name)
|
||||
|
||||
// The general setting should have a general_setting field
|
||||
generalSetting := resp.GetGeneralSetting()
|
||||
require.NotNil(t, generalSetting)
|
||||
|
||||
// General setting should have default values
|
||||
require.False(t, generalSetting.DisallowUserRegistration)
|
||||
require.False(t, generalSetting.DisallowPasswordAuth)
|
||||
require.Empty(t, generalSetting.AdditionalScript)
|
||||
})
|
||||
|
||||
t.Run("GetWorkspaceSetting - storage setting", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Create a host user for storage setting access
|
||||
hostUser, err := ts.CreateHostUser(ctx, "testhost")
|
||||
require.NoError(t, err)
|
||||
|
||||
// Add user to context
|
||||
userCtx := ts.CreateUserContext(ctx, hostUser.Username)
|
||||
|
||||
// Call GetWorkspaceSetting for storage setting
|
||||
req := &v1pb.GetWorkspaceSettingRequest{
|
||||
Name: "workspace/settings/STORAGE",
|
||||
}
|
||||
resp, err := ts.Service.GetWorkspaceSetting(userCtx, req)
|
||||
|
||||
// Verify response
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
require.Equal(t, "workspace/settings/STORAGE", resp.Name)
|
||||
|
||||
// The storage setting should have a storage_setting field
|
||||
storageSetting := resp.GetStorageSetting()
|
||||
require.NotNil(t, storageSetting)
|
||||
})
|
||||
|
||||
t.Run("GetWorkspaceSetting - memo related setting", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Call GetWorkspaceSetting for memo related setting
|
||||
req := &v1pb.GetWorkspaceSettingRequest{
|
||||
Name: "workspace/settings/MEMO_RELATED",
|
||||
}
|
||||
resp, err := ts.Service.GetWorkspaceSetting(ctx, req)
|
||||
|
||||
// Verify response
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, resp)
|
||||
require.Equal(t, "workspace/settings/MEMO_RELATED", resp.Name)
|
||||
|
||||
// The memo related setting should have a memo_related_setting field
|
||||
memoRelatedSetting := resp.GetMemoRelatedSetting()
|
||||
require.NotNil(t, memoRelatedSetting)
|
||||
})
|
||||
|
||||
t.Run("GetWorkspaceSetting - invalid setting name", func(t *testing.T) {
|
||||
// Create test service for this specific test
|
||||
ts := NewTestService(t)
|
||||
defer ts.Cleanup()
|
||||
|
||||
// Call GetWorkspaceSetting with invalid name
|
||||
req := &v1pb.GetWorkspaceSettingRequest{
|
||||
Name: "invalid/setting/name",
|
||||
}
|
||||
_, err := ts.Service.GetWorkspaceSetting(ctx, req)
|
||||
|
||||
// Should return an error
|
||||
require.Error(t, err)
|
||||
require.Contains(t, err.Error(), "invalid workspace setting name")
|
||||
})
|
||||
}
|
||||
|
|
@ -258,7 +258,7 @@ func (s *Store) normalizeMigrationHistoryList(ctx context.Context) error {
|
|||
versions = append(versions, migrationHistory.Version)
|
||||
}
|
||||
if len(versions) == 0 {
|
||||
return errors.Errorf("no migration history found")
|
||||
return nil
|
||||
}
|
||||
sort.Sort(version.SortVersion(versions))
|
||||
latestVersion := versions[len(versions)-1]
|
||||
|
|
@ -309,7 +309,7 @@ func (s *Store) migrateSchemaVersionToSetting(ctx context.Context) error {
|
|||
versions = append(versions, migrationHistory.Version)
|
||||
}
|
||||
if len(versions) == 0 {
|
||||
return errors.Errorf("no migration history found")
|
||||
return nil
|
||||
}
|
||||
sort.Sort(version.SortVersion(versions))
|
||||
latestVersion := versions[len(versions)-1]
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue