Add recipe fetching slap parameters.

setup.py

@@ -121,6 +121,7 @@ setup(name=name,
           'erp5.test = slapos.recipe.erp5_test:Recipe',
           'generic.varnish = slapos.recipe.generic_varnish:Recipe',
           'webchecker = slapos.recipe.web_checker:Recipe',
+          'slapparameters = slapos.recipe.slapparameters:Recipe',
         ],
         'slapos.recipe.nosqltestbed.plugin': [
           'kumo = slapos.recipe.nosqltestbed.kumo:KumoTestBed',

slapos/recipe/slapparameters.py

+##############################################################################
+#
+# Copyright (c) 2012 Vifib SARL and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 3
+# of the License, or (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+import slapos.slap
+import json
+from ConfigParser import RawConfigParser
+
+cast_dict = {
+    'json': (True, json.dumps),
+    'str': (False, str),
+}
+
+class Recipe(object):
+  """
+  Retrieves slap partition parameters, and makes them available to other
+  buildout section in various ways, and in various encodings.
+  Populates the buildout section it is used in with all slap partition
+  parameters.
+
+  Input:
+    url
+      Slap server url.
+      Example:
+        ${slap-connection:server-url}
+    key & cert (optional)
+      Path of files containing key and certificate for secure connection to
+      slap server.
+      Example:
+        ${slap-connection:key-file}
+        ${slap-connection:cert-file}
+    computer
+      Computer identifier.
+      Example:
+        ${slap-connection:computer-id}
+    partition
+      Partition identifier.
+      Example:
+        ${slap-connection:partition-id}
+    unsafe (optional, 0 by default)
+      Enables formats which are unsafe when represented back into a buildout
+      text file. Set to 0 to explicitly disable unsafe formats, any other
+      integer value to enable them.
+
+  Output:
+    One key per supported serialisation format, with all partition parameters
+    serialised in that format as values and format's name.
+    Also, one key per partition parameter, prefixed with serialisation format
+    followed by a dot. Example:
+      json = {"foo": "bar"}
+      json.foo = "bar"
+
+  Supported serailisation formats:
+    json (safe)
+      JavaScript Object Notation
+    str (unsafe)
+      Python string representation.
+  """
+
+  # XXX: used to detect if a configuration key is a valid section key. This
+  # assumes buildout uses ConfigParser - which is currently the case.
+  OPTCRE = RawConfigParser.OPTCRE
+
+  def __init__(self, buildout, name, options):
+      slap = slapos.slap.slap()
+      slap.initializeConnection(
+        options['url'],
+        options.get('key'),
+        options.get('cert'),
+      )
+      parameter_dict = slap.registerComputerPartition(
+        options['computer'],
+        options['partition'],
+      ).getInstanceParameterDict()
+      allow_unsafe = bool(int(options.get('unsafe', '0')))
+      match = self.OPTCRE.match
+      for name, (safe, cast) in cast_dict.iteritems():
+          if not safe and not allow_unsafe:
+              continue
+          options[name] = cast(parameter_dict)
+          for key, value in parameter_dict.iteritems():
+              if match(key) is not None:
+                  # It should be OK to skip silently and unconditionally: such
+                  # parameter cannot be accessed in a well-formed buildout
+                  # config.
+                  continue
+              options[name + '.' + key] = cast(value)
+
+  def install(self):
+      return []
+