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.

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

Update repository unit tests to have Project fixture and do additional Project testing #10022

Merged
merged 5 commits into from
Apr 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
82 changes: 60 additions & 22 deletions tests/unit/config/test_project.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@
import dbt.exceptions
from dbt.adapters.factory import load_plugin
from dbt.adapters.contracts.connection import QueryComment, DEFAULT_QUERY_COMMENT
from dbt.config.project import Project
from dbt.contracts.project import PackageConfig, LocalPackage, GitPackage
from dbt.node_types import NodeType
from dbt_common.exceptions import DbtRuntimeError
from dbt_common.semver import VersionSpecifier

from dbt.flags import set_from_args
Expand All @@ -27,7 +29,64 @@
)


class TestProject(BaseConfigTest):
class TestProjectMethods:
def test_all_source_paths(self, project: Project):
assert (
project.all_source_paths.sort()
== ["models", "seeds", "snapshots", "analyses", "macros"].sort()
)

def test_generic_test_paths(self, project: Project):
assert project.generic_test_paths == ["tests/generic"]

def test_fixture_paths(self, project: Project):
assert project.fixture_paths == ["tests/fixtures"]

def test__str__(self, project: Project):
assert (
str(project)
== "{'name': 'test_project', 'version': 1.0, 'project-root': 'doesnt/actually/exist', 'profile': 'test_profile', 'model-paths': ['models'], 'macro-paths': ['macros'], 'seed-paths': ['seeds'], 'test-paths': ['tests'], 'analysis-paths': ['analyses'], 'docs-paths': ['docs'], 'asset-paths': ['assets'], 'target-path': 'target', 'snapshot-paths': ['snapshots'], 'clean-targets': ['target'], 'log-path': 'path/to/project/logs', 'quoting': {'database': True, 'schema': True, 'identifier': True}, 'models': {}, 'on-run-start': [], 'on-run-end': [], 'dispatch': [{'macro_namespace': 'dbt_utils', 'search_order': ['test_project', 'dbt_utils']}], 'seeds': {}, 'snapshots': {}, 'sources': {}, 'data_tests': {}, 'unit_tests': {}, 'metrics': {}, 'semantic-models': {}, 'saved-queries': {}, 'exposures': {}, 'vars': {}, 'require-dbt-version': ['=1.8.0-b3'], 'restrict-access': False, 'dbt-cloud': {}, 'query-comment': {'comment': \"\\n{%- set comment_dict = {} -%}\\n{%- do comment_dict.update(\\n app='dbt',\\n dbt_version=dbt_version,\\n profile_name=target.get('profile_name'),\\n target_name=target.get('target_name'),\\n) -%}\\n{%- if node is not none -%}\\n {%- do comment_dict.update(\\n node_id=node.unique_id,\\n ) -%}\\n{% else %}\\n {# in the node context, the connection name is the node_id #}\\n {%- do comment_dict.update(connection_name=connection_name) -%}\\n{%- endif -%}\\n{{ return(tojson(comment_dict)) }}\\n\", 'append': False, 'job-label': False}, 'packages': []}"
)

def test_get_selector(self, project: Project):
selector = project.get_selector("my_selector")
assert selector.raw == "give me cats"

with pytest.raises(DbtRuntimeError):
project.get_selector("doesnt_exist")

def test_get_default_selector_name(self, project: Project):
default_selector_name = project.get_default_selector_name()
assert default_selector_name == "my_selector"

project.selectors["my_selector"]["default"] = False
default_selector_name = project.get_default_selector_name()
assert default_selector_name is None

def test_get_macro_search_order(self, project: Project):
search_order = project.get_macro_search_order("dbt_utils")
assert search_order == ["test_project", "dbt_utils"]

search_order = project.get_macro_search_order("doesnt_exist")
assert search_order is None

def test_project_target_path(self, project: Project):
assert project.project_target_path == "doesnt/actually/exist/target"

def test_eq(self, project: Project):
other = deepcopy(project)
assert project == other

def test_neq(self, project: Project):
other = deepcopy(project)
other.project_name = "other project"
assert project != other

def test_hashed_name(self, project: Project):
assert project.hashed_name() == "6e72a69d5c5cca8f0400338441c022e4"


class TestProjectInitialization(BaseConfigTest):
def test_defaults(self):
project = project_from_config_norender(
self.default_project_data, project_root=self.project_dir
Expand Down Expand Up @@ -60,21 +119,6 @@ def test_defaults(self):
# embarrassing
str(project)

def test_eq(self):
project = project_from_config_norender(
self.default_project_data, project_root=self.project_dir
)
other = project_from_config_norender(
self.default_project_data, project_root=self.project_dir
)
self.assertEqual(project, other)

def test_neq(self):
project = project_from_config_norender(
self.default_project_data, project_root=self.project_dir
)
self.assertNotEqual(project, object())

def test_implicit_overrides(self):
self.default_project_data.update(
{
Expand All @@ -89,12 +133,6 @@ def test_implicit_overrides(self):
set(["other-models", "seeds", "snapshots", "analyses", "macros"]),
)

def test_hashed_name(self):
project = project_from_config_norender(
self.default_project_data, project_root=self.project_dir
)
self.assertEqual(project.hashed_name(), "754cd47eac1d6f50a5f7cd399ec43da4")

def test_all_overrides(self):
# log-path is not tested because it is set exclusively from flags, not cfg
self.default_project_data.update(
Expand Down
1 change: 1 addition & 0 deletions tests/unit/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

# All manifest related fixtures.
from tests.unit.utils.manifest import * # noqa
from tests.unit.utils.project import * # noqa


@pytest.fixture
Expand Down
72 changes: 72 additions & 0 deletions tests/unit/utils/project.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import pytest

import dbt.config
import dbt.exceptions
from dbt.adapters.contracts.connection import QueryComment
from dbt.config.project import Project, RenderComponents, VarProvider
from dbt.config.selectors import SelectorConfig
from dbt.contracts.project import PackageConfig
from dbt_common.semver import VersionSpecifier


@pytest.fixture(scope="function")
def selector_config() -> SelectorConfig:
return SelectorConfig.selectors_from_dict(
data={
"selectors": [
{
"name": "my_selector",
"definition": "give me cats",
"default": True,
}
]
}
)


@pytest.fixture(scope="function")
def project(selector_config: SelectorConfig) -> Project:
return Project(
project_name="test_project",
version=1.0,
project_root="doesnt/actually/exist",
profile_name="test_profile",
model_paths=["models"],
macro_paths=["macros"],
seed_paths=["seeds"],
test_paths=["tests"],
analysis_paths=["analyses"],
docs_paths=["docs"],
asset_paths=["assets"],
target_path="target",
snapshot_paths=["snapshots"],
clean_targets=["target"],
log_path="path/to/project/logs",
packages_install_path="dbt_packages",
packages_specified_path="packages.yml",
quoting={"database": True, "schema": True, "identifier": True},
models={},
on_run_start=[],
on_run_end=[],
dispatch=[{"macro_namespace": "dbt_utils", "search_order": ["test_project", "dbt_utils"]}],
seeds={},
snapshots={},
sources={},
data_tests={},
unit_tests={},
metrics={},
semantic_models={},
saved_queries={},
exposures={},
vars=VarProvider({}),
dbt_version=[VersionSpecifier.from_version_string(dbt.version.__version__)],
packages=PackageConfig([]),
manifest_selectors={},
selectors=selector_config,
query_comment=QueryComment(),
config_version=1,
unrendered=RenderComponents({}, {}, {}),
project_env_vars={},
restrict_access=False,
dbt_cloud={},
)