def test_assign_empty_list_no_event(self):
""" assign empty list no event """
a = PluginA()
a.on_trait_change(listener, "x_items")
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# Assign an empty list to one of the plugin's contributions.
b.x = []
# Make sure we pick up the correct contribution via the application.
extensions = application.get_extensions("a.x")
extensions.sort()
self.assertEqual(3, len(extensions))
self.assertEqual([98, 99, 100], extensions)
# Make sure we pick up the correct contribution via the plugin.
extensions = a.x[:]
extensions.sort()
self.assertEqual(3, len(extensions))
self.assertEqual([98, 99, 100], extensions)
# We shouldn't get a trait event here because we haven't accessed the
# extension point yet!
self.assertEqual(None, listener.obj)
def test_assign_non_empty_list(self):
""" assign non-empty list """
a = PluginA()
a.on_trait_change(listener, "x_items")
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# fixme: If the extension point has not been accessed then the
# provider extension registry can't work out what has changed, so it
# won't fire a changed event.
self.assertEqual([1, 2, 3, 98, 99, 100], a.x)
# Keep the old values for later slicing check
source_values = list(a.x)
# Assign a non-empty list to one of the plugin's contributions.
b.x = [2, 4, 6, 8]
# Make sure we pick up the new contribution via the application.
extensions = application.get_extensions("a.x")
extensions.sort()
self.assertEqual(7, len(extensions))
self.assertEqual([2, 4, 6, 8, 98, 99, 100], extensions)
# Make sure we pick up the new contribution via the plugin.
extensions = a.x[:]
extensions.sort()
self.assertEqual(7, len(extensions))
self.assertEqual([2, 4, 6, 8, 98, 99, 100], extensions)
# Make sure we got a trait event telling us that the contributions
# to the extension point have been changed.
self.assertEqual(a, listener.obj)
self.assertEqual("x_items", listener.trait_name)
self.assertEqual([2, 4, 6, 8], listener.new.added)
self.assertEqual([1, 2, 3], listener.new.removed)
# The removed entry should match what the old values say
self.assertEqual(
listener.new.removed, source_values[listener.new.index]
)
# If we use the index and apply the changes to the old list, we should
# recover the new list
source_values[listener.new.index] = listener.new.added
self.assertEqual(source_values, application.get_extensions("a.x"))
self.assertEqual(0, listener.new.index.start)
self.assertEqual(3, listener.new.index.stop)
def test_set_extension_point(self):
""" set extension point """
a = PluginA()
application = TestApplication(plugins=[a])
application.start()
# Try to set the extension point.
with self.assertRaises(SystemError):
setattr(a, "x", [1, 2, 3])
def test_add_plugin(self):
""" add plugin """
a = PluginA()
a.on_trait_change(listener, "x_items")
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")
extensions.sort()
self.assertEqual(3, len(extensions))
self.assertEqual([1, 2, 3], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x[:]
extensions.sort()
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")
extensions.sort()
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[:]
extensions.sort()
self.assertEqual(6, len(extensions))
self.assertEqual([1, 2, 3, 98, 99, 100], extensions)
# Make sure we got a trait event telling us that the contributions
# to the extension point have been changed.
self.assertEqual(a, listener.obj)
self.assertEqual("x_items", listener.trait_name)
self.assertEqual([98, 99, 100], listener.new.added)
self.assertEqual([], listener.new.removed)
self.assertEqual(3, listener.new.index)
def test_remove_plugin(self):
""" remove plugin """
a = PluginA()
a.on_trait_change(listener, 'x_items')
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')
extensions.sort()
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[:]
extensions.sort()
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')
extensions.sort()
self.assertEqual(3, len(extensions))
self.assertEqual([98, 99, 100], extensions)
# Make sure we can get the contributions via the plugin.
extensions = a.x[:]
extensions.sort()
self.assertEqual(3, len(extensions))
self.assertEqual([98, 99, 100], extensions)
# Make sure we got a trait event telling us that the contributions
# to the extension point have been changed.
self.assertEqual(a, listener.obj)
self.assertEqual('x_items', listener.trait_name)
self.assertEqual([], listener.new.added)
self.assertEqual([1, 2, 3], listener.new.removed)
self.assertEqual(0, listener.new.index)
def test_mutate_extension_point_no_events(self):
""" Mutation will not emit change event for name_items """
a = PluginA()
a.on_trait_change(listener, "x_items")
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# when
a.x.append(42)
# then
self.assertIsNone(listener.obj)
def test_assign_non_empty_list(self):
""" assign non-empty list """
a = PluginA()
a.on_trait_change(listener, "x_items")
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# fixme: If the extension point has not been accessed then the
# provider extension registry can't work out what has changed, so it
# won't fire a changed event.
self.assertEqual([1, 2, 3, 98, 99, 100], a.x)
# Assign a non-empty list to one of the plugin's contributions.
b.x = [2, 4, 6, 8]
# Make sure we pick up the new contribution via the application.
extensions = application.get_extensions("a.x")
extensions.sort()
self.assertEqual(7, len(extensions))
self.assertEqual([2, 4, 6, 8, 98, 99, 100], extensions)
# Make sure we pick up the new contribution via the plugin.
extensions = a.x[:]
extensions.sort()
self.assertEqual(7, len(extensions))
self.assertEqual([2, 4, 6, 8, 98, 99, 100], extensions)
# Make sure we got a trait event telling us that the contributions
# to the extension point have been changed.
self.assertEqual(a, listener.obj)
self.assertEqual("x_items", listener.trait_name)
self.assertEqual([2, 4, 6, 8], listener.new.added)
self.assertEqual([1, 2, 3], listener.new.removed)
self.assertEqual(0, listener.new.index.start)
self.assertEqual(4, listener.new.index.stop)
def test_remove(self):
""" remove """
a = PluginA()
a.on_trait_change(listener, "x_items")
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# fixme: If the extension point has not been accessed then the
# provider extension registry can't work out what has changed, so it
# won't fire a changed event.
self.assertEqual([1, 2, 3, 98, 99, 100], a.x)
# Remove a contribution.
b.x.remove(3)
# Make sure we pick up the correct contributions via the application.
extensions = application.get_extensions("a.x")
extensions.sort()
self.assertEqual(5, len(extensions))
self.assertEqual([1, 2, 98, 99, 100], extensions)
# Make sure we pick up the correct contributions via the plugin.
extensions = a.x[:]
extensions.sort()
self.assertEqual(5, len(extensions))
self.assertEqual([1, 2, 98, 99, 100], extensions)
# Make sure we got a trait event telling us that the contributions
# to the extension point have been changed.
self.assertEqual(a, listener.obj)
self.assertEqual("x_items", listener.trait_name)
self.assertEqual([], listener.new.added)
self.assertEqual([3], listener.new.removed)
self.assertEqual(2, listener.new.index)
def test_append(self):
""" append """
a = PluginA()
a.on_trait_change(listener, 'x_items')
b = PluginB()
c = PluginC()
application = TestApplication(plugins=[a, b, c])
application.start()
# fixme: If the extension point has not been accessed then the
# provider extension registry can't work out what has changed, so it
# won't fire a changed event.
self.assertEqual([1, 2, 3, 98, 99, 100], a.x)
# Append a contribution.
b.x.append(4)
# Make sure we pick up the new contribution via the application.
extensions = application.get_extensions('a.x')
extensions.sort()
self.assertEqual(7, len(extensions))
self.assertEqual([1, 2, 3, 4, 98, 99, 100], extensions)
# Make sure we pick up the new contribution via the plugin.
extensions = a.x[:]
extensions.sort()
self.assertEqual(7, len(extensions))
self.assertEqual([1, 2, 3, 4, 98, 99, 100], extensions)
# Make sure we got a trait event telling us that the contributions
# to the extension point have been changed.
self.assertEqual(a, listener.obj)
self.assertEqual('x_items', listener.trait_name)
self.assertEqual([4], listener.new.added)
self.assertEqual([], listener.new.removed)
self.assertEqual(3, listener.new.index)