5c52dd
--- a/heartbeat/ocf.py	2020-04-08 13:03:20.543477544 +0200
5c52dd
+++ b/heartbeat/ocf.py	2020-04-06 10:23:45.950913519 +0200
5c52dd
@@ -88,6 +88,10 @@
5c52dd
 
5c52dd
 OCF_RESOURCE_INSTANCE = env.get("OCF_RESOURCE_INSTANCE")
5c52dd
 
5c52dd
+OCF_ACTION = env.get("__OCF_ACTION")
5c52dd
+if OCF_ACTION is None and len(argv) == 2:
5c52dd
+	OCF_ACTION = argv[1]
5c52dd
+
5c52dd
 HA_DEBUG = env.get("HA_debug", 0)
5c52dd
 HA_DATEFMT = env.get("HA_DATEFMT", "%b %d %T ")
5c52dd
 HA_LOGFACILITY = env.get("HA_LOGFACILITY")
5c52dd
@@ -135,3 +139,343 @@
5c52dd
 	log.addHandler(dfh)
5c52dd
 
5c52dd
 logger = logging.LoggerAdapter(log, {'OCF_RESOURCE_INSTANCE': OCF_RESOURCE_INSTANCE})
5c52dd
+
5c52dd
+
5c52dd
+_exit_reason_set = False
5c52dd
+
5c52dd
+def ocf_exit_reason(msg):
5c52dd
+	"""
5c52dd
+	Print exit error string to stderr.
5c52dd
+
5c52dd
+	Allows the OCF agent to provide a string describing
5c52dd
+	why the exit code was returned.
5c52dd
+	"""
5c52dd
+	global _exit_reason_set
5c52dd
+	cookie = env.get("OCF_EXIT_REASON_PREFIX", "ocf-exit-reason:")
5c52dd
+	sys.stderr.write("{}{}\n".format(cookie, msg))
5c52dd
+	sys.stderr.flush()
5c52dd
+	logger.error(msg)
5c52dd
+	_exit_reason_set = True
5c52dd
+
5c52dd
+
5c52dd
+def have_binary(name):
5c52dd
+	"""
5c52dd
+	True if binary exists, False otherwise.
5c52dd
+	"""
5c52dd
+	def _access_check(fn):
5c52dd
+		return (os.path.exists(fn) and
5c52dd
+				os.access(fn, os.F_OK | os.X_OK) and
5c52dd
+				not os.path.isdir(fn))
5c52dd
+	if _access_check(name):
5c52dd
+		return True
5c52dd
+	path = env.get("PATH", os.defpath).split(os.pathsep)
5c52dd
+	seen = set()
5c52dd
+	for dir in path:
5c52dd
+		dir = os.path.normcase(dir)
5c52dd
+		if dir not in seen:
5c52dd
+			seen.add(dir)
5c52dd
+			name2 = os.path.join(dir, name)
5c52dd
+			if _access_check(name2):
5c52dd
+				return True
5c52dd
+	return False
5c52dd
+
5c52dd
+
5c52dd
+def is_true(val):
5c52dd
+	"""
5c52dd
+	Convert an OCF truth value to a
5c52dd
+	Python boolean.
5c52dd
+	"""
5c52dd
+	return val in ("yes", "true", "1", 1, "YES", "TRUE", "ja", "on", "ON", True)
5c52dd
+
5c52dd
+
5c52dd
+def is_probe():
5c52dd
+	"""
5c52dd
+	A probe is defined as a monitor operation
5c52dd
+	with an interval of zero. This is called
5c52dd
+	by Pacemaker to check the status of a possibly
5c52dd
+	not running resource.
5c52dd
+	"""
5c52dd
+	return (OCF_ACTION == "monitor" and
5c52dd
+			env.get("OCF_RESKEY_CRM_meta_interval", "") == "0")
5c52dd
+
5c52dd
+
5c52dd
+def get_parameter(name, default=None):
5c52dd
+	"""
5c52dd
+	Extract the parameter value from the environment
5c52dd
+	"""
5c52dd
+	return env.get("OCF_RESKEY_{}".format(name), default)
5c52dd
+
5c52dd
+
5c52dd
+def distro():
5c52dd
+	"""
5c52dd
+	Return name of distribution/platform.
5c52dd
+
5c52dd
+	If possible, returns "name/version", else
5c52dd
+	just "name".
5c52dd
+	"""
5c52dd
+	import subprocess
5c52dd
+	import platform
5c52dd
+	try:
5c52dd
+		ret = subprocess.check_output(["lsb_release", "-si"])
5c52dd
+		if type(ret) != str:
5c52dd
+			ret = ret.decode()
5c52dd
+		distro = ret.strip()
5c52dd
+		ret = subprocess.check_output(["lsb_release", "-sr"])
5c52dd
+		if type(ret) != str:
5c52dd
+			ret = ret.decode()
5c52dd
+		version = ret.strip()
5c52dd
+		return "{}/{}".format(distro, version)
5c52dd
+	except Exception:
5c52dd
+		if os.path.exists("/etc/debian_version"):
5c52dd
+			return "Debian"
5c52dd
+		if os.path.exists("/etc/SuSE-release"):
5c52dd
+			return "SUSE"
5c52dd
+		if os.path.exists("/etc/redhat-release"):
5c52dd
+			return "Redhat"
5c52dd
+	return platform.system()
5c52dd
+
5c52dd
+
5c52dd
+class Parameter(object):
5c52dd
+	def __init__(self, name, shortdesc, longdesc, content_type, unique, required, default):
5c52dd
+		self.name = name
5c52dd
+		self.shortdesc = shortdesc
5c52dd
+		self.longdesc = longdesc
5c52dd
+		self.content_type = content_type
5c52dd
+		self.unique = unique
5c52dd
+		self.required = required
5c52dd
+		self.default = default
5c52dd
+
5c52dd
+	def __str__(self):
5c52dd
+		return self.to_xml()
5c52dd
+
5c52dd
+	def to_xml(self):
5c52dd
+		ret = '
5c52dd
+		if self.unique:
5c52dd
+			ret += ' unique="1"'
5c52dd
+		if self.required:
5c52dd
+			ret += ' required="1"'
5c52dd
+		ret += ">\n"
5c52dd
+		ret += '<longdesc lang="en">' + self.longdesc + '</longdesc>' + "\n"
5c52dd
+		ret += '<shortdesc lang="en">' + self.shortdesc + '</shortdesc>' + "\n"
5c52dd
+		ret += '
5c52dd
+		if self.default is not None:
5c52dd
+			ret += ' default="{}"'.format(self.default)
5c52dd
+		ret += " />\n"
5c52dd
+		ret += "</parameter>\n"
5c52dd
+		return ret
5c52dd
+
5c52dd
+
5c52dd
+
5c52dd
+class Action(object):
5c52dd
+	def __init__(self, name, timeout, interval, depth, role):
5c52dd
+		self.name = name
5c52dd
+		self.timeout = timeout
5c52dd
+		self.interval = interval
5c52dd
+		self.depth = depth
5c52dd
+		self.role = role
5c52dd
+
5c52dd
+	def __str__(self):
5c52dd
+		return self.to_xml()
5c52dd
+
5c52dd
+	def to_xml(self):
5c52dd
+		def opt(s, name, var):
5c52dd
+			if var is not None:
5c52dd
+				if type(var) == int and name in ("timeout", "interval"):
5c52dd
+					var = "{}s".format(var)
5c52dd
+				return s + ' {}="{}"'.format(name, var)
5c52dd
+			return s
5c52dd
+		ret = '
5c52dd
+		ret = opt(ret, "timeout", self.timeout)
5c52dd
+		ret = opt(ret, "interval", self.interval)
5c52dd
+		ret = opt(ret, "depth", self.depth)
5c52dd
+		ret = opt(ret, "role", self.role)
5c52dd
+		ret += " />\n"
5c52dd
+		return ret
5c52dd
+
5c52dd
+
5c52dd
+class Agent(object):
5c52dd
+	"""
5c52dd
+	OCF Resource Agent metadata XML generator helper.
5c52dd
+
5c52dd
+	Use add_parameter/add_action to define parameters
5c52dd
+	and actions for the agent. Then call run() to
5c52dd
+	start the agent main loop.
5c52dd
+
5c52dd
+	See doc/dev-guides/writing-python-agents.md for an example
5c52dd
+	of how to use it.
5c52dd
+	"""
5c52dd
+
5c52dd
+	def __init__(self, name, shortdesc, longdesc):
5c52dd
+		self.name = name
5c52dd
+		self.shortdesc = shortdesc
5c52dd
+		self.longdesc = longdesc
5c52dd
+		self.parameters = []
5c52dd
+		self.actions = []
5c52dd
+		self._handlers = {}
5c52dd
+
5c52dd
+	def add_parameter(self, name, shortdesc="", longdesc="", content_type="string", unique=False, required=False, default=None):
5c52dd
+		for param in self.parameters:
5c52dd
+			if param.name == name:
5c52dd
+				raise ValueError("Parameter {} defined twice in metadata".format(name))
5c52dd
+		self.parameters.append(Parameter(name=name,
5c52dd
+										 shortdesc=shortdesc,
5c52dd
+										 longdesc=longdesc,
5c52dd
+										 content_type=content_type,
5c52dd
+										 unique=unique,
5c52dd
+										 required=required,
5c52dd
+										 default=default))
5c52dd
+		return self
5c52dd
+
5c52dd
+	def add_action(self, name, timeout=None, interval=None, depth=None, role=None, handler=None):
5c52dd
+		self.actions.append(Action(name=name,
5c52dd
+								   timeout=timeout,
5c52dd
+								   interval=interval,
5c52dd
+								   depth=depth,
5c52dd
+								   role=role))
5c52dd
+		if handler is not None:
5c52dd
+			self._handlers[name] = handler
5c52dd
+		return self
5c52dd
+
5c52dd
+	def __str__(self):
5c52dd
+		return self.to_xml()
5c52dd
+
5c52dd
+	def to_xml(self):
5c52dd
+		return """
5c52dd
+
5c52dd
+<resource-agent name="{name}">
5c52dd
+<version>1.0</version>
5c52dd
+<longdesc lang="en">
5c52dd
+{longdesc}
5c52dd
+</longdesc>
5c52dd
+<shortdesc lang="en">{shortdesc}</shortdesc>
5c52dd
+
5c52dd
+<parameters>
5c52dd
+{parameters}
5c52dd
+</parameters>
5c52dd
+
5c52dd
+<actions>
5c52dd
+{actions}
5c52dd
+</actions>
5c52dd
+
5c52dd
+</resource-agent>
5c52dd
+""".format(name=self.name,
5c52dd
+		   longdesc=self.longdesc,
5c52dd
+		   shortdesc=self.shortdesc,
5c52dd
+		   parameters="".join(p.to_xml() for p in self.parameters),
5c52dd
+		   actions="".join(a.to_xml() for a in self.actions))
5c52dd
+
5c52dd
+	def run(self):
5c52dd
+		run(self)
5c52dd
+
5c52dd
+
5c52dd
+def run(agent, handlers=None):
5c52dd
+	"""
5c52dd
+	Main loop implementation for resource agents.
5c52dd
+	Does not return.
5c52dd
+
5c52dd
+	Arguments:
5c52dd
+
5c52dd
+	agent: Agent object.
5c52dd
+
5c52dd
+	handlers: Dict of action name to handler function.
5c52dd
+
5c52dd
+	Handler functions can take parameters as arguments,
5c52dd
+	the run loop will read parameter values from the
5c52dd
+	environment and pass to the handler.
5c52dd
+	"""
5c52dd
+	import inspect
5c52dd
+
5c52dd
+	agent._handlers.update(handlers or {})
5c52dd
+	handlers = agent._handlers
5c52dd
+
5c52dd
+	def check_required_params():
5c52dd
+		for p in agent.parameters:
5c52dd
+			if p.required and get_parameter(p.name) is None:
5c52dd
+				ocf_exit_reason("{}: Required parameter not set".format(p.name))
5c52dd
+				sys.exit(OCF_ERR_CONFIGURED)
5c52dd
+
5c52dd
+	def call_handler(func):
5c52dd
+		if hasattr(inspect, 'signature'):
5c52dd
+			params = inspect.signature(func).parameters.keys()
5c52dd
+		else:
5c52dd
+			params = inspect.getargspec(func).args
5c52dd
+		def value_for_parameter(param):
5c52dd
+			val = get_parameter(param)
5c52dd
+			if val is not None:
5c52dd
+				return val
5c52dd
+			for p in agent.parameters:
5c52dd
+				if p.name == param:
5c52dd
+					return p.default
5c52dd
+		arglist = [value_for_parameter(p) for p in params]
5c52dd
+		try:
5c52dd
+			rc = func(*arglist)
5c52dd
+			if rc is None:
5c52dd
+				rc = OCF_SUCCESS
5c52dd
+			return rc
5c52dd
+		except Exception as err:
5c52dd
+			if not _exit_reason_set:
5c52dd
+				ocf_exit_reason(str(err))
5c52dd
+			else:
5c52dd
+				logger.error(str(err))
5c52dd
+			return OCF_ERR_GENERIC
5c52dd
+
5c52dd
+	meta_data_action = False
5c52dd
+	for action in agent.actions:
5c52dd
+		if action.name == "meta-data":
5c52dd
+			meta_data_action = True
5c52dd
+			break
5c52dd
+	if not meta_data_action:
5c52dd
+		agent.add_action("meta-data", timeout=10)
5c52dd
+
5c52dd
+	if len(sys.argv) == 2 and sys.argv[1] in ("-h", "--help"):
5c52dd
+		sys.stdout.write("usage: %s {%s}\n\n" % (sys.argv[0], "|".join(sorted(handlers.keys()))) +
5c52dd
+		                 "Expects to have a fully populated OCF RA compliant environment set.\n")
5c52dd
+		sys.exit(OCF_SUCCESS)
5c52dd
+
5c52dd
+	if OCF_ACTION is None:
5c52dd
+		ocf_exit_reason("No action argument set")
5c52dd
+		sys.exit(OCF_ERR_UNIMPLEMENTED)
5c52dd
+	if OCF_ACTION in ('meta-data', 'usage', 'methods'):
5c52dd
+		sys.stdout.write(agent.to_xml() + "\n")
5c52dd
+		sys.exit(OCF_SUCCESS)
5c52dd
+
5c52dd
+	check_required_params()
5c52dd
+	if OCF_ACTION in handlers:
5c52dd
+		rc = call_handler(handlers[OCF_ACTION])
5c52dd
+		sys.exit(rc)
5c52dd
+	sys.exit(OCF_ERR_UNIMPLEMENTED)
5c52dd
+
5c52dd
+
5c52dd
+if __name__ == "__main__":
5c52dd
+	import unittest
5c52dd
+
5c52dd
+	class TestMetadata(unittest.TestCase):
5c52dd
+		def test_noparams_noactions(self):
5c52dd
+			m = Agent("foo", shortdesc="shortdesc", longdesc="longdesc")
5c52dd
+			self.assertEqual("""
5c52dd
+
5c52dd
+<resource-agent name="foo">
5c52dd
+<version>1.0</version>
5c52dd
+<longdesc lang="en">
5c52dd
+longdesc
5c52dd
+</longdesc>
5c52dd
+<shortdesc lang="en">shortdesc</shortdesc>
5c52dd
+
5c52dd
+<parameters>
5c52dd
+
5c52dd
+</parameters>
5c52dd
+
5c52dd
+<actions>
5c52dd
+
5c52dd
+</actions>
5c52dd
+
5c52dd
+</resource-agent>
5c52dd
+""", str(m))
5c52dd
+
5c52dd
+		def test_params_actions(self):
5c52dd
+			m = Agent("foo", shortdesc="shortdesc", longdesc="longdesc")
5c52dd
+			m.add_parameter("testparam")
5c52dd
+			m.add_action("start")
5c52dd
+			self.assertEqual(str(m.actions[0]), '<action name="start" />\n')
5c52dd
+
5c52dd
+	unittest.main()