Open-source speech recognition toolkit for training, inference, streaming ASR, VAD, punctuation, speaker diarization pipelines, and OpenAI-compatible/MCP serving.
Python asraudiochineseemotion-recognitionfunasrmcp-servermultilingual-asropenai-compatible-apiparaformerpunctuationpytorchreal-time-asrspeaker-diarizationspeech-recognitionspeech-to-textstreaming-asrtranscriptionvllmvoice-activity-detectionwhisper-alternative
from pathlib import Path
import ast
import json
import re
import shlex
import sys
from urllib.parse import unquote, urlsplit
from bs4 import BeautifulSoup
import pytest
SITE_ROOT = Path(__file__).resolve().parents[1]
sys.path.insert(0, str(SITE_ROOT))
from build import build
@pytest.fixture(scope='module')
def output(tmp_path_factory):
path = tmp_path_factory.mktemp('documentation')
build(path)
return path
@pytest.mark.parametrize('prefix', ['', 'en/'])
def test_speech_to_speech_ecosystem_entry_links_to_bounded_source_recipe(output, prefix):
repo = 'https://github.com/huggingface/speech-to-speech'
guide = f'/{prefix}docs/community.html#speech-to-speech'
ecosystem = BeautifulSoup((output / prefix / 'ecosystem.html').read_text(), 'html.parser')
cards = [card for card in ecosystem.select('.card')
if card.select_one('.card-title a[href="' + repo + '"]')]
assert len(cards) == 1
links = {link['href'] for link in cards[0].select('a[href]')}
assert {repo + '/pull/319', guide} <= links
text = cards[0].get_text(' ', strip=True)
assert 'SenseVoiceSmall' in text and 'v1.0.0' in text
assert ('not included' in text) if prefix else ('尚未包含' in text)
page = BeautifulSoup((output / prefix / 'docs/community.html').read_text(), 'html.parser')
article = page.select_one('.docs-article')
assert article.select_one('#speech-to-speech')
commands = '\n'.join(block.get_text() for block in article.select('pre code'))
assert 'git checkout --detach 9e2ed1099190a4e4bc8a972b4a3488949ff1b9f6' in commands
assert 'python -m pip install -e ".[sensevoice]"' in commands
assert 'speech-to-speech serve --stt sense-voice' in commands
assert '--sense_voice_stt_device cpu' in commands and '--help' in commands
text = article.get_text(' ', strip=True)
assert 'LLM' in text and 'TTS' in text and '--log_transcripts' in text
assert ('terminal' in text) if prefix else ('终端' in text)
assert ('not included' in text) if prefix else ('尚未包含' in text)
language = 'en' if prefix else 'zh'
index = json.loads((output / f'search-{language}.json').read_text())
assert any(row['url'] == f'/{prefix}docs/community.html' for row in index)
def test_bilingual_docs_have_navigation_and_real_source_content(output):
for prefix in ('', 'en/'):
index = BeautifulSoup((output / prefix / 'docs/index.html').read_text(), 'html.parser')
assert index.select_one('[data-doc-search]')
assert index.select_one('a[href$="/docs/moss-transcribe-diarize.html"]')
moss = BeautifulSoup((output / prefix / 'docs/moss-transcribe-diarize.html').read_text(), 'html.parser')
assert moss.select_one('.docs-sidebar')
assert moss.select_one('.docs-toc a[href^="#"]')
assert 'OpenMOSS' in moss.select_one('.docs-article').get_text()
assert moss.select_one('.docs-article pre code')
assert moss.select_one('[data-source-link]')['href'].endswith('.md')
def test_official_native_record_has_local_language_links_and_search(output):
for language, prefix, suffix in (('zh', '', '_zh'), ('en', 'en/', '')):
route = '/' + prefix + 'docs/official-native-vllm.html'
page = BeautifulSoup((output / route.lstrip('/')).read_text(), 'html.parser')
assert page.select_one('[data-source-link]')['href'].endswith(
f'/docs/vllm_official_native_validation{suffix}.md')
links = {link['href'] for link in page.select('.docs-article a[href]')}
assert '/' + prefix + 'docs/native-vllm.html' in links
assert '/' + prefix + 'docs/deployment-matrix.html' in links
assert any('/docs/benchmark/vllm_official_native_20260907.json' in link for link in links)
rows = json.loads((output / f'search-{language}.json').read_text())
assert any(row['url'] == route and '2026-09-07' in row['title'] for row in rows)
deploy = BeautifulSoup((output / prefix / 'deploy/vllm.html').read_text(), 'html.parser')
commands = deploy.select_one('[data-section="commands"]').get_text()
assert 'FunAudioLLM/Fun-ASR-Nano-2512-vllm' in commands
assert 'allendou/' not in commands
@pytest.mark.parametrize('language, prefix, suffix, peer', [
('zh', '', '_zh', '/en/docs/gradio.html'),
('en', 'en/', '', '/docs/gradio.html'),
])
def test_gradio_uses_owned_sources_and_internal_discovery(output, language, prefix, suffix, peer):
route = '/' + prefix + 'docs/gradio.html'
path = output / route.lstrip('/')
assert path.is_file(), route
page = BeautifulSoup(path.read_text(), 'html.parser')
article = page.select_one('.docs-article')
assert len(article.select('h2')) == 5
assert page.select_one('[data-source-link]')['href'].endswith(f'/examples/openai_api/GRADIO{suffix}.md')
assert page.select_one(f'a[href="{peer}"]')
assert page.select_one(f'.docs-sidebar a[href="{route}"]')
for slug in ('http-server', 'security', 'moss-transcribe-diarize', 'model-selection'):
links = [a['href'] for a in article.select('a[href]')]
assert any(urlsplit(link).path == '/' + prefix + f'docs/{slug}.html' for link in links)
http = BeautifulSoup((output / prefix / 'docs/http-server.html').read_text(), 'html.parser')
assert http.select_one(f'.docs-article a[href="{route}"]')
index = BeautifulSoup((output / prefix / 'docs/index.html').read_text(), 'html.parser')
assert index.select_one(f'a[href="{route}"]')
search = json.loads((output / f'search-{language}.json').read_text())
assert any(row['url'] == route and 'Gradio' in row['title'] for row in search)
for marker in ('127.0.0.1', 'Python 3.12', 'gradio==6.26.0', 'moss-transcribe-diarize',
'sglang-omni', 'verbose_json', 'diarized_json', 'Authorization', 'allowlist'):
assert marker in article.get_text(), (language, marker)
@pytest.mark.parametrize('prefix', ['', 'en/'])
def test_kubernetes_generated_commands_preserve_root_context_and_internal_security(output, prefix):
page = BeautifulSoup((output / prefix / 'docs/kubernetes.html').read_text(), 'html.parser')
article = page.select_one('.docs-article')
commands = '\n'.join(node.get_text() for node in article.select('pre code'))
assert 'apply -k examples/openai_api/kubernetes' in commands
assert 'apply -k .' not in commands
assert '-f examples/openai_api/Dockerfile.moss' in commands
assert '--model moss-transcribe-diarize --response-format verbose_json' in commands
assert article.select_one(f'a[href="/{prefix}docs/security.html"]')
def test_deployment_limitations_use_short_heading_and_preserve_full_body(output):
entries = json.loads((SITE_ROOT / 'data/deployments.json').read_text())['deployments']
for language in ('zh', 'en'):
for entry in entries:
route = entry['routes'][language].lstrip('/')
page = BeautifulSoup((output / route).read_text(), 'html.parser')
callout = page.select_one('[data-section="limitations"] .limitation-callout')
heading = callout.select_one('h2')
expected = entry['translations'][language]['primary_limitation']
assert heading.get_text() == ('已知限制' if language == 'zh' else 'Known limitations')
assert heading.get_text() != expected
summary = callout.select_one('p.limitation-summary')
assert summary is not None, (language, entry['id'])
assert summary.get_text() == expected, (language, entry['id'])
assert not callout.select('.eyebrow')
def test_search_index_is_bilingual_and_links_to_emitted_pages(output):
for language in ('zh', 'en'):
rows = json.loads((output / f'search-{language}.json').read_text())
assert len(rows) >= 12
assert any('MOSS' in row['title'] for row in rows)
for row in rows:
path = row['url'].split('#')[0].lstrip('/')
if path.endswith('/'):
path += 'index.html'
assert (output / path).is_file(), row['url']
def test_legacy_articles_and_new_pages_share_versioned_design(output):
for relative in ('index.html', 'models.html', 'blog/index.html', 'donors.html', 'deploy/vllm.html'):
soup = BeautifulSoup((output / relative).read_text(), 'html.parser')
assert soup.select_one('link[href*="experience."][href$=".css"]'), relative
assert soup.select_one('[data-primary-nav]'), relative
links = soup.select('[data-primary-nav] a')
assert links[-1]['href'].endswith('donors.html')
home = (output / 'index.html').read_text()
assert 'data-doc-search' in home
assert 'Apache-2.0</dd>' not in home
def test_documentation_links_are_mapped_to_local_pages_or_repository(output):
soup = BeautifulSoup((output / 'docs/model-selection.html').read_text(), 'html.parser')
for link in soup.select('.docs-article a[href]'):
href = link['href']
assert href.startswith(('/', '#', 'https://', 'http://', 'mailto:')), href
@pytest.mark.parametrize('prefix', ['', 'en/'])
def test_model_selection_renders_distinct_local_native_and_split_links(output, prefix):
page = BeautifulSoup((output / prefix / 'docs/model-selection.html').read_text(), 'html.parser')
article = page.select_one('.docs-article')
targets = {a['href'] for a in article.select('a[href]')}
for slug in ('vllm', 'official-native-vllm', 'native-vllm', 'moss-transcribe-diarize'):
assert f'/{prefix}docs/{slug}.html' in targets
ids = [node['id'] for node in page.select('[id]')]
assert ids.count('vllm-checkpoint-paths') == 1
assert len(ids) == len(set(ids)), 'Existing and new section anchors must stay unique'
def test_source_fragment_links_keep_unicode_and_punctuation_boundaries(output):
for prefix in ('', 'en/'):
for path in (output / prefix / 'docs').glob('*.html'):
soup = BeautifulSoup(path.read_text(), 'html.parser')
ids = {node['id'] for node in soup.select('[id]')}
for link in soup.select('.docs-article a[href^="#"]'):
assert unquote(link['href'][1:]) in ids, (path, link['href'])
def test_section_based_quickstarts_are_searchable(output):
for language, route in (('zh', '/quickstart.html'), ('en', '/en/quickstart.html')):
rows = json.loads((output / f'search-{language}.json').read_text())
assert any(row['url'] == route for row in rows)
def test_github_pages_hubs_have_task_navigation_and_search_handoff():
root = SITE_ROOT.parents[1]
for relative, destination in (('index.html', '/en/docs/'), ('zh/index.html', '/docs/')):
soup = BeautifulSoup((root / 'gh-pages-output' / relative).read_text(), 'html.parser')
assert len(soup.select('.chapters section')) == 4
assert soup.select_one('form[role="search"]')['action'] == 'https://www.funasr.com' + destination
assert soup.select_one('a[href$="moss-transcribe-diarize.html"]')
assert soup.select_one('a[href$="api.html"]')
assert '170x' not in soup.get_text()
@pytest.mark.parametrize('language, prefix, suffix, peer', [
('zh', '', '_zh', '/en/docs/agent-integration.html'),
('en', 'en/', '', '/docs/agent-integration.html'),
])
def test_agent_guide_has_shared_sources_discovery_and_six_sections(output, language, prefix, suffix, peer):
route = '/' + prefix + 'docs/agent-integration.html'
path = output / route.lstrip('/')
assert path.is_file(), route
page = BeautifulSoup(path.read_text(), 'html.parser')
article = page.select_one('.docs-article')
assert len(article.select('h2')) == 6
assert page.select_one('[data-source-link]')['href'].endswith(f'/docs/agent_integration{suffix}.md')
links = {a['href'] for a in article.select('a[href]')}
assert peer in links
routes = {urlsplit(link)._replace(fragment='').geturl() for link in links}
for slug in ('http-server', 'workflows', 'javascript', 'speaker-emotion', 'model-selection', 'security'):
assert '/' + prefix + 'docs/' + slug + '.html' in routes
index = BeautifulSoup((output / prefix / 'docs/index.html').read_text(), 'html.parser')
assert index.select_one(f'a[href="{route}"]')
search = json.loads((output / f'search-{language}.json').read_text())
assert any(row['url'] == route and 'Agent' in row['title'] for row in search)
text = article.get_text(' ', strip=True)
for marker in ('127.0.0.1', '/v1/audio/transcriptions', '/v1/models', '/health',
'verbose_json', 'transcribe_audio', 'FUNASR_DEVICE',
'FUNASR_MODEL', 'sentence_info', '--lang', '--segment-mode', '60000'):
assert marker in text, (language, marker)
assert '31-language LLM-based ASR with timestamps' not in text
assert '31 语种 LLM-based ASR,支持时间戳' not in text
def test_agent_recipes_are_bilingual_and_use_existing_script_options():
root = SITE_ROOT.parents[1]
recipes = []
for suffix in ('', '_zh'):
path = root / f'docs/agent_integration{suffix}.md'
assert path.is_file(), path
source = path.read_text()
blocks = re.findall(r'^```(\w+)\n(.*?)^```', source, re.M | re.S)
commands = []
structured = []
for language, code in blocks:
if language == 'python':
tree = ast.parse(code)
compile(tree, str(path), 'exec')
assert any(isinstance(node, ast.With) for node in ast.walk(tree))
structured.append((language, ast.dump(tree)))
elif language == 'json':
data = json.loads(code)
structured.append((language, data))
config = data['mcpServers']['funasr']
assert config['command'].endswith('/bin/python')
assert config['args'][0].endswith('/examples/mcp_server/funasr_mcp.py')
assert config['env']['FUNASR_DEVICE'] == 'cpu'
elif language == 'bash':
commands.extend(tokens for line in code.replace('\\\n', ' ').splitlines()
if (tokens := shlex.split(line, comments=True)))
recipes.append({'shell': commands, 'structured': structured})
scripts = []
for command in commands:
if command[0] == 'funasr-server':
assert command[command.index('--host') + 1] == '127.0.0.1'
assert command[command.index('--model') + 1] == 'sensevoice'
script = root / 'funasr/bin/server.py'
elif command[0] == 'python' and command[1].startswith('examples/'):
script = root / command[1]
scripts.append(command[1])
else:
continue
assert script.is_file(), script
tree = ast.parse(script.read_text())
options = {arg.value for node in ast.walk(tree)
if isinstance(node, ast.Call) and isinstance(node.func, ast.Attribute)
and node.func.attr == 'add_argument' for arg in node.args
if isinstance(arg, ast.Constant) and isinstance(arg.value, str)}
for token in command[1:]:
if token.startswith('--'):
assert token in options, (script, token)
if script.name == 'funasr_input.py':
assert '--lang' not in command
assert set(scripts) == {'examples/mcp_server/funasr_mcp.py',
'examples/voice_input/funasr_input.py',
'examples/subtitle/generate_subtitle.py'}
assert recipes[0] == recipes[1]
@pytest.mark.parametrize('language,prefix,suffix', [('en', 'en/', ''), ('zh', '', '_zh')])
def test_historical_benchmark_preserves_frozen_tables_and_discovery(output, language, prefix, suffix):
frozen = json.loads((SITE_ROOT / 'tests/fixtures/historical_asr_tables.json').read_text())
record = next(item for item in frozen['pages'] if item['language'] == language)
route = '/' + prefix + 'docs/historical-asr-benchmark.html'
path = output / route.lstrip('/')
assert path.is_file(), route
page = BeautifulSoup(path.read_text(), 'html.parser')
article = page.select_one('.docs-article')
tables = article.select('table')
assert len(tables) == 3
assert len(article.select('h2')) == 4
for table, expected in zip(tables, record['tables']):
actual = [[' '.join(cell.get_text().split()) for cell in row.select('th,td')]
for row in table.select('tr')]
assert actual == [[cell['text'] for cell in row] for row in expected['rows']]
assert page.select_one('[data-source-link]')['href'].endswith(
f'/docs/benchmark/historical_asr{suffix}.md')
links = {link['href'] for link in article.select('a[href]')}
for slug in ('agent-integration', 'vllm', 'model-selection', 'benchmark-method', 'realtime-benchmark'):
assert '/' + prefix + 'docs/' + slug + '.html' in links
assert ('/docs/' if prefix else '/en/docs/') + 'historical-asr-benchmark.html' in links
assert 'https://github.com/QwenAudio/Fun-ASR/issues/106' in links
assert 'https://huggingface.co/FunAudioLLM/Fun-ASR-MLT-Nano-2512' in links
original_path = urlsplit(record['requested_url']).path.removeprefix('/FunASR/')
assert f"https://github.com/modelscope/FunASR/blob/{frozen['source_commit']}/{original_path}" in links
index = BeautifulSoup((output / prefix / 'docs/index.html').read_text(), 'html.parser')
assert index.select_one(f'a[href="{route}"]')
search = json.loads((output / f'search-{language}.json').read_text())
assert any(row['url'] == route for row in search)
@pytest.mark.parametrize('suffix', ['', '_zh'])
def test_historical_benchmark_does_not_advertise_missing_scripts_as_runnable(suffix):
root = SITE_ROOT.parents[1]
source_path = root / f'docs/benchmark/historical_asr{suffix}.md'
assert source_path.is_file()
source = source_path.read_text()
blocks = re.findall(r'^```(\w+)\n(.*?)^```', source, re.M | re.S)
assert len(blocks) == 2 and all(language == 'text' for language, _ in blocks)
commands = [line for _, block in blocks for line in block.splitlines() if line.startswith('python ')]
assert commands == ['python benchmark/run_full_benchmark.py',
'python benchmark/run_remaining.py',
'python benchmark/fix_sensevoice_cer.py']
for command in commands:
assert not (root / command.split()[1]).exists()
for marker in ('11,539', '11,541', '169.6x', '211.8x', 'RTFx', '2026-09-07'):
assert marker in source
for marker in (('来源不完整', '不是测量日期', '不能直接执行', '不计算 CER/WER') if suffix
else ('incomplete provenance', 'not the measurement date', 'cannot be run directly', 'does not compute CER/WER')):
assert marker in source
if not suffix:
assert 'Reproduce the 184-file long-audio benchmark' not in (root / 'docs/use_case_showcase.md').read_text()