Add filtering support (but no UI) to upcoming meeting views; add a group attribute to agenda view rows to avoid ambiguity when selecting rows to show/hide. Branch ready for merge.

 - Legacy-Id: 18458

Author: jennifer-richards

ietf/meeting/test_data.py

@@ -219,7 +219,7 @@ def make_interim_test_data():
     ad = Person.objects.get(user__username='ad')
     RoleFactory(group=area,person=ad,name_id='ad')
     mars = GroupFactory(acronym='mars',parent=area,name='Martian Special Interest Group')
-    ames = GroupFactory(acronym='ames',parent=area)
+    ames = GroupFactory(acronym='ames',parent=area,name='Asteroid Mining Equipment Standardization Group')
     RoleFactory(group=mars,person__user__username='marschairman',name_id='chair')
     RoleFactory(group=ames,person__user__username='ameschairman',name_id='chair')
 

ietf/meeting/tests_views.py

@@ -22,6 +22,7 @@
 from django.contrib.auth.models import User
 from django.test import Client, override_settings
 from django.db.models import F
+from django.http import QueryDict
 
 import debug           # pyflakes:ignore
 
@@ -37,7 +38,7 @@
 from ietf.meeting.test_data import make_meeting_test_data, make_interim_meeting, make_interim_test_data
 from ietf.meeting.utils import finalize, condition_slide_order
 from ietf.meeting.utils import add_event_info_to_session_qs
-from ietf.meeting.views import session_draft_list
+from ietf.meeting.views import session_draft_list, parse_agenda_filter_params
 from ietf.name.models import SessionStatusName, ImportantDateName, RoleName
 from ietf.utils.decorators import skip_coverage
 from ietf.utils.mail import outbox, empty_outbox, get_payload_text
@@ -61,6 +62,31 @@
                     "location indicated in settings.py.")
     print("     "+skip_message)
 
+
+def assert_ical_response_is_valid(test_inst, response, expected_event_summaries=None, expected_event_count=None):
+    """Validate an HTTP response containing iCal data
+
+    Based on RFC2445, but not exhaustive by any means. Assumes a single iCalendar object.
+    """
+    test_inst.assertEqual(response.get('Content-Type'), "text/calendar")
+
+    # Validate iCalendar object
+    test_inst.assertContains(response, 'BEGIN:VCALENDAR', count=1)
+    test_inst.assertContains(response, 'END:VCALENDAR', count=1)
+    test_inst.assertContains(response, 'PRODID:', count=1)
+    test_inst.assertContains(response, 'VERSION', count=1)
+
+    # Validate event objects
+    if expected_event_summaries is not None:
+        for summary in expected_event_summaries:
+            test_inst.assertContains(response, 'SUMMARY:' + summary)
+
+    if expected_event_count is not None:
+        test_inst.assertContains(response, 'BEGIN:VEVENT', count=expected_event_count)
+        test_inst.assertContains(response, 'END:VEVENT', count=expected_event_count)
+        test_inst.assertContains(response, 'UID', count=expected_event_count)
+
+
 class MeetingTests(TestCase):
     def setUp(self):
         self.materials_dir = self.tempdir('materials')
@@ -580,28 +606,6 @@ def test_important_dates(self):
         post_date =  meeting.importantdate_set.get(name=idn).date
         self.assertEqual(pre_date, post_date+datetime.timedelta(days=1))
 
-    def assert_ical_response_is_valid(self, response, expected_event_summaries=None, expected_event_count=None):
-        """Validate an HTTP response containing iCal data
-        
-        Based on RFC2445, but not exhaustive by any means. Assumes a single iCalendar object.
-        """
-        self.assertEqual(response.get('Content-Type'), "text/calendar")
-
-        # Validate iCalendar object
-        self.assertContains(response, 'BEGIN:VCALENDAR', count=1)
-        self.assertContains(response, 'END:VCALENDAR', count=1)
-        self.assertContains(response, 'PRODID:', count=1)
-        self.assertContains(response, 'VERSION', count=1)
-
-        # Validate event objects
-        if expected_event_count is None:
-            expected_event_count = len(expected_event_summaries)
-        self.assertContains(response, 'BEGIN:VEVENT', count=expected_event_count)
-        self.assertContains(response, 'END:VEVENT', count=expected_event_count)
-        self.assertContains(response, 'UID', count=expected_event_count)
-        for summary in expected_event_summaries:
-            self.assertContains(response, 'SUMMARY:' + summary)
-    
     def test_group_ical(self):
         meeting = make_meeting_test_data()
         s1 = Session.objects.filter(meeting=meeting, group__acronym="mars").first()
@@ -614,17 +618,18 @@ def test_group_ical(self):
         #
         url = urlreverse('ietf.meeting.views.agenda_ical', kwargs={'num':meeting.number, 'acronym':s1.group.acronym, })
         r = self.client.get(url)
-        self.assert_ical_response_is_valid(r, 
-                                           expected_event_summaries=['mars - Martian Special Interest Group'],
-                                           expected_event_count=2)
+        assert_ical_response_is_valid(self,
+                                      r,
+                                      expected_event_summaries=['mars - Martian Special Interest Group'],
+                                      expected_event_count=2)
         self.assertContains(r, t1.time.strftime('%Y%m%dT%H%M%S'))
         self.assertContains(r, t2.time.strftime('%Y%m%dT%H%M%S'))
         #
         url = urlreverse('ietf.meeting.views.agenda_ical', kwargs={'num':meeting.number, 'session_id':s1.id, })
         r = self.client.get(url)
-        self.assert_ical_response_is_valid(r,
-                                           expected_event_summaries=['mars - Martian Special Interest Group'],
-                                           expected_event_count=1)
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=['mars - Martian Special Interest Group'],
+                                      expected_event_count=1)
         self.assertContains(r, t1.time.strftime('%Y%m%dT%H%M%S'))
         self.assertNotContains(r, t2.time.strftime('%Y%m%dT%H%M%S'))
 
@@ -652,7 +657,36 @@ def test_meeting_agenda_has_static_ical_links(self):
         for g in groups:
             if g.parent_id is not None:
                 self.assertIn('%s?show=%s' % (ical_url, g.parent.acronym.lower()), content)
-        
+
+    def test_parse_agenda_filter_params(self):
+        def _r(show=(), hide=(), showtypes=(), hidetypes=()):
+            """Helper to create expected result dict"""
+            return dict(show=set(show), hide=set(hide), showtypes=set(showtypes), hidetypes=set(hidetypes))
+
+        self.assertIsNone(parse_agenda_filter_params(QueryDict('')))
+
+        self.assertRaises(ValueError, parse_agenda_filter_params, QueryDict('unknown'))  # unknown param
+        self.assertRaises(ValueError, parse_agenda_filter_params, QueryDict('unknown=x'))  # unknown param
+
+        # test valid combos (not exhaustive)
+        for qstr, expected in (
+            ('show=', _r()), ('hide=', _r()), ('showtypes=', _r()), ('hidetypes=', _r()),
+            ('show=x', _r(show=['x'])), ('hide=x', _r(hide=['x'])),
+            ('showtypes=x', _r(showtypes=['x'])), ('hidetypes=x', _r(hidetypes=['x'])),
+            ('show=x,y,z', _r(show=['x','y','z'])),
+            ('hide=x,y,z', _r(hide=['x','y','z'])),
+            ('showtypes=x,y,z', _r(showtypes=['x','y','z'])),
+            ('hidetypes=x,y,z', _r(hidetypes=['x','y','z'])),
+            ('show=a&hide=a', _r(show=['a'], hide=['a'])),
+            ('show=a&hide=b', _r(show=['a'], hide=['b'])),
+            ('show=a&hide=b&showtypes=c&hidetypes=d', _r(show=['a'], hide=['b'], showtypes=['c'], hidetypes=['d'])),
+        ):
+            self.assertEqual(
+                parse_agenda_filter_params(QueryDict(qstr)),
+                expected,
+                'Parsed "%s" incorrectly' % qstr,
+            )
+
     def test_ical_filter_invalid_syntaxes(self):
         meeting = make_meeting_test_data()
         url = urlreverse('ietf.meeting.views.agenda_ical', kwargs={'num':meeting.number})
@@ -667,7 +701,10 @@ def do_ical_filter_test(self, meeting, querystring, expected_session_summaries):
         url = urlreverse('ietf.meeting.views.agenda_ical', kwargs={'num':meeting.number})
         r = self.client.get(url + querystring)
         self.assertEqual(r.status_code, 200)
-        self.assert_ical_response_is_valid(r, expected_event_summaries=expected_session_summaries)
+        assert_ical_response_is_valid(self,
+                                      r,
+                                      expected_event_summaries=expected_session_summaries,
+                                      expected_event_count=len(expected_session_summaries))
 
     def test_ical_filter_default(self):
         meeting = make_meeting_test_data()
@@ -1799,37 +1836,179 @@ def test_past(self):
         #self.assertIn('CANCELLED', q('[id*="'+id+'"]').text())
         self.assertIn('CANCELLED', q('tr>td>a>span').text())
 
-    def test_upcoming(self):
-        make_meeting_test_data(create_interims=True)
+    def do_upcoming_test(self, querystring=None, create_meeting=True):
+        if create_meeting:
+            make_meeting_test_data(create_interims=True)
         url = urlreverse("ietf.meeting.views.upcoming")
+        if querystring is not None:
+            url += '?' + querystring
+
         today = datetime.date.today()
         add_event_info_to_session_qs(Session.objects.filter(meeting__type='interim', group__acronym='mars')).filter(current_status='apprw').first()
-        mars_interim = add_event_info_to_session_qs(Session.objects.filter(meeting__type='interim', meeting__date__gt=today, group__acronym='mars')).filter(current_status='sched').first().meeting
-        ames_interim = add_event_info_to_session_qs(Session.objects.filter(meeting__type='interim', meeting__date__gt=today, group__acronym='ames')).filter(current_status='canceled').first().meeting
-        r = self.client.get(url)
-        self.assertContains(r, mars_interim.number)
-        self.assertContains(r, ames_interim.number)
+        interims = dict(
+            mars=add_event_info_to_session_qs(Session.objects.filter(meeting__type='interim', meeting__date__gt=today, group__acronym='mars')).filter(current_status='sched').first().meeting,
+            ames=add_event_info_to_session_qs(Session.objects.filter(meeting__type='interim', meeting__date__gt=today, group__acronym='ames')).filter(current_status='canceled').first().meeting,
+        )
+        self.check_interim_tabs(url)
+        return self.client.get(url), interims
+
+    def test_upcoming(self):
+        r, interims = self.do_upcoming_test()
+        self.assertContains(r, interims['mars'].number)
+        self.assertContains(r, interims['ames'].number)
         self.assertContains(r, 'IETF 72')
         # cancelled session
         q = PyQuery(r.content)
         self.assertIn('CANCELLED', q('tr>td.text-right>span').text())
-        self.check_interim_tabs(url)
 
-    def test_upcoming_ical(self):
+    def test_upcoming_filter_show(self):
+        r, interims = self.do_upcoming_test('show=ames')
+        self.assertNotContains(r, interims['mars'].number)
+        self.assertContains(r, interims['ames'].number)
+        self.assertContains(r, 'IETF 72')
+        # cancelled session
+        q = PyQuery(r.content)
+        self.assertIn('CANCELLED', q('tr>td.text-right>span').text())
+
+    def test_upcoming_filter_show_area(self):
         make_meeting_test_data(create_interims=True)
+        area = Group.objects.get(acronym='mars').parent
+        self.assertEqual(area,
+                         Group.objects.get(acronym='ames').parent,
+                         'The mars and ames groups have different areas; this breaks this test')
+        r, interims = self.do_upcoming_test('show=%s' % area.acronym, create_meeting=False)
+        self.assertContains(r, interims['mars'].number)
+        self.assertContains(r, interims['ames'].number)
+        self.assertContains(r, 'IETF 72')
+
+    def test_upcoming_filter_hide(self):
+        r, interims = self.do_upcoming_test('hide=mars')
+        self.assertNotContains(r, interims['mars'].number)
+        self.assertNotContains(r, interims['ames'].number)
+        self.assertContains(r, 'IETF 72')
+
+    def test_upcoming_filter_show_and_hide(self):
+        r, interims = self.do_upcoming_test('show=mars,ames&hide=ames')
+        self.assertContains(r, interims['mars'].number)
+        self.assertNotContains(r, interims['ames'].number)
+        self.assertContains(r, 'IETF 72')
+
+    def do_upcoming_ical_test(self, querystring=None):
+        make_meeting_test_data(create_interims=True)
+
+        # Create a group with a plenary interim session for testing type filters
+        somegroup = GroupFactory(acronym='sg', name='Some Group')
+        sg_interim = make_interim_meeting(somegroup, datetime.date.today() + datetime.timedelta(days=20))
+        sg_sess = sg_interim.session_set.first()
+        sg_slot = sg_sess.timeslotassignments.first().timeslot
+        sg_sess.type_id = 'plenary'
+        sg_slot.type_id = 'plenary'
+        sg_sess.save()
+        sg_slot.save()
+
         url = urlreverse("ietf.meeting.views.upcoming_ical")
+        if querystring is not None:
+            url += '?' + querystring
         r = self.client.get(url)
         self.assertEqual(r.status_code, 200)
-        self.assertEqual(r.get('Content-Type'), "text/calendar")
-        self.assertEqual(r.content.count(b'UID'), 8)
-        # check filtered output
-        url = url + '?filters=mars'
-        r = self.client.get(url)
-        self.assertEqual(r.status_code, 200)
-        self.assertEqual(r.get('Content-Type'), "text/calendar")
-        # print r.content
-        self.assertEqual(r.content.count(b'UID'), 2)
+        return r
 
+    def test_upcoming_ical(self):
+        r = self.do_upcoming_ical_test()
+        print(r.content.decode())
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'ames - Asteroid Mining Equipment Standardization Group',
+                                          'mars - Martian Special Interest Group',
+                                          'sg - Some Group',
+                                      ],
+                                      expected_event_count=9)
+
+    def test_upcoming_ical_filter_show(self):
+        r = self.do_upcoming_ical_test('show=mars,ames')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'mars - Martian Special Interest Group',
+                                          'ames - Asteroid Mining Equipment Standardization Group',
+                                      ])
+
+    def test_upcoming_ical_filter_hide(self):
+        r = self.do_upcoming_ical_test('hide=mars')
+        assert_ical_response_is_valid(self, r, expected_event_summaries=[])
+
+    def test_upcoming_ical_filter_show_and_hide(self):
+        r = self.do_upcoming_ical_test('show=mars,ames&hide=mars')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'ames - Asteroid Mining Equipment Standardization Group',
+                                      ])
+
+    def test_upcoming_ical_filter_showtypes(self):
+        r = self.do_upcoming_ical_test('showtypes=regular')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'mars - Martian Special Interest Group',
+                                          'ames - Asteroid Mining Equipment Standardization Group',
+                                      ])
+
+    def test_upcoming_ical_filter_hidetypes(self):
+        r = self.do_upcoming_ical_test('hidetypes=regular')
+        assert_ical_response_is_valid(self, r, expected_event_summaries=[])
+
+    def test_upcoming_ical_filter_showtypes_and_hidetypes(self):
+        r = self.do_upcoming_ical_test('showtypes=plenary,regular&hidetypes=regular')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'sg - Some Group',
+                                      ])
+
+    def test_upcoming_ical_filter_show_and_showtypes(self):
+        r = self.do_upcoming_ical_test('show=mars&showtypes=plenary')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'mars - Martian Special Interest Group',
+                                          'sg - Some Group',
+                                      ])
+
+    def test_upcoming_ical_filter_show_and_hidetypes(self):
+        r = self.do_upcoming_ical_test('show=mars,sg&showtypes=regular')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                              'sg - Some Group',
+                                      ])
+
+    def test_upcoming_ical_filter_hide_and_showtypes(self):
+        r = self.do_upcoming_ical_test('hide=mars&showtypes=regular')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'ames - Asteroid Mining Equipment Standardization Group',
+                                      ])
+
+    def test_upcoming_ical_filter_hide_and_hidetypes(self):
+        r = self.do_upcoming_ical_test('hide=mars&hidetypes=regular')
+        assert_ical_response_is_valid(self, r, expected_event_summaries=[])
+
+    def test_upcoming_ical_filter_show_hide_and_showtypes(self):
+        r = self.do_upcoming_ical_test('show=ames&hide=mars&showtypes=regular,plenary')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'ames - Asteroid Mining Equipment Standardization Group',
+                                          'sg - Some Group',
+                                      ])
+
+    def test_upcoming_ical_filter_show_hide_and_hidetypes(self):
+        r = self.do_upcoming_ical_test('show=ames,sg&hide=mars&hidetypes=regular')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'sg - Some Group',
+                                      ])
+
+    def test_upcoming_ical_filter_all_params(self):
+        r = self.do_upcoming_ical_test('show=sg&hide=ames&showtypes=regular&hidetypes=plenary')
+        assert_ical_response_is_valid(self, r,
+                                      expected_event_summaries=[
+                                          'mars - Martian Special Interest Group',
+                                      ])
 
     def test_upcoming_json(self):
         make_meeting_test_data(create_interims=True)