Merge branch 'rapp_cognitive_exercise_error_reporting' into devel (closes #344)

* rapp_cognitive_exercise_error_reporting:
  adds traceback error reporting on rapp_cognitive_exercises services

Author: athallas

rapp_cognitive_exercise/src/cognitive_test_creator.py

@@ -25,6 +25,7 @@
 import os
 import sys
 from app_error_exception import AppError
+from helper_functions import CognitiveExerciseHelperFunctions
 
 from rapp_platform_ros_communications.srv import (
   cognitiveTestCreatorSrv,
@@ -203,10 +204,12 @@ def testCreator(self,req):
     except IndexError:
       #print "test "+fname +" is broken"
       res.error="IndexError.. test "+fname +" is broken"
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
       res.success=False
     except IOError:
       #print "IO Error, cannot open test file or write xml file"
       res.error="IO Error, cannot open test file or write xml file"
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
       res.success=False
     except AppError as e:
       AppError.passErrorToRosSrv(e,res) 

rapp_cognitive_exercise/src/helper_functions.py

@@ -6,6 +6,7 @@
 from os.path import expanduser
 from collections import OrderedDict
 from app_error_exception import AppError
+import traceback
 
 from rapp_platform_ros_communications.srv import (
   ontologySubSuperClassesOfSrv,
@@ -185,3 +186,16 @@ def organizeUserPerformanceByTimestamp(userPerf):
       userPerfOrganizedByTimestamp[int(userPerf.timestamps[i])]=[tlist]      
     userPerfOrganizedByTimestamp=OrderedDict(sorted(userPerfOrganizedByTimestamp.items(), key=lambda t: t[0], reverse=True)) #Order is descending    
     return userPerfOrganizedByTimestamp
+
+  @staticmethod  
+  ## @brief Traces and returns the code line where an error occured
+  # @param error [String] the error occured
+  # @param trace [list] the execution messages trace list
+  #
+  # @param trace [list] the execution messages trace list
+  def traceError(error,trace):
+    for frame in traceback.extract_tb(sys.exc_info()[2]):
+      fname,lineno,fn,text = frame
+      print "Error in %s on line %d" % (fname, lineno)
+      error = error + "Error in %s on line %d" % (fname, lineno)
+      trace.append("Error in %s on line %d" % (fname, lineno))

rapp_cognitive_exercise/src/recordUserCognitiveTestPerformance.py

@@ -63,14 +63,17 @@ def recordPerformance(self,req):
       res.trace.append("IndexError: " +str(e))
       res.error="IndexError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except IOError, e:
       res.success=False
       res.trace.append("IOError: "+str(e))
       res.error="IOError: "+str(e)
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except KeyError, e:
       res.success=False
       res.trace.append('"KeyError (probably invalid cfg/.yaml parameter) "%s"' % str(e))
       res.error='"KeyError (probably invalid cfg/.yaml parameter) "%s"' % str(e)
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except AppError as e:
       AppError.passErrorToRosSrv(e,res) 
     return res

rapp_cognitive_exercise/src/returnTestsOfTypeSubtypeDiffuclty.py

@@ -92,14 +92,17 @@ def returnTestsFunction(self,req):
       res.trace.append("IndexError: " +str(e))
       res.error="IndexError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except IOError, e:
       res.success=False
       res.trace.append("IOError: "+str(e))
       res.error="IOError: "+str(e)
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except KeyError, e:
       res.success=False
       res.trace.append('"KeyError (probably invalid cfg/.yaml parameter) "%s"' % str(e))
       res.error='"KeyError (probably invalid cfg/.yaml parameter) "%s"' % str(e)
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except AppError as e:
       AppError.passErrorToRosSrv(e,res)
       res.totalNumberOfTestsReturned=0

rapp_cognitive_exercise/src/test_selector.py

@@ -21,7 +21,6 @@
 import rospkg
 import rospy
 import sys
-import traceback
 import xml.etree.ElementTree as ET
 import calendar
 import time
@@ -98,21 +97,17 @@ def chooserFunction(self,req):
       res.trace.append("IndexError: " +str(e))
       res.error="IndexError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except IOError, e:
       res.success=False
       res.trace.append("IOError: "+str(e))
       res.error="IOError: "+str(e)
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except KeyError, e:
       res.success=False
       res.trace.append('"KeyError (probably invalid cfg/.yaml parameter) "%s"' % str(e))
       res.error='"KeyError (probably invalid cfg/.yaml parameter) "%s"' % str(e)
-      print "KeyError Exception. Tracing..."
-      self.traceError(res.error,res.trace)
-      #for frame in traceback.extract_tb(sys.exc_info()[2]):
-        #fname,lineno,fn,text = frame
-        #print "Error in %s on line %d" % (fname, lineno)
-        #res.error = res.error + "Error in %s on line %d" % (fname, lineno)
-        #res.trace.append("Error in %s on line %d" % (fname, lineno))
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except AppError as e:
       AppError.passErrorToRosSrv(e,res) 
     return res
@@ -404,10 +399,3 @@ def loadParamDifficultyModifiersAndHistorySettings(self):
     pastTests = int(rospy.get_param('rapp_cognitive_test_selector_past_performance_number_of_past_tests'))    
     lookBackTimeStamp=pastMonths*30*24*3600
     return difficultyModifier1to2,difficultyModifier2to3,historyBasedOnNumOfTestsAndNotTime,pastMonths,pastTests,lookBackTimeStamp
-
-  def traceError(self,error,trace):
-    for frame in traceback.extract_tb(sys.exc_info()[2]):
-      fname,lineno,fn,text = frame
-      print "Error in %s on line %d" % (fname, lineno)
-      error = error + "Error in %s on line %d" % (fname, lineno)
-      trace.append("Error in %s on line %d" % (fname, lineno))

rapp_cognitive_exercise/src/userScoreHistoryForAllCategories.py

@@ -63,10 +63,12 @@ def returnUserHistory(self,req):
       res.trace.append("ValueError: " +str(e))
       res.error="ValueError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except IndexError, e:
       res.trace.append("IndexError: " +str(e))
       res.error="IndexError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except AppError as e:
       AppError.passErrorToRosSrv(e,res) 
     return res

rapp_cognitive_exercise/src/userScoresForAllCategories.py

@@ -55,10 +55,12 @@ def returnUserScores(self,req):
       res.trace.append("ValueError: " +str(e))
       res.error="ValueError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except IndexError, e:
       res.trace.append("IndexError: " +str(e))
       res.error="IndexError: "+str(e)
       res.success=False
+      CognitiveExerciseHelperFunctions.traceError(res.error,res.trace)
     except AppError as e:
       AppError.passErrorToRosSrv(e,res) 
     return res