import os import os.path import shutil import tempfile import unittest from tableaudocumentapi import Datasource, Workbook TEST_ASSET_DIR = os.path.join( os.path.dirname(__file__), 'assets' ) TEST_TDS_FILE = os.path.join( TEST_ASSET_DIR, 'datasource_test.tds' ) TEST_TWB_FILE = os.path.join( TEST_ASSET_DIR, 'datasource_test.twb' ) class DataSourceFieldsTDS(unittest.TestCase): def setUp(self): self.ds = Datasource.from_file(TEST_TDS_FILE) self.to_delete = set() def cleanUp(self): for path in self.to_delete: if os.path.isdir(path): shutil.rmtree(path, ignore_errors=True) elif os.path.isfile(path): os.unlink(path) def get_temp_file(self, filename): tempdir = tempfile.mkdtemp('tda-datasource') self.to_delete.add(tempdir) return os.path.join(tempdir, filename) def test_datasource_returns_correct_fields(self): self.assertIsNotNone(self.ds.fields) self.assertIsNotNone(self.ds.fields.get('[Number of Records]', None)) def test_datasource_returns_calculation_from_fields(self): self.assertEqual('1', self.ds.fields['[Number of Records]'].calculation) def test_datasource_uses_metadata_record(self): self.assertEqual('Sum', self.ds.fields['[x]'].default_aggregation) def test_datasource_column_name_contains_apostrophy(self): self.assertIsNotNone(self.ds.fields.get("[Today's Date]", None)) def test_datasource_field_can_get_caption(self): self.assertEqual(self.ds.fields['[a]'].caption, 'A') self.assertEqual(getattr(self.ds.fields['[a]'], 'caption', None), 'A') def test_datasource_field_caption_can_be_used_to_query(self): self.assertIsNotNone(self.ds.fields.get('A', None)) def test_datasource_field_is_nominal(self): self.assertTrue(self.ds.fields['[a]'].is_nominal) def test_datasource_field_is_quantitative(self): self.assertTrue(self.ds.fields['[y]'].is_quantitative) def test_datasource_field_is_ordinal(self): self.assertTrue(self.ds.fields['[x]'].is_ordinal) def test_datasource_field_datatype(self): self.assertEqual(self.ds.fields['[x]'].datatype, 'integer') def test_datasource_field_role(self): self.assertEqual(self.ds.fields['[x]'].role, 'measure') def test_datasource_field_description(self): actual = self.ds.fields['[a]'].description self.assertIsNotNone(actual) self.assertTrue(u'muted gray' in actual) def test_datasource_caption(self): actual = self.ds.caption self.assertIsNotNone(actual) self.assertEqual(actual, 'foo') def test_datasource_can_set_caption(self): filename = self.get_temp_file('test_datasource_can_set_caption') self.ds.caption = 'bar' self.ds.save_as(filename) actual = Datasource.from_file(filename) self.assertIsNotNone(actual) self.assertIsNotNone(actual.caption) self.assertEqual(actual.caption, 'bar') def test_datasource_can_remove_caption(self): filename = self.get_temp_file('test_datasource_can_remove_caption') del self.ds.caption self.ds.save_as(filename) actual = Datasource.from_file(filename) self.assertIsNotNone(actual) self.assertEqual(actual.caption, '') def test_datasource_clear_repository_location(self): filename = os.path.join(TEST_ASSET_DIR, 'clear-repository-test.tds') self.assertIsNotNone(self.ds._datasourceXML.find('.//repository-location')) self.ds.clear_repository_location() try: self.ds.save_as(filename) with open(filename, 'r') as newfile: self.assertFalse('repository-location' in newfile.read()) finally: if os.path.exists(filename): os.unlink(filename) class DataSourceFieldsTWB(unittest.TestCase): def setUp(self): self.wb = Workbook(TEST_TWB_FILE) # Assume the first datasource in the file self.ds = self.wb.datasources[0] def test_datasource_fields_loaded_in_workbook(self): self.assertIsNotNone(self.ds.fields) self.assertIsNotNone(self.ds.fields.get('[Number of Records]', None)) class DataSourceFieldsFoundIn(unittest.TestCase): def setUp(self): self.wb = Workbook(TEST_TWB_FILE) # Assume the first datasource in the file self.ds = self.wb.datasources[0] def test_datasource_fields_found_in_returns_fields(self): actual_values = self.ds.fields.used_by_sheet('Sheet 1') self.assertIsNotNone(actual_values) self.assertEqual(1, len(actual_values)) self.assertIn('A', (x.name for x in actual_values)) def test_datasource_fields_found_in_does_not_return_fields_not_used_in_worksheet(self): actual_values = self.ds.fields.used_by_sheet('Sheet 1') self.assertIsNotNone(actual_values) self.assertEqual(1, len(actual_values)) self.assertNotIn('X', (x.name for x in actual_values)) def test_datasource_fields_found_in_returns_multiple_fields(self): actual_values = self.ds.fields.used_by_sheet('Sheet 2') self.assertIsNotNone(actual_values) self.assertEqual(2, len(actual_values)) self.assertIn('A', (x.name for x in actual_values)) self.assertIn('X', (x.name for x in actual_values)) self.assertNotIn('Y', (x.name for x in actual_values)) def test_datasource_fields_found_in_accepts_lists(self): actual_values = self.ds.fields.used_by_sheet(['Sheet 1', 'Sheet 2']) self.assertIsNotNone(actual_values) self.assertEqual(2, len(actual_values)) self.assertIn('A', (x.name for x in actual_values)) self.assertIn('X', (x.name for x in actual_values)) self.assertNotIn('Y', (x.name for x in actual_values))