Add an example function for converting a nova notification to a counter.

Change-Id: I05f2e42059cefb004d5afec7c28d557093eba227

ceilometer/compute/notifications.py

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright © 2012 New Dream Network, LLC (DreamHost)
+#
+# Author: Doug Hellmann <doug.hellmann@dreamhost.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+"""Converters for producing compute counter messages from notification events.
+"""
+
+from .. import signature
+
+
+def c1(body):
+    """Generate c1(instance) counters for a notice."""
+    c = {'source': '?',
+         'counter_type': 'instance',
+         'counter_volume': 1,
+         'user_id': body['payload']['user_id'],
+         'project_id': body['payload']['tenant_id'],
+         'resource_id': body['payload']['instance_id'],
+         'counter_datetime': body['timestamp'],
+         'counter_duration': 0,
+         # FIXME(dhellmann): Add region and other details to metadata
+         'resource_metadata': {'display_name':
+                                   body['payload']['display_name'],
+                               'instance_type':
+                                   body['payload']['instance_type_id'],
+                               'host': body['publisher_id'],
+                               },
+         }
+    c['message_signature'] = signature.compute_signature(c)
+    return [c]

ceilometer/signature.py

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright © 2012 New Dream Network, LLC (DreamHost)
+#
+# Author: Doug Hellmann <doug.hellmann@dreamhost.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+"""Compute the signature of a metering message.
+"""
+
+import hmac
+import hashlib
+
+
+# FIXME(dhellmann): Need to move this secret out of the code. Where?
+SECRET = 'secrete'
+
+
+def compute_signature(message):
+    """Return the signature for a message dictionary.
+    """
+    digest_maker = hmac.new(SECRET, '', hashlib.sha256)
+    for name, value in sorted(message.iteritems()):
+        if name == 'message_signature':
+            # Skip any existing signature value, which would not have
+            # been part of the original message.
+            continue
+        digest_maker.update(name)
+        digest_maker.update(unicode(value).encode('utf-8'))
+    return digest_maker.hexdigest()

tests/compute/test_notifications.py

@@ -0,0 +1,93 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright © 2012 New Dream Network, LLC (DreamHost)
+#
+# Author: Doug Hellmann <doug.hellmann@dreamhost.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+"""Tests for converters for producing compute counter messages from
+notification events.
+"""
+
+from ceilometer.compute import notifications
+
+
+INSTANCE_CREATE_END = {
+    u'_context_auth_token': u'3d8b13de1b7d499587dfc69b77dc09c2',
+    u'_context_is_admin': True,
+    u'_context_project_id': u'7c150a59fe714e6f9263774af9688f0e',
+    u'_context_quota_class': None,
+    u'_context_read_deleted': u'no',
+    u'_context_remote_address': u'10.0.2.15',
+    u'_context_request_id': u'req-d68b36e0-9233-467f-9afb-d81435d64d66',
+    u'_context_roles': [u'admin'],
+    u'_context_timestamp': u'2012-05-08T20:23:41.425105',
+    u'_context_user_id': u'1e3ce043029547f1a61c1996d1a531a2',
+    u'event_type': u'compute.instance.create.end',
+    u'message_id': u'dae6f69c-00e0-41c0-b371-41ec3b7f4451',
+    u'payload': {u'created_at': u'2012-05-08 20:23:41',
+                 u'deleted_at': u'',
+                 u'disk_gb': 0,
+                 u'display_name': u'testme',
+                 u'fixed_ips': [{u'address': u'10.0.0.2',
+                                 u'floating_ips': [],
+                                 u'meta': {},
+                                 u'type': u'fixed',
+                                 u'version': 4}],
+                 u'image_ref_url': u'http://10.0.2.15:9292/images/UUID',
+                 u'instance_id': u'9f9d01b9-4a58-4271-9e27-398b21ab20d1',
+                 u'instance_type': u'm1.tiny',
+                 u'instance_type_id': 2,
+                 u'launched_at': u'2012-05-08 20:23:47.985999',
+                 u'memory_mb': 512,
+                 u'state': u'active',
+                 u'state_description': u'',
+                 u'tenant_id': u'7c150a59fe714e6f9263774af9688f0e',
+                 u'user_id': u'1e3ce043029547f1a61c1996d1a531a2'},
+    u'priority': u'INFO',
+    u'publisher_id': u'compute.vagrant-precise',
+    u'timestamp': u'2012-05-08 20:23:48.028195',
+    }
+
+
+def compare(name, actual, expected):
+    assert actual == expected, name
+
+
+def test_c1():
+    info = notifications.c1(INSTANCE_CREATE_END)[0]
+
+    for name, actual, expected in [
+        ('counter_type', info['counter_type'], 'instance'),
+        ('counter_volume', info['counter_volume'], 1),
+        ('counter_datetime', info['counter_datetime'],
+         INSTANCE_CREATE_END['timestamp']),
+        ('user_id', info['user_id'],
+         INSTANCE_CREATE_END['payload']['user_id']),
+        ('project_id', info['project_id'],
+         INSTANCE_CREATE_END['payload']['tenant_id']),
+        ('resource_id', info['resource_id'],
+         INSTANCE_CREATE_END['payload']['instance_id']),
+        ('display_name', info['resource_metadata']['display_name'],
+         INSTANCE_CREATE_END['payload']['display_name']),
+        ('instance_type', info['resource_metadata']['instance_type'],
+         INSTANCE_CREATE_END['payload']['instance_type_id']),
+        ('host', info['resource_metadata']['host'],
+         INSTANCE_CREATE_END['publisher_id']),
+        ]:
+        yield compare, name, actual, expected
+
+
+def test_c1_signed():
+    info = notifications.c1(INSTANCE_CREATE_END)[0]
+    assert 'message_signature' in info

tests/test_signature.py

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright © 2012 New Dream Network, LLC (DreamHost)
+#
+# Author: Doug Hellmann <doug.hellmann@dreamhost.com>
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+"""Tests for converters for producing compute counter messages from
+notification events.
+"""
+
+from ceilometer import signature
+
+
+def test_change_key():
+    sig1 = signature.compute_signature({'a': 'A', 'b': 'B'})
+    sig2 = signature.compute_signature({'A': 'A', 'b': 'B'})
+    assert sig1 != sig2
+
+
+def test_change_value():
+    sig1 = signature.compute_signature({'a': 'A', 'b': 'B'})
+    sig2 = signature.compute_signature({'a': 'a', 'b': 'B'})
+    assert sig1 != sig2
+
+
+def test_same():
+    sig1 = signature.compute_signature({'a': 'A', 'b': 'B'})
+    sig2 = signature.compute_signature({'a': 'A', 'b': 'B'})
+    assert sig1 == sig2