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

vdk-core: encapsulate router-specific properties logic #817

Merged
merged 2 commits into from
Apr 27, 2022
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from typing import List
from typing import Optional

from vdk.api.job_input import IIngester
from vdk.api.plugin.plugin_input import IIngesterPlugin
from vdk.api.plugin.plugin_input import IIngesterRegistry
from vdk.internal.builtin_plugins.ingestion.ingester_base import IngesterBase
Expand All @@ -30,7 +31,7 @@
log = logging.getLogger(__name__)


class IngesterRouter(IIngesterRegistry):
class IngesterRouter(IIngesterRegistry, IIngester):
"""
Router class for the core Ingestion API. It takes care of routing the
payloads to their respective ingestion plugins.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Copyright 2021 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
import logging
from typing import Any

from vdk.api.job_input import IProperties
from vdk.api.plugin.plugin_input import IPropertiesFactory
from vdk.api.plugin.plugin_input import IPropertiesRegistry
from vdk.internal.builtin_plugins.config.job_config import JobConfigKeys
Expand All @@ -24,7 +26,7 @@
log: logging.Logger = logging.getLogger(__name__)


class PropertiesRouter(IPropertiesRegistry):
class PropertiesRouter(IPropertiesRegistry, IProperties):
"""
Implements registry of IProperties.
"""
Expand All @@ -42,7 +44,26 @@ def set_properties_factory_method(
) -> None:
self.__properties_builders[properties_type] = properties_factory

def get_properties_impl(self):
def get_property(self, name: str, default_value: Any = None) -> str:
return self.__get_properties_impl().get_property(name, default_value)

def get_all_properties(self) -> dict:
return self.__get_properties_impl().get_all_properties()

def set_all_properties(self, properties: dict):
self.__get_properties_impl().set_all_properties(properties)

def has_properties_impl(self) -> bool:
"""
If any properties implementation backend available
:return: bool
"""
return not isinstance(self.__get_properties_impl(), PropertiesNotAvailable)

def __get_properties_impl(self):
"""
Singleton properties backend implementation.
"""
if not self.__cached_properties_impl:
if self.__properties_builders:
self.__cached_properties_impl = (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,25 +70,19 @@ def get_arguments(self) -> dict:
# Properties

def get_property(self, name, default_value=None):
return self.__properties_router.get_properties_impl().get_property(
name, default_value
)
return self.__properties_router.get_property(name, default_value)

def get_all_properties(self):
return self.__properties_router.get_properties_impl().get_all_properties()
return self.__properties_router.get_all_properties()

def set_all_properties(self, properties):
return self.__properties_router.get_properties_impl().set_all_properties(
properties
)
return self.__properties_router.set_all_properties(properties)

def _substitute_query_params(self, sql: str):
sql = textwrap.dedent(sql).strip("\n") + "\n"
query = sql
sql_susbstitute_args = {}
if isinstance(
self.__properties_router.get_properties_impl(), PropertiesNotAvailable
):
if not self.__properties_router.has_properties_impl():
logging.getLogger(__name__).info(
"Data Job Properties has not been initialized., "
"so I won't be able to provide query properties substitution capabilities from job properties."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ def test_routing():
mock_client = MagicMock(spec=IPropertiesServiceClient)
router.set_properties_factory_method("default", lambda: mock_client)

router.get_properties_impl().set_all_properties({"a": "b"})
router.set_all_properties({"a": "b"})
mock_client.write_properties.assert_called_with("foo", "test-team", {"a": "b"})

router.get_properties_impl().get_all_properties()
router.get_all_properties()
mock_client.read_properties.assert_called_with("foo", "test-team")


Expand All @@ -35,22 +35,22 @@ def raise_error():
router.set_properties_factory_method("default", raise_error)

with pytest.raises(VdkConfigurationError):
router.get_properties_impl().set_all_properties({"a": "b"})
router.set_all_properties({"a": "b"})


def test_routing_empty_error():
router = PropertiesRouter("foo", Configuration({}, {}))

with pytest.raises(VdkConfigurationError):
router.get_properties_impl().set_all_properties({"a": "b"})
router.set_all_properties({"a": "b"})


def test_routing_choose_single_registered():
router = PropertiesRouter("foo", Configuration({}, {"team": "test-team"}))
mock_client = MagicMock(spec=IPropertiesServiceClient)
router.set_properties_factory_method("foo", lambda: mock_client)

router.get_properties_impl().set_all_properties({"a": "b"})
router.set_all_properties({"a": "b"})
mock_client.write_properties.assert_called_with("foo", "test-team", {"a": "b"})


Expand All @@ -63,7 +63,7 @@ def test_routing_choose_default_type_chosen():
router.set_properties_factory_method("foo", lambda: foo_mock_client)
router.set_properties_factory_method("bar", lambda: bar_mock_client)

router.get_properties_impl().set_all_properties({"a": "b"})
router.set_all_properties({"a": "b"})
foo_mock_client.write_properties.assert_called_with("foo", None, {"a": "b"})
bar_mock_client.assert_not_called()

Expand All @@ -76,4 +76,4 @@ def test_routing_choose_too_many_choices():
router.set_properties_factory_method("bar", lambda: bar_mock_client)

with pytest.raises(VdkConfigurationError):
router.get_properties_impl().set_all_properties({"a": "b"})
router.set_all_properties({"a": "b"})