Merge pull request #15 from hmrc/ADD_APPEND_ARGS

ADD_APPEND_ARGS Adding capability of play apps to take extra args. Merging post review

Author: vaughansharman

servicemanager/server/smserverlogic.py

@@ -6,6 +6,7 @@
 import sys
 import traceback
 import re
+import types
 
 from abc import abstractmethod
 from bottle import request, response
@@ -193,12 +194,13 @@ def _start_services(self, orchestration_services, service_mapping_ports, proxy):
             run_from = orchestration_services[service_name]["runFrom"]
             classifier = orchestration_services[service_name]["classifier"]
             version = orchestration_services[service_name]["version"]
+            append_args = orchestration_services[service_name]["appendArgs"] # Allows for dynamic config overriding
 
             # Allow for deprecated run_from values
             if run_from in deprecated_release_params:
                 run_from = deprecated_release_params[run_from]
 
-            self.context.start_service(service_name, run_from, proxy, classifier, service_mapping_ports, port, admin_port, version)
+            self.context.start_service(service_name, run_from, proxy, classifier, service_mapping_ports, port, admin_port, version, append_args)
 
     def _await_service_startup(self, service_name, port, admin_port):
         seconds_remaining = SERVICE_START_TIMEOUT_SECONDS
@@ -268,6 +270,8 @@ def _service_mapping_for(self, service_start_request):
         if "version" in service_start_request and service_start_request["version"]:
             version = service_start_request["version"]
 
+        append_args = service_start_request.get("appendArgs", [])
+
         if need_classifier:
 
             valid_classifiers = "[" + (",".join(str(x) for x in mapping.keys())) + "]"
@@ -290,7 +294,7 @@ def _service_mapping_for(self, service_start_request):
             service_name = mapping
             classifier = None
 
-        return service_mapping_name, service_name, classifier, version
+        return service_mapping_name, service_name, classifier, version, append_args
 
     def _validate_start_request_and_assign_ports(self, services_to_start, dontrunfromsource):
 
@@ -299,7 +303,10 @@ def _validate_start_request_and_assign_ports(self, services_to_start, dontrunfro
 
         for service_start_request in services_to_start:
 
-            service_mapping_name, service_name, classifier, version = self._service_mapping_for(service_start_request)
+            service_mapping_name, service_name, classifier, version, append_args = self._service_mapping_for(service_start_request)
+
+            if append_args and not isinstance(append_args, types.ListType):
+                raise self._bad_request_exception("ERROR: I was passed a non list for append args of '" + str(append_args) + "' I dont know what to do with this")
 
             if service_mapping_name in service_mapping_ports:
                 raise self._bad_request_exception("Duplicate entry for service '%s' in start request" % service_mapping_name)
@@ -313,6 +320,9 @@ def _validate_start_request_and_assign_ports(self, services_to_start, dontrunfro
                 if run_from == "SOURCE":
                     raise self._bad_request_exception("runFrom parameter has value '%s', however --nosource was specified when smserver started" % run_from)
 
+            if append_args and not self.context.get_service_starter(service_name, run_from, None).supports_append_args():
+                raise BadRequestException("The service type for '" + service_name + "' does not support append args")
+
             if service_name in orchestration_services:
                 existing_entry = orchestration_services[service_name]
                 service_mapping_ports[service_mapping_name] = existing_entry["port"]
@@ -334,7 +344,8 @@ def _validate_start_request_and_assign_ports(self, services_to_start, dontrunfro
                     "adminPort": admin_port,
                     "runFrom": run_from,
                     "classifier": classifier,
-                    "version": version
+                    "version": version,
+                    "appendArgs": append_args
                 }
 
         return orchestration_services, service_mapping_ports

servicemanager/service/smdropwizardservice.py

@@ -16,8 +16,8 @@ class SmDropwizardServiceStarter(SmJvmServiceStarter):
 
     DEV_NULL = open(os.devnull, 'w')
 
-    def __init__(self, context, service_name, run_from, port, admin_port, classifier, service_mapping_ports, version, proxy):
-        SmMicroServiceStarter.__init__(self, context, service_name, "dropwizard", run_from, port, classifier, service_mapping_ports, version, proxy)
+    def __init__(self, context, service_name, run_from, port, admin_port, classifier, service_mapping_ports, version, proxy, append_args=None):
+        SmMicroServiceStarter.__init__(self, context, service_name, "dropwizard", run_from, port, classifier, service_mapping_ports, version, proxy, append_args)
 
         self.admin_port = admin_port
 

servicemanager/service/smexternalservice.py

@@ -3,6 +3,7 @@
 import re
 
 import requests
+import types
 
 from servicemanager.service.smservice import SmServiceStarter, SmService, SmServiceStatus
 from servicemanager.smprocess import SmProcess, kill_pid
@@ -14,22 +15,33 @@ class SmExternalServiceStarter(SmServiceStarter):
     def process_arguments(self):
         pass
 
-    def __init__(self, context, service_name):
-        SmServiceStarter.__init__(self, context, service_name, "external")
-
+    def __init__(self, context, service_name, append_args):
+        SmServiceStarter.__init__(self, context, service_name, "external", append_args)
         if not "cmd" in self.service_data:
             context.log("Could not start 'external' service '" + service_name + "', 'cmd' is missing from services.json")
-
         self.cmd = self.service_data["cmd"]
 
+    def get_start_command(self, context=None):
+        if self.append_args:
+            if isinstance(self.append_args, types.ListType):
+                return self.cmd + self.append_args
+            else:
+                return self.cmd
+                self.log("WARNING: I was passed a non list for append args of '" + str(self.append_args) + "' I dont know what to do with this")
+        else:
+            return self.cmd
+
+    def supports_append_args(self):
+        return True
+
     def start(self):
         try:
             location = "."
             if "location" in self.service_data:
                 location = self.service_data["location"]
             microservice_path = os.path.join(self.context.application.workspace, location)
             os.chdir(microservice_path)
-            return subprocess.Popen(self.cmd, cwd=microservice_path, env=os.environ.copy()).pid
+            return subprocess.Popen(" ".join(self.get_start_command()), cwd=microservice_path, env=os.environ.copy(), shell=True).pid
         except Exception, e:
             self.log("Could not start service due to exception: " + str(e))
 

servicemanager/service/smjvmservice.py

@@ -15,10 +15,10 @@ class SmJvmServiceStarter(SmMicroServiceStarter):
 
     test_id_param = "service.manager.testId"
 
-    def __init__(self, context, service_name, expected_service_type, run_from, port, classifier, service_mapping_ports, version, proxy):
-        SmMicroServiceStarter.__init__(self, context, service_name, expected_service_type, run_from, port, classifier, service_mapping_ports, version, proxy)
+    def __init__(self, context, service_name, expected_service_type, run_from, port, classifier, service_mapping_ports, version, proxy, append_args):
+        SmMicroServiceStarter.__init__(self, context, service_name, expected_service_type, run_from, port, classifier, service_mapping_ports, version, proxy, append_args)
 
-    def start(self):
+    def start(self, appendArgs=None):
         if self.run_from == "SOURCE":
             if not clone_repo_if_requred(self):
                 # TODO - should this just return None? or throw an exception?  Should clone_repo_if_required throw an exception?

servicemanager/service/smplayservice.py

@@ -4,9 +4,8 @@
 import shutil
 import zipfile
 import stat
-import time
-import json
 import copy
+import types
 
 from servicemanager.subprocess import Popen
 from ..service.smservice import SmMicroServiceStarter
@@ -25,8 +24,8 @@ class SmPlayServiceStarter(SmJvmServiceStarter):
 
     PLAY_PROCESS_STARTUP_TIMEOUT_SECONDS = 120
 
-    def __init__(self, context, service_name, run_from, port, classifier, service_mapping_ports, version, proxy):
-        SmMicroServiceStarter.__init__(self, context, service_name, "play", run_from, port, classifier, service_mapping_ports, version, proxy)
+    def __init__(self, context, service_name, run_from, port, classifier, service_mapping_ports, version, proxy, append_args):
+        SmMicroServiceStarter.__init__(self, context, service_name, "play", run_from, port, classifier, service_mapping_ports, version, proxy, append_args)
 
         if not self.port:
             self.port = self.service_data["defaultPort"]
@@ -63,8 +62,17 @@ def _build_extra_params(self):
                 "-Dhttp.proxyPort=" + proxy_config[1]
             ]
 
+        if self.append_args:
+            if not isinstance(self.append_args, types.ListType):
+                self.log("WARNING: I was passed a non list for append args of '" + str(self.append_args) + "' I dont know what to do with this")
+            else:
+                extra_params += self.append_args
+
         return extra_params
 
+    def supports_append_args(self):
+        return True
+
     def get_start_command(self, run_from):
         if run_from == "SOURCE":
             source_cmd = copy.copy(self.service_data["sources"]["cmd"])

servicemanager/service/smpythonservice.py

@@ -20,8 +20,8 @@ class SmPythonServiceStarter(SmMicroServiceStarter):
 
     PROCESS_STARTUP_TIMEOUT_SECONDS = 90
 
-    def __init__(self, context, service_name, run_from, port, classifier, service_mapping_ports, version, proxy):
-        SmMicroServiceStarter.__init__(self, context, service_name, "assets", run_from, port, classifier, service_mapping_ports, version, None)
+    def __init__(self, context, service_name, run_from, port, classifier, service_mapping_ports, version, proxy=None, append_args=None):
+        SmMicroServiceStarter.__init__(self, context, service_name, "assets", run_from, port, classifier, service_mapping_ports, version, proxy, append_args)
 
         if not self.port:
             self.port = self.service_data["defaultPort"]

servicemanager/service/smservice.py

@@ -2,7 +2,6 @@
 
 from abc import abstractmethod
 
-
 class SmServiceBase():
     def __init__(self, context, service_name, expected_service_type):
         self.context = context
@@ -55,8 +54,9 @@ def get_pattern(self):
 
 class SmServiceStarter(SmServiceBase):
 
-    def __init__(self, context, service_name, expected_service_type):
+    def __init__(self, context, service_name, expected_service_type, append_args):
         SmServiceBase.__init__(self, context, service_name, expected_service_type)
+        self.append_args = append_args
 
     @abstractmethod
     def start(self):
@@ -66,15 +66,19 @@ def start(self):
     def process_arguments(self):
         pass
 
+    @abstractmethod
+    def supports_append_args(self):
+        return False
+
     @abstractmethod
     def get_start_command(self, context = None):
         return ["get_start_command() not implemented for this type of service - fork and make a pull request :)"]
 
 
 class SmMicroServiceStarter(SmServiceStarter):
 
-    def __init__(self, context, service_name, expected_service_type, run_from, port, classifier, service_mapping_ports, version, proxy):
-        SmServiceStarter.__init__(self, context, service_name, expected_service_type)
+    def __init__(self, context, service_name, expected_service_type, run_from, port, classifier, service_mapping_ports, version, proxy, append_args):
+        SmServiceStarter.__init__(self, context, service_name, expected_service_type, append_args)
 
         self.run_from = run_from
         self.version = version
@@ -89,7 +93,7 @@ def __init__(self, context, service_name, expected_service_type, run_from, port,
         self.sources = self.service_data["sources"]
 
     @abstractmethod
-    def start(self):
+    def start(self, appendArgs=None):
         pass
 
     @abstractmethod

servicemanager/smcontext.py

@@ -312,7 +312,7 @@ def get_run_from_service_override_value_or_use_default(self, service, original_r
                 return service.service_data["always_run_from"]
         return original_runfrom
 
-    def get_service_starter(self, service_name, run_from, proxy, classifier=None, service_mapping_ports=None, port=None, admin_port=None, version=None):
+    def get_service_starter(self, service_name, run_from, proxy, classifier=None, service_mapping_ports=None, port=None, admin_port=None, version=None, append_args=None):
         service = self.get_service(service_name)
         run_from = self.get_run_from_service_override_value_or_use_default(service, run_from)
 
@@ -326,20 +326,21 @@ def get_service_starter(self, service_name, run_from, proxy, classifier=None, se
             return None
 
         if service_type == "external":
-            starter = SmExternalServiceStarter(self, service_name)
+            starter = SmExternalServiceStarter(self, service_name, append_args)
         elif service_type == "dropwizard":
-            starter = SmDropwizardServiceStarter(self, service_name, run_from, port, admin_port, classifier, service_mapping_ports, version, proxy)
+            starter = SmDropwizardServiceStarter(self, service_name, run_from, port, admin_port, classifier, service_mapping_ports, version, proxy, append_args)
         elif service_type == "play":
-            starter = SmPlayServiceStarter(self, service_name, run_from, port, classifier, service_mapping_ports, version, proxy)
+            starter = SmPlayServiceStarter(self, service_name, run_from, port, classifier, service_mapping_ports, version, proxy, append_args)
         elif service_type == "assets":
-            starter = SmPythonServiceStarter(self, service_name, run_from, port, classifier, service_mapping_ports, version, None)
+            proxy = None
+            starter = SmPythonServiceStarter(self, service_name, run_from, port, classifier, service_mapping_ports, version, proxy, append_args)
         else:
             raise self.exception("Unknown service type '%s' for service '%s' - please check services.json" % (service_type, service_name))
 
         return starter
 
-    def start_service(self, service_name, run_from, proxy, classifier=None, service_mapping_ports=None, port=None, admin_port=None, version=None):
-        service_starter = self.get_service_starter(service_name, run_from, proxy, classifier, service_mapping_ports, port, admin_port, version)
+    def start_service(self, service_name, run_from, proxy, classifier=None, service_mapping_ports=None, port=None, admin_port=None, version=None, appendArgs=None):
+        service_starter = self.get_service_starter(service_name, run_from, proxy, classifier, service_mapping_ports, port, admin_port, version, appendArgs)
         feature_string = pretty_print_list(" with feature$s $list enabled", self.features)
         self.log("Starting '%s' from %s%s..." % (service_name, run_from, feature_string))
         service_process_id = service_starter.start()