Add the framework for a test suite

Add the framework for a test suite for the Telepathy backend, including
a dummy account manager, account and connection, to allow complete control
over the personas created in libfolks.

This comes with a test case framework which wraps the GLib test framework,
used by a test case which tests that all expected individuals are exposed by
the individual aggregator.

Heavily based on work by Travis Reitter <travis.reitter@collabora.co.uk>.

1 files changed, 175 insertions, 0 deletions

diff --git a/tools/manager-file.py b/tools/manager-file.py
new file mode 100755
index 0000000..45f6404
--- /dev/null
+++ b/tools/manager-file.py
@@ -0,0 +1,175 @@
+#!/usr/bin/python
+
+# manager-file.py: generate .manager files and TpCMParamSpec arrays from the
+# same data (should be suitable for all connection managers that don't have
+# plugins)
+#
+# The master copy of this program is in the telepathy-glib repository -
+# please make any changes there.
+#
+# Copyright (c) Collabora Ltd. <http://www.collabora.co.uk/>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+import re
+import sys
+
+_NOT_C_STR = re.compile(r'[^A-Za-z0-9_-]')
+
+def c_string(x):
+    # whitelist-based brute force and ignorance - escape nearly all punctuation
+    return '"' + _NOT_C_STR.sub(lambda c: r'\x%02x' % ord(c), x) + '"'
+
+def desktop_string(x):
+    return x.replace(' ', r'\s').replace('\n', r'\n').replace('\r', r'\r').replace('\t', r'\t')
+
+supported = list('sbuiqn')
+
+fdefaultencoders = {
+        's': desktop_string,
+        'b': (lambda b: b and '1' or '0'),
+        'u': (lambda n: '%u' % n),
+        'i': (lambda n: '%d' % n),
+        'q': (lambda n: '%u' % n),
+        'n': (lambda n: '%d' % n),
+        }
+for x in supported: assert x in fdefaultencoders
+
+gtypes = {
+        's': 'G_TYPE_STRING',
+        'b': 'G_TYPE_BOOLEAN',
+        'u': 'G_TYPE_UINT',
+        'i': 'G_TYPE_INT',
+        'q': 'G_TYPE_UINT',
+        'n': 'G_TYPE_INT',
+}
+for x in supported: assert x in gtypes
+
+gdefaultencoders = {
+        's': c_string,
+        'b': (lambda b: b and 'GINT_TO_POINTER (TRUE)' or 'GINT_TO_POINTER (FALSE)'),
+        'u': (lambda n: 'GUINT_TO_POINTER (%u)' % n),
+        'i': (lambda n: 'GINT_TO_POINTER (%d)' % n),
+        'q': (lambda n: 'GUINT_TO_POINTER (%u)' % n),
+        'n': (lambda n: 'GINT_TO_POINTER (%d)' % n),
+        }
+for x in supported: assert x in gdefaultencoders
+
+gdefaultdefaults = {
+        's': 'NULL',
+        'b': 'GINT_TO_POINTER (FALSE)',
+        'u': 'GUINT_TO_POINTER (0)',
+        'i': 'GINT_TO_POINTER (0)',
+        'q': 'GUINT_TO_POINTER (0)',
+        'n': 'GINT_TO_POINTER (0)',
+        }
+for x in supported: assert x in gdefaultdefaults
+
+gflags = {
+        'has-default': 'TP_CONN_MGR_PARAM_FLAG_HAS_DEFAULT',
+        'register': 'TP_CONN_MGR_PARAM_FLAG_REGISTER',
+        'required': 'TP_CONN_MGR_PARAM_FLAG_REQUIRED',
+        'secret': 'TP_CONN_MGR_PARAM_FLAG_SECRET',
+        'dbus-property': 'TP_CONN_MGR_PARAM_FLAG_DBUS_PROPERTY',
+}
+
+def write_manager(f, manager, protos):
+    # pointless backwards compat section
+    print >> f, '[ConnectionManager]'
+    print >> f, 'BusName=org.freedesktop.Telepathy.ConnectionManager.' + manager
+    print >> f, 'ObjectPath=/org/freedesktop/Telepathy/ConnectionManager/' + manager
+
+    # protocols
+    for proto, params in protos.iteritems():
+        print >> f
+        print >> f, '[Protocol %s]' % proto
+
+        defaults = {}
+
+        for param, info in params.iteritems():
+            dtype = info['dtype']
+            flags = info.get('flags', '').split()
+            struct_field = info.get('struct_field', param.replace('-', '_'))
+            filter = info.get('filter', 'NULL')
+            filter_data = info.get('filter_data', 'NULL')
+            setter_data = 'NULL'
+
+            if 'default' in info:
+                default = fdefaultencoders[dtype](info['default'])
+                defaults[param] = default
+
+            if flags:
+                flags = ' ' + ' '.join(flags)
+            else:
+                flags = ''
+
+            print >> f, 'param-%s=%s%s' % (param, desktop_string(dtype), flags)
+
+        for param, default in defaults.iteritems():
+            print >> f, 'default-%s=%s' % (param, default)
+
+def write_c_params(f, manager, proto, struct, params):
+    print >> f, "static const TpCMParamSpec %s_%s_params[] = {" % (manager, proto)
+
+    for param, info in params.iteritems():
+        dtype = info['dtype']
+        flags = info.get('flags', '').split()
+        struct_field = info.get('struct_field', param.replace('-', '_'))
+        filter = info.get('filter', 'NULL')
+        filter_data = info.get('filter_data', 'NULL')
+        setter_data = 'NULL'
+
+        if 'default' in info:
+            default = gdefaultencoders[dtype](info['default'])
+        else:
+            default = gdefaultdefaults[dtype]
+
+        if flags:
+            flags = ' | '.join([gflags[flag] for flag in flags])
+        else:
+            flags = '0'
+
+        if struct is None or struct_field is None:
+            struct_offset = '0'
+        else:
+            struct_offset = 'G_STRUCT_OFFSET (%s, %s)' % (struct, struct_field)
+
+        print >> f, ('''  { %s, %s, %s,
+    %s,
+    %s, /* default */
+    %s, /* struct offset */
+    %s, /* filter */
+    %s, /* filter data */
+    %s /* setter data */ },''' %
+                (c_string(param), c_string(dtype), gtypes[dtype], flags,
+                    default, struct_offset, filter, filter_data, setter_data))
+
+    print >> f, "  { NULL }"
+    print >> f, "};"
+
+if __name__ == '__main__':
+    environment = {}
+    execfile(sys.argv[1], environment)
+
+    f = open('%s/%s.manager' % (sys.argv[2], environment['MANAGER']), 'w')
+    write_manager(f, environment['MANAGER'], environment['PARAMS'])
+    f.close()
+
+    f = open('%s/param-spec-struct.h' % sys.argv[2], 'w')
+    for protocol in environment['PARAMS']:
+        write_c_params(f, environment['MANAGER'], protocol,
+                environment['STRUCTS'][protocol],
+                environment['PARAMS'][protocol])
+    f.close()