Skip to content

README.md

Latest commit

 

History

History
115 lines (86 loc) · 3.4 KB

README.md

File metadata and controls

115 lines (86 loc) · 3.4 KB
Raw

Test Generation Scripts

This directory contains scripts for generating Noir tests from the W3C qt3tests test suite.

generate_tests.py

Generates Noir test packages from the qt3tests repository.

Usage

# Generate tests for ALL functions (default)
python generate_tests.py

# Generate tests for specific functions only
python generate_tests.py --functions "fn:abs,op:numeric-add"

# List implemented functions
python generate_tests.py --list-functions

# List all discoverable functions (implemented and unimplemented)
python generate_tests.py --list-all

# Skip cloning qt3tests (if already present)
python generate_tests.py --skip-clone

# Skip running nargo fmt after generation
python generate_tests.py --skip-fmt

# Custom output directory
python generate_tests.py --output-dir ../custom_tests

Options

Option Description
--output-dir Output directory for generated test packages (default: ../test_packages)
--qt3-dir Directory for qt3tests repository (default: ./qt3tests)
--functions Comma-separated list of XPath functions to generate tests for
--skip-clone Skip cloning/updating the qt3tests repository
--list-functions List implemented functions and exit
--list-all List all discoverable functions (implemented and unimplemented) and exit
--skip-fmt Skip running nargo fmt after generation

How It Works

The script generates a Noir test for every test case in the W3C qt3tests suite:

  1. Implemented Functions: Tests call the actual implementation in the xpath library
  2. Unimplemented Functions: Tests call auto-generated stub functions that assert false

Stub Functions

For XPath functions that haven't been implemented yet, the script generates stub functions in xpath/src/stubs.nr. These stub functions always assert false, causing tests to fail until the real implementation is provided:

/// Stub for fn:concat - NOT YET IMPLEMENTED
pub fn stub_fnconcat() -> bool {
    assert(false, "fn:concat is not yet implemented");
    false
}

Tests for unimplemented functions call these stubs:

#[test]
fn fn_concat_1() {
    // Evaluates the 'concat' function
    // XPath: fn:concat("a", "b")
    // Expected: ab
    // Calls stub function - will fail until fn:concat is implemented
    let _ = stub_fnconcat();
}

This ensures:

  • Every qt3test has a corresponding Noir test
  • Tests for unimplemented functions fail clearly
  • Progress can be tracked by the number of passing tests

Generated Structure

xpath/
├── src/
│   ├── lib.nr          # Updated to include stubs module
│   ├── stubs.nr        # Auto-generated stub functions
│   └── ...

test_packages/
├── xpath_test_fnabs/
│   ├── Nargo.toml
│   └── src/
│       ├── lib.nr
│       └── chunk_0.nr
├── xpath_test_fnconcat/   # Uses stub functions
│   └── ...

Formatting

The script automatically runs nargo fmt after generation to ensure all code is properly formatted. Use --skip-fmt to disable this behavior.

After Generation

After generating tests, the script automatically:

  1. Updates the workspace Nargo.toml to include all test packages
  2. Generates stub functions in xpath/src/stubs.nr
  3. Updates xpath/src/lib.nr to export stub functions
  4. Runs nargo fmt to format all generated code