| # Copyright 2016 The Chromium Authors. All rights reserved. |
| # Use of this source code is govered by a BSD-style |
| # license that can be found in the LICENSE file or at |
| # https://developers.google.com/open-source/licenses/bsd |
| |
| """Unit tests for table_view_helpers classes and functions.""" |
| |
| import collections |
| import unittest |
| |
| from framework import framework_views |
| from framework import table_view_helpers |
| from proto import tracker_pb2 |
| from testing import fake |
| from tracker import tracker_bizobj |
| |
| |
| EMPTY_SEARCH_RESULTS = [] |
| |
| SEARCH_RESULTS_WITH_LABELS = [ |
| fake.MakeTestIssue( |
| 789, 1, 'sum 1', 'New', 111L, labels='Priority-High Mstone-1', |
| merged_into=200001, star_count=1), |
| fake.MakeTestIssue( |
| 789, 2, 'sum 2', 'New', 111L, labels='Priority-High Mstone-1', |
| merged_into=1, star_count=1), |
| fake.MakeTestIssue( |
| 789, 3, 'sum 3', 'New', 111L, labels='Priority-Low Mstone-1.1', |
| merged_into=1, star_count=1), |
| # 'Visibility-Super-High' tests that only first dash counts |
| fake.MakeTestIssue( |
| 789, 4, 'sum 4', 'New', 111L, labels='Visibility-Super-High', |
| star_count=1), |
| ] |
| |
| |
| def MakeTestIssue(local_id, issue_id, summary): |
| issue = tracker_pb2.Issue() |
| issue.local_id = local_id |
| issue.issue_id = issue_id |
| issue.summary = summary |
| return issue |
| |
| |
| class TableCellTest(unittest.TestCase): |
| |
| USERS_BY_ID = {} |
| |
| def setUp(self): |
| self.issue1 = MakeTestIssue( |
| local_id=1, issue_id=100001, summary='One') |
| self.issue2 = MakeTestIssue( |
| local_id=2, issue_id=100002, summary='Two') |
| self.issue3 = MakeTestIssue( |
| local_id=3, issue_id=100003, summary='Three') |
| |
| def testTableCellSummary(self): |
| """TableCellSummary stores the data given to it.""" |
| cell = table_view_helpers.TableCellSummary( |
| MakeTestIssue(4, 4, 'Lame default summary.'), None, self.USERS_BY_ID, |
| [('lab', False)], {}, {}, 'fake config') |
| self.assertEqual(cell.type, table_view_helpers.CELL_TYPE_SUMMARY) |
| self.assertEqual(cell.values[0].item, 'Lame default summary.') |
| self.assertEqual(cell.non_column_labels[0].value, 'lab') |
| |
| def testTableCellSummary_NoPythonEscaping(self): |
| """TableCellSummary stores the summary without escaping it in python.""" |
| cell = table_view_helpers.TableCellSummary( |
| MakeTestIssue(4, 4, '<b>bold</b> "summary".'), None, self.USERS_BY_ID, |
| [('lab', False)], {}, {}, 'fake config') |
| self.assertEqual(cell.values[0].item,'<b>bold</b> "summary".') |
| |
| # TODO(jrobbins): TableCellProject, TableCellStars |
| |
| |
| class TableViewHelpersTest(unittest.TestCase): |
| |
| def setUp(self): |
| self.default_cols = 'a b c' |
| self.builtin_cols = ['a', 'b', 'x', 'y', 'z'] |
| self.config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| |
| def testComputeUnshownColumns_CommonCase(self): |
| shown_cols = ['a', 'b', 'c'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['x', 'y', 'z']) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals( |
| unshown, ['Mstone', 'Priority', 'Visibility', 'x', 'y', 'z']) |
| |
| def testComputeUnshownColumns_MoreBuiltins(self): |
| shown_cols = ['a', 'b', 'c', 'x', 'y'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['z']) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['Mstone', 'Priority', 'Visibility', 'z']) |
| |
| def testComputeUnshownColumns_NotAllDefaults(self): |
| shown_cols = ['a', 'b'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['c', 'x', 'y', 'z']) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals( |
| unshown, ['Mstone', 'Priority', 'Visibility', 'c', 'x', 'y', 'z']) |
| |
| def testComputeUnshownColumns_ExtraNonDefaults(self): |
| shown_cols = ['a', 'b', 'c', 'd', 'e', 'f'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['x', 'y', 'z']) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals( |
| unshown, ['Mstone', 'Priority', 'Visibility', 'x', 'y', 'z']) |
| |
| def testComputeUnshownColumns_UserColumnsShown(self): |
| shown_cols = ['a', 'b', 'c', 'Priority'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['x', 'y', 'z']) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['Mstone', 'Visibility', 'x', 'y', 'z']) |
| |
| def testComputeUnshownColumns_EverythingShown(self): |
| shown_cols = [ |
| 'a', 'b', 'c', 'x', 'y', 'z', 'Priority', 'Mstone', 'Visibility'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, []) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, []) |
| |
| def testComputeUnshownColumns_NothingShown(self): |
| shown_cols = [] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = self.default_cols |
| config.well_known_labels = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, self.builtin_cols) |
| self.assertEquals(unshown, ['a', 'b', 'c', 'x', 'y', 'z']) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, self.builtin_cols) |
| self.assertEquals( |
| unshown, |
| ['Mstone', 'Priority', 'Visibility', 'a', 'b', 'c', 'x', 'y', 'z']) |
| |
| def testComputeUnshownColumns_NoBuiltins(self): |
| shown_cols = ['a', 'b', 'c'] |
| config = tracker_bizobj.MakeDefaultProjectIssueConfig(789) |
| config.default_col_spec = 'a b c' |
| config.well_known_labels = [] |
| builtin_cols = [] |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| EMPTY_SEARCH_RESULTS, shown_cols, config, builtin_cols) |
| self.assertEquals(unshown, []) |
| |
| unshown = table_view_helpers.ComputeUnshownColumns( |
| SEARCH_RESULTS_WITH_LABELS, shown_cols, config, builtin_cols) |
| self.assertEquals(unshown, ['Mstone', 'Priority', 'Visibility']) |
| |
| def testExtractUniqueValues_NoColumns(self): |
| column_values = table_view_helpers.ExtractUniqueValues( |
| [], SEARCH_RESULTS_WITH_LABELS, {}, self.config) |
| self.assertEquals([], column_values) |
| |
| def testExtractUniqueValues_NoResults(self): |
| cols = ['type', 'priority', 'owner', 'status', 'stars', 'attachments'] |
| column_values = table_view_helpers.ExtractUniqueValues( |
| cols, EMPTY_SEARCH_RESULTS, {}, self.config) |
| self.assertEquals(6, len(column_values)) |
| for index, col in enumerate(cols): |
| self.assertEquals(index, column_values[index].col_index) |
| self.assertEquals(col, column_values[index].column_name) |
| self.assertEquals([], column_values[index].filter_values) |
| |
| def testExtractUniqueValues_ExplicitResults(self): |
| cols = ['priority', 'owner', 'status', 'stars', 'mstone', 'foo'] |
| users_by_id = { |
| 111L: framework_views.UserView(111, 'foo@example.com', True), |
| } |
| column_values = table_view_helpers.ExtractUniqueValues( |
| cols, SEARCH_RESULTS_WITH_LABELS, users_by_id, self.config) |
| self.assertEquals(len(cols), len(column_values)) |
| |
| self.assertEquals('priority', column_values[0].column_name) |
| self.assertEquals(['High', 'Low'], column_values[0].filter_values) |
| |
| self.assertEquals('owner', column_values[1].column_name) |
| self.assertEquals(['f...@example.com'], column_values[1].filter_values) |
| |
| self.assertEquals('status', column_values[2].column_name) |
| self.assertEquals(['New'], column_values[2].filter_values) |
| |
| self.assertEquals('stars', column_values[3].column_name) |
| self.assertEquals([1], column_values[3].filter_values) |
| |
| self.assertEquals('mstone', column_values[4].column_name) |
| self.assertEquals(['1', '1.1'], column_values[4].filter_values) |
| |
| self.assertEquals('foo', column_values[5].column_name) |
| self.assertEquals([], column_values[5].filter_values) |
| |
| # self.assertEquals('mergedinto', column_values[6].column_name) |
| # self.assertEquals( |
| # ['1', 'other-project:1'], column_values[6].filter_values) |
| |
| def testExtractUniqueValues_CombinedColumns(self): |
| cols = ['priority/pri', 'owner', 'status', 'stars', 'mstone/milestone'] |
| users_by_id = { |
| 111L: framework_views.UserView(111, 'foo@example.com', True), |
| } |
| issue = fake.MakeTestIssue( |
| 789, 5, 'sum 5', 'New', 111L, merged_into=200001, |
| labels='Priority-High Pri-0 Milestone-1.0 mstone-1', |
| star_count=15) |
| |
| column_values = table_view_helpers.ExtractUniqueValues( |
| cols, SEARCH_RESULTS_WITH_LABELS + [issue], users_by_id, |
| self.config) |
| self.assertEquals(5, len(column_values)) |
| |
| self.assertEquals('priority/pri', column_values[0].column_name) |
| self.assertEquals(['0', 'High', 'Low'], column_values[0].filter_values) |
| |
| self.assertEquals('owner', column_values[1].column_name) |
| self.assertEquals(['f...@example.com'], column_values[1].filter_values) |
| |
| self.assertEquals('status', column_values[2].column_name) |
| self.assertEquals(['New'], column_values[2].filter_values) |
| |
| self.assertEquals('stars', column_values[3].column_name) |
| self.assertEquals([1, 15], column_values[3].filter_values) |
| |
| self.assertEquals('mstone/milestone', column_values[4].column_name) |
| self.assertEquals(['1', '1.0', '1.1'], column_values[4].filter_values) |
| |
| def testExtractUniqueValues_DerivedValues(self): |
| cols = ['priority', 'milestone', 'owner', 'status'] |
| users_by_id = { |
| 111L: framework_views.UserView(111, 'foo@example.com', True), |
| 222L: framework_views.UserView(222, 'bar@example.com', True), |
| 333L: framework_views.UserView(333, 'lol@example.com', True), |
| } |
| search_results = [ |
| fake.MakeTestIssue( |
| 789, 1, 'sum 1', '', 111L, labels='Priority-High Milestone-1.0', |
| derived_labels='Milestone-2.0 Foo', derived_status='Started'), |
| fake.MakeTestIssue( |
| 789, 2, 'sum 2', 'New', 111L, labels='Priority-High Milestone-1.0', |
| derived_owner_id=333L), # Not seen because of owner_id |
| fake.MakeTestIssue( |
| 789, 3, 'sum 3', 'New', 0, labels='Priority-Low Milestone-1.1', |
| derived_owner_id=222L), |
| ] |
| |
| column_values = table_view_helpers.ExtractUniqueValues( |
| cols, search_results, users_by_id, self.config) |
| self.assertEquals(4, len(column_values)) |
| |
| self.assertEquals('priority', column_values[0].column_name) |
| self.assertEquals(['High', 'Low'], column_values[0].filter_values) |
| |
| self.assertEquals('milestone', column_values[1].column_name) |
| self.assertEquals(['1.0', '1.1', '2.0'], |
| column_values[1].filter_values) |
| |
| self.assertEquals('owner', column_values[2].column_name) |
| self.assertEquals(['b...@example.com', 'f...@example.com'], |
| column_values[2].filter_values) |
| |
| self.assertEquals('status', column_values[3].column_name) |
| self.assertEquals(['New', 'Started'], column_values[3].filter_values) |
| |
| def testExtractUniqueValues_ColumnsRobustness(self): |
| cols = ['reporter', 'cc', 'owner', 'status', 'attachments'] |
| search_results = [ |
| tracker_pb2.Issue(), |
| ] |
| column_values = table_view_helpers.ExtractUniqueValues( |
| cols, search_results, {}, self.config) |
| |
| self.assertEquals(5, len(column_values)) |
| for col_val in column_values: |
| if col_val.column_name == 'attachments': |
| self.assertEquals([0], col_val.filter_values) |
| else: |
| self.assertEquals([], col_val.filter_values) |
| |
| def testMakeTableData_Empty(self): |
| visible_results = [] |
| lower_columns = [] |
| cell_factories = {} |
| table_data = table_view_helpers.MakeTableData( |
| visible_results, None, [], lower_columns, lower_columns, |
| cell_factories, [], lambda art: 'id', {}, self.config) |
| self.assertEqual([], table_data) |
| |
| lower_columns = ['type', 'priority', 'summary', 'stars'] |
| cell_factories = { |
| 'summary': table_view_helpers.TableCellSummary, |
| 'stars': table_view_helpers.TableCellStars, |
| } |
| |
| table_data = table_view_helpers.MakeTableData( |
| visible_results, None, [], lower_columns, [], {}, |
| cell_factories, lambda art: 'id', {}, self.config) |
| self.assertEqual([], table_data) |
| |
| def testMakeTableData_Normal(self): |
| art = fake.MakeTestIssue( |
| 789, 1, 'sum 1', 'New', 111L, labels='Type-Defect Priority-Medium') |
| visible_results = [art] |
| lower_columns = ['type', 'priority', 'summary', 'stars'] |
| cell_factories = { |
| 'summary': table_view_helpers.TableCellSummary, |
| 'stars': table_view_helpers.TableCellStars, |
| } |
| |
| table_data = table_view_helpers.MakeTableData( |
| visible_results, None, [], lower_columns, lower_columns, {}, |
| cell_factories, lambda art: 'id', {}, self.config) |
| self.assertEqual(1, len(table_data)) |
| row = table_data[0] |
| self.assertEqual(4, len(row.cells)) |
| self.assertEqual('Defect', row.cells[0].values[0].item) |
| |
| def testMakeTableData_Groups(self): |
| art = fake.MakeTestIssue( |
| 789, 1, 'sum 1', 'New', 111L, labels='Type-Defect Priority-Medium') |
| visible_results = [art] |
| lower_columns = ['type', 'priority', 'summary', 'stars'] |
| lower_group_by = ['priority'] |
| cell_factories = { |
| 'summary': table_view_helpers.TableCellSummary, |
| 'stars': table_view_helpers.TableCellStars, |
| } |
| |
| table_data = table_view_helpers.MakeTableData( |
| visible_results, None, [], lower_columns, lower_group_by, {}, |
| cell_factories, lambda art: 'id', {}, self.config) |
| self.assertEqual(1, len(table_data)) |
| row = table_data[0] |
| self.assertEqual(1, len(row.group.cells)) |
| self.assertEqual('Medium', row.group.cells[0].values[0].item) |
| |
| def testMakeRowData(self): |
| art = fake.MakeTestIssue( |
| 789, 1, 'sum 1', 'New', 111L, labels='Type-Defect Priority-Medium', |
| star_count=1) |
| columns = ['type', 'priority', 'summary', 'stars'] |
| |
| cell_factories = [table_view_helpers.TableCellKeyLabels, |
| table_view_helpers.TableCellKeyLabels, |
| table_view_helpers.TableCellSummary, |
| table_view_helpers.TableCellStars] |
| |
| # a result is an table_view_helpers.TableRow object with a "cells" field |
| # containing a list of table_view_helpers.TableCell objects. |
| result = table_view_helpers.MakeRowData( |
| art, columns, True, {}, cell_factories, {}, self.config) |
| |
| self.assertEqual(len(columns), len(result.cells)) |
| |
| for i in range(len(columns)): |
| cell = result.cells[i] |
| self.assertEqual(i, cell.col_index) |
| |
| self.assertEqual(table_view_helpers.CELL_TYPE_ATTR, result.cells[0].type) |
| self.assertEqual('Defect', result.cells[0].values[0].item) |
| self.assertFalse(result.cells[0].values[0].is_derived) |
| |
| self.assertEqual(table_view_helpers.CELL_TYPE_ATTR, result.cells[1].type) |
| self.assertEqual('Medium', result.cells[1].values[0].item) |
| self.assertFalse(result.cells[1].values[0].is_derived) |
| |
| self.assertEqual( |
| table_view_helpers.CELL_TYPE_SUMMARY, result.cells[2].type) |
| self.assertEqual('sum 1', result.cells[2].values[0].item) |
| self.assertFalse(result.cells[2].values[0].is_derived) |
| |
| self.assertEqual(table_view_helpers.CELL_TYPE_ATTR, result.cells[3].type) |
| self.assertEqual(1, result.cells[3].values[0].item) |
| self.assertFalse(result.cells[3].values[0].is_derived) |
| |
| def testAccumulateLabelValues_Empty(self): |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| [], [], label_values, non_col_labels) |
| self.assertEqual({}, label_values) |
| self.assertEqual([], non_col_labels) |
| |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| [], ['Type', 'Priority'], label_values, non_col_labels) |
| self.assertEqual({}, label_values) |
| self.assertEqual([], non_col_labels) |
| |
| def testAccumulateLabelValues_OneWordLabels(self): |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| ['HelloThere'], [], label_values, non_col_labels) |
| self.assertEqual({}, label_values) |
| self.assertEqual([('HelloThere', False)], non_col_labels) |
| |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| ['HelloThere'], [], label_values, non_col_labels, is_derived=True) |
| self.assertEqual({}, label_values) |
| self.assertEqual([('HelloThere', True)], non_col_labels) |
| |
| def testAccumulateLabelValues_KeyValueLabels(self): |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| ['Type-Defect', 'Milestone-Soon'], ['type', 'milestone'], |
| label_values, non_col_labels) |
| self.assertEqual( |
| {'type': [('Defect', False)], |
| 'milestone': [('Soon', False)]}, |
| label_values) |
| self.assertEqual([], non_col_labels) |
| |
| def testAccumulateLabelValues_MultiValueLabels(self): |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| ['OS-Mac', 'OS-Linux'], ['os', 'arch'], |
| label_values, non_col_labels) |
| self.assertEqual( |
| {'os': [('Mac', False), ('Linux', False)]}, |
| label_values) |
| self.assertEqual([], non_col_labels) |
| |
| def testAccumulateLabelValues_MultiPartLabels(self): |
| label_values, non_col_labels = collections.defaultdict(list), [] |
| table_view_helpers._AccumulateLabelValues( |
| ['OS-Mac-Server', 'OS-Mac-Laptop'], ['os', 'os-mac'], |
| label_values, non_col_labels) |
| self.assertEqual( |
| {'os': [('Mac-Server', False), ('Mac-Laptop', False)], |
| 'os-mac': [('Server', False), ('Laptop', False)], |
| }, |
| label_values) |
| self.assertEqual([], non_col_labels) |
| |
| |
| if __name__ == '__main__': |
| unittest.main() |
