mirror of
https://github.com/kikootwo/ReadMeABook.git
synced 2026-06-03 12:50:09 +00:00
Add backend unit test framework and modularize settings UI
Introduced a Vitest-based backend unit testing framework with supporting scripts, helpers, and GitHub Actions integration. Refactored the admin settings page to a modular architecture, splitting monolithic logic into feature-specific tabs and hooks for improved maintainability and testability. Updated documentation to reflect the new testing setup and settings architecture, and added new dependencies for testing utilities.
This commit is contained in:
kikootwo
@@ -0,0 +1,150 @@
|
||||
/**
|
||||
* Component: Audiobookshelf Library Service Tests
|
||||
* Documentation: documentation/features/audiobookshelf-integration.md
|
||||
*/
|
||||
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { AudiobookshelfLibraryService } from '@/lib/services/library/AudiobookshelfLibraryService';
|
||||
|
||||
const apiMock = vi.hoisted(() => ({
|
||||
getABSServerInfo: vi.fn(),
|
||||
getABSLibraries: vi.fn(),
|
||||
getABSLibraryItems: vi.fn(),
|
||||
getABSRecentItems: vi.fn(),
|
||||
getABSItem: vi.fn(),
|
||||
searchABSItems: vi.fn(),
|
||||
triggerABSScan: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock('@/lib/services/audiobookshelf/api', () => apiMock);
|
||||
|
||||
describe('AudiobookshelfLibraryService', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it('tests connection and returns server info', async () => {
|
||||
apiMock.getABSServerInfo.mockResolvedValue({ name: 'ABS', version: '2.0.0' });
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
const result = await service.testConnection();
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.serverInfo).toEqual({
|
||||
name: 'ABS',
|
||||
version: '2.0.0',
|
||||
identifier: 'ABS',
|
||||
});
|
||||
});
|
||||
|
||||
it('returns errors when server info fails', async () => {
|
||||
apiMock.getABSServerInfo.mockRejectedValue(new Error('No connection'));
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
const result = await service.testConnection();
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('No connection');
|
||||
});
|
||||
|
||||
it('filters audiobook libraries only', async () => {
|
||||
apiMock.getABSLibraries.mockResolvedValue([
|
||||
{ id: 'lib-1', name: 'Books', mediaType: 'book', stats: { totalItems: 10 } },
|
||||
{ id: 'lib-2', name: 'Podcasts', mediaType: 'podcast', stats: { totalItems: 5 } },
|
||||
]);
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
const libs = await service.getLibraries();
|
||||
|
||||
expect(libs).toEqual([
|
||||
{ id: 'lib-1', name: 'Books', type: 'book', itemCount: 10 },
|
||||
]);
|
||||
});
|
||||
|
||||
it('maps library items to generic fields', async () => {
|
||||
apiMock.getABSLibraryItems.mockResolvedValue([
|
||||
{
|
||||
id: 'item-1',
|
||||
addedAt: 1700000000000,
|
||||
updatedAt: 1700000100000,
|
||||
media: {
|
||||
duration: 3600,
|
||||
coverPath: '/covers/1.jpg',
|
||||
metadata: {
|
||||
title: 'Title',
|
||||
authorName: 'Author',
|
||||
narratorName: 'Narrator',
|
||||
description: 'Desc',
|
||||
asin: 'ASIN1',
|
||||
isbn: 'ISBN1',
|
||||
publishedYear: '2020',
|
||||
},
|
||||
},
|
||||
},
|
||||
]);
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
const items = await service.getLibraryItems('lib-1');
|
||||
|
||||
expect(items[0]).toEqual({
|
||||
id: 'item-1',
|
||||
externalId: 'item-1',
|
||||
title: 'Title',
|
||||
author: 'Author',
|
||||
narrator: 'Narrator',
|
||||
description: 'Desc',
|
||||
coverUrl: '/api/items/item-1/cover',
|
||||
duration: 3600,
|
||||
asin: 'ASIN1',
|
||||
isbn: 'ISBN1',
|
||||
year: 2020,
|
||||
addedAt: new Date(1700000000000),
|
||||
updatedAt: new Date(1700000100000),
|
||||
});
|
||||
});
|
||||
|
||||
it('returns null when item fetch fails', async () => {
|
||||
apiMock.getABSItem.mockRejectedValue(new Error('missing'));
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
const result = await service.getItem('item-1');
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('searches items and maps results', async () => {
|
||||
apiMock.searchABSItems.mockResolvedValue([
|
||||
{
|
||||
libraryItem: {
|
||||
id: 'item-2',
|
||||
addedAt: 1700000000000,
|
||||
updatedAt: 1700000000000,
|
||||
media: {
|
||||
duration: 200,
|
||||
metadata: {
|
||||
title: 'Search Title',
|
||||
authorName: 'Search Author',
|
||||
narratorName: '',
|
||||
description: '',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
]);
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
const items = await service.searchItems('lib-1', 'Search');
|
||||
|
||||
expect(items[0].title).toBe('Search Title');
|
||||
expect(items[0].author).toBe('Search Author');
|
||||
});
|
||||
|
||||
it('triggers library scans', async () => {
|
||||
apiMock.triggerABSScan.mockResolvedValue(undefined);
|
||||
|
||||
const service = new AudiobookshelfLibraryService();
|
||||
await service.triggerLibraryScan('lib-1');
|
||||
|
||||
expect(apiMock.triggerABSScan).toHaveBeenCalledWith('lib-1');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,62 @@
|
||||
/**
|
||||
* Component: Library Service Factory Tests
|
||||
* Documentation: documentation/features/audiobookshelf-integration.md
|
||||
*/
|
||||
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { clearLibraryServiceCache, getLibraryService } from '@/lib/services/library';
|
||||
|
||||
const MockPlexService = vi.hoisted(() => class MockPlexService {});
|
||||
const MockAbsService = vi.hoisted(() => class MockAbsService {});
|
||||
|
||||
const configServiceMock = vi.hoisted(() => ({
|
||||
getBackendMode: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock('@/lib/services/config.service', () => ({
|
||||
getConfigService: () => configServiceMock,
|
||||
}));
|
||||
|
||||
vi.mock('@/lib/services/library/PlexLibraryService', () => ({
|
||||
PlexLibraryService: MockPlexService,
|
||||
}));
|
||||
|
||||
vi.mock('@/lib/services/library/AudiobookshelfLibraryService', () => ({
|
||||
AudiobookshelfLibraryService: MockAbsService,
|
||||
}));
|
||||
|
||||
describe('Library service factory', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
clearLibraryServiceCache();
|
||||
});
|
||||
|
||||
it('returns Plex service when backend mode is plex', async () => {
|
||||
configServiceMock.getBackendMode.mockResolvedValue('plex');
|
||||
|
||||
const service = await getLibraryService();
|
||||
|
||||
expect(service).toBeInstanceOf(MockPlexService);
|
||||
});
|
||||
|
||||
it('returns cached service when mode is unchanged', async () => {
|
||||
configServiceMock.getBackendMode.mockResolvedValue('plex');
|
||||
|
||||
const first = await getLibraryService();
|
||||
const second = await getLibraryService();
|
||||
|
||||
expect(first).toBe(second);
|
||||
});
|
||||
|
||||
it('switches to Audiobookshelf service when mode changes', async () => {
|
||||
configServiceMock.getBackendMode
|
||||
.mockResolvedValueOnce('plex')
|
||||
.mockResolvedValueOnce('audiobookshelf');
|
||||
|
||||
const first = await getLibraryService();
|
||||
const second = await getLibraryService();
|
||||
|
||||
expect(first).toBeInstanceOf(MockPlexService);
|
||||
expect(second).toBeInstanceOf(MockAbsService);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,214 @@
|
||||
/**
|
||||
* Component: Plex Library Service Tests
|
||||
* Documentation: documentation/features/audiobookshelf-integration.md
|
||||
*/
|
||||
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { PlexLibraryService } from '@/lib/services/library/PlexLibraryService';
|
||||
|
||||
const plexServiceMock = vi.hoisted(() => ({
|
||||
testConnection: vi.fn(),
|
||||
getLibraries: vi.fn(),
|
||||
getLibraryContent: vi.fn(),
|
||||
getRecentlyAdded: vi.fn(),
|
||||
getItemMetadata: vi.fn(),
|
||||
searchLibrary: vi.fn(),
|
||||
scanLibrary: vi.fn(),
|
||||
}));
|
||||
|
||||
const configServiceMock = vi.hoisted(() => ({
|
||||
getPlexConfig: vi.fn(),
|
||||
}));
|
||||
|
||||
vi.mock('@/lib/integrations/plex.service', () => ({
|
||||
getPlexService: () => plexServiceMock,
|
||||
}));
|
||||
|
||||
vi.mock('@/lib/services/config.service', () => ({
|
||||
getConfigService: () => configServiceMock,
|
||||
}));
|
||||
|
||||
describe('PlexLibraryService', () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it('returns error when Plex config is incomplete', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: null, authToken: null });
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const result = await service.testConnection();
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('Plex server configuration is incomplete');
|
||||
});
|
||||
|
||||
it('returns server info on successful test', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.testConnection.mockResolvedValue({
|
||||
success: true,
|
||||
info: {
|
||||
platform: 'Plex',
|
||||
version: '1.0.0',
|
||||
machineIdentifier: 'machine',
|
||||
},
|
||||
});
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const result = await service.testConnection();
|
||||
|
||||
expect(result.success).toBe(true);
|
||||
expect(result.serverInfo).toEqual({
|
||||
name: 'Plex',
|
||||
version: '1.0.0',
|
||||
platform: 'Plex',
|
||||
identifier: 'machine',
|
||||
});
|
||||
});
|
||||
|
||||
it('returns an error when testConnection throws', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.testConnection.mockRejectedValue(new Error('boom'));
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const result = await service.testConnection();
|
||||
|
||||
expect(result.success).toBe(false);
|
||||
expect(result.error).toBe('boom');
|
||||
});
|
||||
|
||||
it('maps libraries and items', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.getLibraries.mockResolvedValue([
|
||||
{ id: 'lib-1', title: 'Audiobooks', type: 'artist', itemCount: 5 },
|
||||
]);
|
||||
plexServiceMock.getLibraryContent.mockResolvedValue([
|
||||
{
|
||||
ratingKey: 'rk-1',
|
||||
guid: 'com.plexapp.agents.audible://B00ABC1234?lang=en',
|
||||
title: 'Title',
|
||||
author: 'Author',
|
||||
narrator: 'Narrator',
|
||||
summary: 'Summary',
|
||||
thumb: '/thumb',
|
||||
duration: 120000,
|
||||
year: 2020,
|
||||
addedAt: 1700000000,
|
||||
updatedAt: 1700000100,
|
||||
},
|
||||
]);
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const libs = await service.getLibraries();
|
||||
const items = await service.getLibraryItems('lib-1');
|
||||
|
||||
expect(libs).toEqual([{ id: 'lib-1', name: 'Audiobooks', type: 'artist', itemCount: 5 }]);
|
||||
expect(items[0]).toEqual({
|
||||
id: 'rk-1',
|
||||
externalId: 'com.plexapp.agents.audible://B00ABC1234?lang=en',
|
||||
title: 'Title',
|
||||
author: 'Author',
|
||||
narrator: 'Narrator',
|
||||
description: 'Summary',
|
||||
coverUrl: '/thumb',
|
||||
duration: 120,
|
||||
asin: 'B00ABC1234',
|
||||
isbn: undefined,
|
||||
year: 2020,
|
||||
addedAt: new Date(1700000000 * 1000),
|
||||
updatedAt: new Date(1700000100 * 1000),
|
||||
});
|
||||
});
|
||||
|
||||
it('returns null for getItem when metadata is unavailable', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.getItemMetadata.mockResolvedValue({ userRating: 4 });
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const item = await service.getItem('rk-1');
|
||||
|
||||
expect(item).toBeNull();
|
||||
});
|
||||
|
||||
it('triggers Plex scans and searches', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.searchLibrary.mockResolvedValue([
|
||||
{
|
||||
ratingKey: 'rk-2',
|
||||
guid: 'plex://album/abc',
|
||||
title: 'Search Title',
|
||||
author: 'Search Author',
|
||||
addedAt: 1700000000,
|
||||
updatedAt: 1700000000,
|
||||
},
|
||||
]);
|
||||
plexServiceMock.scanLibrary.mockResolvedValue(undefined);
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const results = await service.searchItems('lib-1', 'Search');
|
||||
await service.triggerLibraryScan('lib-1');
|
||||
|
||||
expect(results[0].title).toBe('Search Title');
|
||||
expect(results[0].asin).toBeUndefined();
|
||||
expect(plexServiceMock.scanLibrary).toHaveBeenCalledWith('http://plex', 'token', 'lib-1');
|
||||
});
|
||||
|
||||
it('maps recently added items with missing duration', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.getRecentlyAdded.mockResolvedValue([
|
||||
{
|
||||
ratingKey: 'rk-3',
|
||||
guid: 'plex://album/xyz',
|
||||
title: 'Recent Title',
|
||||
author: 'Author',
|
||||
addedAt: 1700000000,
|
||||
updatedAt: 1700000100,
|
||||
},
|
||||
]);
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const items = await service.getRecentlyAdded('lib-1', 5);
|
||||
|
||||
expect(items[0]).toEqual(expect.objectContaining({
|
||||
id: 'rk-3',
|
||||
title: 'Recent Title',
|
||||
asin: undefined,
|
||||
duration: undefined,
|
||||
}));
|
||||
});
|
||||
|
||||
it('throws when server info cannot be retrieved', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.testConnection.mockResolvedValue({ success: false, message: 'down' });
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
|
||||
await expect(service.getServerInfo()).rejects.toThrow('Failed to get server information');
|
||||
});
|
||||
|
||||
it('throws when libraries are fetched without config', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: null, authToken: null });
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
|
||||
await expect(service.getLibraries()).rejects.toThrow('Plex server configuration is incomplete');
|
||||
});
|
||||
|
||||
it('returns null when getItem metadata lookup fails', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: 'http://plex', authToken: 'token' });
|
||||
plexServiceMock.getItemMetadata.mockRejectedValue(new Error('boom'));
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
const item = await service.getItem('rk-2');
|
||||
|
||||
expect(item).toBeNull();
|
||||
});
|
||||
|
||||
it('throws when triggerLibraryScan is called without config', async () => {
|
||||
configServiceMock.getPlexConfig.mockResolvedValue({ serverUrl: null, authToken: null });
|
||||
|
||||
const service = new PlexLibraryService();
|
||||
|
||||
await expect(service.triggerLibraryScan('lib-1')).rejects.toThrow('Plex server configuration is incomplete');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user