Merge lp:~piastucki/bzr-xmloutput/fix-551351-ignored-in-symlink-root into lp:bzr-xmloutput

[Piotr Piastucki]

This patch fixes the way ignored files are handled in case the branch is access via symlink rather than a real path.

Invoking xmlls in the following way
bzr xmlls --ignored symlink

Results in an error (see traceback below) because the code first concatenates the symlink with the relative path of the ignored file and then tries to get the relative path by calling tree.relpath(fp). tree.relpath(fp) cannot find the relative path as bzr seems to expand symlinks so that the branch root (tree.basedir) contains the actual path.
The fix changes the order of pattern lookup and path concatenation and completely removes the need to call tree.relpath(fp).

Traceback:
0.102 Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/bzrlib/plugins/xmloutput/xml_errors.py", line 69, in xml_error_handling
    return func(*args, **kwargs)
  File "/usr/lib/python2.7/dist-packages/bzrlib/plugins/xmloutput/cmds.py", line 385, in run
    lsxml.show_ls_xml(self.outf, *args, **kwargs)
  File "/usr/lib/python2.7/dist-packages/bzrlib/plugins/xmloutput/lsxml.py", line 89, in show_ls_xml
    pattern = '<pattern>%s</pattern>' % _escape_cdata(pat)
  File "/usr/lib/python2.7/dist-packages/bzrlib/plugins/xmloutput/writer.py", line 13, in _escape_cdata
    text = text.replace("&", "&amp;")
AttributeError: 'NoneType' object has no attribute 'replace'

[Guillermo Gonzalez (verterok)]

Thanks for working on this, can I ask you to add a test case for it?

Thanks.

review: Needs Information

[lp:~piastucki/bzr-xmloutput/fix-551351-ignored-in-symlink-root]

174. By Piotr Piastucki on 2013-08-26

Add test case

[Piotr Piastucki (piastucki)]

Test case added

[Guillermo Gonzalez (verterok)]

Thanks!

review: Approve

=== modified file 'lsxml.py'
--- lsxml.py	2011-12-12 15:11:38 +0000
+++ lsxml.py	2013-08-26 19:03:54 +0000
@@ -71,6 +71,12 @@
                 continue
             if kind is not None and fkind != kind:
                 continue
+            if fc == 'I' and ignored:
+                # get the pattern
+                pat = tree.is_ignored(fp)
+                pattern = '<pattern>%s</pattern>' % _escape_cdata(pat)
+            else:
+                pattern = ''
             if prefix:
                 fp = osutils.pathjoin(prefix, fp)
             if fid is None:
@@ -80,15 +86,6 @@
             fkind = '<kind>%s</kind>' % fkind
             status_kind = '<status_kind>%s</status_kind>' % long_status_kind[fc]
             fpath = '<path>%s</path>' % _escape_cdata(fp)
-            if fc == 'I' and ignored:
-                # get the pattern
-                if tree.basedir in fp:
-                    pat = tree.is_ignored(tree.relpath(fp))
-                else:
-                    pat = tree.is_ignored(fp)
-                pattern = '<pattern>%s</pattern>' % _escape_cdata(pat)
-            else:
-                pattern = ''
             outstring = '<item>%s%s%s%s%s</item>' % (fid, fkind, fpath,
                                                    status_kind, pattern)
             outf.write(outstring)

=== modified file 'tests/test_ls_xml.py'
--- tests/test_ls_xml.py	2012-02-21 10:14:16 +0000
+++ tests/test_ls_xml.py	2013-08-26 19:03:54 +0000
@@ -318,4 +318,21 @@
                            'path': 'a',
                            'status_kind': 'versioned'}]
         self.assertEquals(expected_items, self.run_xmlls('--revision 1'))
+        
+    def test_lsxml_ignored_symlink(self):
+        # Ignored files inside a symlink directory
+        self.wt.add(['a', '.bzrignore'], ['a-id', 'bzrignore-id'])
+        self.build_tree(['blah.py', 'blah.pyo', 'user-ignore'])
+        symlink = self.test_dir + '_symlink'
+        os.symlink(self.test_dir, symlink)
+        expected_items = [{'kind': 'file',
+                           'path': os.path.join(symlink, 'blah.pyo'),
+                           'pattern': '*.pyo',
+                           'status_kind': 'ignored'},
+                          {'kind': 'file',
+                           'path': os.path.join(symlink, 'user-ignore'),
+                           'pattern': 'user-ignore',
+                           'status_kind': 'ignored'}]
+        self.assertEquals(expected_items, self.run_xmlls('--ignored ' + symlink))
+