Merge lp:~piastucki/bzr-xmloutput/xml-shelve-list into lp:bzr-xmloutput

[Piotr Piastucki]

The changes in this branch add xmlshelvelist command, an XML version of "bzr shelve --list".

[Guillermo Gonzalez (verterok)]

The code looks good.
Just one question, any reason to add the specific xmlshelvelist command instead of a command + option like the shelve command, e.g: xmlshelve --list?

Thanks

review: Needs Information

[Piotr Piastucki (piastucki)]

Good point. I was also thinking about that. I decided to add a new command as the main purpose of the shelve command is shelving files and --list option seems to be secondary. I think it is a good idea to provide XML versions of the commands that generate complex output and avoid re-implementing commands that modify anything. In this case I could add xmlshelve command that would support only --list option and throw an error otherwise. (or maybe delegate to built-in commands instead?). Instead of adding a very limited xmlshelve command I added xmlshelvelist to make it more obvious what the command actually does. However, I am not fully convinced this is the best apporach either. Please let me know what you think and I will change the code accordingly.

[Piotr Piastucki (piastucki)]

> The code looks good.
> Just one question, any reason to add the specific xmlshelvelist command
> instead of a command + option like the shelve command, e.g: xmlshelve --list?
>
> Thanks

Good point. I was also thinking about that. I decided to add a new command as the main purpose of the shelve command is shelving files and --list option seems to be secondary. I think it is a good idea to provide XML versions of the commands that generate complex output and avoid re-implementing commands that modify anything. In this case I could add xmlshelve command that would support only --list option and throw an error otherwise. (or maybe delegate to built-in commands instead?). Instead of adding a very limited xmlshelve command I added xmlshelvelist to make it more obvious what the command actually does. However, I am not fully convinced this is the best apporach either. Please let me know what you think and I will change the code accordingly.

[Guillermo Gonzalez (verterok)]

review: Approve

=== modified file '__init__.py'
--- __init__.py	2013-02-12 18:38:52 +0000
+++ __init__.py	2013-04-26 15:15:34 +0000
@@ -50,7 +50,8 @@
     "stop_xmlrpc",
     "xmllog",
     "xmlls",
-    "xmltags"]:
+    "xmltags",
+    "xmlshelvelist"]:
     plugin_cmds.register_lazy(
         "cmd_%s" % cmd, [],
         "bzrlib.plugins.xmloutput.cmds")

=== modified file 'cmds.py'
--- cmds.py	2013-02-16 23:15:33 +0000
+++ cmds.py	2013-04-26 15:15:34 +0000
@@ -465,3 +465,25 @@
             self.outf.write('\0')
         self.outf.write('\n')
 
+class cmd_xmlshelvelist(Command):
+    """List shelved changes.
+    This command lists previously-shelved changes.
+    """
+    hidden = True
+    _see_also = ['unshelve', 'configuration']
+    takes_options = [
+         'directory',
+         null_option
+    ]
+    encoding_type = 'replace'
+
+    @display_command
+    @handle_error_xml
+    def run(self, *args, **kwargs):
+        import shelvexml
+        null = kwargs.pop('null', False)
+        shelvexml.list_xml(self.outf, *args, **kwargs)
+        if null:
+            self.outf.write('\0')
+        self.outf.write('\n')
+

=== modified file 'info.py'
--- info.py	2013-02-12 18:38:52 +0000
+++ info.py	2013-04-26 15:15:34 +0000
@@ -20,5 +20,5 @@
 bzr_plugin_version = (0, 8, 9, 'final', 0)
 
 bzr_commands = ['xmlannotate', 'xmlinfo', 'xmlmissing', 'xmllog', 'xmlls',
-                'xmlplugins', 'xmltags', 'xmlversion', 'start-xmlrpc', 'stop-xmlrpc']
+                'xmlplugins', 'xmlshelvelist', 'xmltags', 'xmlversion', 'start-xmlrpc', 'stop-xmlrpc']
 

=== added file 'shelvexml.py'
--- shelvexml.py	1970-01-01 00:00:00 +0000
+++ shelvexml.py	2013-04-26 15:15:34 +0000
@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+#
+# Copyright (C) 2013 Piotr Piastucki
+#
+# The code taken from bzrlib is under: Copyright (C) 2005-2007 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+#
+
+"""modified shelve --list command to generate xml output"""
+
+import bzrlib
+from bzrlib import errors
+from bzrlib.workingtree import WorkingTree
+from writer import _escape_cdata
+
+def list_xml(outf, directory='.'):
+    tree = WorkingTree.open_containing(directory)[0]
+    manager = tree.get_shelf_manager()
+    shelves = manager.active_shelves()
+    outf.write('<?xml version="1.0" encoding="%s"?>' % \
+            bzrlib.osutils.get_user_encoding())
+    outf.write('<shelves>')
+    for shelf_id in reversed(shelves):
+        message = manager.get_metadata(shelf_id).get('message')
+        if message is None:
+            message = ''
+        outf.write('<shelf><id>%s</id><message>%s</message></shelf>' % (shelf_id, _escape_cdata(message)))
+    outf.write('</shelves>')
+
+

=== added file 'tests/test_shelve_xml.py'
--- tests/test_shelve_xml.py	1970-01-01 00:00:00 +0000
+++ tests/test_shelve_xml.py	2013-04-26 15:15:34 +0000
@@ -0,0 +1,101 @@
+# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
+# Copyright (C) 2013 Piotr Piastucki
+# -*- coding: utf-8 -*-
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+"""Black-box tests for bzr shelve list."""
+
+import os
+import sys
+import bzrlib
+from bzrlib import osutils
+from bzrlib import shelf
+from bzrlib.tests.blackbox import ExternalBase
+from bzrlib.tests import TestCaseInTempDir, TestCaseWithTransport
+from bzrlib.xml_serializer import elementtree as elementtree
+fromstring = elementtree.fromstring
+elementtree_tostring = elementtree.tostring
+
+class TestShelveList(ExternalBase):
+
+    def prepare_shelves(self):
+        tree = self.make_branch_and_tree('.')
+        tree.lock_write()
+        self.addCleanup(tree.unlock)
+        self.build_tree(['foo/', 'bar/', 'foo/baz', 'foo/text'])
+        self.build_tree_contents([('foo/text', 'a\n')])
+        tree.add(['foo', 'bar', 'foo/baz', 'foo/text'], ['foo-id', 'bar-id', 'baz-id', 'text-id'])
+        tree.commit('Committed foo')
+        self.build_tree_contents([('foo/text', 'b\na\nc\n')])
+        # shelf #1 - content change
+        creator = shelf.ShelfCreator(tree, tree.basis_tree())
+        creator.shelve_all()
+        manager = tree.get_shelf_manager()
+        manager.shelve_changes(creator, 'message1')
+        creator.finalize()
+        tree.rename_one('foo/baz', 'bar/baz')
+        # shelf #2 - rename
+        creator = shelf.ShelfCreator(tree, tree.basis_tree())
+        creator.shelve_all()
+        manager.shelve_changes(creator, 'message2')
+        creator.finalize()
+        return tree
+
+    def test_list_all(self):
+        tree = self.prepare_shelves()
+        shelves_xml = fromstring(self.run_bzr('xmlshelvelist')[0])
+       # tree = WorkingTree.open_containing('.')[0]
+        manager = tree.get_shelf_manager()
+        shelves = manager.active_shelves()
+        self.assertEquals(shelves_xml.tag, 'shelves') 
+        self.assertEquals(len(shelves_xml), 2)
+        self.assertEquals(shelves_xml[0].tag, 'shelf')
+        self.assertEquals(shelves_xml[0][0].tag, 'id') 
+        self.assertEquals(shelves_xml[0][0].text, '2') 
+        self.assertEquals(shelves_xml[0][1].tag, 'message') 
+        self.assertEquals(shelves_xml[0][1].text, 'message2') 
+        self.assertEquals(shelves_xml[1].tag, 'shelf')
+        self.assertEquals(shelves_xml[1][0].tag, 'id') 
+        self.assertEquals(shelves_xml[1][0].text, '1') 
+        self.assertEquals(shelves_xml[1][1].tag, 'message') 
+        self.assertEquals(shelves_xml[1][1].text, 'message1') 
+
+    def test_empty(self):
+        shelves_xml = fromstring(self.run_bzr('xmlshelvelist')[0])
+        self.assertEquals(shelves_xml.tag, 'shelves') 
+        self.assertEquals(len(shelves_xml), 0)
+
+    def test_shelve_list_outside_branch(self):
+        # we disable isolation because the error we want to catch is triggered
+        # outside of the jail
+        self.disable_directory_isolation()
+        if sys.platform == "win32":
+            location = "C:/i/do/not/exist/"
+        else:
+            location = "/i/do/not/exist/"
+        out, err = self.run_bzr('xmlshelvelist --directory='+ location, retcode=3)
+        self.assertEqual(out, '')
+        self.assertEqual(
+            '<?xml version="1.0" encoding="%s"?><error>'
+            '<class>NotBranchError</class><dict><key>path</key><value>'
+            '%s</value><key>extra</key><value></value>'
+            '<key>detail</key><value></value></dict>'
+            '<message>Not a branch: "%s".</message>'
+            '</error>' % (osutils.get_user_encoding(),
+                          location, location), err)
+
+