Merge pull request #31 from Overdrivr/improve-cli-testing

Improved cli testing

Author: Overdrivr

.travis.yml

@@ -0,0 +1,37 @@
+language: python
+matrix:
+  include:
+  - os: linux
+    python: '3.3'
+  - os: linux
+    python: '3.4'
+  - os: linux
+    python: '3.5'
+# command to install dependencies
+install:
+  - sudo apt-get update
+  # We do this conditionally because it saves us some downloading if the
+  # version is the same.
+  - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
+      wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh;
+    else
+      wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
+    fi
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - hash -r
+  - conda config --set always_yes yes --set changeps1 no
+  - conda update -q conda
+  # Useful for debugging any issues with conda
+  - conda info -a
+
+  # Replace dep1 dep2 ... with your dependencies
+  - conda install numpy -y -q
+  - conda install pyqt -y -q
+  - conda install pip -y -q
+  - pip install pytelemetry docopt sortedcontainers pyqtgraph pytest-cov
+  - export PYTHONPATH="$PYTHONPATH:$TRAVIS_BUILD_DIR"
+
+# command to run tests
+script:
+  - py.test --cov

appveyor.yml

@@ -0,0 +1,46 @@
+version: 1.1.{build}-{branch}
+
+build: false
+
+environment:
+  matrix:
+    - MINICONDA: "C:\\Miniconda3"
+      PYTHON_ARCH: "32"
+      platform: x86
+
+    - MINICONDA: "C:\\Miniconda3"
+      PYTHON_ARCH: "32"
+      platform: x64
+
+    - MINICONDA: "C:\\Miniconda3"
+      PYTHON_ARCH: "64"
+      platform: x64
+
+    - MINICONDA: "C:\\Miniconda35"
+      PYTHON_ARCH: "32"
+      platform: x86
+
+    - MINICONDA: "C:\\Miniconda35"
+      PYTHON_ARCH: "32"
+      platform: x64
+
+    - MINICONDA: "C:\\Miniconda35"
+      PYTHON_ARCH: "64"
+      platform: x64
+
+init:
+  - "ECHO %PYTHON_ARCH%"
+  - "ECHO %PYTHON_VERSION%"
+  - "ECHO %MINICONDA%"
+  - "ECHO %APPVEYOR_BUILD_FOLDER%"
+  - "ECHO %PYTHONPATH%"
+
+install:
+  - "%MINICONDA%\\Scripts\\conda install numpy -y -q"
+  - "%MINICONDA%\\Scripts\\conda install pyqt -y -q"
+  - "%MINICONDA%\\Scripts\\conda install pip -y -q"
+  - "%MINICONDA%\\Scripts\\pip.exe install pytelemetry docopt sortedcontainers pyqtgraph pytest-cov"
+  - "cd %APPVEYOR_BUILD_FOLDER%"
+  - "SET PYTHONPATH=%PYTHONPATH%;%APPVEYOR_BUILD_FOLDER%"
+test_script:
+  - "%MINICONDA%\\Scripts\\py.test --cov"

dev-requirements.txt

@@ -0,0 +1,4 @@
+pytelemetry>1.1.0
+docopt
+sortedcontainers
+pyqtgraph

pytelemetrycli/cli.py

@@ -43,16 +43,19 @@ def fn(self, arg):
     return fn
 
 class Application (cmd.Cmd):
-    def __init__(self):
+    def __init__(self, transport=None, stdout=None):
         # cmd Initialization and configuration
-        cmd.Cmd.__init__(self)
+        cmd.Cmd.__init__(self,stdout=stdout)
         self.intro = 'pytelemetry terminal started.' \
                  + ' (type help for a list of commands.)'
         self.prompt = ':> '
         self.file = None
 
         # pytelemetry setup
-        self.transport = transports.SerialTransport()
+        if not transport:
+            self.transport = transports.SerialTransport()
+        else:
+            self.transport = transport
         self.telemetry = Pytelemetry(self.transport)
         self.topics = Topics()
         self.plots = []
@@ -101,15 +104,17 @@ def do_serial(self, arg):
             b = int(arg['--bauds'])
             self.runner.connect(arg['<port>'],b)
         except IOError as e:
-            print("Failed to connect to {0} at {1} (bauds)."
+            self.stdout.write("Failed to connect to {0} at {1} (bauds).\n"
                     .format(arg['<port>'],b))
 
-            logger.warn("Failed to connect to {0} at {1} (bauds). E : "
+            logger.warn("Failed to connect to {0} at {1} (bauds). E : \n"
                           .format(arg['<port>'],b,e))
         else:
-            s = "Connected to {0} at {1} (bauds).".format(arg['<port>'],b)
-            print(s)
+            s = "Connected to {0} at {1} (bauds).\n".format(arg['<port>'],b)
+            self.stdout.write(s)
             logger.info(s)
+            self.topics.clear()
+            logger.info("Cleared all topics for new session.")
 
     @docopt_cmd
     def do_print(self, arg):
@@ -124,26 +129,26 @@ def do_print(self, arg):
         """
         topic = arg['<topic>']
         if not self.topics.exists(topic):
-            s = "Topic '{0}' unknown. Type 'ls' to list all available topics.".format(topic)
-            print(s)
+            s = "Topic '{0}' unknown. Type 'ls' to list all available topics.\n".format(topic)
+            self.stdout.write(s)
             logger.warn(s)
             return
 
         try:
             amount = int(arg['--amount'])
         except:
-            s = "Could not cast --amount = '{0}' to integer. Using 1.".format(amount)
-            print(s)
+            s = "Could not cast --amount = '{0}' to integer. Using 1.\n".format(arg['--amount'])
+            self.stdout.write(s)
             logger.warn(s)
             amount = 1
 
         s = self.topics.samples(topic,amount)
 
         if s is not None:
             for i in s:
-                print(i)
+                self.stdout.write("%i\n" % i)
         else:
-            logger.error("Could not retrieve {0} sample(s) under topic '{1}'.".format(amount,topic))
+            logger.error("Could not retrieve {0} sample(s) under topic '{1}'.\n".format(amount,topic))
 
     @docopt_cmd
     def do_ls(self, arg):
@@ -158,12 +163,14 @@ def do_ls(self, arg):
 
         """
         if arg['--serial']:
-            print("Available COM ports:")
+            self.stdout.write("Available COM ports:\n")
             for port,desc,hid in list_ports.comports():
-                print(port,'\t',desc)
+                self.stdout.write("%s \t %s\n" % (port,desc))
         else:
+
             for topic in self.topics.ls():
-                print(topic)
+                self.stdout.write("%s\n" % topic)
+
 
     @docopt_cmd
     def do_plot(self, arg):
@@ -176,14 +183,14 @@ def do_plot(self, arg):
         topic = arg['<topic>']
 
         if not self.topics.exists(topic):
-            s = "Topic '{0}' unknown. Type 'ls' to list all available topics.".format(topic)
-            print(s)
+            s = "Topic '{0}' unknown. Type 'ls' to list all available topics.\n".format(topic)
+            self.stdout.write(s)
             logger.warn(s)
             return
 
         if self.topics.intransfer(topic):
-            s = "Topic '{0}' already plotting.".format(topic)
-            print(s)
+            s = "Topic '{0}' already plotting.\n".format(topic)
+            self.stdout.write(s)
             logger.warn(s)
             return
 
@@ -210,9 +217,9 @@ def do_plot(self, arg):
 
         self.topics.transfer(topic,q)
 
-        s = "Plotting '{0}' in mode [{1}].".format(topic,plotTypeFlag)
+        s = "Plotting '{0}' in mode [{1}].\n".format(topic,plotTypeFlag)
         logger.info(s)
-        print(s)
+        self.stdout.write(s)
 
     @docopt_cmd
     def do_pub(self, arg):
@@ -242,8 +249,8 @@ def do_pub(self, arg):
 
         self.telemetry.publish(arg['<topic>'],arg['<value>'],valtype)
 
-        s = "Published on topic '{0}' : {1} [{2}]".format(arg['<topic>'], arg['<value>'],valtype)
-        print(s)
+        s = "Published on topic '{0}' : {1} [{2}]\n".format(arg['<topic>'], arg['<value>'],valtype)
+        self.stdout.write(s)
         logger.info(s)
 
     @docopt_cmd
@@ -254,7 +261,7 @@ def do_count(self, arg):
 Usage: count
         """
         for topic in self.topics.ls():
-            print("{0} : {1}".format(topic, self.topics.count(topic)))
+            self.stdout.write("{0} : {1}\n".format(topic, self.topics.count(topic)))
 
     @docopt_cmd
     def do_disconnect(self, arg):
@@ -265,7 +272,7 @@ def do_disconnect(self, arg):
         """
         try:
             self.runner.disconnect()
-            print("Disconnected.")
+            self.stdout.write("Disconnected.\n")
             logger.info("Disconnected.")
         except:
             logger.warn("Already disconnected. Continuing happily.")
@@ -277,11 +284,11 @@ def do_info(self, arg):
 
 Usage: info
         """
-        print("- CLI path : %s" % os.path.dirname(os.path.realpath(__file__)))
+        self.stdout.write("- CLI path : %s\n" % os.path.dirname(os.path.realpath(__file__)))
         try:
-            print("- version : %s" % __version__)
+            self.stdout.write("- version : %s\n" % __version__)
         except:
-            print("- version : not found.")
+            self.stdout.write("- version : not found.\n")
 
     def do_quit(self, arg):
         """
@@ -290,7 +297,7 @@ def do_quit(self, arg):
 Usage: quit
         """
         self.runner.terminate()
-        print("Good Bye!")
+        self.stdout.write("Good Bye!\n")
         logger.info("Application quit.")
         exit()
 

pytelemetrycli/runner.py

@@ -40,31 +40,34 @@ def terminate(self):
         except:
             pass # Already disconnected
 
-    def run(self):
-        while self.running.is_set():
-            if self.connected.is_set():
-                # Update protocol decoding
-                self.telemetryWrapper.update()
+    def update(self):
+        # Update protocol decoding
+        self.telemetryWrapper.update()
+
+        # Protect the self.plots data structure from
+        # being modified from the main thread
+        self.plotsLock.acquire()
 
-                # Protect the self.plots data structure from
-                # being modified from the main thread
-                self.plotsLock.acquire()
-                
-                # Poll each poll pipe to see if user closed them
-                plotToDelete = None
-                for p, i in zip(self.plots,range(len(self.plots))):
-                    if p['ctrl'].poll():
-                        if p['ctrl'].recv() == "closing":
-                            plotToDelete = i
-                            break
+        # Poll each poll pipe to see if user closed them
+        plotToDelete = None
+        for p, i in zip(self.plots,range(len(self.plots))):
+            if p['ctrl'].poll():
+                if p['ctrl'].recv() == "closing":
+                    plotToDelete = i
+                    break
 
-                # Delete a plot if needed
-                if plotToDelete is not None:
-                    self.plots[plotToDelete]['ctrl'].close()
-                    topic = self.plots[plotToDelete]['topic']
-                    self.topics.untransfer(topic)
-                    self.plots.pop(plotToDelete)
+        # Delete a plot if needed
+        if plotToDelete is not None:
+            self.plots[plotToDelete]['ctrl'].close()
+            topic = self.plots[plotToDelete]['topic']
+            self.topics.untransfer(topic)
+            self.plots.pop(plotToDelete)
 
-                self.plotsLock.release()
+        self.plotsLock.release()
+
+    def run(self):
+        while self.running.is_set():
+            if self.connected.is_set():
+                self.update()
             else:
                 time.sleep(0.5)