mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-08 09:54:26 +00:00
693f9b4495
Community tier opened the Fleet Overview drilldown (node card → stack list → container list) but two read-only metadata endpoints in fleet.ts kept their requirePaid gate. Stack names still rendered because they ride on the un-gated /api/fleet/overview payload, but expanding a stack always re-fetched containers and hit the orphan gate, surfacing as a "Failed to load containers for X" toast on every node card on Community. Drop requirePaid from GET /node/:nodeId/stacks and GET /node/:nodeId/stacks/:stackName/containers. Both handlers stay behind authMiddleware, validate inputs, and proxy to the per-node api_token for remote nodes. Paid mutations (bulk update, scheduled snapshots, label bulk actions, Fleet Actions cards) keep their gates in fleetActions.ts. Add positive Community-tier tests in fleet.test.ts and clear the stale "Requires Skipper or Admiral license" line from the OpenAPI descriptions.
551 lines
18 KiB
TypeScript
551 lines
18 KiB
TypeScript
/**
|
|
* Tests for fleet management API endpoints.
|
|
* Covers auth enforcement, input validation, overview, snapshot CRUD, and tier gating.
|
|
*/
|
|
import { describe, it, expect, beforeAll, afterAll, afterEach, vi } from 'vitest';
|
|
import request from 'supertest';
|
|
import jwt from 'jsonwebtoken';
|
|
import { setupTestDb, cleanupTestDb, TEST_USERNAME, TEST_JWT_SECRET } from './helpers/setupTestDb';
|
|
|
|
let tmpDir: string;
|
|
let app: import('express').Express;
|
|
let authHeader: string;
|
|
let LicenseService: typeof import('../services/LicenseService').LicenseService;
|
|
|
|
beforeAll(async () => {
|
|
tmpDir = await setupTestDb();
|
|
({ app } = await import('../index'));
|
|
({ LicenseService } = await import('../services/LicenseService'));
|
|
const token = jwt.sign({ username: TEST_USERNAME }, TEST_JWT_SECRET, { expiresIn: '1m' });
|
|
authHeader = `Bearer ${token}`;
|
|
});
|
|
|
|
afterAll(() => {
|
|
cleanupTestDb(tmpDir);
|
|
});
|
|
|
|
function mockTier(tier: 'paid' | 'community') {
|
|
vi.spyOn(LicenseService.getInstance(), 'getTier').mockReturnValue(tier);
|
|
}
|
|
|
|
// ─── Auth Enforcement ───
|
|
|
|
describe('Fleet endpoints require authentication', () => {
|
|
it('GET /api/fleet/overview returns 401 without auth', async () => {
|
|
const res = await request(app).get('/api/fleet/overview');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('GET /api/fleet/update-status returns 401 without auth', async () => {
|
|
const res = await request(app).get('/api/fleet/update-status');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('POST /api/fleet/snapshots returns 401 without auth', async () => {
|
|
const res = await request(app).post('/api/fleet/snapshots').send({ description: 'test' });
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('GET /api/fleet/snapshots returns 401 without auth', async () => {
|
|
const res = await request(app).get('/api/fleet/snapshots');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('DELETE /api/fleet/snapshots/1 returns 401 without auth', async () => {
|
|
const res = await request(app).delete('/api/fleet/snapshots/1');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('POST /api/fleet/nodes/1/update returns 401 without auth', async () => {
|
|
const res = await request(app).post('/api/fleet/nodes/1/update');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('POST /api/fleet/update-all returns 401 without auth', async () => {
|
|
const res = await request(app).post('/api/fleet/update-all');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('DELETE /api/fleet/nodes/1/update-status returns 401 without auth', async () => {
|
|
const res = await request(app).delete('/api/fleet/nodes/1/update-status');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('DELETE /api/fleet/update-status returns 401 without auth', async () => {
|
|
const res = await request(app).delete('/api/fleet/update-status');
|
|
expect(res.status).toBe(401);
|
|
});
|
|
});
|
|
|
|
// ─── Input Validation ───
|
|
|
|
describe('Fleet input validation', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
it('rejects NaN nodeId on GET /api/fleet/node/:nodeId/stacks', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get('/api/fleet/node/abc/stacks')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid node id/i);
|
|
});
|
|
|
|
it('rejects NaN nodeId on GET /api/fleet/node/:nodeId/stacks/:stackName/containers', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get('/api/fleet/node/xyz/stacks/mystack/containers')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid node id/i);
|
|
});
|
|
|
|
it('rejects invalid stackName on containers endpoint', async () => {
|
|
mockTier('paid');
|
|
// Stack name with characters that fail the alphanumeric+dash+underscore regex
|
|
const res = await request(app)
|
|
.get('/api/fleet/node/1/stacks/bad%20stack%21/containers')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid stack name/i);
|
|
});
|
|
|
|
it('rejects NaN snapshot ID on GET /api/fleet/snapshots/:id', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get('/api/fleet/snapshots/notanumber')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid snapshot id/i);
|
|
});
|
|
|
|
it('rejects oversized snapshot description', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader)
|
|
.send({ description: 'x'.repeat(501) });
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/500 characters/i);
|
|
});
|
|
});
|
|
|
|
// ─── Fleet Overview ───
|
|
|
|
describe('GET /api/fleet/overview', () => {
|
|
it('returns 200 with an array', async () => {
|
|
const res = await request(app)
|
|
.get('/api/fleet/overview')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(200);
|
|
expect(Array.isArray(res.body)).toBe(true);
|
|
});
|
|
|
|
it('includes the local node', async () => {
|
|
const res = await request(app)
|
|
.get('/api/fleet/overview')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(200);
|
|
const local = res.body.find((n: { type: string }) => n.type === 'local');
|
|
expect(local).toBeDefined();
|
|
expect(local.name).toBeTruthy();
|
|
});
|
|
});
|
|
|
|
// ─── Tier Gating ───
|
|
|
|
describe('Fleet tier gating', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
it('POST /api/fleet/update-all returns 403 on community tier (bulk update is Skipper+)', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.post('/api/fleet/update-all')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('GET /api/fleet/update-status is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.get('/api/fleet/update-status')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('GET /api/fleet/snapshots is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.get('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('POST /api/fleet/nodes/1/update is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.post('/api/fleet/nodes/1/update')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('DELETE /api/fleet/nodes/1/update-status is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.delete('/api/fleet/nodes/1/update-status')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('DELETE /api/fleet/update-status is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.delete('/api/fleet/update-status')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('GET /api/fleet/node/:nodeId/stacks is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.get('/api/fleet/node/1/stacks')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('GET /api/fleet/node/:nodeId/stacks/:stackName/containers is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.get('/api/fleet/node/1/stacks/db-compose/containers')
|
|
.set('Authorization', authHeader);
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
});
|
|
|
|
// ─── Update Endpoint Input Validation ───
|
|
|
|
describe('Fleet update input validation', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
it('POST /api/fleet/nodes/abc/update returns 400 for NaN nodeId', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/nodes/abc/update')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid node id/i);
|
|
});
|
|
|
|
it('POST /api/fleet/nodes/99999/update returns 404 for missing node', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/nodes/99999/update')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(404);
|
|
expect(res.body.error).toMatch(/not found/i);
|
|
});
|
|
|
|
it('DELETE /api/fleet/nodes/abc/update-status returns 400 for NaN nodeId', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.delete('/api/fleet/nodes/abc/update-status')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid node id/i);
|
|
});
|
|
|
|
it('DELETE /api/fleet/nodes/99999/update-status returns 404 for missing node', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.delete('/api/fleet/nodes/99999/update-status')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(404);
|
|
expect(res.body.error).toMatch(/not found/i);
|
|
});
|
|
});
|
|
|
|
// ─── Admin Role Enforcement ───
|
|
|
|
describe('Fleet update admin enforcement', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
let viewerHeader: string;
|
|
|
|
beforeAll(async () => {
|
|
// Create a viewer user and generate a token for them
|
|
const { DatabaseService } = await import('../services/DatabaseService');
|
|
const db = DatabaseService.getInstance();
|
|
const bcrypt = await import('bcrypt');
|
|
const viewerHash = await bcrypt.hash('viewerpass', 1);
|
|
try {
|
|
db.addUser({ username: 'testviewer', password_hash: viewerHash, role: 'viewer' });
|
|
} catch {
|
|
// User may already exist from a prior run
|
|
}
|
|
const viewerToken = jwt.sign({ username: 'testviewer', role: 'viewer' }, TEST_JWT_SECRET, { expiresIn: '1m' });
|
|
viewerHeader = `Bearer ${viewerToken}`;
|
|
});
|
|
|
|
it('POST /api/fleet/nodes/1/update returns 403 for viewer', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/nodes/1/update')
|
|
.set('Authorization', viewerHeader);
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe('ADMIN_REQUIRED');
|
|
});
|
|
|
|
it('POST /api/fleet/update-all returns 403 for viewer', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/update-all')
|
|
.set('Authorization', viewerHeader);
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe('ADMIN_REQUIRED');
|
|
});
|
|
});
|
|
|
|
// ─── Snapshot CRUD ───
|
|
|
|
describe('Fleet snapshot lifecycle', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
let snapshotId: number;
|
|
|
|
it('creates a snapshot (POST /api/fleet/snapshots)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader)
|
|
.send({ description: 'Test snapshot' });
|
|
expect(res.status).toBe(201);
|
|
expect(res.body).toHaveProperty('id');
|
|
expect(res.body.description).toBe('Test snapshot');
|
|
snapshotId = res.body.id;
|
|
});
|
|
|
|
it('lists snapshots (GET /api/fleet/snapshots)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toHaveProperty('snapshots');
|
|
expect(res.body).toHaveProperty('total');
|
|
expect(res.body.total).toBeGreaterThanOrEqual(1);
|
|
});
|
|
|
|
it('gets snapshot detail (GET /api/fleet/snapshots/:id)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get(`/api/fleet/snapshots/${snapshotId}`)
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.id).toBe(snapshotId);
|
|
expect(res.body).toHaveProperty('nodes');
|
|
});
|
|
|
|
it('returns 404 for missing snapshot', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get('/api/fleet/snapshots/99999')
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(404);
|
|
});
|
|
|
|
it('deletes a snapshot (DELETE /api/fleet/snapshots/:id)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.delete(`/api/fleet/snapshots/${snapshotId}`)
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.message).toMatch(/deleted/i);
|
|
|
|
// Verify it's gone
|
|
const check = await request(app)
|
|
.get(`/api/fleet/snapshots/${snapshotId}`)
|
|
.set('Authorization', authHeader);
|
|
expect(check.status).toBe(404);
|
|
});
|
|
});
|
|
|
|
// ─── Snapshot Restore Endpoint ───
|
|
|
|
describe('Fleet snapshot restore', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
let snapshotId: number;
|
|
|
|
beforeAll(async () => {
|
|
const { LicenseService: LS } = await import('../services/LicenseService');
|
|
vi.spyOn(LS.getInstance(), 'getTier').mockReturnValue('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader)
|
|
.send({ description: 'Restore test snapshot' });
|
|
snapshotId = res.body.id;
|
|
vi.restoreAllMocks();
|
|
});
|
|
|
|
it('POST /api/fleet/snapshots/:id/restore returns 401 without auth', async () => {
|
|
const res = await request(app)
|
|
.post(`/api/fleet/snapshots/${snapshotId}/restore`)
|
|
.send({ nodeId: 1, stackName: 'test' });
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('POST /api/fleet/snapshots/:id/restore is accessible on community tier', async () => {
|
|
mockTier('community');
|
|
const res = await request(app)
|
|
.post(`/api/fleet/snapshots/${snapshotId}/restore`)
|
|
.set('Authorization', authHeader)
|
|
.send({ nodeId: 1, stackName: 'test' });
|
|
expect(res.body.code).not.toBe('PAID_REQUIRED');
|
|
});
|
|
|
|
it('returns 400 with missing nodeId/stackName', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post(`/api/fleet/snapshots/${snapshotId}/restore`)
|
|
.set('Authorization', authHeader)
|
|
.send({});
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/nodeId and stackName are required/i);
|
|
});
|
|
|
|
it('returns 400 with invalid stackName (path traversal)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post(`/api/fleet/snapshots/${snapshotId}/restore`)
|
|
.set('Authorization', authHeader)
|
|
.send({ nodeId: 1, stackName: '../etc/passwd' });
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid stack name/i);
|
|
});
|
|
|
|
it('returns 400 for NaN snapshot ID', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots/abc/restore')
|
|
.set('Authorization', authHeader)
|
|
.send({ nodeId: 1, stackName: 'mystack' });
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toMatch(/invalid snapshot id/i);
|
|
});
|
|
|
|
it('returns 404 for non-existent snapshot', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots/99999/restore')
|
|
.set('Authorization', authHeader)
|
|
.send({ nodeId: 1, stackName: 'mystack' });
|
|
expect(res.status).toBe(404);
|
|
expect(res.body.error).toMatch(/snapshot not found/i);
|
|
});
|
|
|
|
it('returns 404 when no files match the nodeId/stackName combo', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post(`/api/fleet/snapshots/${snapshotId}/restore`)
|
|
.set('Authorization', authHeader)
|
|
.send({ nodeId: 999, stackName: 'nonexistent-stack' });
|
|
expect(res.status).toBe(404);
|
|
expect(res.body.error).toMatch(/no files found/i);
|
|
});
|
|
});
|
|
|
|
// ─── Snapshot Admin Role Enforcement ───
|
|
|
|
describe('Fleet snapshot admin enforcement', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
let viewerHeader: string;
|
|
|
|
beforeAll(async () => {
|
|
const { DatabaseService: DS } = await import('../services/DatabaseService');
|
|
const db = DS.getInstance();
|
|
const bcrypt = await import('bcrypt');
|
|
const viewerHash = await bcrypt.hash('snapshotviewer', 1);
|
|
try {
|
|
db.addUser({ username: 'snapshotviewer', password_hash: viewerHash, role: 'viewer' });
|
|
} catch {
|
|
// User may already exist
|
|
}
|
|
const viewerToken = jwt.sign({ username: 'snapshotviewer', role: 'viewer' }, TEST_JWT_SECRET, { expiresIn: '1m' });
|
|
viewerHeader = `Bearer ${viewerToken}`;
|
|
});
|
|
|
|
it('POST /api/fleet/snapshots returns 403 for viewer', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots')
|
|
.set('Authorization', viewerHeader)
|
|
.send({ description: 'test' });
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe('ADMIN_REQUIRED');
|
|
});
|
|
|
|
it('DELETE /api/fleet/snapshots/1 returns 403 for viewer', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.delete('/api/fleet/snapshots/1')
|
|
.set('Authorization', viewerHeader);
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe('ADMIN_REQUIRED');
|
|
});
|
|
|
|
it('POST /api/fleet/snapshots/1/restore returns 403 for viewer', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots/1/restore')
|
|
.set('Authorization', viewerHeader)
|
|
.send({ nodeId: 1, stackName: 'test' });
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe('ADMIN_REQUIRED');
|
|
});
|
|
|
|
it('GET /api/fleet/snapshots succeeds for viewer (read-only)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.get('/api/fleet/snapshots')
|
|
.set('Authorization', viewerHeader);
|
|
expect(res.status).toBe(200);
|
|
});
|
|
});
|
|
|
|
// ─── Snapshot Edge Cases ───
|
|
|
|
describe('Fleet snapshot edge cases', () => {
|
|
afterEach(() => vi.restoreAllMocks());
|
|
|
|
it('snapshot with 0 stacks captured (empty COMPOSE_DIR)', async () => {
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.post('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader)
|
|
.send({ description: 'Empty snapshot' });
|
|
expect(res.status).toBe(201);
|
|
expect(res.body.stack_count).toBe(0);
|
|
});
|
|
|
|
it('DELETE on already-deleted snapshot returns 404', async () => {
|
|
mockTier('paid');
|
|
const createRes = await request(app)
|
|
.post('/api/fleet/snapshots')
|
|
.set('Authorization', authHeader)
|
|
.send({ description: 'To delete twice' });
|
|
const id = createRes.body.id;
|
|
|
|
await request(app)
|
|
.delete(`/api/fleet/snapshots/${id}`)
|
|
.set('Authorization', authHeader);
|
|
|
|
mockTier('paid');
|
|
const res = await request(app)
|
|
.delete(`/api/fleet/snapshots/${id}`)
|
|
.set('Authorization', authHeader);
|
|
expect(res.status).toBe(404);
|
|
});
|
|
});
|