Node refactoring

* Add a base class with abstract methods that every device has to
  implement
* Rename init_node to _detect_device_type() because that is what it is
* Renamed init_boot_time to init_dev_data because it captures better
  what we're trying to do.
* Add _init_rest to test connectivity/auth
* Have all derived Device classes implement init_dev_data() rather than
  having half of them do init_node, and the others do init_boot_time.
* Rename all internal functions to start with _. Only run, post_commands
  and initialize ought to be called from outside the class.
* Got rid of the _status field because its only purpose was to determine
  if a device's type was unknown and so we needed to continue to run the
  automatic device type determination logic.
* Added substantial commentary at the start of the device class to
  explain the workings of this class, its assumptions and its
  weaknesses.
* Get rid of sigend, which was used to catch and terminate the Node
  runner when the user hit Ctrl-C. Ctrl-C driven termination is handled
  elsewhere now.
* Add docstrings to all public class methods.

Signed-off-by: Dinesh Dutt <[email protected]>

Author: ddutt

suzieq/poller/worker/nodes/files.py

@@ -16,12 +16,11 @@ class FileNode:
     '''Class using run-once=gather snapshot output as mock device input'''
 
     # pylint: disable=attribute-defined-outside-init
-    async def _init(self, datadir: str):
-
+    async def initialize(self, datadir: str):
+        '''Load the data to be read from files'''
         self.logger = logging.getLogger(__name__)
         self.data = {}          # The dict of command to output entries
         self.hostname = '_filedata'  # Need this for the services
-        self.sigend = False
 
         self._service_queue = asyncio.Queue()
 
@@ -121,9 +120,6 @@ async def run(self):
         '''Main workhorse routine, serving data from files based on command'''
 
         while True:
-            if self.sigend:
-                return
-
             request = await self._service_queue.get()
             # request consists of callback fn, service_defn string, cb_token
             if request: