Merge lp:~jamesh-f/ensoft-sextant/ensoft-sextant into lp:ensoft-sextant

[James]

When asking for the shortest path between two nodes the graph now doesn't display calls where a node calls its self
Also a change where when a connection can't be made to the web server or the neo4j database a sane output is given.

When asking for the shortest path between two nodes the graph now doesn't display calls where a node calls its self
Also a change where when a connection can't be made to the web server or the neo4j database a sane output is given.

[Patrick Stevens (patrickas)]

Comments inline - nothing particularly major, apart from a point about separating the changes out (this commit is two changes, one about the error handling and one about the shortest-path stuff).

review: Needs Fixing

[Patrick Stevens (patrickas)]

I think there's a bug where get_plot ignores its remove_self_calls argument.

review: Needs Fixing

[Patrick Stevens (patrickas)]

review: Approve

[Martin Morrison (isoschiz)]

Attempt to merge into lp:ensoft-sextant failed due to conflicts:

text conflict in src/sextant/export.py
text conflict in src/sextant/query.py
text conflict in src/sextant/web/server.py

[Patrick Stevens (patrickas)]

You probably want to check out these merge conflicts.

review: Needs Fixing

[Patrick Stevens (patrickas)]

review: Approve

[Martin Morrison (isoschiz)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Patrick Stevens (patrickas)]

review: Approve

=== modified file 'src/sextant/export.py' (properties changed: -x to +x)
--- src/sextant/export.py	2014-08-19 09:20:45 +0000
+++ src/sextant/export.py	2014-08-22 14:50:12 +0000
@@ -10,7 +10,7 @@
 
 class ProgramConverter:
     # Given our internal program representation, converts it to output formats.
-    # Currently supported: GraphML
+    # Currently supported: GraphML, dot
 
     @staticmethod
     def get_supported_outputs():
@@ -36,11 +36,14 @@
     def to_dot(program, suppress_common_nodes=False):
         """
         Convert the program to DOT output format.
+        program: Nodes and edges to be outputted
+        suppress_common_nodes: If true doesn't output connections to common nodes
+        remove_self_calls: If is True doesn't output edges back to original func.
         """
         output_str = 'digraph "{}" {{\n '.format(program.program_name)
         output_str += 'overlap=false; \n'
 
-        font_name = "helvetica"
+        font_name = "Helvetica"
 
         for func in program.get_functions():
             if func.type == "plt_stub":
@@ -58,6 +61,13 @@
             if func.is_common:
                 output_str += ' "{}" [fillcolor=lightgreen, style=filled]\n'.format(func.name)
 
+            functions_called = func.functions_i_call
+            if remove_self_calls is True:
+                #remove calls where a function calls to itself
+                for func_called in functions_called:
+                    if func_called == func:
+                        functions_called.remove(func_called)
+
             for func_called in func.functions_i_call:
                 if not (suppress_common_nodes and func_called.is_common):
                     output_str += ' "{}" -> "{}"\n'.format(func.name, func_called.name)
@@ -65,11 +75,16 @@
         output_str += '}'
         return output_str
 
-
-
     @staticmethod
-    def to_yed_graphml(program, suppress_common_nodes=False):
+    def to_yed_graphml(program, suppress_common_nodes=False, remove_self_calls=False):
+        """
+        Convert the program to GraphML output format.
+        program: Nodes and edges to be outputted
+        suppress_common_nodes: If true doesn't output connections to common nodes
+        remove_self_calls: If is True doesn't output edges back to original func.
+        """
         commonly_called = []
+
         output_str = """<?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <graphml xmlns="http://graphml.graphdrawing.org/xmlns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" \
 xmlns:y="http://www.yworks.com/xml/graphml" xmlns:yed="http://www.yworks.com/xml/yed/3" \
@@ -120,7 +135,15 @@
                                     </y:ShapeNode>
                                 </data> 
                                 </node>\n""".format(func.name, 20, len(display_func)*8, colour, display_func)
-            for callee in func.functions_i_call:
+
+            functions_called = func.functions_i_call
+            if remove_self_calls is True:
+                #remove calls where a function calls itself
+                for func_called in functions_called:
+                    if func_called == func:
+                        functions_called.remove(func_called)
+
+            for callee in functions_called:
                 if callee not in commonly_called:
                     if not(suppress_common_nodes and callee.is_common):
                             output_str += """<edge source="{}" target="{}"> <data key="d9">
 
=== modified file 'src/sextant/query.py' (properties changed: -x to +x)
--- src/sextant/query.py	2014-08-19 09:20:45 +0000
+++ src/sextant/query.py	2014-08-22 14:50:12 +0000
@@ -31,6 +31,10 @@
 
     prog = None
     names_list = None
+    #If a function calls itself we don't want to output these calls in the
+    # shortest path query if remove_self_calls is True don't output a nodes
+    #calls to itself
+    remove_self_calls = False
 
     if input_query == 'functions-calling':
         if argument_1 == None:
 
=== modified file 'src/sextant/web/server.py' (properties changed: -x to +x)
--- src/sextant/web/server.py	2014-08-20 09:04:45 +0000
+++ src/sextant/web/server.py	2014-08-22 14:50:12 +0000
@@ -61,14 +61,16 @@
         return connection.get_all_functions_calling(progname, funcname)
 
     @staticmethod
-    def get_plot(program, suppress_common_functions=False):
-        graph_dot = export.ProgramConverter.to_dot(program, suppress_common_functions)
+    def get_plot(program, suppress_common_functions=False, remove_self_calls=False):
+        graph_dot = export.ProgramConverter.to_dot(program, suppress_common_functions,
+                                                   remove_self_calls=remove_self_calls)
 
         file_written_to = tempfile.NamedTemporaryFile(delete=False)
         file_out = tempfile.NamedTemporaryFile(delete=False)
         file_written_to.write(graph_dot)
         file_written_to.close()
-        subprocess.call(['dot', '-Tsvg', '-Kdot', '-o', file_out.name, file_written_to.name])
+        subprocess.call(['dot', '-Tsvg', '-Kdot', '-o', file_out.name,
+                         file_written_to.name])
 
         output = file_out.read().encode()
         file_out.close()
@@ -202,8 +204,8 @@
             request.setResponseCode(204)
             request.finish()
             defer.returnValue(None)
-
-        output = yield deferToThread(self.get_plot, program, suppress_common)
+        output = yield deferToThread(self.get_plot, program, suppress_common,
+                                     remove_self_calls=False)
         request.setHeader("content-type", "image/svg+xml")
 
         logging.info('SVG: return')