Skip to content
This repository has been archived by the owner on May 17, 2024. It is now read-only.

Commit

Permalink
Merge branch 'master' into valentin-dx-842-add-column-types-to-json-o…
Browse files Browse the repository at this point in the history
…utput
  • Loading branch information
dlawin authored Jul 15, 2023
2 parents 4ee1a88 + 0d65830 commit 80647b5
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/stale.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ jobs:
close-issue-message: "Although we are closing this issue as stale, it's not gone forever. Issues can be reopened if there is renewed community interest. Just add a comment and it will be reopened for triage."
close-pr-message: "Although we are closing this pull request as stale, it's not gone forever. PRs can be reopened if there is renewed community interest. Just add a comment and it will be reopened for triage."
close-issue-reason: "not_planned"
exempt-issue-labels: "stale_immune"
exempt-pr-labels: "stale_immune"
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,43 @@ You can adjust how many rows we benchmark with by passing `N_SAMPLES` to `dev/be
```shell-session
$ N_SAMPLES=100000000 dev/benchmark.sh # 100m which is our canonical target
```

## VSCode Setup
To debug using the unit tests in VSCode, add the following files to a `.vscode` directory in the root of the repo

`launch.json`
```
{
"version": "0.1.0",
"configurations": [
{
"name": "Debug Unit Test",
"type": "python",
"request": "test",
"justMyCode": true,
}
]
}
```

`settings.json`
```
{
"python.testing.unittestArgs": [
"-v",
"-s",
"",
"-p",
"test_*.py"
],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true,
}
```
You should see that the tests are now appearing in the test explorer view:

![asdf](/docs/debug_example.png)

This will allow you to run tests in the IDE, debug them, and hit breakpoints.

Note that some tests require that you have the docker containers mentioned above running in order to pass.
Binary file added docs/debug_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/usage_analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ We capture two events: one when the data-diff run starts, and one when it is fin
- Sizes of tables diffed, run time, and diff row count (numbers only)
- Error message, if any, truncated to the first 20 characters.
- A persistent UUID to indentify the session, stored in `~/.datadiff.toml`
- IP address of the machine running diff

When using the `--dbt` feature, we also collect:

Expand All @@ -27,4 +28,4 @@ To disable, use one of the following methods:
import data_diff
# Invoke the following before making any API calls
data_diff.disable_tracking()
```
```

0 comments on commit 80647b5

Please sign in to comment.