spalidate

README

Spalidate

A command-line tool for validating data in Google Cloud Spanner emulator against YAML configuration files.

Installation

go install github.com/nu0ma/spalidate@latest

Usage

spalidate --project=test-project --instance=test-instance --database=test-database ./validation.yaml

Flags

• --project: Spanner project ID (required)
• --instance: Spanner instance ID (required)
• --database: Spanner database ID (required)
• --port: Spanner emulator port (default: 9010)
• --version: Show version information
• --verbose: Enable verbose logging
• --help: Show help information

Positional Arguments

• config-file: Path to YAML configuration file (required)

Configuration File Format

Create a YAML file that defines the expected data structure:

tables:
  # Example: Users table
  Users:
    count: 1  # Expected number of rows
    columns:
      UserID: "user-001"
      Name: "Test User"
      Email: "test@example.com"
      Status: 1
  
  # Example: Products table
  Products:
    count: 2
    columns:
      ProductID: "prod-001"
      Name: "Test Product"
      Price: 1000
      IsActive: true

What It Validates

• Table existence: Ensures all tables defined in the config exist in Spanner
• Row count: Verifies the exact number of rows matches the expected count
• Column values: Validates that the first row contains the expected column values
• Data types: Performs flexible type comparison (e.g., int vs int64, string representations)

Examples

Basic validation

spalidate --project=test-project --instance=test-instance --database=test-database ./validation.yaml

Verbose output

spalidate --project=test-project --instance=test-instance --database=test-database --verbose ./validation.yaml

Custom emulator port

spalidate --project=test-project --instance=test-instance --database=test-database --port=9020 ./validation.yaml

Example output (success)

✅ All validations passed!

Example output (failure)

Validation failed:
  ❌ Table Users: expected 2 rows, got 1
  ❌ Table Products, column Price: expected 1000 (int), got 1200 (int64)

Spanner Connection

The tool connects to Spanner using the database path constructed from your parameters:

projects/{project}/instances/{instance}/databases/{database}

Make sure your Spanner emulator is running and accessible with the specified project, instance, and database.

Development

Building from source

git clone https://github.com/nu0ma/spalidate.git
cd spalidate
go build -o spalidate main.go

Running tests

go test ./internal/...

License

MIT License - see LICENSE file for details.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Ensure all tests pass
6. Submit a pull request