Rework agenda filters with show/hide keywords in place of 'types' and add bof / AD office hours buttons

 - Legacy-Id: 18563

Author: jennifer-richards

ietf/meeting/helpers.py

@@ -239,6 +239,29 @@ def preprocess_assignments_for_agenda(assignments_queryset, meeting, extra_prefe
 
     return assignments
 
+def tag_assignments_with_filter_keywords(assignments):
+    """Add keywords for agenda filtering
+    
+    Keywords are all lower case.
+    """
+    for a in assignments:
+        a.filter_keywords = [a.timeslot.type.slug.lower()]
+        a.filter_keywords.extend(filter_keywords_for_session(a.session))
+
+def filter_keywords_for_session(session):
+    keywords = []
+    group = getattr(session, 'historic_group', session.group)
+    if group is not None:
+        if group.state_id == 'bof':
+            keywords.append('bof')
+        keywords.append(group.acronym.lower())
+        area = getattr(group, 'historic_parent', group.parent)
+        if area is not None:
+            keywords.append(area.acronym.lower())
+    if session.name.lower().endswith('office hours'):
+        keywords.append('adofficehours')
+    return keywords
+
 def read_session_file(type, num, doc):
     # XXXX FIXME: the path fragment in the code below should be moved to
     # settings.py.  The *_PATH settings should be generalized to format()

ietf/meeting/tests_helpers.py

@@ -0,0 +1,96 @@
+# Copyright The IETF Trust 2020, All Rights Reserved
+# -*- coding: utf-8 -*-
+from ietf.group.factories import GroupFactory
+from ietf.meeting.factories import SessionFactory, MeetingFactory
+from ietf.meeting.helpers import tag_assignments_with_filter_keywords
+from ietf.utils.test_utils import TestCase
+
+
+class HelpersTests(TestCase):
+    def do_test_tag_assignments_with_filter_keywords(self, bof=False, historic=None):
+        """Assignments should be tagged properly
+        
+        The historic param can be None, group, or parent, to specify whether to test
+        with no historic_group, a historic_group but no historic_parent, or both.
+        """
+        meeting_types = ['regular', 'plenary']
+        group_state_id = 'bof' if bof else 'active'
+        group = GroupFactory(state_id=group_state_id)
+        historic_group = GroupFactory(state_id=group_state_id)
+        historic_parent = GroupFactory(type_id='area')
+
+        if historic == 'parent':
+            historic_group.historic_parent = historic_parent
+
+        # Create meeting and sessions
+        meeting = MeetingFactory()
+        for meeting_type in meeting_types:
+            sess = SessionFactory(group=group, meeting=meeting, type_id=meeting_type)
+            ts = sess.timeslotassignments.first().timeslot
+            ts.type = sess.type
+            ts.save()
+
+        # Create an office hours session in the group's area (i.e., parent). This is not
+        # currently really needed, but will protect against areas and groups diverging
+        # in a way that breaks keywording.
+        office_hours = SessionFactory(
+            name='some office hours',
+            group=group.parent,
+            meeting=meeting,
+            type_id='other'
+        )
+        ts = office_hours.timeslotassignments.first().timeslot
+        ts.type = office_hours.type
+        ts.save()
+
+        assignments = meeting.schedule.assignments.all()
+        orig_num_assignments = len(assignments)
+
+        # Set up historic groups if needed
+        if historic:
+            for a in assignments:
+                if a.session != office_hours:
+                    a.session.historic_group = historic_group
+
+        # Execute the method under test
+        tag_assignments_with_filter_keywords(assignments)
+
+        # Assert expected results
+        self.assertEqual(len(assignments), orig_num_assignments, 'Should not change number of assignments')
+
+        if historic:
+            expected_group = historic_group
+            expected_area = historic_parent if historic == 'parent' else historic_group.parent
+        else:
+            expected_group = group
+            expected_area = group.parent
+
+        for assignment in assignments:
+            expected_filter_keywords = [assignment.timeslot.type.slug]
+
+            if assignment.session == office_hours:
+                expected_filter_keywords.extend([
+                    group.parent.acronym,
+                    'adofficehours',
+                ])
+            else:
+                expected_filter_keywords.extend([
+                    expected_group.acronym,
+                    expected_area.acronym
+                ])
+                if bof:
+                    expected_filter_keywords.append('bof')
+
+            self.assertCountEqual(
+                assignment.filter_keywords,
+                expected_filter_keywords,
+                'Assignment has incorrect filter keywords'
+            )
+
+    def test_tag_assignments_with_filter_keywords(self):
+        self.do_test_tag_assignments_with_filter_keywords()
+        self.do_test_tag_assignments_with_filter_keywords(historic='group')
+        self.do_test_tag_assignments_with_filter_keywords(historic='parent')
+        self.do_test_tag_assignments_with_filter_keywords(bof=True)
+        self.do_test_tag_assignments_with_filter_keywords(bof=True, historic='group')
+        self.do_test_tag_assignments_with_filter_keywords(bof=True, historic='parent')

ietf/meeting/tests_js.py

@@ -466,6 +466,14 @@ def test_agenda_view_filter_show_area(self):
         area = mars.parent
         self.do_agenda_view_filter_test('?show=%s' % area.acronym, ['ames', 'mars'])
 
+    def test_agenda_view_filter_bof(self):
+        mars = Group.objects.get(acronym='mars')
+        mars.state_id = 'bof'
+        mars.save()
+        self.do_agenda_view_filter_test('?show=bof', ['mars'])
+        self.do_agenda_view_filter_test('?show=bof,mars', ['mars'])
+        self.do_agenda_view_filter_test('?show=bof,ames', ['mars','ames'])
+
     def test_agenda_view_filter_show_two(self):
         """Filtered agenda view should display only matching rows (two groups selected)"""
         self.do_agenda_view_filter_test('?show=mars,ames', ['mars', 'ames'])
@@ -482,43 +490,6 @@ def test_agenda_view_filter_hide_area(self):
         area = mars.parent
         self.do_agenda_view_filter_test('?show=mars&hide=%s' % area.acronym, [])
 
-    def test_agenda_view_filter_show_and_hide(self):
-        self.do_agenda_view_filter_test('?show=mars&hide=ietf', ['mars'])
-
-    def test_agenda_view_filter_show_and_hide_same_group(self):
-        self.do_agenda_view_filter_test('?show=mars&hide=mars', [])
-
-    def test_agenda_view_filter_showtypes(self):
-        self.do_agenda_view_filter_test('?showtypes=plenary', ['ietf'])  # ietf has a plenary session
-
-    def test_agenda_view_filter_hidetypes(self):
-        self.do_agenda_view_filter_test('?hidetypes=plenary', []) 
-        
-    def test_agenda_view_filter_showtypes_and_hidetypes(self):
-        self.do_agenda_view_filter_test('?showtypes=plenary&hidetypes=regular', ['ietf'])  # ietf has a plenary session
-    
-    def test_agenda_view_filter_showtypes_and_hidetypes_same_type(self):
-        self.do_agenda_view_filter_test('?showtypes=plenary&hidetypes=plenary', [])
-        
-    def test_agenda_view_filter_show_and_showtypes(self):
-        self.do_agenda_view_filter_test('?show=mars&showtypes=plenary', ['mars', 'ietf'])  # ietf has a plenary session
-        
-    def test_agenda_view_filter_show_and_hidetypes(self):
-        self.do_agenda_view_filter_test('?show=ietf,mars&hidetypes=plenary', ['mars'])  # ietf has a plenary session
-        
-    def test_agenda_view_filter_hide_and_hidetypes(self):
-        self.do_agenda_view_filter_test('?hide=ietf,mars&hidetypes=plenary', [])
-        
-    def test_agenda_view_filter_show_hide_and_showtypes(self):
-        self.do_agenda_view_filter_test('?show=mars&hide=ames&showtypes=plenary,regular', ['mars', 'ietf'])  # ietf has plenary session
-        
-    def test_agenda_view_filter_show_hide_and_hidetypes(self):
-        self.do_agenda_view_filter_test('?show=mars,ietf&hide=ames&hidetypes=plenary', ['mars'])  # ietf has plenary session
-        
-    def test_agenda_view_filter_all_params(self):
-        self.do_agenda_view_filter_test('?show=secretariat,ietf&hide=ames&showtypes=regular&hidetypes=plenary',
-                                        ['secretariat', 'mars'])
-        
     def assert_agenda_item_visibility(self, visible_groups=None):
         """Assert that correct items are visible in current browser window
         
@@ -692,19 +663,20 @@ def assert_upcoming_meeting_visibility(self, visible_meetings=None):
         not_visible = set()
         unexpected = set()
         entries = self.driver.find_elements_by_css_selector(
-            'table#upcoming-meeting-table > tbody > tr.entry'
+            'table#upcoming-meeting-table a.ietf-meeting-link, table#upcoming-meeting-table a.interim-meeting-link'
         )
         for entry in entries:
-            nums = [n for n in expected if n in entry.text]
+            entry_text = entry.get_attribute('innerHTML').strip()  # gets text, even if element is hidden
+            nums = [n for n in expected if n in entry_text]
             self.assertLessEqual(len(nums), 1, 'Multiple matching meeting numbers')
             if len(nums) > 0:  # asserted that it's at most 1, so if it's not 0, it's 1.
                 expected.remove(nums[0])
                 if not entry.is_displayed():
                     not_visible.add(nums[0])
                 continue
-            # Found an unexpected row - this is ok as long as it's hidden
+            # Found an unexpected row - this is only a problem if it is visible
             if entry.is_displayed():
-                unexpected.add(entry.text)
+                unexpected.add(entry_text)
 
         self.assertEqual(expected, set(), "Missing entries for expected iterim meetings.")
         self.assertEqual(not_visible, set(), "Hidden rows for expected interim meetings.")