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.

Sign up for GitHub

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

Remove duplicative parts of tests/unit/test_context.py #100

Merged
merged 1 commit into from
Apr 13, 2022
Merged

Remove duplicative parts of tests/unit/test_context.py #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
255 changes: 2 additions & 253 deletions tests/unit/test_context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import unittest
import os
from typing import Set, Dict, Any
from unittest import mock

import pytest
Expand All @@ -10,115 +9,12 @@
from dbt.contracts.graph.parsed import (
ParsedModelNode, NodeConfig, DependsOn, ParsedMacro
)
from dbt.config.project import VarProvider
from dbt.context import base, target, providers, docs, manifest
from dbt.contracts.files import FileHash
from dbt.context import providers
from dbt.node_types import NodeType
import dbt.exceptions
from .utils import profile_from_dict, config_from_parts_or_dicts, inject_adapter, clear_plugin
from .utils import config_from_parts_or_dicts, inject_adapter, clear_plugin
from .mock_adapter import adapter_factory


class TestVar(unittest.TestCase):
def setUp(self):
self.model = ParsedModelNode(
alias='model_one',
name='model_one',
database='dbt',
schema='analytics',
resource_type=NodeType.Model,
unique_id='model.root.model_one',
fqn=['root', 'model_one'],
package_name='root',
original_file_path='model_one.sql',
root_path='/usr/src/app',
refs=[],
sources=[],
depends_on=DependsOn(),
config=NodeConfig.from_dict({
'enabled': True,
'materialized': 'view',
'persist_docs': {},
'post-hook': [],
'pre-hook': [],
'vars': {},
'quoting': {},
'column_types': {},
'tags': [],
}),
tags=[],
path='model_one.sql',
raw_sql='',
description='',
columns={},
checksum=FileHash.from_contents(''),
)
self.context = mock.MagicMock()
self.provider = VarProvider({})
self.config = mock.MagicMock(
config_version=2, vars=self.provider, cli_vars={}, project_name='root'
)

def test_var_default_something(self):
self.config.cli_vars = {'foo': 'baz'}
var = providers.RuntimeVar(self.context, self.config, self.model)
self.assertEqual(var('foo'), 'baz')
self.assertEqual(var('foo', 'bar'), 'baz')

def test_var_default_none(self):
self.config.cli_vars = {'foo': None}
var = providers.RuntimeVar(self.context, self.config, self.model)
self.assertEqual(var('foo'), None)
self.assertEqual(var('foo', 'bar'), None)

def test_var_not_defined(self):
var = providers.RuntimeVar(self.context, self.config, self.model)

self.assertEqual(var('foo', 'bar'), 'bar')
with self.assertRaises(dbt.exceptions.CompilationException):
var('foo')

def test_parser_var_default_something(self):
self.config.cli_vars = {'foo': 'baz'}
var = providers.ParseVar(self.context, self.config, self.model)
self.assertEqual(var('foo'), 'baz')
self.assertEqual(var('foo', 'bar'), 'baz')

def test_parser_var_default_none(self):
self.config.cli_vars = {'foo': None}
var = providers.ParseVar(self.context, self.config, self.model)
self.assertEqual(var('foo'), None)
self.assertEqual(var('foo', 'bar'), None)

def test_parser_var_not_defined(self):
# at parse-time, we should not raise if we encounter a missing var
# that way disabled models don't get parse errors
var = providers.ParseVar(self.context, self.config, self.model)

self.assertEqual(var('foo', 'bar'), 'bar')
self.assertEqual(var('foo'), None)


class TestParseWrapper(unittest.TestCase):
def setUp(self):
self.mock_config = mock.MagicMock()
adapter_class = adapter_factory()
self.mock_adapter = adapter_class(self.mock_config)
self.namespace = mock.MagicMock()
self.wrapper = providers.ParseDatabaseWrapper(
self.mock_adapter, self.namespace)
self.responder = self.mock_adapter.responder

def test_unwrapped_method(self):
self.assertEqual(self.wrapper.quote('test_value'), '"test_value"')
self.responder.quote.assert_called_once_with('test_value')

def test_wrapped_method(self):
found = self.wrapper.get_relation('database', 'schema', 'identifier')
self.assertEqual(found, None)
self.responder.get_relation.assert_not_called()


class TestRuntimeWrapper(unittest.TestCase):
def setUp(self):
self.mock_config = mock.MagicMock()
Expand All @@ -131,99 +27,6 @@ def setUp(self):
self.mock_adapter, self.namespace)
self.responder = self.mock_adapter.responder

def test_unwrapped_method(self):
# the 'quote' method isn't wrapped, we should get our expected inputs
self.assertEqual(self.wrapper.quote('test_value'), '"test_value"')
self.responder.quote.assert_called_once_with('test_value')

def test_wrapped_method(self):
rel = mock.MagicMock()
rel.matches.return_value = True
self.responder.list_relations_without_caching.return_value = [rel]

found = self.wrapper.get_relation('database', 'schema', 'identifier')

self.assertEqual(found, rel)

self.responder.list_relations_without_caching.assert_called_once_with(
mock.ANY)
# extract the argument
assert len(self.responder.list_relations_without_caching.mock_calls) == 1
assert len(
self.responder.list_relations_without_caching.call_args[0]) == 1
arg = self.responder.list_relations_without_caching.call_args[0][0]
assert arg.database == 'database'
assert arg.schema == 'schema'


def assert_has_keys(
required_keys: Set[str], maybe_keys: Set[str], ctx: Dict[str, Any]
):
keys = set(ctx)
for key in required_keys:
assert key in keys, f'{key} in required keys but not in context'
keys.remove(key)
extras = keys.difference(maybe_keys)
assert not extras, f'got extra keys in context: {extras}'


REQUIRED_BASE_KEYS = frozenset({
'context',
'builtins',
'dbt_version',
'var',
'env_var',
'return',
'fromjson',
'tojson',
'fromyaml',
'toyaml',
'log',
'run_started_at',
'invocation_id',
'modules',
'flags',
'print'
})

REQUIRED_TARGET_KEYS = REQUIRED_BASE_KEYS | {'target'}
REQUIRED_DOCS_KEYS = REQUIRED_TARGET_KEYS | {'project_name'} | {'doc'}
MACROS = frozenset({'macro_a', 'macro_b', 'root', 'dbt'})
REQUIRED_QUERY_HEADER_KEYS = REQUIRED_TARGET_KEYS | {'project_name'} | MACROS
REQUIRED_MACRO_KEYS = REQUIRED_QUERY_HEADER_KEYS | {
'_sql_results',
'load_result',
'store_result',
'store_raw_result',
'validation',
'write',
'render',
'try_or_compiler_error',
'load_agate_table',
'ref',
'source',
'config',
'execute',
'exceptions',
'database',
'schema',
'adapter',
'api',
'column',
'env',
'graph',
'model',
'pre_hooks',
'post_hooks',
'sql',
'sql_now',
'adapter_macro',
'selected_resources',
}
REQUIRED_MODEL_KEYS = REQUIRED_MACRO_KEYS | {'this'}
MAYBE_KEYS = frozenset({'debug'})


PROFILE_DATA = {
'target': 'test',
'quoting': {},
Expand Down Expand Up @@ -282,18 +85,6 @@ def model():
columns={}
)


def test_base_context():
ctx = base.generate_base_context({})
assert_has_keys(REQUIRED_BASE_KEYS, MAYBE_KEYS, ctx)


def test_target_context():
profile = profile_from_dict(PROFILE_DATA, 'test')
ctx = target.generate_target_context(profile, {})
assert_has_keys(REQUIRED_TARGET_KEYS, MAYBE_KEYS, ctx)


def mock_macro(name, package_name):
macro = mock.MagicMock(
__class__=ParsedMacro,
Expand Down Expand Up @@ -396,48 +187,6 @@ def redshift_adapter(config, get_adapter):
clear_plugin(redshift.Plugin)


def test_query_header_context(config, manifest_fx):
ctx = manifest.generate_query_header_context(
config=config,
manifest=manifest_fx,
)
assert_has_keys(REQUIRED_QUERY_HEADER_KEYS, MAYBE_KEYS, ctx)


def test_macro_runtime_context(config, manifest_fx, get_adapter, get_include_paths):
ctx = providers.generate_runtime_macro_context(
macro=manifest_fx.macros['macro.root.macro_a'],
config=config,
manifest=manifest_fx,
package_name='root',
)
assert_has_keys(REQUIRED_MACRO_KEYS, MAYBE_KEYS, ctx)


def test_model_parse_context(config, manifest_fx, get_adapter, get_include_paths):
ctx = providers.generate_parser_model_context(
model=mock_model(),
config=config,
manifest=manifest_fx,
context_config=mock.MagicMock(),
)
assert_has_keys(REQUIRED_MODEL_KEYS, MAYBE_KEYS, ctx)


def test_model_runtime_context(config, manifest_fx, get_adapter, get_include_paths):
ctx = providers.generate_runtime_model_context(
model=mock_model(),
config=config,
manifest=manifest_fx,
)
assert_has_keys(REQUIRED_MODEL_KEYS, MAYBE_KEYS, ctx)


def test_docs_runtime_context(config):
ctx = docs.generate_runtime_docs_context(config, mock_model(), [], 'root')
assert_has_keys(REQUIRED_DOCS_KEYS, MAYBE_KEYS, ctx)


def test_resolve_specific(config, manifest_extended, redshift_adapter, get_include_paths):
rs_macro = manifest_extended.macros['macro.dbt_redshift.redshift__some_macro']
package_rs_macro = manifest_extended.macros['macro.root.redshift__some_macro']
Expand Down