def test_geography_subscription_info(self, mock_fetch):
# Given
mock_fetch.return_value = test_subscription_info
credentials = Credentials('fake_user', '1234')
geography = Geography(db_geography1)
# When
info = geography.subscription_info(credentials)
# Then
mock_fetch.assert_called_once_with(db_geography1['id'], 'geography',
credentials)
assert isinstance(info, SubscriptionInfo)
assert info.id == test_subscription_info['id']
assert info.estimated_delivery_days == test_subscription_info[
'estimated_delivery_days']
assert info.subscription_list_price == test_subscription_info[
'subscription_list_price']
assert info.tos == test_subscription_info['tos']
assert info.tos_link == test_subscription_info['tos_link']
assert info.licenses == test_subscription_info['licenses']
assert info.licenses_link == test_subscription_info['licenses_link']
assert info.rights == test_subscription_info['rights']
assert str(info) == 'Properties: id, estimated_delivery_days, ' + \
'subscription_list_price, tos, tos_link, ' + \
'licenses, licenses_link, rights'
def test_geography_subscription_info_default_credentials(
self, mocked_credentials, mock_fetch):
# Given
expected_credentials = Credentials('fake_user', '1234')
mocked_credentials.return_value = expected_credentials
geography = Geography(db_geography1)
# When
geography.subscription_info()
# Then
mock_fetch.assert_called_once_with(db_geography1['id'], 'geography',
expected_credentials)
def test_geography_subscription_info_wrong_credentials(self):
# Given
wrong_credentials = 1234
geography = Geography(db_geography1)
# When
with pytest.raises(ValueError) as e:
geography.subscription_info(wrong_credentials)
# Then
assert str(
e.value) == ('Credentials attribute is required. '
'Please pass a `Credentials` instance '
'or use the `set_default_credentials` function.')
def test_geography_subscribe_default_credentials(self, mocked_credentials,
mock_display_form,
mock_subscription_ids):
# Given
expected_credentials = Credentials('fake_user', '1234')
mocked_credentials.return_value = expected_credentials
geography = Geography(db_geography1)
# When
geography.subscribe()
# Then
mock_subscription_ids.assert_called_once_with(expected_credentials)
mock_display_form.assert_called_once_with(db_geography1['id'],
'geography',
expected_credentials)
def test_geography_properties(self):
# Given
geography = Geography(db_geography1)
# When
geography_id = geography.id
slug = geography.slug
name = geography.name
description = geography.description
country = geography.country
language = geography.language
provider = geography.provider
geom_coverage = geography.geom_coverage
update_frequency = geography.update_frequency
version = geography.version
is_public_data = geography.is_public_data
summary = geography.summary
# Then
assert geography_id == db_geography1['id']
assert slug == db_geography1['slug']
assert name == db_geography1['name']
assert description == db_geography1['description']
assert country == db_geography1['country_id']
assert language == db_geography1['lang']
assert provider == db_geography1['provider_id']
assert geom_coverage == db_geography1['geom_coverage']
assert update_frequency == db_geography1['update_frequency']
assert version == db_geography1['version']
assert is_public_data == db_geography1['is_public_data']
assert summary == db_geography1['summary_json']
def test_missing_fields_are_mapped_as_None(self, mocked_repo):
# Given
mocked_repo.return_value = [{'id': 'geography1'}]
repo = GeographyRepository()
expected_geographies = CatalogList([Geography({
'id': 'geography1',
'slug': None,
'name': None,
'description': None,
'provider_id': None,
'provider_name': None,
'country_id': None,
'lang': None,
'geom_coverage': None,
'geom_type': None,
'update_frequency': None,
'version': None,
'is_public_data': None,
'summary_json': None
})])
# When
geographies = repo.get_all()
# Then
assert geographies == expected_geographies
def test_geography_download_without_do_enabled(self, mock_download_stream,
mock_get_by_id):
# Given
mock_get_by_id.return_value = test_geography1
geography = Geography.get(test_geography1.id)
def raise_exception(limit=None,
order_by=None,
sql_query=None,
add_geom=None,
is_geography=None):
raise ServerErrorException(
['The user does not have Data Observatory enabled'])
mock_download_stream.side_effect = raise_exception
credentials = Credentials('fake_user', '1234')
# When
with pytest.raises(Exception) as e:
geography.to_csv('fake_path', credentials)
# Then
assert str(e.value) == (
'We are sorry, the Data Observatory is not enabled for your account yet. '
'Please contact your customer success manager or send an email to '
'[email protected] to request access to it.')
def test_geography_is_exported_as_dict(self):
# Given
geography = Geography(db_geography1)
excluded_fields = ['summary_json', 'geom_coverage']
expected_dict = {
key: value
for key, value in db_geography1.items()
if key not in excluded_fields
}
# When
geography_dict = geography.to_dict()
# Then
assert isinstance(geography_dict, dict)
assert geography_dict == expected_dict
def test_geography_subscribe_existing(self, mock_display_message,
mock_display_form,
mock_subscription_ids):
# Given
expected_id = db_geography1['id']
expected_subscribed_ids = [expected_id]
mock_subscription_ids.return_value = expected_subscribed_ids
credentials = Credentials('fake_user', '1234')
geography = Geography(db_geography1)
# When
geography.subscribe(credentials)
# Then
mock_subscription_ids.assert_called_once_with(credentials, 'geography')
mock_display_message.assert_called_once_with(expected_id, 'geography')
assert not mock_display_form.called
def test_get_all_geographies_credentials_without_do_enabled(
self, mocked_repo):
# Given
def raise_exception(a, b):
raise ServerErrorException(
['The user does not have Data Observatory enabled'])
mocked_repo.side_effect = raise_exception
credentials = Credentials('fake_user', '1234')
# When
with pytest.raises(Exception) as e:
Geography.get_all(credentials=credentials)
# Then
assert str(e.value) == (
'We are sorry, the Data Observatory is not enabled for your account yet. '
'Please contact your customer success manager or send an email to '
'[email protected] to request access to it.')
def test_geography_is_represented_with_classname_and_slug(self):
# Given
geography = Geography(db_geography1)
# When
geography_repr = repr(geography)
# Then
assert geography_repr == "<Geography.get('{id}')>".format(
id=db_geography1['slug'])
def test_geography_is_printed_with_classname(self):
# Given
geography = Geography(db_geography1)
# When
geography_str = str(geography)
# Then
assert geography_str == "<Geography.get('{id}')>".format(
id=db_geography1['slug'])
def test_geography_download_not_subscribed_but_public(
self, download_stream_mock, get_by_id_mock, get_all_mock):
# Given
get_by_id_mock.return_value = test_geography1 # is public
geography = Geography.get(test_geography1.id)
get_all_mock.return_value = []
download_stream_mock.return_value = []
credentials = Credentials('fake_user', '1234')
geography.to_csv('fake_path', credentials)
def test_geography_download_not_subscribed_but_public(
self, mock_download_stream, mock_get_by_id):
# Given
mock_get_by_id.return_value = test_geography1 # is public
geography = Geography.get(test_geography1.id)
mock_download_stream.return_value = []
credentials = Credentials('fake_user', '1234')
geography.to_csv('fake_path', credentials)
os.remove('fake_path')
def test_geography_download_not_subscribed_but_public(
self, mocked_bq_client, get_by_id_mock, get_all_mock):
# Given
get_by_id_mock.return_value = test_geography1 # is public
geography = Geography.get(test_geography1.id)
get_all_mock.return_value = []
mocked_bq_client.return_value = BigQueryClientMock()
credentials = Credentials('fake_user', '1234')
geography.to_csv('fake_path', credentials)
def test_geography_subscription_info_without_do_enabled(self, mock_fetch):
# Given
def raise_exception(a, b, c):
raise ServerErrorException(
['The user does not have Data Observatory enabled'])
mock_fetch.side_effect = raise_exception
geography = Geography(db_geography1)
credentials = Credentials('fake_user', '1234')
# When
with pytest.raises(Exception) as e:
geography.subscription_info(credentials)
# Then
assert str(e.value) == (
'We are sorry, the Data Observatory is not enabled for your account yet. '
'Please contact your customer success manager or send an email to '
'[email protected] to request access to it.')
def test_get_geography_by_id(self, mocked_repo):
# Given
mocked_repo.return_value = test_geography1
# When
geography = Geography.get(test_geography1.id)
# Then
assert isinstance(geography, object)
assert isinstance(geography, Geography)
assert geography == test_geography1
def test_geography_download(self, mocked_bq_client, get_by_id_mock,
get_all_mock):
# Given
get_by_id_mock.return_value = test_geography1
geography = Geography.get(test_geography1.id)
get_all_mock.return_value = [geography]
mocked_bq_client.return_value = BigQueryClientMock()
credentials = Credentials('fake_user', '1234')
# Then
geography.to_csv('fake_path', credentials)
def test_geography_download(self, download_stream_mock, get_by_id_mock,
get_all_mock):
# Given
get_by_id_mock.return_value = test_geography1
geography = Geography.get(test_geography1.id)
get_all_mock.return_value = [geography]
download_stream_mock.return_value = []
credentials = Credentials('fake_user', '1234')
# Then
geography.to_csv('fake_path', credentials)
def test_get_all_geographies(self, mocked_repo):
# Given
mocked_repo.return_value = test_geographies
# When
geographies = Geography.get_all()
# Then
assert isinstance(geographies, list)
assert isinstance(geographies, CatalogList)
assert geographies == test_geographies
def test_geography_download(self, mock_download_stream, mock_get_by_id,
mock_subscription_ids):
# Given
mock_get_by_id.return_value = test_geography1
geography = Geography.get(test_geography1.id)
mock_download_stream.return_value = []
mock_subscription_ids.return_value = [test_geography1.id]
credentials = Credentials('fake_user', '1234')
# Then
geography.to_csv('fake_path', credentials)
os.remove('fake_path')
def test_get_all_geographies_credentials(self, mocked_repo):
# Given
mocked_repo.return_value = test_geographies
credentials = Credentials('fake_user', '1234')
# When
geographies = Geography.get_all(credentials=credentials)
# Then
mocked_repo.assert_called_once_with(None, credentials)
assert isinstance(geographies, list)
assert isinstance(geographies, CatalogList)
assert geographies == test_geographies
def test_geography_download_not_subscribed(self, mock_get_by_id,
mock_subscription_ids):
# Given
mock_get_by_id.return_value = test_geography2 # is private
geography = Geography.get(test_geography2.id)
mock_subscription_ids.return_value = []
credentials = Credentials('fake_user', '1234')
with pytest.raises(Exception) as e:
geography.to_csv('fake_path', credentials)
# Then
assert str(
e.value) == ('You are not subscribed to this Geography yet. '
'Please, use the subscribe method first.')
def test_geography_download_not_subscribed(self, mocked_bq_client,
get_by_id_mock, get_all_mock):
# Given
get_by_id_mock.return_value = test_geography2 # is private
get_by_id_mock.return_value = test_geography2
geography = Geography.get(test_geography2.id)
get_all_mock.return_value = []
mocked_bq_client.return_value = BigQueryClientMock()
credentials = Credentials('fake_user', '1234')
with pytest.raises(Exception) as e:
geography.to_csv('fake_path', credentials)
# Then
assert str(
e.value) == ('You are not subscribed to this Geography yet. '
'Please, use the subscribe method first.')
def test_geography_not_available_in_bq_download_fails(
self, mocked_bq_client, get_by_id_mock, get_all_mock):
# mock geography
get_by_id_mock.return_value = test_geography2
geography = Geography.get(test_geography2.id)
# mock subscriptions
get_all_mock.return_value = [geography]
# mock big query client
mocked_bq_client.return_value = BigQueryClientMock()
# test
credentials = Credentials('fake_user', '1234')
with pytest.raises(Exception) as e:
geography.to_csv('fake_path', credentials)
error = '{} is not ready for Download. Please, contact us for more information.'.format(
geography)
assert str(e.value) == error
def test_geography_download_without_do_enabled(self, mocked_bq_client,
get_by_id_mock,
get_all_mock):
# Given
get_by_id_mock.return_value = test_geography1
geography = Geography.get(test_geography1.id)
get_all_mock.return_value = []
mocked_bq_client.return_value = BigQueryClientMock(
ServerErrorException(
['The user does not have Data Observatory enabled']))
credentials = Credentials('fake_user', '1234')
# When
with pytest.raises(Exception) as e:
geography.to_csv('fake_path', credentials)
# Then
assert str(e.value) == (
'We are sorry, the Data Observatory is not enabled for your account yet. '
'Please contact your customer success manager or send an email to '
'[email protected] to request access to it.')
def test_geography_is_available_in(self):
geography_in_bq = Geography(db_geography1)
geography_not_in_bq = Geography(db_geography2)
assert geography_in_bq._is_available_in('bq')
assert not geography_not_in_bq._is_available_in('bq')
def test_geography_is_available_in_with_empty_field(self):
db_geography = dict(db_geography1)
db_geography['available_in'] = None
geography_null = Geography(db_geography)
assert not geography_null._is_available_in('bq')
'slug': 'esp_municipalities_2019_3456789c',
'name': 'ESP - Municipalities',
'description': 'Geography data for Spanish municipalities',
'provider_id': 'bbva',
'provider_name': 'bbva',
'country_id': 'esp',
'lang': 'esp',
'geom_coverage': '',
'geom_type': '',
'update_frequency': 'monthly',
'version': '20190203',
'is_public_data': False,
'summary_json': {},
'available_in': []
}
test_geography1 = Geography(db_geography1)
test_geography2 = Geography(db_geography2)
test_geographies = CatalogList([test_geography1, test_geography2])
db_dataset1 = {
'id': 'carto-do-public.project.basicstats-census',
'slug': 'basicstats_census_1234567a',
'name': 'Basic Stats - Census',
'description': 'Basic stats on 2019 Spanish census',
'provider_id': 'bbva',
'provider_name': 'bbva',
'category_id': 'demographics',
'category_name': 'demographics',
'data_source_id': 'basicstats',
'country_id': 'esp',
'lang': 'esp',