Tests fail on Trac 1.0-beta1

[ejucovy]

Running customfieldadmin's setup.py test against Trac 1.0-beta1 results in several test failures. They seem to be caused by a change in the return value of Trac's TicketSystem.get_custom_fields() API. The dicts returned by that method now include a key "custom": True for custom fields, which is not expected by the tests in CustomFieldApiTestCase.

The attached patch causes the tests to pass by adding "custom": True to the expected return value in those tests.

[ejucovy]

Hmm, attaching a patch doesn't seem to work -- here's the contents of the patch, produced by svn diff:

customfieldadmin/tests/api.py

@@ -38 +38 @@
             self.cf_api.create_custom_field(cfield)
         self.assertEquals(self.cf_api.get_custom_fields(),
                     [{'name': u'one', 'format': 'plain', 'value': '',
-                      'label': u'One', 'type': u'text', 'order': 1},
+                      'label': u'One', 'type': u'text', 'order': 1,
+                      'custom': True},
                      {'name': u'two', 'format': 'plain', 'value': '',
-                      'label': u'Two', 'type': u'text', 'order': 2},
+                      'label': u'Two', 'type': u'text', 'order': 2,
+                      'custom': True},
                      {'name': u'three', 'format': 'plain', 'value': '',
-                      'label': u'Three', 'type': u'text', 'order': 3}])
+                      'label': u'Three', 'type': u'text', 'order': 3,
+                      'custom': True}])
 
     def test_update(self):
         cfield = {'name': 'foo', 'type': 'text'}
         self.cf_api.create_custom_field(cfield)
-        self.assertEquals(cfield, {'name': u'foo', 'format': 'plain',
+        self.assertEquals(cfield, {'name': u'foo', 'format': 'plain', 'custom': True,
                 'value': '', 'label': u'Foo', 'type': u'text', 'order': 1})
         cfield['label'] = 'Answer'
         cfield['value'] = '42'
         self.cf_api.update_custom_field(cfield=cfield)
-        self.assertEquals(cfield, {'name': u'foo', 'format': 'plain',
+        self.assertEquals(cfield, {'name': u'foo', 'format': 'plain', 'custom': True,
                 'value': '42', 'label': u'Answer', 'type': u'text', 'order': 1})
 
     def test_update_non_existing(self):
@@ -84 +87 @@
         # Note: Should also reorder higher-ordered items
         self.assertEquals(self.cf_api.get_custom_fields(),
                     [{'name': u'one', 'format': 'plain', 'value': '',
-                      'label': u'One', 'type': u'text', 'order': 1},
+                      'label': u'One', 'type': u'text', 'order': 1,
+                      'custom': True},
                      {'name': u'three', 'format': 'plain', 'value': '',
-                      'label': u'Three', 'type': u'text', 'order': 2}])
+                      'label': u'Three', 'type': u'text', 'order': 2,
+                      'custom': True}])
         self.assertEquals(None,
                 self.cf_api.get_custom_fields(cfield={'name': 'two'}))

[osimons]

Huh.

Why we have changed TicketSystem(self.env).get_custom_fields() to include the truly useless 'custom': True information I don't know. It makes no sense and just adds overhead IMHO - the API call already requests the custom fields, and I cannot see the point of adding some sort of additional marker saying the field is a custom field??

Ideally I'd like to see this fixed in Trac, but if not I can also strip it at the receiving end so that the new working patch would look something like this:

0.11/customfieldadmin/api.py

@@ -73 +73 @@
         """ Returns the custom fields from TicketSystem component.
         Use a cfdict with 'name' key set to find a specific custom field only.
         """
+        def _get_custom_fields():
+            for item in TicketSystem(self.env).get_custom_fields():
+                # Remove the superfluous `'custom': True` item from field dict
+                item.pop('custom', None)
+                yield item
         if not cfield:    # return full list
-            return TicketSystem(self.env).get_custom_fields()
+            return list(_get_custom_fields())
         else:                  # only return specific item with cfname
-            for item in TicketSystem(self.env).get_custom_fields():
+            for item in _get_custom_fields():
                 if item['name'] == cfield['name']:
                     return item
             return None        # item not found

[Ryan J Ollos]

It looks like the change was made in ​[t 11330], moving the dictionary key from the fields method to the custom_fields method.

[Steffen Hoffmann]

This is the test result running Trac 1.0.1 backed by SQLite (PostgreSQL8.4 and PostgreSQL9.1 successfully tested as well):

(trac-1.0_pg)hasienda@debian6.0:th_devel/customfieldadminplugin_build$ python ./setup.py test
running test
running egg_info
creating TracCustomFieldAdmin.egg-info
writing requirements to TracCustomFieldAdmin.egg-info/requires.txt
writing TracCustomFieldAdmin.egg-info/PKG-INFO
writing top-level names to TracCustomFieldAdmin.egg-info/top_level.txt
writing dependency_links to TracCustomFieldAdmin.egg-info/dependency_links.txt
writing entry points to TracCustomFieldAdmin.egg-info/entry_points.txt
writing manifest file 'TracCustomFieldAdmin.egg-info/SOURCES.txt'
reading manifest file 'TracCustomFieldAdmin.egg-info/SOURCES.txt'
writing manifest file 'TracCustomFieldAdmin.egg-info/SOURCES.txt'
running build_ext
test_create (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_delete (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_delete_unknown_options (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_not_delete_unknown_options_for_modify (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_systeminfo (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_update (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_update_non_existing (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_update_non_existing_no_name (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_update_textarea (customfieldadmin.tests.api.CustomFieldApiTestCase) ... ok
test_translation_function (customfieldadmin.tests.api.CustomFieldL10NTestCase) ... ok
test_translation_function_tag (customfieldadmin.tests.api.CustomFieldL10NTestCase) ... ok
test_add_optional_select (customfieldadmin.tests.admin.CustomFieldAdminPageTestCase) ... ok
test_apply_optional_select (customfieldadmin.tests.admin.CustomFieldAdminPageTestCase) ... ok
test_create (customfieldadmin.tests.admin.CustomFieldAdminPageTestCase) ... ok

----------------------------------------------------------------------
Ran 14 tests in 0.301s