Take care of return codes when executing scripts

As userdata plugin is doing when executing userdata scripts,
do the same for the scripts executed under the localscripts plugin.
    * move the `get_plugin_return_value` to a common place
    * properly test the method above
    * use it with the localscripts plugin and make sure to choose
      the most comprehensive plugin status and reboot requirement

Change-Id: Id3aeab079be39e2c4d3d8bf51ef10ef1c7be68e2

cloudbaseinit/plugins/common/execcmd.py

@@ -21,6 +21,7 @@ import uuid
 
 from cloudbaseinit.openstack.common import log as logging
 from cloudbaseinit.osutils import factory as osutils_factory
+from cloudbaseinit.plugins.common import base
 
 
 __all__ = (
@@ -51,6 +52,10 @@ TAG_REGEX = {
     )
 }
 
+# important return values range
+RET_START = 1001
+RET_END = 1003
+
 
 def _ec2_find_sections(data):
     """An intuitive script generator.
@@ -85,6 +90,23 @@ def _split_sections(multicmd):
         yield command
 
 
+def get_plugin_return_value(ret_val):
+    plugin_status = base.PLUGIN_EXECUTION_DONE
+    reboot = False
+
+    try:
+        ret_val = int(ret_val)
+    except (ValueError, TypeError):
+        ret_val = 0
+
+    if ret_val and RET_START <= ret_val <= RET_END:
+        reboot = bool(ret_val & 1)
+        if ret_val & 2:
+            plugin_status = base.PLUGIN_EXECUTE_ON_NEXT_BOOT
+
+    return plugin_status, reboot
+
+
 class BaseCommand(object):
     """Implements logic for executing an user command.
 

cloudbaseinit/plugins/common/localscripts.py

@@ -17,6 +17,7 @@ import os
 from oslo.config import cfg
 
 from cloudbaseinit.plugins.common import base
+from cloudbaseinit.plugins.common import execcmd
 from cloudbaseinit.plugins.common import fileexecutils
 
 opts = [
@@ -36,8 +37,17 @@ class LocalScriptsPlugin(base.BasePlugin):
                        if os.path.isfile(os.path.join(path, f))])
 
     def execute(self, service, shared_data):
+        plugin_status = base.PLUGIN_EXECUTION_DONE
+        reboot = False
+
         if CONF.local_scripts_path:
             for file_path in self._get_files_in_dir(CONF.local_scripts_path):
-                fileexecutils.exec_file(file_path)
+                ret_val = fileexecutils.exec_file(file_path)
+                new_plugin_status, new_reboot = \
+                    execcmd.get_plugin_return_value(ret_val)
+                plugin_status = max(plugin_status, new_plugin_status)
+                reboot = reboot or new_reboot
+                if reboot:
+                    break
 
-        return (base.PLUGIN_EXECUTION_DONE, False)
+        return plugin_status, reboot

cloudbaseinit/plugins/common/userdata.py

@@ -19,6 +19,7 @@ import io
 from cloudbaseinit.metadata.services import base as metadata_services_base
 from cloudbaseinit.openstack.common import log as logging
 from cloudbaseinit.plugins.common import base
+from cloudbaseinit.plugins.common import execcmd
 from cloudbaseinit.plugins.common.userdataplugins import factory
 from cloudbaseinit.plugins.common import userdatautils
 from cloudbaseinit.utils import encoding
@@ -114,7 +115,7 @@ class UserDataPlugin(base.BasePlugin):
                        'filename': part.get_filename()})
             LOG.exception(ex)
 
-        return self._get_plugin_return_value(ret_val)
+        return execcmd.get_plugin_return_value(ret_val)
 
     def _add_part_handlers(self, user_data_plugins, user_handlers,
                            new_user_handlers):
@@ -142,22 +143,6 @@ class UserDataPlugin(base.BasePlugin):
         LOG.debug("Calling part handler \"__end__\" event")
         handler_func(None, "__end__", None, None)
 
-    def _get_plugin_return_value(self, ret_val):
-        plugin_status = base.PLUGIN_EXECUTION_DONE
-        reboot = False
-
-        try:
-            ret_val = int(ret_val)
-        except (ValueError, TypeError):
-            ret_val = 0
-
-        if ret_val and 1001 <= ret_val <= 1003:
-            reboot = bool(ret_val & 1)
-            if ret_val & 2:
-                plugin_status = base.PLUGIN_EXECUTE_ON_NEXT_BOOT
-
-        return (plugin_status, reboot)
-
     def _process_non_multi_part(self, user_data):
         if user_data.startswith(b'#cloud-config'):
             user_data_plugins = factory.load_plugins()
@@ -166,4 +151,4 @@ class UserDataPlugin(base.BasePlugin):
         else:
             ret_val = userdatautils.execute_user_data_script(user_data)
 
-        return self._get_plugin_return_value(ret_val)
+        return execcmd.get_plugin_return_value(ret_val)