Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update contributing with pytest info #2479

Merged
merged 2 commits into from
Jan 23, 2024
Merged

chore: update contributing with pytest info #2479

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c31cf3a
chore: update contributing with pytest info
tychoish Jan 23, 2024
e280c7a
Merge branch 'main' into tycho/document-pytest
tychoish Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,25 @@ provide insight as to whether the system as a whole is working as intended.
There are two types of functional tests in this repo: **SQL Logic Tests** and
**Postgres Protocol Tests**.

### Python (pytest) Integration Tests

The `tests` directory contains a pytest environment useful for
creating black box tests and ecosystem integration tests, and
providing a low-friction way to exercise parts of the codebase that
are difficult to interact with in any other way. To use these tests,
you must:

- build `glaredb` using `just build` or `cargo build --bin glaredb`

- run `just pytest-setup` to configure a virtual environment and
install dependencies.

Then run the tests, using:

```shell
just pytest
```

#### SQL Logic Tests

SQL logic tests run end-to-end tests that execute actual SQL queries against a
Expand Down