| ralph |
| resultsdb |
The way the messaging plugins are loaded, it is required to run
python setup.py develop for resultsdb to function properly,
if you use it from git checkout.
To make the development a bit more pleasant, I made sure the
dummy plugin can be loaded even without that.
As @ralph noted at IRC, doing this kind of lets us in the dark most
of the time, so to catch the plugin loading issues, I updated the
unitests with code that tries to load both dummy (should work always)
and fedmsg (only works after setup.py develop) plugins.
Helpfull message is shown when loading the fedmsg plugin fails.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
Tiny cosmetic change requested.
| resultsdb/messaging.py | ||
|---|---|---|
| 111 | This might be simpler if you just put classes['dummy'] = DummyPlugin up here. You could get rid of the conditional. | |
| Path | Packages | |||
|---|---|---|---|---|
| M | resultsdb/config.py (5 lines) | |||
| M | resultsdb/messaging.py (3 lines) | |||
| M | testing/test_general.py (25 lines) |
| Commit | Tree | Parents | Author | Summary | Date |
|---|---|---|---|---|---|
| 7b2183a00eee | 2094317a04d7 | c2950414db41 | Josef Skladanka | lint | Jan 18 2017, 4:59 PM |
| c2950414db41 | ca66fbc014d3 | 2169842d7211 | Josef Skladanka | Changed to remove the if-clause | Jan 18 2017, 4:59 PM |
| 2169842d7211 | 4b6902c3d951 | 8ff450a1d526 | Josef Skladanka | Make messaging plugin loading more pleasant for dev (Show More…) | Jan 18 2017, 4:17 PM |
| Show All 32 Lines | 22 | class Config(object): | |||
|---|---|---|---|---|---|
| 33 | 33 | | |||
| 34 | PRODUCTION = False | 34 | PRODUCTION = False | ||
| 35 | 35 | | |||
| 36 | SHOW_DB_URI = False | 36 | SHOW_DB_URI = False | ||
| 37 | 37 | | |||
| 38 | FEDMENU_URL = 'https://apps.fedoraproject.org/fedmenu' | 38 | FEDMENU_URL = 'https://apps.fedoraproject.org/fedmenu' | ||
| 39 | FEDMENU_DATA_URL = 'https://apps.fedoraproject.org/js/data.js' | 39 | FEDMENU_DATA_URL = 'https://apps.fedoraproject.org/js/data.js' | ||
| 40 | 40 | | |||
| 41 | MESSAGE_BUS_PUBLISH = False | 41 | MESSAGE_BUS_PUBLISH = True | ||
| 42 | MESSAGE_BUS_PLUGIN = 'dummy' | 42 | MESSAGE_BUS_PLUGIN = 'dummy' | ||
| 43 | MESSAGE_BUS_KWARGS = {} | 43 | MESSAGE_BUS_KWARGS = {} | ||
| 44 | 44 | | |||
| 45 | # Specify which fields are required (in addition to those already required) | 45 | # Specify which fields are required (in addition to those already required) | ||
| 46 | # when creating result/group/testcase. | 46 | # when creating result/group/testcase. | ||
| 47 | # If you want to set some result's extra-data as required, you can do so by | 47 | # If you want to set some result's extra-data as required, you can do so by | ||
| 48 | # prepending 'data.' to the name (e.g. 'data.arch'). | 48 | # prepending 'data.' to the name (e.g. 'data.arch'). | ||
| 49 | REQUIRED_DATA = { | 49 | REQUIRED_DATA = { | ||
| 50 | 'create_result': [], | 50 | 'create_result': [], | ||
| 51 | 'create_group': [], | 51 | 'create_group': [], | ||
| 52 | 'create_testcase': [], | 52 | 'create_testcase': [], | ||
| 53 | } | 53 | } | ||
| 54 | 54 | | |||
| 55 | class ProductionConfig(Config): | 55 | class ProductionConfig(Config): | ||
| 56 | DEBUG = False | 56 | DEBUG = False | ||
| 57 | PRODUCTION = True | 57 | PRODUCTION = True | ||
| 58 | MESSAGE_BUS_PUBLISH = True | | |||
| 59 | MESSAGE_BUS_PLUGIN = 'fedmsg' | 58 | MESSAGE_BUS_PLUGIN = 'fedmsg' | ||
| 60 | MESSAGE_BUS_KWARGS = {'modname': 'resultsdb'} | 59 | MESSAGE_BUS_KWARGS = {'modname': 'resultsdb'} | ||
| 61 | 60 | | |||
| 62 | 61 | | |||
| 63 | class DevelopmentConfig(Config): | 62 | class DevelopmentConfig(Config): | ||
| 64 | TRAP_BAD_REQUEST_ERRORS = True | 63 | TRAP_BAD_REQUEST_ERRORS = True | ||
| 65 | SQLALCHEMY_DATABASE_URI = 'sqlite:////var/tmp/resultsdb_db.sqlite' | 64 | SQLALCHEMY_DATABASE_URI = 'sqlite:////var/tmp/resultsdb_db.sqlite' | ||
| 66 | SHOW_DB_URI = True | 65 | SHOW_DB_URI = True | ||
| 67 | MESSAGE_BUS_PUBLISH = True | | |||
| 68 | 66 | | |||
| 69 | 67 | | |||
| 70 | class TestingConfig(Config): | 68 | class TestingConfig(Config): | ||
| 71 | TRAP_BAD_REQUEST_ERRORS = True | 69 | TRAP_BAD_REQUEST_ERRORS = True | ||
| 72 | TESTING = True | 70 | TESTING = True | ||
| 73 | FEDMENU_URL = 'https://apps.stg.fedoraproject.org/fedmenu' | 71 | FEDMENU_URL = 'https://apps.stg.fedoraproject.org/fedmenu' | ||
| 74 | FEDMENU_DATA_URL = 'https://apps.stg.fedoraproject.org/js/data.js' | 72 | FEDMENU_DATA_URL = 'https://apps.stg.fedoraproject.org/js/data.js' | ||
| 75 | MESSAGE_BUS_PUBLISH = True | | |||
| Show First 20 Lines • Show All 100 Lines • ▼ Show 20 Line(s) | 100 | if hasattr(result, 'group'): | |||
|---|---|---|---|---|---|
| 101 | msg['msg']['result']['group_url'] = result.group.ref_url | 101 | msg['msg']['result']['group_url'] = result.group.ref_url | ||
| 102 | 102 | | |||
| 103 | return msg | 103 | return msg | ||
| 104 | 104 | | |||
| 105 | 105 | | |||
| 106 | def load_messaging_plugin(name, kwargs): | 106 | def load_messaging_plugin(name, kwargs): | ||
| 107 | """ Instantiate and return the appropriate messaging plugin. """ | 107 | """ Instantiate and return the appropriate messaging plugin. """ | ||
| 108 | points = pkg_resources.iter_entry_points('resultsdb.messaging.plugins') | 108 | points = pkg_resources.iter_entry_points('resultsdb.messaging.plugins') | ||
| 109 | classes = dict([(point.name, point.load()) for point in points]) | 109 | classes = {'dummy': DummyPlugin} | ||
| 110 | classes.update(dict([(point.name, point.load()) for point in points])) | ||||
| 110 | 111 | | |||
| 111 | log.debug("Found the following installed messaging plugin %r" % classes) | 112 | log.debug("Found the following installed messaging plugin %r" % classes) | ||
| 112 | if name not in classes: | 113 | if name not in classes: | ||
| 113 | raise KeyError("%r not found in %r" % (name, classes.keys())) | 114 | raise KeyError("%r not found in %r" % (name, classes.keys())) | ||
| 114 | 115 | | |||
| 115 | cls = classes[name] | 116 | cls = classes[name] | ||
| 116 | 117 | | |||
| 117 | # Sanity check | 118 | # Sanity check | ||
| 118 | if not issubclass(cls, MessagingPlugin): | 119 | if not issubclass(cls, MessagingPlugin): | ||
| 119 | raise TypeError("%s %r does not extend MessagingPlugin." % (name, cls)) | 120 | raise TypeError("%s %r does not extend MessagingPlugin." % (name, cls)) | ||
| 120 | 121 | | |||
| 121 | log.debug("Instantiating plugin %r named %s" % (cls, name)) | 122 | log.debug("Instantiating plugin %r named %s" % (cls, name)) | ||
| 122 | return cls(**kwargs) | 123 | return cls(**kwargs) | ||
| 1 | import datetime | 1 | import datetime | ||
|---|---|---|---|---|---|
| 2 | import pytest | 2 | import pytest | ||
| 3 | import functools | 3 | import functools | ||
| 4 | 4 | | |||
| 5 | import resultsdb.controllers.api_v2 as apiv2 | 5 | import resultsdb.controllers.api_v2 as apiv2 | ||
| 6 | import resultsdb.lib.helpers as helpers | 6 | import resultsdb.lib.helpers as helpers | ||
| 7 | import resultsdb.messaging as messaging | ||||
| 7 | 8 | | |||
| 8 | 9 | | |||
| 9 | class MyRequest(object): | 10 | class MyRequest(object): | ||
| 10 | 11 | | |||
| 11 | def __init__(self, url): | 12 | def __init__(self, url): | ||
| 12 | self.url = url | 13 | self.url = url | ||
| 13 | 14 | | |||
| 14 | 15 | | |||
| ▲ Show 20 Lines • Show All 154 Lines • ▼ Show 20 Line(s) | 163 | def test_parse_start_with_timezone_info(self): | |||
| 169 | assert end is None | 170 | assert end is None | ||
| 170 | 171 | | |||
| 171 | def test_parse_end(self): | 172 | def test_parse_end(self): | ||
| 172 | start, end = apiv2.parse_since(self.date_str + ',' + self.date_str) | 173 | start, end = apiv2.parse_since(self.date_str + ',' + self.date_str) | ||
| 173 | assert start == self.date_obj | 174 | assert start == self.date_obj | ||
| 174 | assert end == self.date_obj | 175 | assert end == self.date_obj | ||
| 175 | 176 | | |||
| 176 | 177 | | |||
| 178 | class TestMessaging(): | ||||
| 179 | | ||||
| 180 | def test_load_plugin(self): | ||||
| 181 | plugin = messaging.load_messaging_plugin('dummy', {}) | ||||
| 182 | assert isinstance(plugin, messaging.DummyPlugin) | ||||
| 183 | try: | ||||
| 184 | plugin = messaging.load_messaging_plugin('fedmsg', {}) | ||||
| 185 | except KeyError as err: | ||||
| 186 | if "not found" in err.message: | ||||
| 187 | print """=============== HINT =============== | ||||
| 188 | This exception can be caused by the fact, that you did not run | ||||
| 189 | `python setup.py develop` before executing the testsuite. | ||||
| 190 | | ||||
| 191 | The messaging plugins are defined as setuptools entry-points, and those live in the | ||||
| 192 | .egg-info directory. If you're developing locally, that directory is usually present | ||||
| 193 | in pwd due to `python setup.py develop`. | ||||
| 194 | | ||||
| 195 | If you ran `python setup.py develop` and are still seeing this error, then: | ||||
| 196 | - you might me missing the 'fedmsg' entrypoint in setup.py | ||||
| 197 | - there can be an error in the plugin loading code""" | ||||
| 198 | raise | ||||
| 199 | assert isinstance(plugin, messaging.FedmsgPlugin), "check whether `fedmsg` entrypoint in setup.py points to resultsdb.messaging:FedmsgPlugin" | ||||
| 200 | | ||||
| 201 | | ||||
| 177 | class TestGetResultsParseArgs(): | 202 | class TestGetResultsParseArgs(): | ||
| 178 | # TODO: write something! | 203 | # TODO: write something! | ||
| 179 | pass | 204 | pass | ||
This might be simpler if you just put classes['dummy'] = DummyPlugin up here. You could get rid of the conditional.