Harden scaffold (reviewer followups)
- main.ts awaits DatabaseInitService.init() before app.listen(), ensuring
migrations + seed run before the HTTP server accepts traffic.
- AppModule now uses NestModule with consumer.apply() no longer needed for
CSRF (registered globally via app.use after body parsers in main.ts).
- JwtAuthGuard extended from AuthGuard('jwt') so protected endpoints
actually validate the bearer token.
- Admin controller now uses Zod-validated DTOs for body/path/query:
createUser, updateUserRole, userIdParam, listUsersQuery; with @Public
/ @Roles decorators and AdminGuard applied.
- Multer upload module + controller (POST /api/v1/uploads/category-icon
and /challenge-file) with safe-filename strategy, configured
UPLOAD_SIZE_LIMIT, admin-only via AdminGuard, served via /uploads
static handler.
- ThemeLoaderService now requires all 10 canonical theme ids at startup,
backfilling missing themes from built-ins with a warning; validates the
configured themeKey setting and falls back to 'classic' if invalid;
gracefully tolerates missing setting table during early boot.
- Test suite expanded to 76 tests / 17 suites; new specs:
admin-validation, uploads, theme-required, database-init.
This commit is contained in:
@@ -5,11 +5,15 @@ process.env.FRONTEND_DIST = './frontend/dist';
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { INestApplication, ValidationPipe } from '@nestjs/common';
|
||||
import { HttpAdapterHost } from '@nestjs/core';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import * as express from 'express';
|
||||
import request from 'supertest';
|
||||
import { CookieAccessInfo } from 'cookiejar';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import { AppModule } from '../../backend/src/app.module';
|
||||
import { GlobalExceptionFilter } from '../../backend/src/common/filters/global-exception.filter';
|
||||
import { CsrfMiddleware } from '../../backend/src/common/middleware/csrf.middleware';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { initDb } from './db-helper';
|
||||
|
||||
describe('Admin route protection', () => {
|
||||
let app: INestApplication;
|
||||
@@ -19,10 +23,14 @@ describe('Admin route protection', () => {
|
||||
const moduleRef = await Test.createTestingModule({ imports: [AppModule] }).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
app.use(cookieParser());
|
||||
app.use(express.json({ limit: '1mb' }));
|
||||
const csrfMw = new CsrfMiddleware(app.get(ConfigService));
|
||||
app.use((req: any, res: any, next: any) => csrfMw.use(req, res, next));
|
||||
app.useGlobalPipes(new ValidationPipe({ whitelist: true, forbidNonWhitelisted: false, transform: true }));
|
||||
const httpAdapterHost = app.get(HttpAdapterHost);
|
||||
app.useGlobalFilters(new GlobalExceptionFilter(httpAdapterHost));
|
||||
await app.init();
|
||||
await initDb(app);
|
||||
|
||||
const server = app.getHttpServer();
|
||||
await request(server).post('/api/v1/auth/register-first-admin')
|
||||
|
||||
@@ -0,0 +1,163 @@
|
||||
process.env.DATABASE_PATH = ':memory:';
|
||||
process.env.THEMES_DIR = './themes';
|
||||
process.env.FRONTEND_DIST = './frontend/dist';
|
||||
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { INestApplication, ValidationPipe } from '@nestjs/common';
|
||||
import { HttpAdapterHost } from '@nestjs/core';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import * as express from 'express';
|
||||
import request from 'supertest';
|
||||
import { CookieAccessInfo } from 'cookiejar';
|
||||
import { AppModule } from '../../backend/src/app.module';
|
||||
import { GlobalExceptionFilter } from '../../backend/src/common/filters/global-exception.filter';
|
||||
import { DatabaseInitService } from '../../backend/src/database/database-init.service';
|
||||
|
||||
describe('Admin route validation (Zod DTOs)', () => {
|
||||
let app: INestApplication;
|
||||
let adminToken: string;
|
||||
|
||||
beforeAll(async () => {
|
||||
const moduleRef = await Test.createTestingModule({ imports: [AppModule] }).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
app.use(express.json({ limit: '1mb' }));
|
||||
app.use(cookieParser());
|
||||
app.useGlobalPipes(new ValidationPipe({ whitelist: true, forbidNonWhitelisted: false, transform: true }));
|
||||
const httpAdapterHost = app.get(HttpAdapterHost);
|
||||
app.useGlobalFilters(new GlobalExceptionFilter(httpAdapterHost));
|
||||
await app.init();
|
||||
await app.get(DatabaseInitService).init();
|
||||
|
||||
const server = app.getHttpServer();
|
||||
await request(server).post('/api/v1/auth/register-first-admin')
|
||||
.send({ username: 'admin', password: 'Sup3rSecret!Pass' })
|
||||
.expect(201);
|
||||
|
||||
const login = await request(server).post('/api/v1/auth/login')
|
||||
.send({ username: 'admin', password: 'Sup3rSecret!Pass' })
|
||||
.expect(201);
|
||||
adminToken = login.body.accessToken;
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
async function primeCsrf(): Promise<{ agent: any; csrf: string }> {
|
||||
const server = app.getHttpServer();
|
||||
const agent = request.agent(server);
|
||||
await agent.get('/api/v1/auth/csrf');
|
||||
const cookies: any = agent.jar.getCookies(CookieAccessInfo.All);
|
||||
return { agent, csrf: cookies.find((c: any) => c.name === 'csrf').value };
|
||||
}
|
||||
|
||||
describe('POST /api/v1/admin/users', () => {
|
||||
it('rejects missing username with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.post('/api/v1/admin/users')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.send({ password: 'Sup3rSecret!Pass', role: 'player' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects username with invalid characters with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.post('/api/v1/admin/users')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.send({ username: 'bad name!', password: 'Sup3rSecret!Pass', role: 'player' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects weak password with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.post('/api/v1/admin/users')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.send({ username: 'goodname', password: 'short', role: 'player' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects invalid role with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.post('/api/v1/admin/users')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.send({ username: 'goodname', password: 'Sup3rSecret!Pass', role: 'god' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('accepts a well-formed body', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent
|
||||
.post('/api/v1/admin/users')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.set('Content-Type', 'application/json')
|
||||
.send({ username: 'gooduser', password: 'Sup3rSecret!Pass', role: 'player' });
|
||||
expect(res.status).toBe(201);
|
||||
});
|
||||
});
|
||||
|
||||
describe('PATCH /api/v1/admin/users/:id', () => {
|
||||
it('rejects a non-UUID id with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.patch('/api/v1/admin/users/not-a-uuid')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.send({ role: 'player' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects an invalid role with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.patch('/api/v1/admin/users/00000000-0000-0000-0000-000000000000')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.send({ role: 'superuser' });
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe('DELETE /api/v1/admin/users/:id', () => {
|
||||
it('rejects a non-UUID id with 400', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent.delete('/api/v1/admin/users/not-a-uuid')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf);
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe('GET /api/v1/admin/users?limit=...', () => {
|
||||
it('rejects limit > 200 with 400', async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get('/api/v1/admin/users?limit=999')
|
||||
.set('Authorization', `Bearer ${adminToken}`);
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects limit=0 with 400', async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get('/api/v1/admin/users?limit=0')
|
||||
.set('Authorization', `Bearer ${adminToken}`);
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('rejects non-numeric limit with 400', async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get('/api/v1/admin/users?limit=abc')
|
||||
.set('Authorization', `Bearer ${adminToken}`);
|
||||
expect(res.status).toBe(400);
|
||||
});
|
||||
|
||||
it('accepts a valid limit and returns 200', async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get('/api/v1/admin/users?limit=10')
|
||||
.set('Authorization', `Bearer ${adminToken}`);
|
||||
expect(res.status).toBe(200);
|
||||
expect(Array.isArray(res.body)).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -6,22 +6,31 @@ import { Test } from '@nestjs/testing';
|
||||
import { INestApplication, ValidationPipe } from '@nestjs/common';
|
||||
import { HttpAdapterHost } from '@nestjs/core';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import * as express from 'express';
|
||||
import request from 'supertest';
|
||||
import { CookieAccessInfo } from 'cookiejar';
|
||||
import { AppModule } from '../../backend/src/app.module';
|
||||
import { GlobalExceptionFilter } from '../../backend/src/common/filters/global-exception.filter';
|
||||
import { CsrfMiddleware } from '../../backend/src/common/middleware/csrf.middleware';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { initDb } from './db-helper';
|
||||
import { DatabaseInitService } from '../../backend/src/database/database-init.service';
|
||||
|
||||
describe('Auth refresh rotation', () => {
|
||||
let app: INestApplication;
|
||||
|
||||
beforeAll(async () => {
|
||||
beforeAll(async () => {
|
||||
const moduleRef = await Test.createTestingModule({ imports: [AppModule] }).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
app.use(cookieParser());
|
||||
app.use(express.json({ limit: '1mb' }));
|
||||
const csrfMw = new CsrfMiddleware(app.get(ConfigService));
|
||||
app.use((req: any, res: any, next: any) => csrfMw.use(req, res, next));
|
||||
app.useGlobalPipes(new ValidationPipe({ whitelist: true, forbidNonWhitelisted: false, transform: true }));
|
||||
const httpAdapterHost = app.get(HttpAdapterHost);
|
||||
app.useGlobalFilters(new GlobalExceptionFilter(httpAdapterHost));
|
||||
await app.init();
|
||||
await initDb(app);
|
||||
|
||||
const server = app.getHttpServer();
|
||||
await request(server).post('/api/v1/auth/register-first-admin')
|
||||
|
||||
@@ -8,6 +8,7 @@ import { HttpAdapterHost } from '@nestjs/core';
|
||||
import { AppModule } from '../../backend/src/app.module';
|
||||
import { GlobalExceptionFilter } from '../../backend/src/common/filters/global-exception.filter';
|
||||
import { csrfClient, primeCsrf } from './csrf-client';
|
||||
import { initDb } from './db-helper';
|
||||
|
||||
describe('Bootstrap integration', () => {
|
||||
let app: INestApplication;
|
||||
@@ -19,6 +20,7 @@ describe('Bootstrap integration', () => {
|
||||
const httpAdapterHost = app.get(HttpAdapterHost);
|
||||
app.useGlobalFilters(new GlobalExceptionFilter(httpAdapterHost));
|
||||
await app.init();
|
||||
await initDb(app);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { validateEnv } from '../../backend/src/config/env.schema';
|
||||
import { DatabaseModule } from '../../backend/src/database/database.module';
|
||||
import { DatabaseInitService } from '../../backend/src/database/database-init.service';
|
||||
import { CategoryEntity } from '../../backend/src/database/entities/category.entity';
|
||||
import { SettingEntity } from '../../backend/src/database/entities/setting.entity';
|
||||
|
||||
describe('DatabaseInitService', () => {
|
||||
let app: INestApplication;
|
||||
let init: DatabaseInitService;
|
||||
|
||||
beforeAll(async () => {
|
||||
process.env.DATABASE_PATH = ':memory:';
|
||||
process.env.THEMES_DIR = './themes';
|
||||
process.env.FRONTEND_DIST = './frontend/dist';
|
||||
|
||||
const moduleRef = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({ isGlobal: true, validate: validateEnv }),
|
||||
DatabaseModule,
|
||||
],
|
||||
}).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
init = app.get(DatabaseInitService);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
if (app) await app.close();
|
||||
});
|
||||
|
||||
it('creates the schema and seed data on first init()', async () => {
|
||||
await init.init();
|
||||
const ds = (init as any).dataSource;
|
||||
expect(ds.isInitialized).toBe(true);
|
||||
const tables: any[] = await ds.query("SELECT name FROM sqlite_master WHERE type='table'");
|
||||
const names = tables.map((t) => t.name);
|
||||
expect(names).toEqual(expect.arrayContaining([
|
||||
'user', 'setting', 'category', 'challenge', 'challenge_file',
|
||||
'solve', 'refresh_token', 'blog_post',
|
||||
]));
|
||||
|
||||
const categories = await ds.getRepository(CategoryEntity).find();
|
||||
const systemCats = categories.filter((c: any) => c.systemKey);
|
||||
expect(systemCats.length).toBeGreaterThanOrEqual(6);
|
||||
|
||||
const settings = await ds.getRepository(SettingEntity).find();
|
||||
const keys = settings.map((s: any) => s.key);
|
||||
expect(keys).toEqual(expect.arrayContaining([
|
||||
'pageTitle', 'logo', 'welcomeMarkdown', 'themeKey',
|
||||
'defaultChallengeIp', 'registrationsEnabled',
|
||||
'eventStartUtc', 'eventEndUtc',
|
||||
]));
|
||||
});
|
||||
|
||||
it('is idempotent — calling init() twice does not duplicate migrations or seeds', async () => {
|
||||
await init.init();
|
||||
await init.init();
|
||||
const ds = (init as any).dataSource;
|
||||
const categories = await ds.getRepository(CategoryEntity).find();
|
||||
const systemCats = categories.filter((c: any) => c.systemKey);
|
||||
expect(systemCats.length).toBe(6);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,11 @@
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { DatabaseInitService } from '../../backend/src/database/database-init.service';
|
||||
|
||||
/**
|
||||
* Await database initialization (migrations + seed verification) on the
|
||||
* given Nest app. Without this, integration tests that hit controllers
|
||||
* will hit a fresh `:memory:` SQLite database with no tables.
|
||||
*/
|
||||
export async function initDb(app: INestApplication): Promise<void> {
|
||||
await app.get<DatabaseInitService>(DatabaseInitService).init();
|
||||
}
|
||||
@@ -6,9 +6,14 @@ import { RegistrationRateLimitService } from '../../backend/src/common/services/
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { HttpAdapterHost } from '@nestjs/core';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import * as express from 'express';
|
||||
import request from 'supertest';
|
||||
import { AppModule } from '../../backend/src/app.module';
|
||||
import { GlobalExceptionFilter } from '../../backend/src/common/filters/global-exception.filter';
|
||||
import { CsrfMiddleware } from '../../backend/src/common/middleware/csrf.middleware';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { initDb } from './db-helper';
|
||||
|
||||
describe('RegistrationRateLimitService', () => {
|
||||
it('allows up to 10 per minute per IP', () => {
|
||||
@@ -36,9 +41,14 @@ describe('register-first-admin registration rate limit (integration)', () => {
|
||||
beforeAll(async () => {
|
||||
const moduleRef = await Test.createTestingModule({ imports: [AppModule] }).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
app.use(cookieParser());
|
||||
app.use(express.json({ limit: '1mb' }));
|
||||
const csrfMw = new CsrfMiddleware(app.get(ConfigService));
|
||||
app.use((req: any, res: any, next: any) => csrfMw.use(req, res, next));
|
||||
const httpAdapterHost = app.get(HttpAdapterHost);
|
||||
app.useGlobalFilters(new GlobalExceptionFilter(httpAdapterHost));
|
||||
await app.init();
|
||||
await initDb(app);
|
||||
limiter = app.get(RegistrationRateLimitService);
|
||||
});
|
||||
|
||||
@@ -58,7 +68,7 @@ describe('register-first-admin registration rate limit (integration)', () => {
|
||||
|
||||
const server = app.getHttpServer();
|
||||
const agent = request.agent(server);
|
||||
await agent.post('/api/v1/auth/csrf');
|
||||
await agent.get('/api/v1/auth/csrf');
|
||||
const cookies: any = agent.jar.getCookies(require('cookiejar').CookieAccessInfo.All);
|
||||
const csrf = cookies.find((c: any) => c.name === 'csrf');
|
||||
|
||||
|
||||
@@ -5,16 +5,21 @@ import { ThemeLoaderService } from '../../backend/src/common/utils/theme-loader.
|
||||
|
||||
describe('ThemeLoaderService', () => {
|
||||
const config = { get: jest.fn() } as any;
|
||||
// ThemeLoaderService now takes SettingsService for the configured-theme
|
||||
// validation step. We pass a stub that always returns 'classic' so the
|
||||
// existing tests focus on disk loading + lookup behavior.
|
||||
const settings = { get: jest.fn().mockResolvedValue('classic') } as any;
|
||||
|
||||
it('falls back to default and warns on unknown theme id', () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-'));
|
||||
fs.writeFileSync(path.join(tmp, 'classic.json'), JSON.stringify({ id: 'classic', name: 'Classic', tokens: { primary: '#000', secondary: '#111', accent: '#222', surface: '#fff', text: '#000', success: '#0f0', warning: '#ff0', danger: '#f00', fontFamily: 'sans', radii: { sm: '1px', md: '2px', lg: '3px' }, spacingScale: [4, 8] } }));
|
||||
config.get.mockImplementation((k: string, d: any) => (k === 'THEMES_DIR' ? tmp : d));
|
||||
const svc = new ThemeLoaderService(config);
|
||||
svc.onModuleInit();
|
||||
const t = svc.getTheme('does-not-exist');
|
||||
expect(t.id).toBe('classic');
|
||||
expect(t.tokens.primary).toBe('#000');
|
||||
const svc = new ThemeLoaderService(config, settings);
|
||||
return svc.onModuleInit().then(() => {
|
||||
const t = svc.getTheme('does-not-exist');
|
||||
expect(t.id).toBe('classic');
|
||||
expect(t.tokens.primary).toBe('#000');
|
||||
});
|
||||
});
|
||||
|
||||
it('loads a valid theme by id', () => {
|
||||
@@ -22,21 +27,23 @@ describe('ThemeLoaderService', () => {
|
||||
const theme = { id: 'classic', name: 'Classic', tokens: { primary: '#000', secondary: '#111', accent: '#222', surface: '#fff', text: '#000', success: '#0f0', warning: '#ff0', danger: '#f00', fontFamily: 'sans', radii: { sm: '1px', md: '2px', lg: '3px' }, spacingScale: [4, 8] } };
|
||||
fs.writeFileSync(path.join(tmp, 'classic.json'), JSON.stringify(theme));
|
||||
config.get.mockImplementation((k: string, d: any) => (k === 'THEMES_DIR' ? tmp : d));
|
||||
const svc = new ThemeLoaderService(config);
|
||||
svc.onModuleInit();
|
||||
const t = svc.getTheme('classic');
|
||||
expect(t.id).toBe('classic');
|
||||
expect(t.tokens.spacingScale).toEqual([4, 8]);
|
||||
const svc = new ThemeLoaderService(config, settings);
|
||||
return svc.onModuleInit().then(() => {
|
||||
const t = svc.getTheme('classic');
|
||||
expect(t.id).toBe('classic');
|
||||
expect(t.tokens.spacingScale).toEqual([4, 8]);
|
||||
});
|
||||
});
|
||||
|
||||
it('skips invalid theme files', () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-'));
|
||||
fs.writeFileSync(path.join(tmp, 'classic.json'), JSON.stringify({ id: 'classic', name: 'Classic', tokens: { primary: '#000' } })); // missing required
|
||||
config.get.mockImplementation((k: string, d: any) => (k === 'THEMES_DIR' ? tmp : d));
|
||||
const svc = new ThemeLoaderService(config);
|
||||
svc.onModuleInit();
|
||||
// Falls back to builtins; classic should be findable via builtins
|
||||
const t = svc.getTheme('classic');
|
||||
expect(t).toBeDefined();
|
||||
const svc = new ThemeLoaderService(config, settings);
|
||||
return svc.onModuleInit().then(() => {
|
||||
// Falls back to builtins; classic should be findable via builtins
|
||||
const t = svc.getTheme('classic');
|
||||
expect(t).toBeDefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,101 @@
|
||||
import * as path from 'path';
|
||||
import * as fs from 'fs';
|
||||
import * as os from 'os';
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { ConfigModule } from '@nestjs/config';
|
||||
import { validateEnv, SETTINGS_KEYS } from '../../backend/src/config/env.schema';
|
||||
import { ThemeLoaderService } from '../../backend/src/common/utils/theme-loader.service';
|
||||
import { SettingsModule, SettingsService } from '../../backend/src/modules/settings/settings.module';
|
||||
import { CommonModule } from '../../backend/src/common/common.module';
|
||||
import { DatabaseModule } from '../../backend/src/database/database.module';
|
||||
import { DatabaseInitService } from '../../backend/src/database/database-init.service';
|
||||
import { THEME_IDS } from '../../backend/src/common/types/theme-ids';
|
||||
|
||||
describe('ThemeLoaderService - require 10 + validate configured key', () => {
|
||||
let app: INestApplication;
|
||||
let svc: ThemeLoaderService;
|
||||
|
||||
async function buildApp(themeDir: string, themeKey: string): Promise<void> {
|
||||
process.env.THEMES_DIR = themeDir;
|
||||
process.env.DATABASE_PATH = ':memory:';
|
||||
process.env.FRONTEND_DIST = './frontend/dist';
|
||||
|
||||
const moduleRef = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({ isGlobal: true, validate: validateEnv }),
|
||||
DatabaseModule,
|
||||
SettingsModule,
|
||||
CommonModule,
|
||||
],
|
||||
}).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
await app.get(DatabaseInitService).init();
|
||||
const settings = app.get(SettingsService);
|
||||
await settings.set(SETTINGS_KEYS.THEME_KEY, themeKey);
|
||||
svc = app.get(ThemeLoaderService);
|
||||
await svc.onModuleInit();
|
||||
}
|
||||
|
||||
afterEach(async () => {
|
||||
if (app) await app.close();
|
||||
});
|
||||
|
||||
it('exposes all 10 canonical theme ids even when THEMES_DIR is empty', async () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-empty-'));
|
||||
await buildApp(tmp, 'classic');
|
||||
const ids = svc.listThemes().map((t) => t.id).sort();
|
||||
expect(ids).toEqual([
|
||||
'classic', 'crimson', 'cyber', 'forest', 'midnight',
|
||||
'monochrome', 'neon', 'ocean', 'paper', 'sunset',
|
||||
]);
|
||||
expect(svc.listThemes().length).toBe(THEME_IDS.length);
|
||||
});
|
||||
|
||||
it('backfills missing disk themes with built-ins (per-id warn)', async () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-partial-'));
|
||||
// Only write 3 of the 10 themes to disk.
|
||||
for (const id of ['classic', 'midnight', 'cyber']) {
|
||||
fs.writeFileSync(path.join(tmp, `${id}.json`), JSON.stringify({
|
||||
id,
|
||||
name: id,
|
||||
tokens: {
|
||||
primary: '#000', secondary: '#111', accent: '#222', surface: '#fff', text: '#000',
|
||||
success: '#0f0', warning: '#ff0', danger: '#f00',
|
||||
fontFamily: 'sans', radii: { sm: '1px', md: '2px', lg: '3px' },
|
||||
spacingScale: [4, 8],
|
||||
},
|
||||
}));
|
||||
}
|
||||
await buildApp(tmp, 'classic');
|
||||
expect(svc.listThemes().length).toBe(THEME_IDS.length);
|
||||
});
|
||||
|
||||
it('uses the configured themeKey as default when valid', async () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-'));
|
||||
await buildApp(tmp, 'ocean');
|
||||
expect(svc.getDefaultId()).toBe('ocean');
|
||||
const theme = svc.getTheme('ocean');
|
||||
expect(theme.id).toBe('ocean');
|
||||
});
|
||||
|
||||
it('falls back to classic and warns when configured themeKey is invalid', async () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-'));
|
||||
await buildApp(tmp, 'this-theme-does-not-exist');
|
||||
expect(svc.getDefaultId()).toBe('classic');
|
||||
});
|
||||
|
||||
it('falls back to classic and warns when configured themeKey is empty', async () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-'));
|
||||
await buildApp(tmp, '');
|
||||
expect(svc.getDefaultId()).toBe('classic');
|
||||
});
|
||||
|
||||
it('getTheme() returns a real theme for any canonical id', async () => {
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'themes-'));
|
||||
await buildApp(tmp, 'classic');
|
||||
for (const id of THEME_IDS) {
|
||||
expect(svc.getTheme(id).id).toBe(id);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,167 @@
|
||||
process.env.DATABASE_PATH = ':memory:';
|
||||
process.env.THEMES_DIR = './themes';
|
||||
process.env.FRONTEND_DIST = './frontend/dist';
|
||||
process.env.UPLOAD_DIR = '/tmp/hipctf-uploads-test';
|
||||
process.env.UPLOAD_SIZE_LIMIT = '1mb';
|
||||
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
|
||||
import { safeFilename, parseUploadSizeLimit } from '../../backend/src/common/utils/upload';
|
||||
|
||||
describe('safeFilename', () => {
|
||||
it('strips directory traversal', () => {
|
||||
expect(safeFilename('../../etc/passwd')).not.toMatch(/\.\./);
|
||||
expect(safeFilename('/etc/passwd')).not.toMatch(/^\//);
|
||||
});
|
||||
|
||||
it('lowercases and restricts charset to [a-z0-9._-]', () => {
|
||||
const out = safeFilename('My File (1).TXT');
|
||||
expect(out).toMatch(/^[a-z0-9._-]+$/);
|
||||
expect(out).toMatch(/\.txt$/);
|
||||
});
|
||||
|
||||
it('always returns a non-empty unique name with a random suffix', () => {
|
||||
const a = safeFilename('icon.png');
|
||||
const b = safeFilename('icon.png');
|
||||
expect(a).not.toBe(b);
|
||||
expect(a).toMatch(/^icon-[0-9a-f]{8}\.png$/);
|
||||
});
|
||||
|
||||
it('falls back to "file" when nothing usable is left', () => {
|
||||
expect(safeFilename('///')).toMatch(/^file-[0-9a-f]{8}$/);
|
||||
});
|
||||
});
|
||||
|
||||
describe('parseUploadSizeLimit', () => {
|
||||
it('parses kb/mb/gb', () => {
|
||||
expect(parseUploadSizeLimit('1kb')).toBe(1024);
|
||||
expect(parseUploadSizeLimit('5mb')).toBe(5 * 1024 * 1024);
|
||||
expect(parseUploadSizeLimit('2gb')).toBe(2 * 1024 * 1024 * 1024);
|
||||
expect(parseUploadSizeLimit('512b')).toBe(512);
|
||||
});
|
||||
|
||||
it('defaults to 50mb on invalid input', () => {
|
||||
expect(parseUploadSizeLimit(undefined)).toBe(50 * 1024 * 1024);
|
||||
expect(parseUploadSizeLimit('garbage')).toBe(50 * 1024 * 1024);
|
||||
});
|
||||
});
|
||||
|
||||
// Integration: hit the real endpoint via supertest.
|
||||
import { Test } from '@nestjs/testing';
|
||||
import { INestApplication } from '@nestjs/common';
|
||||
import { HttpAdapterHost } from '@nestjs/core';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import * as express from 'express';
|
||||
import request from 'supertest';
|
||||
import { CookieAccessInfo } from 'cookiejar';
|
||||
import { AppModule } from '../../backend/src/app.module';
|
||||
import { GlobalExceptionFilter } from '../../backend/src/common/filters/global-exception.filter';
|
||||
import { CsrfMiddleware } from '../../backend/src/common/middleware/csrf.middleware';
|
||||
import { ConfigService } from '@nestjs/config';
|
||||
import { initDb } from './db-helper';
|
||||
|
||||
describe('Uploads endpoint integration', () => {
|
||||
let app: INestApplication;
|
||||
let adminToken: string;
|
||||
|
||||
beforeAll(async () => {
|
||||
if (fs.existsSync(process.env.UPLOAD_DIR!)) {
|
||||
fs.rmSync(process.env.UPLOAD_DIR!, { recursive: true, force: true });
|
||||
}
|
||||
fs.mkdirSync(process.env.UPLOAD_DIR!, { recursive: true });
|
||||
|
||||
const moduleRef = await Test.createTestingModule({ imports: [AppModule] }).compile();
|
||||
app = moduleRef.createNestApplication();
|
||||
app.use(cookieParser());
|
||||
app.use(express.json({ limit: '1mb' }));
|
||||
// Mirror production: serve /uploads static so we can verify public fetch.
|
||||
app.use('/uploads', express.static(process.env.UPLOAD_DIR!));
|
||||
const csrfMw = new CsrfMiddleware(app.get(ConfigService));
|
||||
app.use((req: any, res: any, next: any) => csrfMw.use(req, res, next));
|
||||
const httpAdapterHost = app.get(HttpAdapterHost);
|
||||
app.useGlobalFilters(new GlobalExceptionFilter(httpAdapterHost));
|
||||
await app.init();
|
||||
await initDb(app);
|
||||
|
||||
const server = app.getHttpServer();
|
||||
await request(server).post('/api/v1/auth/register-first-admin')
|
||||
.send({ username: 'admin', password: 'Sup3rSecret!Pass' })
|
||||
.expect(201);
|
||||
const login = await request(server).post('/api/v1/auth/login')
|
||||
.send({ username: 'admin', password: 'Sup3rSecret!Pass' })
|
||||
.expect(201);
|
||||
adminToken = login.body.accessToken;
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
if (fs.existsSync(process.env.UPLOAD_DIR!)) {
|
||||
fs.rmSync(process.env.UPLOAD_DIR!, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
async function primeCsrf(): Promise<{ agent: any; csrf: string }> {
|
||||
const server = app.getHttpServer();
|
||||
const agent = request.agent(server);
|
||||
await agent.get('/api/v1/auth/csrf');
|
||||
const cookies: any = agent.jar.getCookies(CookieAccessInfo.All);
|
||||
return { agent, csrf: cookies.find((c: any) => c.name === 'csrf').value };
|
||||
}
|
||||
|
||||
it('rejects upload without auth (or CSRF)', async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.post('/api/v1/uploads/category-icon')
|
||||
.attach('file', Buffer.from('hello'), 'icon.png');
|
||||
// Without a session AND without a CSRF cookie, the CSRF middleware
|
||||
// short-circuits first with 403. Either 401 (auth) or 403 (csrf) is
|
||||
// a valid rejection; the test asserts the upload is rejected.
|
||||
expect([401, 403]).toContain(res.status);
|
||||
});
|
||||
|
||||
it('uploads a small file successfully', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent
|
||||
.post('/api/v1/uploads/category-icon')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.attach('file', Buffer.from('hello world'), 'icon.png');
|
||||
expect(res.status).toBe(201);
|
||||
expect(res.body.id).toMatch(/^icon-[0-9a-f]{8}\.png$/);
|
||||
expect(res.body.publicUrl).toBe(`/uploads/icons/${res.body.id}`);
|
||||
// File actually written under UPLOAD_DIR/icons
|
||||
const written = path.join(process.env.UPLOAD_DIR!, 'icons', res.body.id);
|
||||
expect(fs.existsSync(written)).toBe(true);
|
||||
// Public-served via /uploads static handler.
|
||||
const fetched = await request(app.getHttpServer()).get(res.body.publicUrl).expect(200);
|
||||
expect(fetched.body?.toString()).toBe('hello world');
|
||||
});
|
||||
|
||||
it('rejects oversize uploads (limit=1mb, file=2mb)', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const big = Buffer.alloc(2 * 1024 * 1024, 'a'); // 2MB
|
||||
const res = await agent
|
||||
.post('/api/v1/uploads/category-icon')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.attach('file', big, 'big.bin');
|
||||
// Multer's LIMIT_FILE_SIZE surfaces as 500 by default; we accept 4xx/5xx
|
||||
// and just verify the file was NOT saved.
|
||||
expect([400, 413, 500]).toContain(res.status);
|
||||
const icons = fs.existsSync(path.join(process.env.UPLOAD_DIR!, 'icons'))
|
||||
? fs.readdirSync(path.join(process.env.UPLOAD_DIR!, 'icons'))
|
||||
: [];
|
||||
expect(icons.some((f) => f === 'big.bin')).toBe(false);
|
||||
});
|
||||
|
||||
it('stores files under per-route subdirectories', async () => {
|
||||
const { agent, csrf } = await primeCsrf();
|
||||
const res = await agent
|
||||
.post('/api/v1/uploads/challenge-file')
|
||||
.set('Authorization', `Bearer ${adminToken}`)
|
||||
.set('X-CSRF-Token', csrf)
|
||||
.attach('file', Buffer.from('attachment'), 'readme.txt');
|
||||
expect(res.status).toBe(201);
|
||||
expect(res.body.publicUrl).toMatch(/^\/uploads\/challenges\//);
|
||||
});
|
||||
});
|
||||
@@ -19,9 +19,11 @@ describe('ThemeLoaderService builtins', () => {
|
||||
|
||||
it('falls back to default for unknown id', () => {
|
||||
const config = { get: jest.fn((k: string, d: any) => d) } as any;
|
||||
const svc = new ThemeLoaderService(config);
|
||||
svc.onModuleInit();
|
||||
const t = svc.getTheme('totally-unknown');
|
||||
expect(t.id).toBe('classic');
|
||||
const settings = { get: jest.fn().mockResolvedValue('classic') } as any;
|
||||
const svc = new ThemeLoaderService(config, settings);
|
||||
return svc.onModuleInit().then(() => {
|
||||
const t = svc.getTheme('totally-unknown');
|
||||
expect(t.id).toBe('classic');
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user