From ebb7540b9ab7d9d011152e75745af6e9ed9f4164 Mon Sep 17 00:00:00 2001 From: Chris DeCarolis Date: Wed, 23 Oct 2024 11:02:45 -0700 Subject: [PATCH] [dagster-dlift] rename DbtCloudInstance to DbtCloudClient --- .../{cloud_instance.py => client.py} | 2 +- .../test/{instance_fake.py => client_fake.py} | 4 ++-- .../dagster_dlift_tests/test_instance.py | 18 +++++++++--------- .../dagster_dlift_tests/test_test_utils.py | 8 ++++---- .../dlift_kitchen_sink/instance.py | 6 +++--- .../dlift_kitchen_sink_tests/conftest.py | 4 ++-- .../test_instance_from_env.py | 4 ++-- .../test_instance_methods.py | 8 ++++---- 8 files changed, 27 insertions(+), 27 deletions(-) rename examples/experimental/dagster-dlift/dagster_dlift/{cloud_instance.py => client.py} (99%) rename examples/experimental/dagster-dlift/dagster_dlift/test/{instance_fake.py => client_fake.py} (96%) diff --git a/examples/experimental/dagster-dlift/dagster_dlift/cloud_instance.py b/examples/experimental/dagster-dlift/dagster_dlift/client.py similarity index 99% rename from examples/experimental/dagster-dlift/dagster_dlift/cloud_instance.py rename to examples/experimental/dagster-dlift/dagster_dlift/client.py index 1498e6ccebfa4..8b2709ffb91de 100644 --- a/examples/experimental/dagster-dlift/dagster_dlift/cloud_instance.py +++ b/examples/experimental/dagster-dlift/dagster_dlift/client.py @@ -12,7 +12,7 @@ ENVIRONMENTS_SUBPATH = "environments/" -class DbtCloudInstance: +class DbtCloudClient: def __init__( self, # Can be found on the Account Info page of dbt. diff --git a/examples/experimental/dagster-dlift/dagster_dlift/test/instance_fake.py b/examples/experimental/dagster-dlift/dagster_dlift/test/client_fake.py similarity index 96% rename from examples/experimental/dagster-dlift/dagster_dlift/test/instance_fake.py rename to examples/experimental/dagster-dlift/dagster_dlift/test/client_fake.py index 19d8190e3edf1..c7db45bf06a37 100644 --- a/examples/experimental/dagster-dlift/dagster_dlift/test/instance_fake.py +++ b/examples/experimental/dagster-dlift/dagster_dlift/test/client_fake.py @@ -1,6 +1,6 @@ from typing import Any, Dict, Mapping, NamedTuple, Optional, Sequence -from dagster_dlift.cloud_instance import DbtCloudInstance +from dagster_dlift.client import DbtCloudClient class ExpectedDiscoveryApiRequest(NamedTuple): @@ -18,7 +18,7 @@ def __hash__(self) -> int: return hash(self.subpath) -class DbtCloudInstanceFake(DbtCloudInstance): +class DbtCloudClientFake(DbtCloudClient): """A version that allows users to fake API responses for testing purposes.""" def __init__( diff --git a/examples/experimental/dagster-dlift/dagster_dlift_tests/test_instance.py b/examples/experimental/dagster-dlift/dagster_dlift_tests/test_instance.py index fcb2f20d04b00..87b717d5b6938 100644 --- a/examples/experimental/dagster-dlift/dagster_dlift_tests/test_instance.py +++ b/examples/experimental/dagster-dlift/dagster_dlift_tests/test_instance.py @@ -1,13 +1,13 @@ import pytest -from dagster_dlift.cloud_instance import ENVIRONMENTS_SUBPATH +from dagster_dlift.client import ENVIRONMENTS_SUBPATH from dagster_dlift.gql_queries import ( GET_DBT_MODELS_QUERY, GET_DBT_SOURCES_QUERY, GET_DBT_TESTS_QUERY, VERIFICATION_QUERY, ) -from dagster_dlift.test.instance_fake import ( - DbtCloudInstanceFake, +from dagster_dlift.test.client_fake import ( + DbtCloudClientFake, ExpectedAccessApiRequest, ExpectedDiscoveryApiRequest, build_model_response, @@ -19,7 +19,7 @@ def test_verification() -> None: """Test proper error states when we can't properly verify the instance.""" # We get no response back from the discovery api - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={ ExpectedAccessApiRequest(subpath=ENVIRONMENTS_SUBPATH): {"data": [{"id": 1}]} }, @@ -34,7 +34,7 @@ def test_verification() -> None: fake_instance.verify_connections() # We get a response back from the discovery api, but it's not what we expect - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={ ExpectedAccessApiRequest(subpath=ENVIRONMENTS_SUBPATH): {"data": [{"id": 1}]} }, @@ -49,7 +49,7 @@ def test_verification() -> None: fake_instance.verify_connections() # Finally, we get a valid response back from the discovery api - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={ ExpectedAccessApiRequest(subpath=ENVIRONMENTS_SUBPATH): {"data": [{"id": 1}]} }, @@ -72,7 +72,7 @@ def test_get_models() -> None: "model.jaffle_shop.stg_customers": set(), "model.jaffle_shop.stg_orders": set(), } - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={}, discovery_api_responses={ ExpectedDiscoveryApiRequest( @@ -102,7 +102,7 @@ def test_get_sources() -> None: "source.jaffle_shop.jaffle_shop.orders", } - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={}, discovery_api_responses={ ExpectedDiscoveryApiRequest( @@ -128,7 +128,7 @@ def test_get_tests() -> None: "test.jaffle_shop.stg_orders.test_stg_orders": {"model.jaffle_shop.stg_orders"}, } - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={}, discovery_api_responses={ ExpectedDiscoveryApiRequest( diff --git a/examples/experimental/dagster-dlift/dagster_dlift_tests/test_test_utils.py b/examples/experimental/dagster-dlift/dagster_dlift_tests/test_test_utils.py index bc9c29034a3f0..230f4b165ccbd 100644 --- a/examples/experimental/dagster-dlift/dagster_dlift_tests/test_test_utils.py +++ b/examples/experimental/dagster-dlift/dagster_dlift_tests/test_test_utils.py @@ -1,9 +1,9 @@ import pytest from dagster._core.test_utils import environ -from dagster_dlift.cloud_instance import ENVIRONMENTS_SUBPATH +from dagster_dlift.client import ENVIRONMENTS_SUBPATH from dagster_dlift.gql_queries import VERIFICATION_QUERY -from dagster_dlift.test.instance_fake import ( - DbtCloudInstanceFake, +from dagster_dlift.test.client_fake import ( + DbtCloudClientFake, ExpectedAccessApiRequest, ExpectedDiscoveryApiRequest, ) @@ -21,7 +21,7 @@ def test_get_env_var() -> None: def test_cloud_instance_fake() -> None: """Test that cloud instance fake behaves properly when inducing queries.""" - fake_instance = DbtCloudInstanceFake( + fake_instance = DbtCloudClientFake( access_api_responses={ ExpectedAccessApiRequest(subpath=ENVIRONMENTS_SUBPATH): { "data": {"environments": [{"id": 1}]} diff --git a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink/instance.py b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink/instance.py index 0c90218b2326d..b477995607e2a 100644 --- a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink/instance.py +++ b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink/instance.py @@ -1,11 +1,11 @@ -from dagster_dlift.cloud_instance import DbtCloudInstance +from dagster_dlift.client import DbtCloudClient from dagster_dlift.test.utils import get_env_var from dlift_kitchen_sink.constants import TEST_ENV_NAME -def get_instance() -> DbtCloudInstance: - return DbtCloudInstance( +def get_instance() -> DbtCloudClient: + return DbtCloudClient( account_id=get_env_var("KS_DBT_CLOUD_ACCOUNT_ID"), token=get_env_var("KS_DBT_CLOUD_TOKEN"), access_url=get_env_var("KS_DBT_CLOUD_ACCESS_URL"), diff --git a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/conftest.py b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/conftest.py index 60ab10d508953..c861b02312e98 100644 --- a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/conftest.py +++ b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/conftest.py @@ -1,10 +1,10 @@ import pytest -from dagster_dlift.cloud_instance import DbtCloudInstance +from dagster_dlift.client import DbtCloudClient from dlift_kitchen_sink.instance import get_environment_id, get_instance @pytest.fixture -def instance() -> DbtCloudInstance: +def instance() -> DbtCloudClient: return get_instance() diff --git a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_from_env.py b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_from_env.py index 3e5caf3c541f8..604183aea66bb 100644 --- a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_from_env.py +++ b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_from_env.py @@ -1,11 +1,11 @@ -from dagster_dlift.cloud_instance import DbtCloudInstance +from dagster_dlift.client import DbtCloudClient from dlift_kitchen_sink.instance import get_environment_id, get_instance def test_cloud_instance() -> None: """Test that we can create a DbtCloudInstance and verify connections successfully.""" instance = get_instance() - assert isinstance(instance, DbtCloudInstance) + assert isinstance(instance, DbtCloudClient) instance.verify_connections() diff --git a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_methods.py b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_methods.py index 68cebcbf8208e..1f239fb2ac272 100644 --- a/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_methods.py +++ b/examples/experimental/dagster-dlift/kitchen-sink/dlift_kitchen_sink_tests/test_instance_methods.py @@ -1,7 +1,7 @@ -from dagster_dlift.cloud_instance import DbtCloudInstance +from dagster_dlift.client import DbtCloudClient -def test_get_models(instance: DbtCloudInstance, environment_id: int) -> None: +def test_get_models(instance: DbtCloudClient, environment_id: int) -> None: models_response = instance.get_dbt_models(environment_id) assert len(models_response) == 3 customers = next( @@ -46,7 +46,7 @@ def test_get_models(instance: DbtCloudInstance, environment_id: int) -> None: } -def test_get_sources(instance: DbtCloudInstance, environment_id: int) -> None: +def test_get_sources(instance: DbtCloudClient, environment_id: int) -> None: """Test that we can get sources from the instance.""" sources_response = instance.get_dbt_sources(environment_id) assert len(sources_response) == 2 @@ -56,7 +56,7 @@ def test_get_sources(instance: DbtCloudInstance, environment_id: int) -> None: } -def test_get_tests(instance: DbtCloudInstance, environment_id: int) -> None: +def test_get_tests(instance: DbtCloudClient, environment_id: int) -> None: """Test that we can get tests from the instance.""" tests_response = instance.get_dbt_tests(environment_id) assert {test["name"] for test in tests_response} == {