Merge branch 'master' into valentin-dx-842-add-column-types-to-json-output

Author: dlawin

.github/workflows/stale.yml

@@ -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"

CONTRIBUTING.md

@@ -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.

docs/debug_example.png

@@ -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:
 
@@ -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()
-    ```
+    ```