def test_disable_synchronized_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(), request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client, plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
self.assertTrue(result['enabled'])
# Update plugin_configuration
logic.enable_plugin_configuration(self.client, plugin_configuration_ref, enabled=False)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
self.assertFalse(result['enabled'])
def test_update_synchronized_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(), request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client, plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
self.assertEqual(result['config']['second'], plugin_configuration_ref.config['second'])
# Update plugin_configuration
new_value = 5
self.assertNotEqual(new_value, plugin_configuration_ref.config['second'])
plugin_configuration_ref.config['second'] = new_value
plugin_configuration_ref.save()
logic.publish_plugin_configuration(self.client, plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
self.assertEqual(result['config']['second'], plugin_configuration_ref.config['second'])
def test_create_oauth2_plugin_with_scopes(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(),
request_host=fake.domain_name())
# Create plugin_configuration_ref
plugin_configuration_ref = PluginConfigurationReferenceFactory(
api=api_ref,
plugin=Plugins.OAUTH2_AUTHENTICATION,
config={'scopes': 'email,subscriptions,topups'})
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Reload plugin configuration
plugin_configuration_ref = PluginConfigurationReference.objects.get(
id=plugin_configuration_ref.id)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
self.assertEqual(result['config']['scopes'],
['email', 'subscriptions', 'topups'])
def test_delete_synchronized_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(),
request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(
api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client,
plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
# Delete plugin_configuration
plugin_configuration_kong_id = plugin_configuration_ref.kong_id
plugin_configuration_ref.delete()
# Check
with self.assertRaises(ValueError):
_ = self.client.apis.plugins(
api_ref.kong_id).retrieve(plugin_configuration_kong_id)
def test_delete_synchronized_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(), request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client, plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
# Delete plugin_configuration
plugin_configuration_kong_id = plugin_configuration_ref.kong_id
plugin_configuration_ref.delete()
# Check
with self.assertRaises(ValueError):
_ = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_kong_id)
def test_sync_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(),
request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Check if remote upstream_url matches the locally known upstream_url
result = self.client.apis.retrieve(api_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['upstream_url'], api_ref.upstream_url)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(
api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client,
plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
def on_publish(self, client, obj):
api_kong_id = obj.api.kong_id
consumer_kong_id = obj.consumer.kong_id if obj.consumer is not None else None
try:
plugin_configuration_struct = client.apis.plugins(
str(api_kong_id)).create_or_update(
plugin_configuration_id=obj.kong_id,
plugin_name=Plugins.label(obj.plugin),
enabled=obj.enabled,
consumer_id=consumer_kong_id,
**obj.config)
except ConflictError:
plugin_configuration_struct = client.apis.plugins(
str(api_kong_id)).update(plugin_id=obj.name,
enabled=obj.enabled,
consumer_id=consumer_kong_id,
**obj.config)
config = plugin_configuration_struct['config']
if obj.config != config:
obj.config = config
self.get_proxy_class().objects.filter(id=obj.id).update(
config=obj.config)
return plugin_configuration_struct['id']
def test_sync_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(), request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Check if remote upstream_url matches the locally known upstream_url
result = self.client.apis.retrieve(api_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['upstream_url'], api_ref.upstream_url)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client, plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
def test_update_synchronized_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(),
request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(
api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client,
plugin_configuration_ref)
# Check if remote plugin name matches the locally known plugin, and that the configuration matches the locally
# known configuration
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
self.assertEqual(result['config']['second'],
plugin_configuration_ref.config['second'])
# Update plugin_configuration
new_value = 5
self.assertNotEqual(new_value,
plugin_configuration_ref.config['second'])
plugin_configuration_ref.config['second'] = new_value
plugin_configuration_ref.save()
logic.publish_plugin_configuration(self.client,
plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
self.assertEqual(result['config']['second'],
plugin_configuration_ref.config['second'])
def test_disable_synchronized_plugin_configuration(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(),
request_host=fake.domain_name())
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Create plugin_configuration
plugin_configuration_ref = PluginConfigurationReferenceFactory(
api=api_ref)
# Publish plugin_configuration
logic.synchronize_plugin_configuration(self.client,
plugin_configuration_ref)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
self.assertTrue(result['enabled'])
# Update plugin_configuration
logic.enable_plugin_configuration(self.client,
plugin_configuration_ref,
enabled=False)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(
plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'],
Plugins.label(plugin_configuration_ref.plugin))
self.assertFalse(result['enabled'])
def on_publish(self, client, obj):
api_kong_id = obj.api.kong_id
consumer_kong_id = obj.consumer.kong_id if obj.consumer is not None else None
try:
plugin_configuration_struct = client.apis.plugins(str(api_kong_id)).create_or_update(
plugin_configuration_id=obj.kong_id, plugin_name=Plugins.label(obj.plugin), enabled=obj.enabled,
consumer_id=consumer_kong_id, **obj.config)
except ConflictError:
plugin_configuration_struct = client.apis.plugins(str(api_kong_id)).update(
plugin_id=obj.name, enabled=obj.enabled, consumer_id=consumer_kong_id, **obj.config)
config = plugin_configuration_struct['config']
if obj.config != config:
obj.config = config
self.get_proxy_class().objects.filter(id=obj.id).update(config=obj.config)
return plugin_configuration_struct['id']
def test_create_oauth2_plugin(self):
# Create api_ref
api_ref = APIReferenceFactory(upstream_url=fake.url(), request_host=fake.domain_name())
# Create plugin_configuration_ref
plugin_configuration_ref = PluginConfigurationReferenceFactory(
api=api_ref, plugin=Plugins.OAUTH2_AUTHENTICATION, config={})
# Mark for auto cleanup
self._cleanup_afterwards(api_ref)
# Publish api
logic.synchronize_api(self.client, api_ref)
# Reload plugin configuration
plugin_configuration_ref = PluginConfigurationReference.objects.get(id=plugin_configuration_ref.id)
# Check
result = self.client.apis.plugins(api_ref.kong_id).retrieve(plugin_configuration_ref.kong_id)
self.assertIsNotNone(result)
self.assertEqual(result['name'], Plugins.label(plugin_configuration_ref.plugin))
