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

Jump to bottom

fix: add support for Tableau multi-site deployment #463

Merged
merged 2 commits into from
Mar 30, 2021
Merged

fix: add support for Tableau multi-site deployment #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dddf7a1
Add support for Tableau multi-site deployment
shuichiro-makigaki Mar 26, 2021
c3671d2
Add defaulting Tableau site name
shuichiro-makigaki Mar 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions databuilder/extractor/dashboard/tableau/tableau_dashboard_extractor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ class TableauGraphQLApiMetadataExtractor(TableauGraphQLApiExtractor):

CLUSTER = const.CLUSTER
EXCLUDED_PROJECTS = const.EXCLUDED_PROJECTS
SITE_NAME = const.SITE_NAME
TABLEAU_BASE_URL = const.TABLEAU_BASE_URL

def execute(self) -> Iterator[Dict[str, Any]]:
Expand All @@ -39,6 +40,10 @@ def execute(self) -> Iterator[Dict[str, Any]]:
if workbook['projectName'] not in
self._conf.get_list(TableauGraphQLApiMetadataExtractor.EXCLUDED_PROJECTS, [])]
base_url = self._conf.get(TableauGraphQLApiMetadataExtractor.TABLEAU_BASE_URL)
site_name = self._conf.get_string(TableauGraphQLApiMetadataExtractor.SITE_NAME, '')
site_url_path = ''
if site_name != '':
site_url_path = f'/site/{site_name}'
for workbook in workbooks_data:
if None in (workbook['projectName'], workbook['name']):
LOGGER.warning(f'Ignoring workbook (ID:{workbook["vizportalUrlId"]}) ' +
Expand All @@ -49,8 +54,8 @@ def execute(self) -> Iterator[Dict[str, Any]]:
'dashboard_name': TableauDashboardUtils.sanitize_workbook_name(workbook['name']),
'description': workbook.get('description', ''),
'created_timestamp': workbook['createdAt'],
'dashboard_group_url': f'{base_url}/#/projects/{workbook["projectVizportalUrlId"]}',
'dashboard_url': f'{base_url}/#/workbooks/{workbook["vizportalUrlId"]}/views',
'dashboard_group_url': f'{base_url}/#{site_url_path}/projects/{workbook["projectVizportalUrlId"]}',
'dashboard_url': f'{base_url}/#{site_url_path}/workbooks/{workbook["vizportalUrlId"]}/views',
'cluster': self._conf.get_string(TableauGraphQLApiMetadataExtractor.CLUSTER)
}
yield data
Expand Down
2 changes: 1 addition & 1 deletion databuilder/extractor/dashboard/tableau/tableau_dashboard_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ def __init__(self, conf: ConfigTree) -> None:
self._access_token_name = self._conf.get_string(TableauDashboardAuth.TABLEAU_ACCESS_TOKEN_NAME)
self._access_token_secret = self._conf.get_string(TableauDashboardAuth.TABLEAU_ACCESS_TOKEN_SECRET)
self._api_version = self._conf.get_string(TableauDashboardAuth.API_VERSION)
self._site_name = self._conf.get_string(TableauDashboardAuth.SITE_NAME)
self._site_name = self._conf.get_string(TableauDashboardAuth.SITE_NAME, '')
self._api_base_url = self._conf.get_string(TableauDashboardAuth.API_BASE_URL)
self._verify_request = self._conf.get(TableauDashboardAuth.VERIFY_REQUEST, None)

Expand Down
41 changes: 39 additions & 2 deletions tests/unit/extractor/dashboard/tableau/test_tableau_dashboard_extractor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ class TestTableauDashboardExtractor(unittest.TestCase):
def test_dashboard_metadata_extractor(self) -> None:

config = ConfigFactory.from_dict({
'extractor.tableau_dashboard_metadata.api_base_url': 'api_base_url',
'extractor.tableau_dashboard_metadata.tableau_base_url': 'tableau_base_url',
'extractor.tableau_dashboard_metadata.api_base_url': 'https://api_base_url',
'extractor.tableau_dashboard_metadata.tableau_base_url': 'https://tableau_base_url',
'extractor.tableau_dashboard_metadata.api_version': 'tableau_api_version',
'extractor.tableau_dashboard_metadata.site_name': 'tableau_site_name',
'extractor.tableau_dashboard_metadata.tableau_personal_access_token_name':
Expand All @@ -79,6 +79,43 @@ def test_dashboard_metadata_extractor(self) -> None:
self.assertEqual(record.dashboard_group, 'Test Project')
self.assertEqual(record.product, 'tableau')
self.assertEqual(record.cluster, 'tableau_dashboard_cluster')
self.assertEqual(record.dashboard_group_url, 'https://tableau_base_url/#/site/tableau_site_name/projects/123')
self.assertEqual(record.dashboard_url, 'https://tableau_base_url/#/site/tableau_site_name/workbooks/456/views')
self.assertEqual(record.created_timestamp, 1586323921)

record = extractor.extract()
self.assertIsNone(record)

# Test for Tableau single site deployment
config = ConfigFactory.from_dict({
'extractor.tableau_dashboard_metadata.api_base_url': 'https://api_base_url',
'extractor.tableau_dashboard_metadata.tableau_base_url': 'https://tableau_base_url',
'extractor.tableau_dashboard_metadata.api_version': 'tableau_api_version',
'extractor.tableau_dashboard_metadata.site_name': '',
'extractor.tableau_dashboard_metadata.tableau_personal_access_token_name':
'tableau_personal_access_token_name',
'extractor.tableau_dashboard_metadata.tableau_personal_access_token_secret':
'tableau_personal_access_token_secret',
'extractor.tableau_dashboard_metadata.excluded_projects': [],
'extractor.tableau_dashboard_metadata.cluster': 'tableau_dashboard_cluster',
'extractor.tableau_dashboard_metadata.database': 'tableau_dashboard_database',
'extractor.tableau_dashboard_metadata.transformer.timestamp_str_to_epoch.timestamp_format':
'%Y-%m-%dT%H:%M:%SZ',

})

extractor = TableauDashboardExtractor()
extractor.init(Scoped.get_scoped_conf(conf=config, scope=extractor.get_scope()))

record = extractor.extract()
self.assertEqual(record.dashboard_id, 'Test Workbook')
self.assertEqual(record.dashboard_name, 'Test Workbook')
self.assertEqual(record.dashboard_group_id, 'Test Project')
self.assertEqual(record.dashboard_group, 'Test Project')
self.assertEqual(record.product, 'tableau')
self.assertEqual(record.cluster, 'tableau_dashboard_cluster')
self.assertEqual(record.dashboard_group_url, 'https://tableau_base_url/#/projects/123')
self.assertEqual(record.dashboard_url, 'https://tableau_base_url/#/workbooks/456/views')
self.assertEqual(record.created_timestamp, 1586323921)

record = extractor.extract()
Expand Down