Merge pull request #114 from Helene/thread_stop

ConfigWatchThread need to be properly stoped

Author: Helene

source/queryHandler/SensorConfig.py

@@ -33,6 +33,15 @@
 collectorsFile = '/opt/IBM/zimon/ZIMonCollector.cfg'
 
 
+def get_config_paths():
+    files_to_watch = []
+    if os.path.isfile(mmsdrfsFile):
+        files_to_watch.append(mmsdrfsFile)
+    else:
+        files_to_watch.append(zimonFile)
+    return files_to_watch
+
+
 def readSensorsConfigFromMMSDRFS(logger=None):
     '''
     :return: list of dictionaries with sensorsName as key and the values of the sensors in the mmsdrfs

source/watcher.py

@@ -20,14 +20,17 @@
 @author: HWASSMAN
 '''
 
+import cherrypy
 import os
 import time
 from bridgeLogger import getBridgeLogger
 from messages import MSG
+from threading import Thread
 
 
 class ConfigWatcher(object):
     running = False
+    thread = None
     refresh_delay_secs = 30
 
     def __init__(self, watch_paths, call_func_on_change=None, *args, **kwargs):
@@ -39,7 +42,16 @@ def __init__(self, watch_paths, call_func_on_change=None, *args, **kwargs):
         self.args = args
         self.kwargs = kwargs
 
-    def update_files_list(self):
+    def start_watch(self):
+        """ Function to start watch in a thread"""
+        self.running = True
+        if not self.thread:
+            self.thread = Thread(name='ConfigWatchThread', target=self.watch)
+            self.thread.start()
+            cherrypy.engine.log('Started custom thread %r.' % self.thread.name)
+            self.logger.debug(MSG['StartWatchingFiles'].format(self.paths))
+
+    def _update_files_list(self):
         oldfiles = self.filenames.copy()
         for path in self.paths:
             if os.path.isfile(path):
@@ -54,7 +66,7 @@ def update_files_list(self):
         for file in self.filenames.difference(oldfiles):
             self.logger.debug(MSG['FileAddedToWatch'].format(file))
 
-    def look(self):
+    def _look(self):
         """ Function to check if a file timestamp has changed"""
         for filename in self.filenames:
             stamp = os.stat(filename).st_mtime
@@ -69,14 +81,12 @@ def look(self):
 
     def watch(self):
         """ Function to keep watching in a loop """
-        self.running = True
-        self.logger.debug(MSG['StartWatchingFiles'].format(self.paths))
         while self.running:
             try:
                 # Look for changes
                 time.sleep(self.refresh_delay_secs)
-                self.update_files_list()
-                self.look()
+                self._update_files_list()
+                self._look()
             except KeyboardInterrupt:
                 self.logger.details(MSG['StopWatchingFiles'].format(self.paths))
                 break
@@ -91,4 +101,11 @@ def watch(self):
 
     def stop_watch(self):
         """ Function to break watching """
-        self.running = False
+        try:
+            self.running = False
+            if self.thread:
+                self.thread.join()
+                cherrypy.engine.log('Stopped custom thread %r.' % self.thread.name)
+                self.thread = None
+        except KeyboardInterrupt:
+            print(f"Recived KeyboardInterrupt during stopping the thread {self.thread.name}")

source/zimonGrafanaIntf.py

@@ -41,7 +41,6 @@
 from collections import defaultdict
 from timeit import default_timer as timer
 from time import sleep
-from threading import Thread
 
 
 class MetadataHandler(metaclass=Singleton):
@@ -177,6 +176,7 @@ def __getSuggest(self, params):
         return resp
 
     def __getLookup(self, params):
+        self.logger.debug(f'Lookup for {params} called')
 
         if params.get('m'):
             try:
@@ -616,17 +616,6 @@ def refresh_metadata(refresh_all=False):
     md.update(refresh_all)
 
 
-def watch_config():
-    files_to_watch = []
-    if os.path.isfile(SensorConfig.mmsdrfsFile):
-        files_to_watch.append(SensorConfig.mmsdrfsFile)
-    else:
-        files_to_watch.append(SensorConfig.zimonFile)
-
-    watcher = ConfigWatcher(files_to_watch, refresh_metadata, refresh_all=True)
-    watcher.watch()
-
-
 def main(argv):
     # parse input arguments
     args, msg = getSettings(argv)
@@ -714,11 +703,13 @@ def main(argv):
     logger.info("%s", MSG['sysStart'].format(sys.version, cherrypy.__version__))
 
     try:
+        files_to_watch = SensorConfig.get_config_paths()
+        watcher = ConfigWatcher(files_to_watch, refresh_metadata, refresh_all=True)
+        cherrypy.engine.subscribe('start', watcher.start_watch)
+        cherrypy.engine.subscribe('stop', watcher.stop_watch)
         cherrypy.engine.start()
+        cherrypy.engine.log('test')
         logger.info("server started")
-        t = Thread(name='ConfigWatchThread', target=watch_config)
-        t.start()
-        # t.join()
         with open("/proc/{}/stat".format(os.getpid())) as f:
             data = f.read()
         foreground_pid_of_group = data.rsplit(" ", 45)[1]
@@ -736,7 +727,7 @@ def main(argv):
     ph = None
     gh = None
 
-    logger.warn("server stopped")
+    logger.warning("server stopped")
 
 
 if __name__ == '__main__':

tests/test_configWatcher.py

@@ -3,7 +3,6 @@
 from source.watcher import ConfigWatcher
 from source.bridgeLogger import configureLogging
 from nose2.tools.decorators import with_setup
-from threading import Thread
 
 
 def my_setup():
@@ -21,11 +20,9 @@ def test_case01():
     cw = ConfigWatcher([dummyFile])
     assert len(cw.paths) == 1
     assert len(cw.filenames) == 0
-    t = Thread(name='ConfigWatchThread', target=cw.watch)
-    t.start()
+    cw.start_watch()
     time.sleep(3)
     cw.stop_watch()
-    t.join()
     assert len(cw.paths) == 1
     assert len(cw.filenames) == 0
 
@@ -35,10 +32,8 @@ def test_case02():
     cw = ConfigWatcher([path])
     assert len(cw.paths) > 0
     assert len(cw.filenames) == 0
-    t = Thread(name='ConfigWatchThread', target=cw.watch)
-    t.start()
+    cw.start_watch()
     time.sleep(3)
     cw.stop_watch()
-    t.join()
     assert len(cw.paths) > 0
     assert len(cw.filenames) > 1