Skip to main content

Submission correctness tests for SQL

Project description

sqlwhat

Build Status PyPI version

sqlwhat enables you to write Submission Correctness Tests (SCTs) for interactive SQL exercises on DataCamp.

Installing

pip install sqlwhat     # install from pypi
make install            # install from source

Reference

Raising issues with how SQL is parsed

Please raise an issue on the respsective parser repo:

Basic Use

from sqlwhat.State import State    # State holds info needed for tests
from sqlwhat.Reporter import Reporter
from sqlwhat.checks import *       # imports all SCTs
from sqlalchemy import create_engine

code = "SELECT * FROM artists WHERE id < 100"

state = State(
    student_code = code,
    solution_code = code,
    pre_exercise_code = "",
    student_conn = create_engine('sqlite:///'),
    solution_conn = create_engine('sqlite:///'),
    student_result = {'id': [1,2,3], 'name': ['greg', 'jon', 'martha']},
    solution_result = {'id': [1,2,3], 'name': ['toby', 'keith', 'deb']},
    reporter = Reporter()
    )

# test below passes, since code is equal for student and solution
has_equal_ast(state)

# test below raises a TestFail error, since 'name' col of results
# doesn't match between student and solution results
check_result(state)
# shows error data
state.reporter.build_payload()

# can also be done using a chain
from sqlwhat.sct_syntax import Ex
Ex(state).check_result()

Running unit tests

pytest -m "not backend"

If you also want to run the backend tests, you need to set a GITHUB_TOKEN environment variable with access to the (private) sqlbackend repository. After this, you can:

make install
pytest

Rules of testing

  1. Running queries is the backend's job
  2. If a test doesn't run queries, it doesn't need the backend
  3. Very few tests should run queries

Building Docs

Install sqlwhat and run ..

cd docs
make html

Project details


Download files

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

Source Distribution

sqlwhat-3.9.4.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

sqlwhat-3.9.4-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file sqlwhat-3.9.4.tar.gz.

File metadata

  • Download URL: sqlwhat-3.9.4.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.2 requests/2.25.1 setuptools/50.3.0 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/3.5.10

File hashes

Hashes for sqlwhat-3.9.4.tar.gz
Algorithm Hash digest
SHA256 cb756931236ad5fc991fef4c74594c8a7ce34590a780505c198c96e65cb98d4d
MD5 c67805776d8d2b46ee87c18ce818c9c1
BLAKE2b-256 1b694a49e7a1f65389d723148f4c539c735cfedb41d6b29961e401e7d02a688a

See more details on using hashes here.

File details

Details for the file sqlwhat-3.9.4-py3-none-any.whl.

File metadata

  • Download URL: sqlwhat-3.9.4-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.8.2 requests/2.25.1 setuptools/50.3.0 requests-toolbelt/1.0.0 tqdm/4.64.1 CPython/3.5.10

File hashes

Hashes for sqlwhat-3.9.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1ecb8fd08cf55009344fe72c73c17f1d52b4b221b696afb9f9c84c71e6631509
MD5 8e60bcf2268a0d6bdd1fe8436fe375ca
BLAKE2b-256 a6a6cd3f8b3b4dc77cfa68191c014a47d1205ed4a03abf920fc386d0d5b30ff6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page