Issue 5458, 5457 - Refactor _parse_targetspec, add support for locales and blockTotal

sitescripts/notifications/test/parser.py

 # This file is part of the Adblock Plus web scripts,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ skipping 142 matching lines @@
         self.assertEqual(notifications[1]['severity'], 'critical')
         self.assertEqual(notifications[2]['severity'], 'normal')
         self.assertEqual(notifications[3]['severity'], 'relentless')
 
     def test_urls(self):
         self.notification_to_load = [
             ('1', '\nurls = adblockplus.org\n'),
             ('1', '\nurls = adblockplus.org eyeo.com\n'),
         ]
         notifications = parser.load_notifications()
-        self.assertEqual(len(notifications), 2)
-        self.assertEqual(
-            notifications[0]['urlFilters'], ['ADBLOCKPLUS.ORG^$document'])
-        self.assertEqual(notifications[1]['urlFilters'], [
+
+        assert len(notifications) == 2
+        assert notifications[0]['urlFilters'] == ['ADBLOCKPLUS.ORG^$document']
+        assert notifications[1]['urlFilters'] == [
             'ADBLOCKPLUS.ORG^$document',
-            'EYEO.COM^$document'])
+            'EYEO.COM^$document']
 
     def test_target(self):
         self.notification_to_load = [
             ('1', '\ntarget = extension=adblockplus\n'),
             ('2', '\ntarget = extensionVersion=1.2.3\n'),
             ('3', '\ntarget = extensionVersion>=1.2.3\n'),
             ('4', '\ntarget = extensionVersion<=1.2.3\n'),
             ('5', '\ntarget = application=chrome\n'),
             ('6', '\ntarget = applicationVersion=1.2.3\n'),
             ('7', '\ntarget = applicationVersion>=1.2.3\n'),
             ('8', '\ntarget = applicationVersion<=1.2.3\n'),
             ('9', '\ntarget = platform=chromium\n'),
             ('10', '\ntarget = platformVersion=1.2.3\n'),
             ('11', '\ntarget = platformVersion>=1.2.3\n'),
             ('12', '\ntarget = platformVersion<=1.2.3\n'),
             ('13', '\ntarget = blockedTotal=10\n'),
             ('14', '\ntarget = blockedTotal>=10\n'),
             ('15', '\ntarget = blockedTotal<=10\n'),
             ('16', '\ntarget = locales=en-US\n'),
             ('17', '\ntarget = locales=en-US,de-DE\n'),
         ]
 
         notifications = parser.load_notifications()
 
         assert len(notifications) == 17

[Wladimir Palant, 2017/09/21 09:24:02]

I'd recommend switching back to self.assertEqual() here. Both will throw
AssertionError but currently it won't have any information beyond the stack
trace. Calling self.assertEqual() on the other hand will produce a message like
"AssertionError: 16 != 17"  which is more meaningful. Yes, I tried this.

[Vasily Kuznetsov, 2017/09/21 09:41:30]

Here's the error message that I get (after changing 17 to 16):
E       AssertionError: assert 17 == 16
E        +  where 17 = len([{'id': '1', 'message': {}, 'severity':
'information', 'targets': [{'extension': 'adblockplus'}], ...}, {'id': '2',
'm...severity': 'information', 'targets': [{'applicationMaxVersion': '1.2.3',
'applicationMinVersion': '1.2.3'}], ...}, ...])

Seems detailed and clear. Given that these tests run under pytest and tox (see
https://hg.adblockplus.org/sitescripts/file/tip/README.md) we might as well use
the benefits of those tools.

[wspee, 2017/09/21 10:15:11]

I agree with Vasily, using assert only provides additional information IMHO.

-
-        self.assertEqual(
-            notifications[0]['targets'][0]['extension'], 'adblockplus')

[Wladimir Palant, 2017/09/21 09:24:02]

You should verify that there are no additional targets either. This should work:

  self.assertEqual(notifications[0]['targets'], [{'extension': 'adblockplus'}])

[wspee, 2017/09/21 10:15:11]

Done.

-        self.assertEqual(
-            notifications[1]['targets'][0]['extensionMinVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[1]['targets'][0]['extensionMaxVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[2]['targets'][0]['extensionMinVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[3]['targets'][0]['extensionMaxVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[4]['targets'][0]['application'], 'chrome')
-        self.assertEqual(
-            notifications[5]['targets'][0]['applicationMinVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[5]['targets'][0]['applicationMaxVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[6]['targets'][0]['applicationMinVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[7]['targets'][0]['applicationMaxVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[8]['targets'][0]['platform'], 'chromium')
-        self.assertEqual(
-            notifications[9]['targets'][0]['platformMinVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[9]['targets'][0]['platformMaxVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[10]['targets'][0]['platformMinVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[11]['targets'][0]['platformMaxVersion'], '1.2.3')
-        self.assertEqual(
-            notifications[12]['targets'][0]['blockedTotalMin'], 10)
-        self.assertEqual(
-            notifications[12]['targets'][0]['blockedTotalMax'], 10)
-        self.assertEqual(
-            notifications[13]['targets'][0]['blockedTotalMin'], 10)
-        self.assertEqual(
-            notifications[14]['targets'][0]['blockedTotalMax'], 10)
-        self.assertEqual(
-            notifications[15]['targets'][0]['locales'], ['en-US'])
-        self.assertEqual(
-            notifications[16]['targets'][0]['locales'], ['en-US', 'de-DE'])
+        assert notifications[0]['targets'] == [{'extension': 'adblockplus'}]
+        assert notifications[1]['targets'] == [{
+            'extensionMinVersion': '1.2.3',
+            'extensionMaxVersion': '1.2.3'}]
+        assert notifications[2]['targets'] == [
+            {'extensionMinVersion': '1.2.3'}]
+        assert notifications[3]['targets'] == [{
+            'extensionMaxVersion': '1.2.3'}]
+        assert notifications[4]['targets'] == [{'application': 'chrome'}]
+        assert notifications[5]['targets'] == [{
+            'applicationMinVersion': '1.2.3',
+            'applicationMaxVersion': '1.2.3'}]
+        assert notifications[6]['targets'] == [{
+            'applicationMinVersion': '1.2.3'}]
+        assert notifications[7]['targets'] == [{
+            'applicationMaxVersion': '1.2.3'}]
+        assert notifications[8]['targets'] == [{'platform': 'chromium'}]
+        assert notifications[9]['targets'] == [{
+            'platformMinVersion': '1.2.3',
+            'platformMaxVersion': '1.2.3'}]
+        assert notifications[10]['targets'] == [{
+            'platformMinVersion': '1.2.3'}]
+        assert notifications[11]['targets'] == [{
+            'platformMaxVersion': '1.2.3'}]
+        assert notifications[12]['targets'] == [{
+            'blockedTotalMin': 10,
+            'blockedTotalMax': 10}]
+        assert notifications[13]['targets'] == [{'blockedTotalMin': 10}]
+        assert notifications[14]['targets'] == [{'blockedTotalMax': 10}]
+        assert notifications[15]['targets'] == [{'locales': ['en-US']}]
+        assert notifications[16]['targets'] == [{
+            'locales': ['en-US', 'de-DE']}]
 
 
 if __name__ == '__main__':
     unittest.main()