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.
2026-06-02 20:30:10 +00:00 · 2026-01-15 16:49:59 -05:00
parent b3f89d67bb
commit 94dbaf073b
127 changed files with 23549 additions and 2868 deletions
@@ -0,0 +1,225 @@
+/**
+ * Component: Admin Settings Core API Route Tests
+ * Documentation: documentation/testing.md
+ */
+
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { createPrismaMock } from '../helpers/prisma';
+
+let authRequest: any;
+
+const prismaMock = createPrismaMock();
+const requireAuthMock = vi.hoisted(() => vi.fn());
+const requireAdminMock = vi.hoisted(() => vi.fn());
+const configServiceMock = vi.hoisted(() => ({
+  setMany: vi.fn(),
+  clearCache: vi.fn(),
+}));
+const audibleServiceMock = vi.hoisted(() => ({
+  forceReinitialize: vi.fn(),
+}));
+const jobQueueMock = vi.hoisted(() => ({
+  addAudibleRefreshJob: vi.fn(),
+}));
+const plexServiceMock = vi.hoisted(() => ({
+  testConnection: vi.fn(),
+}));
+const pathMapperMock = vi.hoisted(() => ({
+  validate: vi.fn(),
+}));
+const invalidateQbMock = vi.hoisted(() => vi.fn());
+const invalidateSabMock = vi.hoisted(() => vi.fn());
+
+vi.mock('@/lib/db', () => ({
+  prisma: prismaMock,
+}));
+
+vi.mock('@/lib/middleware/auth', () => ({
+  requireAuth: requireAuthMock,
+  requireAdmin: requireAdminMock,
+}));
+
+vi.mock('@/lib/services/config.service', () => ({
+  getConfigService: () => configServiceMock,
+}));
+
+vi.mock('@/lib/integrations/audible.service', () => ({
+  getAudibleService: () => audibleServiceMock,
+}));
+
+vi.mock('@/lib/services/job-queue.service', () => ({
+  getJobQueueService: () => jobQueueMock,
+}));
+
+vi.mock('@/lib/integrations/plex.service', () => ({
+  getPlexService: () => plexServiceMock,
+}));
+
+vi.mock('@/lib/utils/path-mapper', () => ({
+  PathMapper: pathMapperMock,
+}));
+
+vi.mock('@/lib/integrations/qbittorrent.service', () => ({
+  invalidateQBittorrentService: invalidateQbMock,
+}));
+
+vi.mock('@/lib/integrations/sabnzbd.service', () => ({
+  invalidateSABnzbdService: invalidateSabMock,
+}));
+
+describe('Admin settings core routes', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    authRequest = { user: { id: 'admin-1', role: 'admin' }, json: vi.fn() };
+    requireAuthMock.mockImplementation((_req: any, handler: any) => handler(authRequest));
+    requireAdminMock.mockImplementation((_req: any, handler: any) => handler());
+  });
+
+  it('returns settings payload', async () => {
+    prismaMock.configuration.findMany.mockResolvedValueOnce([
+      { key: 'plex_url', value: 'http://plex' },
+      { key: 'plex_token', value: 'token' },
+      { key: 'system.backend_mode', value: 'plex' },
+    ]);
+    prismaMock.user.count.mockResolvedValueOnce(0);
+
+    const { GET } = await import('@/app/api/admin/settings/route');
+    const response = await GET({} as any);
+    const payload = await response.json();
+
+    expect(payload.plex.url).toBe('http://plex');
+    expect(payload.backendMode).toBe('plex');
+  });
+
+  it('updates Plex settings', async () => {
+    plexServiceMock.testConnection.mockResolvedValue({ success: true, info: { machineIdentifier: 'machine' } });
+    const request = {
+      json: vi.fn().mockResolvedValue({
+        url: 'http://plex',
+        token: 'token',
+        libraryId: 'lib',
+        triggerScanAfterImport: true,
+      }),
+    };
+
+    const { PUT } = await import('@/app/api/admin/settings/plex/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(prismaMock.configuration.upsert).toHaveBeenCalled();
+  });
+
+  it('updates download client settings', async () => {
+    const request = {
+      json: vi.fn().mockResolvedValue({
+        type: 'qbittorrent',
+        url: 'http://qbt',
+        username: 'user',
+        password: 'pass',
+        remotePathMappingEnabled: false,
+      }),
+    };
+
+    const { PUT } = await import('@/app/api/admin/settings/download-client/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(invalidateQbMock).toHaveBeenCalled();
+  });
+
+  it('updates paths settings', async () => {
+    const request = {
+      json: vi.fn().mockResolvedValue({
+        downloadDir: '/downloads',
+        mediaDir: '/media',
+        metadataTaggingEnabled: true,
+        chapterMergingEnabled: false,
+      }),
+    };
+
+    const { PUT } = await import('@/app/api/admin/settings/paths/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(invalidateQbMock).toHaveBeenCalled();
+  });
+
+  it('updates Prowlarr settings', async () => {
+    const request = { json: vi.fn().mockResolvedValue({ url: 'http://prowlarr', apiKey: 'key' }) };
+
+    const { PUT } = await import('@/app/api/admin/settings/prowlarr/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+  });
+
+  it('updates registration settings', async () => {
+    const request = { json: vi.fn().mockResolvedValue({ enabled: true, requireAdminApproval: false }) };
+
+    const { PUT } = await import('@/app/api/admin/settings/registration/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(configServiceMock.setMany).toHaveBeenCalled();
+  });
+
+  it('updates OIDC settings', async () => {
+    const request = { json: vi.fn().mockResolvedValue({ enabled: true, providerName: 'OIDC', clientSecret: 'secret' }) };
+
+    const { PUT } = await import('@/app/api/admin/settings/oidc/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(configServiceMock.setMany).toHaveBeenCalled();
+  });
+
+  it('updates ebook settings', async () => {
+    const request = {
+      json: vi.fn().mockResolvedValue({ enabled: true, format: 'epub', baseUrl: 'https://annas-archive.li' }),
+    };
+
+    const { PUT } = await import('@/app/api/admin/settings/ebook/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(configServiceMock.setMany).toHaveBeenCalled();
+  });
+
+  it('updates Audible region and triggers refresh', async () => {
+    const request = { json: vi.fn().mockResolvedValue({ region: 'us' }) };
+
+    const { PUT } = await import('@/app/api/admin/settings/audible/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(jobQueueMock.addAudibleRefreshJob).toHaveBeenCalled();
+  });
+
+  it('updates Audiobookshelf settings', async () => {
+    const request = {
+      json: vi.fn().mockResolvedValue({
+        serverUrl: 'http://abs',
+        apiToken: 'token',
+        libraryId: 'lib',
+        triggerScanAfterImport: true,
+      }),
+    };
+
+    const { PUT } = await import('@/app/api/admin/settings/audiobookshelf/route');
+    const response = await PUT(request as any);
+    const payload = await response.json();
+
+    expect(payload.success).toBe(true);
+    expect(configServiceMock.setMany).toHaveBeenCalled();
+  });
+});
+
+