Merge pull request #129 from Helene/opentsdb

Check port settings before bind opentsdb api application

Author: Helene

source/confParser.py

@@ -45,6 +45,12 @@ def checkTLSsettings(args):
     return True, ''
 
 
+def checkApplicationPort(args):
+    if not args.get('port') or not args.get('apiKeyValue'):
+        return False, MSG['MissingParm']
+    return True, ''
+
+
 def checkAPIsettings(args):
     if not args.get('apiKeyName') or not args.get('apiKeyValue'):
         return False, MSG['MissingParm']
@@ -70,6 +76,8 @@ def getSettings(argv):
         settings = args
     else:
         return None, msg
+    # check application port
+    valid, msg = checkApplicationPort(settings)
     # check API key settings
     valid, msg = checkAPIsettings(settings)
     if not valid:

source/zimonGrafanaIntf.py

@@ -79,10 +79,7 @@ def setup_cherrypy_logging(args):
 
 def updateCherrypyConf(args):
 
-    globalConfig = {'global': {'server.socket_port': args.get('port'),
-                               # default error response
-                               'error_page.default': format_default_error_page,
-                               # unexpected errors
+    globalConfig = {'global': {'error_page.default': format_default_error_page,
                                'request.error_response': handle_error},
                     }
 
@@ -91,6 +88,20 @@ def updateCherrypyConf(args):
     dirname, filename = os.path.split(os.path.abspath(__file__))
     customconf = os.path.join(dirname, 'mycherrypy.conf')
     cherrypy.config.update(customconf)
+    cherrypy.server.unsubscribe()
+
+
+def bind_opentsdb_server(args):
+    opentsdb_server = cherrypy._cpserver.Server()
+    opentsdb_server.socket_port = args.get('port')
+    opentsdb_server._socket_host = '0.0.0.0'
+    if args.get('protocol') == "https":
+        certPath = os.path.join(args.get('tlsKeyPath'), args.get('tlsCertFile'))
+        keyPath = os.path.join(args.get('tlsKeyPath'), args.get('tlsKeyFile'))
+        opentsdb_server.ssl_module = 'builtin'
+        opentsdb_server.ssl_certificate = certPath
+        opentsdb_server.ssl_private_key = keyPath
+    opentsdb_server.subscribe()
 
 
 def updateCherrypySslConf(args):
@@ -164,8 +175,6 @@ def main(argv):
 
     # prepare cherrypy server configuration
     updateCherrypyConf(args)
-    if args.get('protocol') == "https":
-        updateCherrypySslConf(args)
 
     # prepare metadata
     try:
@@ -203,44 +212,47 @@ def main(argv):
         logger.error("ZiMon sensor configuration file not found")
         return
 
-    api = OpenTsdbApi(logger, mdHandler)
-    cherrypy.tree.mount(api, '/api/query',
-                        {'/':
-                         {'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
-                          'request.body.processors': {'application/x-www-form-urlencoded': processFormJSON}
-                          }
-                         }
-                        )
-    # query for metric name (openTSDB: zimon extension returns keys as well)
-    cherrypy.tree.mount(api, '/api/suggest',
-                        {'/':
-                         {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
-                         }
-                        )
-    # query for tag name and value, given a metric (openTSDB)
-    cherrypy.tree.mount(api, '/api/search/lookup',
-                        {'/':
-                         {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
-                         }
-                        )
-    # query to force update of metadata (zimon feature)
-    cherrypy.tree.mount(api, '/api/update',
-                        {'/':
-                         {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
-                         }
-                        )
-    # query for list of aggregators (openTSDB)
-    cherrypy.tree.mount(api, '/api/aggregators',
-                        {'/':
-                         {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
-                         }
-                        )
-    # query for list of filters (openTSDB)
-    cherrypy.tree.mount(api, '/api/config/filters',
-                        {'/':
-                         {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
-                         }
-                        )
+    if args.get('port'):
+        bind_opentsdb_server(args)
+        api = OpenTsdbApi(logger, mdHandler)
+
+        cherrypy.tree.mount(api, '/api/query',
+                            {'/':
+                             {'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
+                              'request.body.processors': {'application/x-www-form-urlencoded': processFormJSON}
+                              }
+                             }
+                            )
+        # query for metric name (openTSDB: zimon extension returns keys as well)
+        cherrypy.tree.mount(api, '/api/suggest',
+                            {'/':
+                             {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+                             }
+                            )
+        # query for tag name and value, given a metric (openTSDB)
+        cherrypy.tree.mount(api, '/api/search/lookup',
+                            {'/':
+                             {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+                             }
+                            )
+        # query to force update of metadata (zimon feature)
+        cherrypy.tree.mount(api, '/api/update',
+                            {'/':
+                             {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+                             }
+                            )
+        # query for list of aggregators (openTSDB)
+        cherrypy.tree.mount(api, '/api/aggregators',
+                            {'/':
+                             {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+                             }
+                            )
+        # query for list of filters (openTSDB)
+        cherrypy.tree.mount(api, '/api/config/filters',
+                            {'/':
+                             {'request.dispatch': cherrypy.dispatch.MethodDispatcher()}
+                             }
+                            )
 
     try:
         files_to_watch = SensorConfig.get_config_paths()

tests/test_params.py

@@ -1,4 +1,4 @@
-from source.confParser import ConfigManager, merge_defaults_and_args, parse_cmd_args, checkCAsettings
+from source.confParser import ConfigManager, merge_defaults_and_args, parse_cmd_args, checkCAsettings, checkApplicationPort
 from source.__version__ import __version__ as version
 from nose2.tools.decorators import with_setup
 
@@ -133,3 +133,15 @@ def test_case12():
     assert isinstance(result.get('caCertPath'), str)
     assert valid == False
     assert len(msg) > 0
+
+
+@with_setup(my_setup)
+def test_case13():
+    x = a.copy()
+    del x['port']
+    result = merge_defaults_and_args(x, b)
+    valid, msg = checkApplicationPort(result)
+    assert len(result.keys()) > 0
+    assert 'port' not in result.keys()
+    assert valid == False
+    assert len(msg) > 0