[Lldb-commits] [PATCH] D19215: normalize test file extension for test filenames

[Todd Fiala via lldb-commits]

tfiala updated this revision to Diff 54102.
tfiala added a comment.

Final change: this change:

1. has the lldbinline.py test intercept its __file parameter and convert from .pyc to .py before storing to the test.test_filename attribute.
2. has the test event creation mechanism and test_event usage mechanism always validate that the filename ends in .py.  It will generate an exception if not.

If we find that #2 is triggering sometimes, I want to go back to being permissive in input now that it is clear this started when we removed the disabling feature that prohibited .pyc files from being generated.


http://reviews.llvm.org/D19215

Files:
  packages/Python/lldbsuite/test/lldbinline.py
  packages/Python/lldbsuite/test/result_formatter.py

Index: packages/Python/lldbsuite/test/result_formatter.py
===================================================================
--- packages/Python/lldbsuite/test/result_formatter.py
+++ packages/Python/lldbsuite/test/result_formatter.py
@@ -64,7 +64,7 @@
     def create_socket(port):
         """Creates a socket to the localhost on the given port.
 
-        @param port the port number of the listenering port on
+        @param port the port number of the listening port on
         the localhost.
 
         @return (socket object, socket closing function)
@@ -243,6 +243,13 @@
         return event
 
     @staticmethod
+    def _assert_is_python_sourcefile(test_filename):
+        if test_filename is not None:
+            if not test_filename.endswith(".py"):
+                raise Exception("source python filename has unexpected extension: {}".format(test_filename))
+        return test_filename
+
+    @staticmethod
     def _event_dictionary_common(test, event_type):
         """Returns an event dictionary setup with values for the given event type.
 
@@ -257,9 +264,9 @@
         # Determine the filename for the test case.  If there is an attribute
         # for it, use it.  Otherwise, determine from the TestCase class path.
         if hasattr(test, "test_filename"):
-            test_filename = test.test_filename
+            test_filename = EventBuilder._assert_is_python_sourcefile(test.test_filename)
         else:
-            test_filename = inspect.getsourcefile(test.__class__)
+            test_filename = EventBuilder._assert_is_python_sourcefile(inspect.getsourcefile(test.__class__))
 
         event = EventBuilder.bare_event(event_type)
         event.update({
@@ -498,7 +505,7 @@
         if exception_description is not None:
             event["exception_description"] = exception_description
         if test_filename is not None:
-            event["test_filename"] = test_filename
+            event["test_filename"] = EventBuilder._assert_is_python_sourcefile(test_filename)
         if command_line is not None:
             event["command_line"] = command_line
         return event
@@ -522,7 +529,7 @@
         if worker_index is not None:
             event["worker_index"] = int(worker_index)
         if test_filename is not None:
-            event["test_filename"] = test_filename
+            event["test_filename"] = EventBuilder._assert_is_python_sourcefile(test_filename)
         if command_line is not None:
             event["command_line"] = command_line
         return event
Index: packages/Python/lldbsuite/test/lldbinline.py
===================================================================
--- packages/Python/lldbsuite/test/lldbinline.py
+++ packages/Python/lldbsuite/test/lldbinline.py
@@ -189,6 +189,12 @@
     
 
 def MakeInlineTest(__file, __globals, decorators=None):
+    # Adjust the filename if it ends in .pyc.  We want filenames to
+    # reflect the source python file, not the compiled variant.
+    if __file is not None and __file.endswith(".pyc"):
+        # Strip the trailing "c"
+        __file = __file[0:-1]
+
     # Derive the test name from the current file name
     file_basename = os.path.basename(__file)
     InlineTest.mydir = TestBase.compute_mydir(__file)
@@ -205,7 +211,8 @@
     # Add the test case to the globals, and hide InlineTest
     __globals.update({test_name : test})
 
-    # Store the name of the originating file.o
+    # Keep track of the original test filename so we report it
+    # correctly in test results.
     test.test_filename = __file
     return test
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D19215.54102.patch
Type: text/x-patch
Size: 3581 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/lldb-commits/attachments/20160418/1563b68b/attachment.bin>