fix KV API to unified format, and test

This commit is contained in:
Pierre
2026-01-24 18:15:21 +01:00
parent 24b1c2fcea
commit 1c51d09719
13 changed files with 4064 additions and 83 deletions
+93
View File
@@ -0,0 +1,93 @@
# FFmpeg Plugin Tests
Integration tests for the FFmpeg metadata extraction plugin.
## Requirements
Tests require FFprobe to be installed. Since FFprobe is typically only available in the Docker container, tests are designed to run inside Docker.
## Running Tests
### Quick Start (Recommended)
```bash
# From the plugin directory
./test.sh
```
This builds a test Docker image and runs all tests inside it.
### Options
```bash
./test.sh --no-cache # Rebuild without Docker cache
./test.sh --shell # Start interactive shell for debugging
```
### Running Locally (if FFprobe is installed)
```bash
npm install
npm test
```
## Test Structure
```
test/
├── fixtures/
│ ├── generate-test-video.sh # Generates test video files
│ ├── simple.mp4 # Basic video + audio (generated)
│ ├── multi-audio.mkv # Multiple audio tracks (generated)
│ ├── with-subs.mkv # Video with subtitles (generated)
│ └── audio-only.mp3 # Audio file for skip tests (generated)
├── integration.test.ts # Integration tests
└── README.md # This file
```
## Test Categories
### Integration Tests (`integration.test.ts`)
1. **Prerequisites** - Verify FFprobe and fixtures are available
2. **Manifest** - Validate plugin manifest structure
3. **Skip Logic** - Test that non-video files are skipped
4. **FFprobe Validation** - Direct FFprobe output verification
5. **Output Format** - Validate FFprobe JSON matches plugin expectations
## Test Fixtures
Test fixtures are generated automatically during Docker build using `generate-test-video.sh`. The script creates:
- `simple.mp4` - 2-second 320x240 H.264 video with AAC audio
- `multi-audio.mkv` - Video with two audio tracks (English + Japanese)
- `with-subs.mkv` - Video with embedded SRT subtitles
- `audio-only.mp3` - Audio file (for testing skip logic)
## Writing New Tests
```typescript
import { describe, it, expect } from 'vitest';
import path from 'path';
const FIXTURES_DIR = path.join(__dirname, 'fixtures');
describe('My New Test', () => {
it('does something', async () => {
// Your test here
});
});
```
## Debugging
Start an interactive shell in the test container:
```bash
./test.sh --shell
# Inside container:
npm test # Run all tests
npx vitest run -t "skip" # Run tests matching "skip"
ffprobe test/fixtures/simple.mp4 # Manually inspect video
```
BIN
View File
Binary file not shown.
+73
View File
@@ -0,0 +1,73 @@
#!/bin/bash
# Generate minimal test videos for FFprobe integration tests
# Run inside Docker container with FFmpeg installed
set -e
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cd "$SCRIPT_DIR"
echo "Generating test video files..."
# 1. Simple video with video + audio streams (2 seconds, ~100KB)
if [ ! -f "simple.mp4" ]; then
echo "Creating simple.mp4..."
ffmpeg -y -f lavfi -i testsrc=duration=2:size=320x240:rate=24 \
-f lavfi -i sine=frequency=440:duration=2 \
-c:v libx264 -preset ultrafast -crf 28 \
-c:a aac -b:a 64k \
-shortest \
simple.mp4
fi
# 2. Video with multiple audio tracks (for multi-stream testing)
if [ ! -f "multi-audio.mkv" ]; then
echo "Creating multi-audio.mkv..."
ffmpeg -y -f lavfi -i testsrc=duration=2:size=640x480:rate=30 \
-f lavfi -i sine=frequency=440:duration=2 \
-f lavfi -i sine=frequency=880:duration=2 \
-c:v libx264 -preset ultrafast -crf 28 \
-filter_complex "[1:a]aformat=channel_layouts=stereo[a1];[2:a]aformat=channel_layouts=stereo[a2]" \
-map 0:v -map "[a1]" -map "[a2]" \
-c:a aac -b:a 64k \
-metadata:s:a:0 language=eng -metadata:s:a:0 title="English" \
-metadata:s:a:1 language=jpn -metadata:s:a:1 title="Japanese" \
multi-audio.mkv
fi
# 3. Video with subtitles (if possible, create with embedded subs)
if [ ! -f "with-subs.mkv" ]; then
echo "Creating with-subs.mkv..."
# Create a simple SRT file
cat > temp_subs.srt << 'EOF'
1
00:00:00,000 --> 00:00:01,000
Test subtitle line 1
2
00:00:01,000 --> 00:00:02,000
Test subtitle line 2
EOF
ffmpeg -y -f lavfi -i testsrc=duration=2:size=320x240:rate=24 \
-f lavfi -i sine=frequency=440:duration=2 \
-i temp_subs.srt \
-c:v libx264 -preset ultrafast -crf 28 \
-c:a aac -b:a 64k \
-c:s srt \
-metadata:s:s:0 language=eng \
with-subs.mkv
rm -f temp_subs.srt
fi
# 4. Audio-only file (should be skipped by FFmpeg plugin)
if [ ! -f "audio-only.mp3" ]; then
echo "Creating audio-only.mp3..."
ffmpeg -y -f lavfi -i sine=frequency=440:duration=2 \
-c:a libmp3lame -b:a 128k \
audio-only.mp3
fi
echo "Test fixtures generated:"
ls -la *.mp4 *.mkv *.mp3 2>/dev/null || true
BIN
View File
Binary file not shown.
BIN
View File
Binary file not shown.
BIN
View File
Binary file not shown.
+274
View File
@@ -0,0 +1,274 @@
/**
* FFmpeg Plugin Integration Tests
*
* These tests require FFprobe to be installed (run in Docker container).
* Tests the full processing pipeline with real video files.
*/
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
import { execSync } from 'child_process';
import path from 'path';
import { fileURLToPath } from 'url';
import fs from 'fs';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const FIXTURES_DIR = path.join(__dirname, 'fixtures');
// Dynamic import of plugin module (ES modules)
let processFile: typeof import('../src/plugin.js').process;
let manifest: typeof import('../src/plugin.js').manifest;
// Mock callback collector
interface CallbackResult {
taskId: string;
status: 'completed' | 'failed' | 'skipped';
duration: number;
error?: string;
reason?: string;
}
let lastCallback: CallbackResult | null = null;
const mockSendCallback = async (payload: CallbackResult): Promise<void> => {
lastCallback = payload;
};
// Check if FFprobe is available
function isFFprobeAvailable(): boolean {
try {
execSync('ffprobe -version', { stdio: 'ignore' });
return true;
} catch {
return false;
}
}
// Check if test fixtures exist
function fixturesExist(): boolean {
return fs.existsSync(path.join(FIXTURES_DIR, 'simple.mp4'));
}
describe('FFmpeg Plugin Integration Tests', () => {
beforeAll(async () => {
// Skip all tests if FFprobe is not available
if (!isFFprobeAvailable()) {
console.warn('FFprobe not available - skipping integration tests');
return;
}
// Check fixtures
if (!fixturesExist()) {
console.warn('Test fixtures not found - run generate-test-video.sh first');
return;
}
// Import the plugin module
const plugin = await import('../src/plugin.js');
processFile = plugin.process;
manifest = plugin.manifest;
});
afterAll(() => {
lastCallback = null;
});
describe('Prerequisites', () => {
it('FFprobe is available', () => {
expect(isFFprobeAvailable()).toBe(true);
});
it('test fixtures exist', () => {
expect(fixturesExist()).toBe(true);
});
});
describe('Manifest', () => {
it('has required fields', async () => {
if (!manifest) return;
expect(manifest.id).toBe('ffmpeg');
expect(manifest.name).toBeDefined();
expect(manifest.version).toBeDefined();
expect(manifest.dependencies).toContain('file-info');
expect(manifest.priority).toBe(15);
expect(manifest.timeout).toBe(60000);
});
it('declares correct schema', async () => {
if (!manifest) return;
expect(manifest.schema).toHaveProperty('fileinfo/duration');
expect(manifest.schema).toHaveProperty('fileinfo/formatName');
expect(manifest.schema).toHaveProperty('stream/*');
});
});
describe('Process - Skip Logic', () => {
it('skips non-video files', async () => {
if (!processFile) return;
await processFile({
taskId: 'test-skip-1',
cid: 'test-cid-1',
filePath: path.join(FIXTURES_DIR, 'audio-only.mp3'),
callbackUrl: 'http://localhost/callback',
metaCoreUrl: 'http://localhost:9000',
existingMeta: { fileType: 'audio' },
}, mockSendCallback);
expect(lastCallback).toBeDefined();
expect(lastCallback?.status).toBe('skipped');
expect(lastCallback?.reason).toContain('Not a video');
});
it('skips already processed files', async () => {
if (!processFile) return;
await processFile({
taskId: 'test-skip-2',
cid: 'test-cid-2',
filePath: path.join(FIXTURES_DIR, 'simple.mp4'),
callbackUrl: 'http://localhost/callback',
metaCoreUrl: 'http://localhost:9000',
existingMeta: {
fileType: 'video',
'fileinfo/duration': '2.0', // Already has duration
},
}, mockSendCallback);
expect(lastCallback).toBeDefined();
expect(lastCallback?.status).toBe('skipped');
expect(lastCallback?.reason).toContain('Already processed');
});
});
describe('Process - Simple Video (MP4)', () => {
it('extracts metadata from simple.mp4', async () => {
if (!processFile) return;
// Create a mock MetaCoreClient that captures the metadata
let capturedMetadata: Record<string, string> = {};
// We need to mock the MetaCoreClient - for now, we'll just verify the callback
await processFile({
taskId: 'test-simple-1',
cid: 'test-cid-simple',
filePath: path.join(FIXTURES_DIR, 'simple.mp4'),
callbackUrl: 'http://localhost/callback',
metaCoreUrl: 'http://localhost:9000', // Won't actually connect
existingMeta: { fileType: 'video' },
}, mockSendCallback);
// The test will fail when trying to connect to metaCoreUrl
// but we can still verify the callback behavior
expect(lastCallback).toBeDefined();
// If meta-core is not available, it will fail
// In a real test we'd mock the MetaCoreClient
});
});
describe('Process - Direct FFprobe Validation', () => {
it('ffprobe can read simple.mp4', async () => {
const result = execSync(
`ffprobe -v quiet -print_format json -show_format -show_streams "${path.join(FIXTURES_DIR, 'simple.mp4')}"`,
{ encoding: 'utf-8' }
);
const data = JSON.parse(result);
expect(data.format).toBeDefined();
expect(data.format.duration).toBeDefined();
expect(parseFloat(data.format.duration)).toBeGreaterThan(0);
expect(data.streams).toBeDefined();
expect(data.streams.length).toBeGreaterThanOrEqual(1);
});
it('ffprobe extracts video stream from simple.mp4', async () => {
const result = execSync(
`ffprobe -v quiet -print_format json -show_streams "${path.join(FIXTURES_DIR, 'simple.mp4')}"`,
{ encoding: 'utf-8' }
);
const data = JSON.parse(result);
const videoStream = data.streams.find((s: any) => s.codec_type === 'video');
expect(videoStream).toBeDefined();
expect(videoStream.codec_name).toBe('h264');
expect(videoStream.width).toBe(320);
expect(videoStream.height).toBe(240);
});
it('ffprobe extracts audio stream from simple.mp4', async () => {
const result = execSync(
`ffprobe -v quiet -print_format json -show_streams "${path.join(FIXTURES_DIR, 'simple.mp4')}"`,
{ encoding: 'utf-8' }
);
const data = JSON.parse(result);
const audioStream = data.streams.find((s: any) => s.codec_type === 'audio');
expect(audioStream).toBeDefined();
expect(audioStream.codec_name).toBe('aac');
});
it('ffprobe extracts multiple audio tracks from multi-audio.mkv', async () => {
const mkvPath = path.join(FIXTURES_DIR, 'multi-audio.mkv');
if (!fs.existsSync(mkvPath)) {
console.warn('multi-audio.mkv not found, skipping');
return;
}
const result = execSync(
`ffprobe -v quiet -print_format json -show_streams "${mkvPath}"`,
{ encoding: 'utf-8' }
);
const data = JSON.parse(result);
const audioStreams = data.streams.filter((s: any) => s.codec_type === 'audio');
expect(audioStreams.length).toBeGreaterThanOrEqual(2);
});
it('ffprobe extracts subtitles from with-subs.mkv', async () => {
const mkvPath = path.join(FIXTURES_DIR, 'with-subs.mkv');
if (!fs.existsSync(mkvPath)) {
console.warn('with-subs.mkv not found, skipping');
return;
}
const result = execSync(
`ffprobe -v quiet -print_format json -show_streams "${mkvPath}"`,
{ encoding: 'utf-8' }
);
const data = JSON.parse(result);
const subStream = data.streams.find((s: any) => s.codec_type === 'subtitle');
expect(subStream).toBeDefined();
});
});
});
describe('FFprobe Output Format', () => {
it('validates stream JSON structure matches plugin expectations', async () => {
if (!fixturesExist()) return;
const result = execSync(
`ffprobe -v quiet -print_format json -show_format -show_streams "${path.join(FIXTURES_DIR, 'simple.mp4')}"`,
{ encoding: 'utf-8' }
);
const data = JSON.parse(result);
// Validate format fields the plugin expects
expect(data.format).toHaveProperty('duration');
expect(data.format).toHaveProperty('format_name');
// Validate stream fields the plugin expects
const videoStream = data.streams.find((s: any) => s.codec_type === 'video');
expect(videoStream).toHaveProperty('codec_type');
expect(videoStream).toHaveProperty('codec_name');
expect(videoStream).toHaveProperty('index');
expect(videoStream).toHaveProperty('width');
expect(videoStream).toHaveProperty('height');
const audioStream = data.streams.find((s: any) => s.codec_type === 'audio');
expect(audioStream).toHaveProperty('codec_type');
expect(audioStream).toHaveProperty('codec_name');
expect(audioStream).toHaveProperty('sample_rate');
});
});