1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
|
""" Tests for applications and plugins. """
# Standard library imports.
import os, random, shutil, unittest
# Enthought library imports.
from enthought.etsconfig.api import ETSConfig
from enthought.envisage.api import Application, ExtensionPoint, IApplication
from enthought.envisage.api import Plugin, PluginManager
from enthought.traits.api import Bool, HasTraits, Instance, Int, Interface
from enthought.traits.api import List, Str, implements
# Local imports.
#
# We do these as absolute imports to allow nose to run from a different
# working directory.
from enthought.envisage.tests.event_tracker import EventTracker
def listener(obj, trait_name, old, new):
""" A useful trait change handler for testing! """
listener.obj = obj
listener.trait_name = trait_name
listener.old = old
listener.new = new
return
def vetoer(event):
""" A function that will veto an event. """
event.veto = True
return
class TestApplication(Application):
""" The type of application used in the tests. """
id = 'test'
class SimplePlugin(Plugin):
""" A simple plugin. """
#### 'SimplePlugin' interface #############################################
started = Bool(False)
stopped = Bool(False)
###########################################################################
# 'IPlugin' interface.
###########################################################################
def start(self):
""" Start the plugin. """
self.started = True
self.stopped = False
return
def stop(self):
""" Stop the plugin. """
self.started = False
self.stopped = True
return
class BadPlugin(Plugin):
""" A plugin that just causes trouble ;^). """
###########################################################################
# 'IPlugin' interface.
###########################################################################
def start(self):
""" Start the plugin. """
raise 1/0
def stop(self):
""" Stop the plugin. """
raise 1/0
class PluginA(Plugin):
""" A plugin that offers an extension point. """
id = 'A'
x = ExtensionPoint(List, id='a.x')
class PluginB(Plugin):
""" A plugin that contributes to an extension point. """
id = 'B'
x = List(Int, [1, 2, 3], contributes_to='a.x')
class PluginC(Plugin):
""" Another plugin that contributes to an extension point! """
id = 'C'
x = List(Int, [98, 99, 100], contributes_to='a.x')
class ApplicationTestCase(unittest.TestCase):
""" Tests for applications and plugins. """
###########################################################################
# 'TestCase' interface.
###########################################################################
def setUp(self):
""" Prepares the test fixture before each test method is called. """
# Make sure that the listener contents get cleand up before each test.
listener.obj = None
listener.trait_name = None
listener.old = None
listener.new = None
return
def tearDown(self):
""" Called immediately after each test method has been called. """
return
###########################################################################
# Tests.
###########################################################################
def test_home(self):
""" home """
application = TestApplication()
# Make sure we get the right default value.
self.assertEqual(ETSConfig.application_home, application.home)
# Delete the directory.
shutil.rmtree(application.home)
# Create a new application.
application = TestApplication()
# Make sure the directory got created.
self.assert_(os.path.exists(application.home))
# Delete the directory.
shutil.rmtree(application.home)
return
def test_no_plugins(self):
""" no plugins """
application = TestApplication()
tracker = EventTracker(
subscriptions = [
(application, 'starting'),
(application, 'started'),
(application, 'stopping'),
(application, 'stopped')
]
)
# Start the application.
started = application.start()
self.assertEqual(True, started)
self.assertEqual(['starting', 'started'], tracker.event_names)
# Stop the application.
stopped = application.stop()
self.assertEqual(True, stopped)
self.assertEqual(
['starting', 'started', 'stopping', 'stopped'], tracker.event_names
)
return
def test_veto_starting(self):
""" veto starting """
application = TestApplication()
# This listener will veto the 'starting' event.
application.on_trait_change(vetoer, 'starting')
tracker = EventTracker(
subscriptions = [
(application, 'starting'),
(application, 'started'),
(application, 'stopping'),
(application, 'stopped')
]
)
# Start the application.
started = application.start()
self.assertEqual(False, started)
self.assert_('started' not in tracker.event_names)
return
def test_veto_stopping(self):
""" veto stopping """
application = TestApplication()
# This listener will veto the 'stopping' event.
application.on_trait_change(vetoer, 'stopping')
tracker = EventTracker(
subscriptions = [
(application, 'starting'),
(application, 'started'),
(application, 'stopping'),
(application, 'stopped')
]
)
# Start the application.
started = application.start()
self.assertEqual(['starting', 'started'], tracker.event_names)
self.assertEqual(True, started)
# Stop the application.
stopped = application.stop()
self.assertEqual(False, stopped)
self.assert_('stopped' not in tracker.event_names)
return
def test_start_and_stop_errors(self):
""" start and stop errors """
simple_plugin = SimplePlugin()
bad_plugin = BadPlugin()
application = TestApplication(plugins=[simple_plugin, bad_plugin])
# Try to start the application - the bad plugin should barf.
self.failUnlessRaises(ZeroDivisionError, application.start)
# Try to stop the application - the bad plugin should barf.
self.failUnlessRaises(ZeroDivisionError, application.stop)
# Try to start a non-existent plugin.
self.failUnlessRaises(
SystemError, application.start_plugin, plugin_id='bogus'
)
# Try to stop a non-existent plugin.
self.failUnlessRaises(
SystemError, application.stop_plugin, plugin_id='bogus'
)
return
def test_extension_point(self):
""" extension point """
a = PluginA()
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
return
def test_add_extension_point_listener(self):
""" add extension point listener """
a = PluginA()
b = PluginB()
c = PluginC()
# Start off with just two of the plugins.
application = TestApplication(plugins=[a, b])
application.start()
def listener(extension_registry, event):
""" An extension point listener. """
listener.extension_point_id = event.extension_point_id
listener.added = event.added
listener.removed = event.removed
return
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(3, len(extensions))
self.assertEqual([1, 2, 3], extensions)
# Add the listener.
application.add_extension_point_listener(listener, 'a.x')
# Now add the other plugin.
application.add_plugin(c)
# Make sure the listener was called.
self.assertEqual('a.x', listener.extension_point_id)
self.assertEqual([], listener.removed)
self.assertEqual([98, 99, 100], listener.added)
return
def test_remove_extension_point_listener(self):
""" remove extension point listener """
a = PluginA()
b = PluginB()
c = PluginC()
# Start off with just one of the plugins.
application = TestApplication(plugins=[a])
application.start()
def listener(extension_registry, event):
""" An extension point listener. """
listener.extension_point_id = event.extension_point_id
listener.added = event.added
listener.removed = event.removed
return
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(0, len(extensions))
# Add the listener.
application.add_extension_point_listener(listener, 'a.x')
# Now add one of the other plugins.
application.add_plugin(b)
# Make sure the listener was called.
self.assertEqual('a.x', listener.extension_point_id)
self.assertEqual([], listener.removed)
self.assertEqual([1, 2, 3], listener.added)
# Now remove the listener.
listener.extension_point_id = None
application.remove_extension_point_listener(listener, 'a.x')
# Now add the final plugin.
application.add_plugin(c)
# Make sure the listener was *not* called.
self.assertEqual(None, listener.extension_point_id)
return
def test_add_plugin(self):
""" add plugin """
a = PluginA()
b = PluginB()
c = PluginC()
# Start off with just two of the plugins.
application = TestApplication(plugins=[a, b])
application.start()
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(3, len(extensions))
self.assertEqual([1, 2, 3], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x
self.assertEqual(3, len(extensions))
self.assertEqual([1, 2, 3], extensions)
# Now add the other plugin.
application.add_plugin(c)
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
return
def test_get_plugin(self):
""" get plugin """
a = PluginA()
b = PluginB()
c = PluginC()
# Start off with just two of the plugins.
application = TestApplication(plugins=[a, b, c])
application.start()
# Make sure we can get the plugins.
self.assertEqual(a, application.get_plugin('A'))
self.assertEqual(b, application.get_plugin('B'))
self.assertEqual(c, application.get_plugin('C'))
# Make sure we can't get one that isn't there ;^)
self.assertEqual(None, application.get_plugin('BOGUS'))
return
def test_remove_plugin(self):
""" remove plugin """
a = PluginA()
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
# Now remove one plugin.
application.remove_plugin(b)
# Make sure we can get the contributions via the application.
extensions = application.get_extensions('a.x')
self.assertEqual(3, len(extensions))
self.assertEqual([98, 99, 100], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x
self.assertEqual(3, len(extensions))
self.assertEqual([98, 99, 100], extensions)
return
def test_set_plugin_manager_at_contruction_time(self):
""" set plugin manager at construction time"""
a = PluginA()
b = PluginB()
c = PluginC()
# Start off with just two of the plugins.
application = TestApplication(
plugin_manager=PluginManager(plugins=[a, b, c])
)
application.start()
# Make sure we can get the plugins.
self.assertEqual(a, application.get_plugin('A'))
self.assertEqual(b, application.get_plugin('B'))
self.assertEqual(c, application.get_plugin('C'))
# Make sure we can't get one that isn't there ;^)
self.assertEqual(None, application.get_plugin('BOGUS'))
return
# Entry point for stand-alone testing.
if __name__ == '__main__':
unittest.main()
#### EOF ######################################################################
|
