🐛 fix: Change the default name to custom for disambiguation

Using `dbt_py` as the default name would import _this_ package, not the local version in the dbt project

.github/workflows/application-tests.yaml

@@ -38,6 +38,6 @@ jobs:
       - name: ✅ Run unit tests
         run: poetry run pytest
         env:
-          # TODO: The tests should configure this themselves
-          DBT_PY_PACKAGE_ROOT: "tests.integration.jaffle-shop.dbt_py"
-          DBT_PY_PACKAGE_NAME: "dbt_py"
+          # TODO: This is configured in the tests, but not being picked up in CI
+          DBT_PY_PACKAGE_ROOT: "tests.integration.jaffle-shop.dbt_py_test"
+          DBT_PY_PACKAGE_NAME: "dbt_py_test"

dbt_py/__init__.py

@@ -4,6 +4,6 @@
 from dbt_py.main import PROJECT_ROOT, main
 
 __all__ = [
-    "main",
     "PROJECT_ROOT",
+    "main",
 ]

dbt_py/main.py

@@ -15,13 +15,14 @@
 
 PROJECT_ROOT = pathlib.Path(__file__).parent.parent
 # Python-style ref, e.g. `package.module.submodule`
-PACKAGE_ROOT: str = os.environ.get("DBT_PY_PACKAGE_ROOT", "dbt_py")
+PACKAGE_ROOT: str = os.environ.get("DBT_PY_PACKAGE_ROOT", "custom")
 # The name to associate with the package
 PACKAGE_NAME: str = os.environ.get("DBT_PY_PACKAGE_NAME", PACKAGE_ROOT)
 
 
 def import_submodules(
-    package_name: str, recursive: bool = True
+    package_name: str,
+    recursive: bool = True,
 ) -> dict[str, ModuleType]:
     """
     Import all submodules of a module, recursively, including subpackages.

tests/integration/jaffle-shop/dbt-commands.sh

@@ -1,6 +1,6 @@
 # Just for reference
-# $env:DBT_PY_PACKAGE_ROOT = "tests.integration.jaffle-shop.dbt_py"
-# $env:DBT_PY_PACKAGE_NAME = "dbt_py"
+# $env:DBT_PY_PACKAGE_ROOT = "tests.integration.jaffle-shop.dbt_py_test"
+# $env:DBT_PY_PACKAGE_NAME = "dbt_py_test"
 dbt    clean   --project-dir tests/integration/jaffle-shop --profiles-dir tests/integration/jaffle-shop --no-clean-project-files-only
 dbt-py compile --project-dir tests/integration/jaffle-shop --profiles-dir tests/integration/jaffle-shop
 rm dbt_packages

tests/integration/jaffle-shop/models/example.sql

@@ -1,5 +1,5 @@
-{{ modules.dbt_py.some_module.select_final() }}
-{{ modules.dbt_py.some_module.salutation("World") }}
+{{ modules.dbt_py_test.some_module.select_final() }}
+{{ modules.dbt_py_test.some_module.salutation("World") }}
 
-{{ modules.dbt_py.select_final() }}
-{{ modules.dbt_py.salutation("World") }}
+{{ modules.dbt_py_test.select_final() }}
+{{ modules.dbt_py_test.salutation("World") }}

tests/integration/test__integration.py

@@ -1,7 +1,6 @@
 """
 Integration tests for the package.
 """
-import os
 import textwrap
 import unittest.mock
 
@@ -30,13 +29,21 @@
 )
 
 
-def test__integration() -> None:
+@pytest.fixture
+def mock_env(monkeypatch) -> None:
     """
-    Placeholder integration test.
+    Mock the environment variables used by dbt_py.
     """
-    os.environ["DBT_PY_PACKAGE_ROOT"] = "tests.integration.jaffle-shop.dbt_py"
-    os.environ["DBT_PY_PACKAGE_NAME"] = "dbt_py"
+    monkeypatch.setenv(
+        "DBT_PY_PACKAGE_ROOT", "tests.integration.jaffle-shop.dbt_py_test"
+    )
+    monkeypatch.setenv("DBT_PY_PACKAGE_NAME", "dbt_py_test")
+
 
+def test__integration(mock_env) -> None:
+    """
+    Placeholder integration test.
+    """
     with unittest.mock.patch("sys.argv", ["", "compile", *ARGS]):
         dbt_py.main()