Add recipe requesting instance without failing if not ready

setup.py

@@ -100,6 +100,7 @@ setup(name=name,
           'pwgen = slapos.recipe.pwgen:Recipe',
           'proactive = slapos.recipe.proactive:Recipe',
           'request = slapos.recipe.request:Recipe',
+          'requestoptional = slapos.recipe.requestoptional:Recipe',
           'seleniumrunner = slapos.recipe.seleniumrunner:Recipe',
           'sheepdogtestbed = slapos.recipe.sheepdogtestbed:SheepDogTestBed',
           'shell = slapos.recipe.shell:Recipe',

slapos/recipe/requestoptional.py

+##############################################################################
+#
+# Copyright (c) 2010 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 logging
+
+from slapos import slap as slapmodule
+
+class Recipe(object):
+  """ Request a SlapOS instance. Won't fail if instance is not ready.
+  """
+
+  def __init__(self, buildout, name, options):
+    self.logger = logging.getLogger(name)
+
+    slap = slapmodule.slap()
+
+    self.software_release_url = options['software-url']
+    self.name = options['name']
+
+    slap.initializeConnection(options['server-url'],
+                              options.get('key-file'),
+                              options.get('cert-file'),
+                             )
+    computer_partition = slap.registerComputerPartition(
+      options['computer-id'], options['partition-id'])
+    self.request = computer_partition.request
+
+    self.isSlave = False
+    if 'slave' in options:
+      self.isSlave = options['slave'].lower() in ['y', 'yes', 'true', '1']
+
+    self.return_parameters = []
+    if 'return' in options:
+      self.return_parameters = [str(parameter).strip()
+                               for parameter in options['return'].split()]
+    else:
+      self.logger.debug("No parameter to return to main instance."
+                          "Be careful about that...")
+
+    software_type = 'RootSoftwareInstance'
+    if 'software-type' in options:
+      software_type = options['software-type']
+
+    filter_kw = {}
+    if 'sla' in options:
+      for sla_parameter in options['sla'].split():
+        filter_kw[sla_parameter] = options['sla-%s' % sla_parameter]
+
+    partition_parameter_kw = {}
+    if 'config' in options:
+      for config_parameter in options['config'].split():
+        partition_parameter_kw[config_parameter] = \
+            options['config-%s' % config_parameter]
+
+    self.instance = self.request(options['software-url'], software_type,
+      self.name, partition_parameter_kw=partition_parameter_kw,
+      filter_kw=filter_kw, shared=self.isSlave)
+
+    self.failed = None
+    for param in self.return_parameters:
+      try:
+        options['connection-%s' % param] = str(
+            self.instance.getConnectionParameter(param))
+      except slapmodule.NotFoundError:
+        options['connection-%s' % param] = ''
+        if self.failed is None:
+          self.failed = param
+
+  def install(self):
+    if self.failed is not None:
+      # Check instance status to know if instance has been deployed
+      try:
+        status = self.instance.getState()
+      except slapmodule.NotFoundError:
+        status = 'not ready yet'
+      except AttributeError:
+        status = 'unknown'
+      error_message = 'Connection parameter %s not found. '\
+          'Requested instance is currently %s. If this error persists, '\
+          'check status of this instance.' % (self.failed, status)
+      self.logger.error(error_message)
+    return []
+
+  update = install