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
2026-01-15 16:49:59 -05:00
parent b3f89d67bb
commit 94dbaf073b
127 changed files with 23549 additions and 2868 deletions
+203
View File
@@ -0,0 +1,203 @@
/**
* Component: Setup Validation API Route Tests
* Documentation: documentation/testing.md
*/
import { beforeEach, describe, expect, it, vi } from 'vitest';
const plexServiceMock = vi.hoisted(() => ({
testConnection: vi.fn(),
getLibraries: vi.fn(),
}));
const qbtMock = vi.hoisted(() => ({
testConnectionWithCredentials: vi.fn(),
}));
const sabnzbdMock = vi.hoisted(() => ({
testConnection: vi.fn(),
}));
const prowlarrMock = vi.hoisted(() => ({
getIndexers: vi.fn(),
}));
const issuerMock = vi.hoisted(() => ({
discover: vi.fn(),
}));
const fsMock = vi.hoisted(() => ({
access: vi.fn(),
mkdir: vi.fn(),
writeFile: vi.fn(),
unlink: vi.fn(),
}));
const configServiceMock = vi.hoisted(() => ({
get: vi.fn(),
}));
vi.mock('@/lib/integrations/plex.service', () => ({
getPlexService: () => plexServiceMock,
}));
vi.mock('@/lib/integrations/qbittorrent.service', () => ({
QBittorrentService: {
testConnectionWithCredentials: qbtMock.testConnectionWithCredentials,
},
}));
vi.mock('@/lib/integrations/sabnzbd.service', () => ({
SABnzbdService: class {
constructor() {}
testConnection = sabnzbdMock.testConnection;
},
}));
vi.mock('@/lib/integrations/prowlarr.service', () => ({
ProwlarrService: class {
constructor() {}
getIndexers = prowlarrMock.getIndexers;
},
}));
vi.mock('openid-client', () => ({
Issuer: issuerMock,
}));
vi.mock('fs/promises', () => ({ default: fsMock, ...fsMock, constants: { R_OK: 4 } }));
vi.mock('@/lib/services/config.service', () => ({
getConfigService: () => configServiceMock,
}));
describe('Setup test routes', () => {
beforeEach(() => {
vi.clearAllMocks();
});
it('validates Plex connection and returns libraries', async () => {
plexServiceMock.testConnection.mockResolvedValue({
success: true,
info: { platform: 'Plex', version: '1.0', machineIdentifier: 'machine' },
});
plexServiceMock.getLibraries.mockResolvedValue([{ id: '1', title: 'Books', type: 'book' }]);
const { POST } = await import('@/app/api/setup/test-plex/route');
const response = await POST({ json: vi.fn().mockResolvedValue({ url: 'http://plex', token: 'token' }) } as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.libraries[0].id).toBe('1');
});
it('tests qBittorrent credentials', async () => {
qbtMock.testConnectionWithCredentials.mockResolvedValue('4.0.0');
const { POST } = await import('@/app/api/setup/test-download-client/route');
const response = await POST({
json: vi.fn().mockResolvedValue({
type: 'qbittorrent',
url: 'http://qbt',
username: 'user',
password: 'pass',
}),
} as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.version).toBe('4.0.0');
});
it('tests SABnzbd connection', async () => {
sabnzbdMock.testConnection.mockResolvedValue({ success: true, version: '3.0' });
const { POST } = await import('@/app/api/setup/test-download-client/route');
const response = await POST({
json: vi.fn().mockResolvedValue({
type: 'sabnzbd',
url: 'http://sab',
password: 'api-key',
}),
} as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.version).toBe('3.0');
});
it('tests Prowlarr indexers', async () => {
prowlarrMock.getIndexers.mockResolvedValue([
{ id: 1, name: 'Indexer', protocol: 'torrent', enable: true, capabilities: {} },
{ id: 2, name: 'Disabled', protocol: 'torrent', enable: false, capabilities: {} },
]);
const { POST } = await import('@/app/api/setup/test-prowlarr/route');
const response = await POST({ json: vi.fn().mockResolvedValue({ url: 'http://prowlarr', apiKey: 'key' }) } as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.indexerCount).toBe(1);
});
it('validates OIDC issuer discovery', async () => {
issuerMock.discover.mockResolvedValue({
issuer: 'http://issuer',
metadata: {
authorization_endpoint: 'http://issuer/auth',
token_endpoint: 'http://issuer/token',
userinfo_endpoint: 'http://issuer/user',
jwks_uri: 'http://issuer/jwks',
scopes_supported: ['openid'],
response_types_supported: ['code'],
},
});
const { POST } = await import('@/app/api/setup/test-oidc/route');
const response = await POST({
json: vi.fn().mockResolvedValue({
issuerUrl: 'http://issuer',
clientId: 'client',
clientSecret: 'secret',
}),
} as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.issuer.authorizationEndpoint).toBe('http://issuer/auth');
});
it('validates paths are writable', async () => {
fsMock.access.mockRejectedValueOnce(new Error('missing'));
fsMock.mkdir.mockResolvedValueOnce(undefined);
fsMock.writeFile.mockResolvedValueOnce(undefined);
fsMock.unlink.mockResolvedValueOnce(undefined);
fsMock.access.mockResolvedValueOnce(undefined);
fsMock.writeFile.mockResolvedValueOnce(undefined);
fsMock.unlink.mockResolvedValueOnce(undefined);
const { POST } = await import('@/app/api/setup/test-paths/route');
const response = await POST({
json: vi.fn().mockResolvedValue({ downloadDir: '/downloads', mediaDir: '/media' }),
} as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.downloadDirValid).toBe(true);
});
it('tests Audiobookshelf connection with saved token', async () => {
configServiceMock.get.mockResolvedValueOnce('token');
const fetchMock = vi.fn().mockResolvedValue({
ok: true,
json: vi.fn().mockResolvedValue({ libraries: [{ id: '1', name: 'Lib', mediaType: 'book', stats: { totalItems: 10 } }] }),
});
vi.stubGlobal('fetch', fetchMock);
const { POST } = await import('@/app/api/setup/test-abs/route');
const response = await POST({
json: vi.fn().mockResolvedValue({ serverUrl: 'http://abs', apiToken: '********' }),
} as any);
const payload = await response.json();
expect(payload.success).toBe(true);
expect(payload.libraries[0].id).toBe('1');
});
});