Skip to main content

Yet another SQL-testing framework for BigQuery provided by pytest plugin

Project description

Pytest plugin for Bigquery SQL

pytest-sql-bigquery is pytest-plugin which provides a sql-unitest-framework for BigQuery. This plugin adopts an end-to-end approch that runnning SQL test on SQL engines.

Yet anthoer approch to tst SQL code

See following SQL codes:

with dataset as (
    select 1
    union all select 2
, __check_sample as (
    select 'test' as label, count(1) as actual, 2 as expected from dataset 

select * from dataset

This code is minimal example including test case. __check_sample is a test case which makes sure the dataset view has just 2 record.

Our idea is very simple: "Verify SQL code by SQL-self."

This plugin generate SQL test codes from SQL and executed them on SQL-engine such as BigQuery.

The advantages of this approch are

  • SQL codes owns specification itself
  • Provide portability of logic and its test codes.
  • Free to hard-mocking database system

Get Started


  • Python >= 3.7

  • sqlparse

  • google-cloud-bigquery (For BigQuery integration)

  • BigQuery (Google Cloud Project)


pip install pytest-bigquery-sql

Then, set up for pytest settings.

import pytest

from pytest_sql_bigquery.integrations.pytest import SQLReaderForChecking

class ChainPytestFile(pytest.File):

    def __init__(self, path, parent, chains, **kwargs):
        super().__init__(path, parent, **kwargs)
        self.chains = chains

    def collect(self):
        for interpreter in self.chains:
            yield from interpreter.collect()

def pytest_collect_file(parent, path):
    if path.ext == ".sql":
        return ChainPytestFile(
            path, parent,
                SQLReaderForChecking(path, parent),

Run test for examples/sql directory

pytest run -vv examples/sql 

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pytest-sql-bigquery, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size pytest_sql_bigquery-0.0.3-py3-none-any.whl (5.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pytest_sql_bigquery-0.0.3.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page