BetterTwill: Output path to HTML file as followable link

[Ryan J Ollos]

When a twill test fails, we get output such as the following:

======================================================================
FAIL: runTest (__main__.TestDefaultHandler)
Set default handler from the Basic Settings page.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "trac/admin/tests/functional.py", line 133, in runTest
    tc.find(r'<option value="BatchModifyModule">BatchModifyModule'
  File "/home/user/Workspace/tracdev/teo-rjollos.git/trac/tests/functional/better_twill.py", line 225, in better_find
    raise twill.errors.TwillAssertionError(*args)
TwillAssertionError: ('no match to \'<option value="BatchModifyModule">BatchModifyModule</option>\'', '/home/user/Workspace/tracdev/teo-rjollos.git/testenv/trac/log/TestDefaultHandler.html')

I've wondered whether /home/user/Workspace/tracdev/teo-rjollos.git/testenv/trac/log/TestDefaultHandler.html can be rendered in the terminal as a followable link for all OSs that we support, or at least for the most widely used ones (sh and Windows Command Prompt, at least).

[Ryan J Ollos]

I typically use Gnome Terminal. The feature I wish to take advantage of is ​URL detection. This could be accomplished with a change such as the following:

trac/tests/functional/better_twill.py

@@ -17 +17 @@
 """
 
 import os
-from os.path import abspath, dirname, join
 import sys
+import urllib
+import urlparse
+from os.path import abspath, dirname, join
 from pkg_resources import parse_version as pv
 try:
     from cStringIO import StringIO
@@ -160 +162 @@
         html_file.write(b.get_html())
         html_file.close()
 
-        return filename
+        return urlparse.urljoin('file:', urllib.pathname2url(filename))
 
     # Twill isn't as helpful with errors as I'd like it to be, so we replace
     # the formvalue function.  This would be better done as a patch to Twill.

The output would be:

TwillAssertionError: ("no match to 'Your changes have been saved.!!'", 'file:///home/user/Workspace/tracdev/teo-rjollos.git/testenv/trac/log/TestDefaultHandler.html')

rather than:

TwillAssertionError: ("no match to 'Your changes have been saved.!!'", '/home/user/Workspace/tracdev/teo-rjollos.git/testenv/trac/log/TestDefaultHandler.html')

and a CTRL+click while hovering over the file URL opens the file in the default web browser.

However, I've not evaluated the cross-platform or cross-terminal usability of the change.

[Jun Omae]

I don't use URL detection (I'm using PuTTY on Windows), but that's okay. Because Vim can open the file:/// resource. Also, I tried with ​ConEmu. The terminal detects file:///....html') as a link.

I think the detection and message would be good to apply the following.

trac/tests/functional/better_twill.py

@@ -221 +223 @@
             tcfind(what, flags)
         except twill.errors.TwillAssertionError as e:
             filename = twill_write_html()
-            args = e.args + (filename,)
-            raise twill.errors.TwillAssertionError(*args)
+            raise twill.errors.TwillAssertionError('%s at %s' %
+                                                   (unicode(e), filename))

Traceback (most recent call last):
  File "trac\admin\tests\functional.py", line 73, in runTest
    tc.find('https://my.example.com/something')
  File "C:\usr\src\trac\trac.git\trac\tests\functional\better_twill.py", line 227, in better_find
    (unicode(e), filename))
TwillAssertionError: no match to 'https://my.example.com/something' at file:///C:/usr/src/trac/trac.git/testenv/trac/log/TestBasicSettings.html

The link can open the html file on Firefox by clicking.

[Ryan J Ollos]

Do the changes in log:rjollos.git:t11635 look good?

[Jun Omae]

I tried the branch with conemu. It looks good to me.

[Ryan J Ollos]

Committed to 1.0-stable in [12880], merged to trunk in [12881]. Tested on my end with Ubuntu 13.04.