DMTF CADF format

Adding support for the DMTF Cloud Audit (CADF) format which will be
used along with a generic notification filter to audit 'core'
component APIs.

initial code drop

blueprint support-standard-audit-formats

Change-Id: I3b27ceae8faa6427e4be1290c1406102e790e2e3

1 files changed, 61 insertions, 0 deletions

diff --git a/pycadf/attachment.py b/pycadf/attachment.py
new file mode 100644
index 0000000..77cf425
--- /dev/null
+++ b/pycadf/attachment.py
@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2013 IBM Corp.
+#
+# Author: Matt Rutkowski <mrutkows@us.ibm.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.
+
+from pycadf import cadftype
+
+ATTACHMENT_KEYNAME_TYPEURI = "typeURI"
+ATTACHMENT_KEYNAME_CONTENT = "content"
+ATTACHMENT_KEYNAME_NAME = "name"
+
+ATTACHMENT_KEYNAMES = [ATTACHMENT_KEYNAME_TYPEURI,
+                       ATTACHMENT_KEYNAME_CONTENT,
+                       ATTACHMENT_KEYNAME_NAME]
+
+
+class Attachment(cadftype.CADFAbstractType):
+
+    # TODO(mrutkows): OpenStack / Ceilometer may want to define
+    # the set of approved attachment types in order to
+    # limit and validate them.
+    typeURI = cadftype.ValidatorDescriptor(ATTACHMENT_KEYNAME_TYPEURI,
+                                           lambda x: isinstance(x, str))
+    content = cadftype.ValidatorDescriptor(ATTACHMENT_KEYNAME_CONTENT)
+    name = cadftype.ValidatorDescriptor(ATTACHMENT_KEYNAME_NAME,
+                                        lambda x: isinstance(x, str))
+
+    def __init__(self, typeURI=None, content=None, name=None):
+        # Attachment.typeURI
+        if typeURI is not None:
+            setattr(self, ATTACHMENT_KEYNAME_TYPEURI, typeURI)
+
+        # Attachment.content
+        if content is not None:
+            setattr(self, ATTACHMENT_KEYNAME_CONTENT, content)
+
+        # Attachment.name
+        if name is not None:
+            setattr(self, ATTACHMENT_KEYNAME_NAME, name)
+
+    # self validate cadf:Attachment type against schema
+    def is_valid(self):
+        # Existence test, All attributes must exist for valid Attachment type
+        return (
+            hasattr(self, ATTACHMENT_KEYNAME_TYPEURI) and
+            hasattr(self, ATTACHMENT_KEYNAME_NAME) and
+            hasattr(self, ATTACHMENT_KEYNAME_CONTENT)
+        )