Merge lp:~patrickas/ensoft-sextant/sextant1_addprogram_exceptions into lp:ensoft-sextant

[Patrick Stevens]

Make update_db.upload_program use exceptions rather than returning error codes, and get __main__.py to handle these. Incidentally fix a bug where file-not-found was not handled neatly on program upload.

Make update_db.upload_program use exceptions rather than returning error codes, and get __main__.py to handle these. Incidentally fix a bug where file-not-found was not handled neatly on program upload.

[lp:~patrickas/ensoft-sextant/sextant1_addprogram_exceptions]

5. By Patrick Stevens <email address hidden> on 2014-08-18

Update docstring to match Python 2 change

6. By Patrick Stevens <email address hidden> on 2014-08-18

Merge Sextant 1.0.1 changes

7. By Patrick Stevens <email address hidden> on 2014-08-18

Merge minor_bugfixes branch

[James (jamesh-f)]

I like the exception handling in __main__ for the neo4j connection.
All looks fine to me (although initially I didn't think you were returning a connection error from uploading a program.)

[James (jamesh-f)]

Approve

review: Approve

[Patrick Stevens (patrickas)]

review: Approve

=== modified file 'src/sextant/__main__.py'
--- src/sextant/__main__.py	2014-08-15 10:49:08 +0000
+++ src/sextant/__main__.py	2014-08-18 16:11:12 +0000
@@ -15,6 +15,7 @@
 import logging
 import logging.config
 import os
+import requests
 import sys
 
 from . import update_db
@@ -169,10 +170,17 @@
     not_object_file = namespace.not_object_file
     # the default is "yes, this is an object file" if not-object-file was
     # unsupplied
-    
-    update_db.upload_program(namespace.input_file[0],
-                             namespace.remote_neo4j,
-                             alternative_name, not_object_file)
+    try:
+        update_db.upload_program(namespace.input_file[0],
+                                 namespace.remote_neo4j,
+                                 alternative_name, not_object_file)
+    except IOError: # in case of Python 2, where FileNotFoundError is undefined
+        logging.error('Input file {} was not found.'.format(namespace.input_file[0]))
+    except requests.exceptions.ConnectionError as e:
+        logging.error('Connection error to server {}: {}'.format(namespace.remote_neo4j,
+                                                                 e))
+    except ValueError as e:
+        logging.error(e)
 
 
 def delete_file(namespace):

=== modified file 'src/sextant/objdump_parser.py'
--- src/sextant/objdump_parser.py	2014-08-14 14:41:19 +0000
+++ src/sextant/objdump_parser.py	2014-08-18 16:11:12 +0000
@@ -214,8 +214,9 @@
 
     # first, check whether the given file exists
     if not os.path.isfile(filepath):
-        logging.error('Input file does not exist')
-        return False
+        # we'd like to use FileNotFoundError, but we might be running under
+        # Python 2, which doesn't have it.
+        raise IOError(filepath + 'is not found.')
 
     #now the file should exist
     if not not_object_file:  #if it is something we need to run through objdump first

=== modified file 'src/sextant/query.py'
--- src/sextant/query.py	2014-08-11 15:14:05 +0000
+++ src/sextant/query.py	2014-08-18 16:11:12 +0000
@@ -18,8 +18,8 @@
     try:
         db = db_api.SextantConnection(remote_neo4j)
     except requests.exceptions.ConnectionError as err:
-        logging.exception("Could not connect to Neo4J server {}. Are you sure it is running?".format(remote_neo4j))
-        logging.exception(str(err))
+        logging.error("Could not connect to Neo4J server {}. Are you sure it is running?".format(remote_neo4j))
+        logging.error(str(err))
         return 2
     #Not supported in python 2
     #except (urllib.exceptions.MaxRetryError):

=== modified file 'src/sextant/update_db.py'
--- src/sextant/update_db.py	2014-08-11 15:14:05 +0000
+++ src/sextant/update_db.py	2014-08-18 16:11:12 +0000
@@ -11,57 +11,51 @@
 from .objdump_parser import get_parsed_objects
 
 import logging
-import requests
 
 
 def upload_program(file_path, db_url, alternative_name=None, not_object_file=False):
     """
     Uploads a program to the remote database.
+    Raises requests.exceptions.ConnectionError if the server didn't exist.
+    Raises IOError if file_path doesn't correspond to a file.
+    Raises ValueError if the desired alternative_name (or the default, if no
+    alternative_name was specified) already exists in the database.
     :param file_path: the path to the local file we wish to upload
     :param db_url: the URL of the database (eg. http://localhost:7474)
     :param alternative_name: a name to give the program to override the default
     :param object_file: bool(the file is an objdump text output file, rather than a compiled binary)
-    :return: 1 if the program already exists in database, 2 if there was a connection error
     """
-    try:
-        connection = SextantConnection(db_url)
-    except requests.exceptions.ConnectionError as err:
-        logging.exception("Could not connect to Neo4J server {}. Are you sure it is running?".format(db_url))
-        return 2
-    #except urllib.exceptions.MaxRetryError:
-     #   logging.error("Connection was refused to {}. Are you sure the server is running?".format(db_url))
-      #  return 2
+
+    connection = SextantConnection(db_url)
 
     program_names = connection.get_program_names()
     if alternative_name is None:
         if Validator.sanitise(file_path) in program_names:
-            logging.error("There is already a program under this name; please delete the previous one with the same name "
-                          "and retry, or rename the input file.")
-            return 1
+            raise ValueError("There is already a program under this name; "
+                             "please delete the previous one with the same name"
+                             " and retry, or rename the input file.")
     else:
         if Validator.sanitise(alternative_name) in program_names:
-            logging.error("There is already a program under this name; please delete the previous one with the same name "
-                          "and retry, or rename the input file.")
-            return 1
+            raise ValueError("There is already a program under this name; "
+                             "please delete the previous one with the same name"
+                             " and retry, or rename the input file.")
 
     parsed_objects = get_parsed_objects(filepath=file_path, sections_to_view=['.text'],
                                         not_object_file=not_object_file, ignore_function_pointers=False)
 
-    logging.warning('Objdump has parsed!')
+    logging.info('Objdump has parsed!')
 
     if alternative_name is None:
         program_representation = connection.new_program(Validator.sanitise(file_path))
     else:
         program_representation = connection.new_program(Validator.sanitise(alternative_name))
 
-
-
     for obj in parsed_objects:
         for called in obj.what_do_i_call:
             if not program_representation.add_function_call(obj.name, called[-1]): # called is a tuple (address, name)
                 logging.error('Validation error: {} calling {}'.format(obj.name, called[-1]))
 
-    logging.warning('Sending {} named objects to server {}...'.format(len(parsed_objects), db_url))
+    logging.info('Sending {} named objects to server {}...'.format(len(parsed_objects), db_url))
     program_representation.commit()
     logging.info('Sending complete! Exiting.')