Converter QA

Converter QA Framework

Trust your converters -- 284 assertions prove they work

Test harness that validates all converter outputs: md-to-word regression tests, md-to-eml structure validation, shared module unit tests, file size bounds, and output format verification.

When to Use

• After modifying any converter muscle or shared module
• Before releasing a new version of the converter pipeline
• When adding new features to md-to-word, md-to-eml, or shared modules
• As part of the pre-publish quality gate

Test Suites

Usage

# Run all tests
node .github/muscles/converter-qa.cjs

# Run a specific suite
node .github/muscles/converter-qa.cjs --suite=word
node .github/muscles/converter-qa.cjs --suite=shared

# Verbose output (show passing tests)
node .github/muscles/converter-qa.cjs --verbose

Adding Tests

Tests use a minimal zero-dependency framework:

suite('My test suite', () => {
  assert(condition, 'description of what is being tested');
  skip('description of skipped test');  // for known issues
});

Quality Gate Integration

This muscle is part of the pre-publish quality gate:

1. converter-qa.cjs runs all 284 assertions
2. Zero failures required to pass
3. Skips are tracked but don't block (used for environment-dependent tests)

Test Patterns

Assertion Style

Tests use direct boolean assertions with descriptive messages:

suite('preprocessor', () => {
  const result = preprocessMarkdown(input);
  assert(result.includes('expected'), 'preprocessor should transform X to Y');
  assert(!result.includes('bad'), 'preprocessor should strip bad patterns');
});

Regression Testing

OOXML tests compare generated Word document XML structure against known-good snapshots:

1. Generate a .docx from a known markdown input
2. Unzip the .docx and extract document.xml
3. Assert specific XML elements exist (table styles, heading formats, image references)
4. Assert element counts match expected values

Environment-Dependent Skips

Some tests depend on external tools (Pandoc, Mermaid CLI). Use skip() when the tool is unavailable:

if (!hasPandoc()) {
  skip('Pandoc Lua filter syntax (pandoc not installed)');
} else {
  suite('Lua filter', () => { /* ... */ });
}

Troubleshooting