set working dir to test dir in snippet tests

allow to import snippets from any file
dlt-hub · Sep 11, 2023 · 594b618 · 594b618
1 parent 0562a42
commit 594b618
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 10 deletions.
diff --git a/docs/website/docs/conftest.py b/docs/website/docs/conftest.py
@@ -4,10 +4,9 @@
 from tests.utils import patch_home_dir, autouse_test_storage, preserve_environ, duckdb_pipeline_location, wipe_pipeline
 
 @pytest.fixture(autouse=True)
-def set_working_dir():
+def set_working_dir(request):
     # always set working dir to main website folder
-    abspath = os.path.abspath(__file__)
-    dname = os.path.dirname(abspath)
+    dname =  os.path.dirname(request.module.__file__)
     os.chdir(dname)
 
 def pytest_configure(config):

diff --git a/docs/website/docs/getting-started.md b/docs/website/docs/getting-started.md
@@ -40,7 +40,7 @@ Make sure that your `dlt` version is **0.3.15** or above. Check it in the termin
 
 Let's load a list of Python objects (dictionaries) into `duckdb` and inspect the created dataset:
 
-<!--@@@DLT_SNIPPET_START start-->
+<!--@@@DLT_SNIPPET_START ./getting-started-snippets.py::start-->
 ```python
 import dlt
 
@@ -58,7 +58,7 @@ load_info = pipeline.run(data, table_name="users")
 
 print(load_info)
 ```
-<!--@@@DLT_SNIPPET_END start-->
+<!--@@@DLT_SNIPPET_END ./getting-started-snippets.py::start-->
 
 Save this python script with the name `quick_start_pipeline.py` and run the following command:
 

diff --git a/docs/website/package.json b/docs/website/package.json
@@ -4,9 +4,9 @@
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
-    "start": "node update_snippets.js --watch & docusaurus start",
-    "build": "node update_snippets.js && docusaurus build",
-    "build:netlify": "node update_snippets.js && docusaurus build --out-dir build/docs",
+    "start": "node tools/update_snippets.js --watch & docusaurus start",
+    "build": "node tools/update_snippets.js && docusaurus build",
+    "build:netlify": "node tools/update_snippets.js && docusaurus build --out-dir build/docs",
     "swizzle": "docusaurus swizzle",
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",

diff --git a/docs/website/update_snippets.js → docs/website/tools/update_snippets.js b/docs/website/update_snippets.js → docs/website/tools/update_snippets.js
@@ -3,7 +3,7 @@ const path = require('path');
 const dedent = require('dedent');
 var watch = require('node-watch');
 
-const BASE_DIR = "./docs";
+const BASE_DIR = "./docs/";
 const DOCS_EXTENSIONS = [".md", ".mdx"];
 const SNIPPETS_FILE_SUFFIX = "-snippets.py"
 
@@ -67,7 +67,12 @@ function buildSnippetMap(lines, fileName) {
 // get the right snippet for a file
 function getSnippet(fileName, snippetName) {
     const ext = path.extname(fileName);
-    const snippetsFileName = fileName.slice(0, -ext.length) + SNIPPETS_FILE_SUFFIX;
+    const snippetParts = snippetName.split("::");
+    let snippetsFileName = fileName.slice(0, -ext.length) + SNIPPETS_FILE_SUFFIX;
+    if (snippetParts.length > 1) {
+        snippetsFileName = BASE_DIR + snippetParts[0];
+        snippetName = snippetParts[1];
+    }
     const lines = fs.readFileSync(snippetsFileName, 'utf8').split(/\r?\n/);
     const snippetMap = buildSnippetMap(lines, snippetsFileName);