Merge lp:~mbp/bzr/scripts into lp:bzr

[Martin Pool]

ignore common leading whitespace in shell-like script tests

This makes shell-like tests ignore consistent leading indentation which makes them much easier to use.

[lp:~mbp/bzr/scripts]

5295. By Canonical.com Patch Queue Manager <email address hidden> on 2010-06-15

(mbp) add ObjectWithCleanups (Martin Pool)

[Vincent Ladeuil (vila)]

Nice sugar.
Will it still work if a test expects an output with leading spaces like:
$ bzr xxx
    done

I'm not sure we *need* to support that though and a leading '\ ' may work too in this case.

review: Approve

[Martin Pool (mbp)]

On 15 June 2010 17:35, Vincent Ladeuil <email address hidden> wrote:
> Review: Approve
> Nice sugar.
> Will it still work if a test expects an output with leading spaces like:
> $ bzr xxx
>    done
>
> I'm not sure we *need* to support that though and a leading '\ ' may work too in this case.

I think that's an important case and yes, it does support it: dedent
strips the common prefix of space from each line.

--
Martin

[Martin Pool (mbp)]

sent to pqm by email

[lp:~mbp/bzr/scripts]

5296. By Canonical.com Patch Queue Manager <email address hidden> on 2010-06-15

(mbp) ignore common leading whitespace in shell-like script tests (Martin
 Pool)

=== modified file 'NEWS'
--- NEWS	2010-06-15 04:32:49 +0000
+++ NEWS	2010-06-15 07:45:44 +0000
@@ -36,6 +36,10 @@
 * ``bzr log --exclude-common-ancestry`` is now taken into account for
   linear ancetries. (Vincent Ladeuil, #575631)
 
+* ``bzr pull`` now works when a lp: URL is explicitly defined as the parent
+  or pull location in locations.conf or branch.conf.
+  (Gordon Tyler, #534787)
+
 * Ensure that wrong path specifications in ``BZR_PLUGINS_AT`` display
   proper error messages. (Vincent Ladeuil, #591215)
 
@@ -52,13 +56,13 @@
   test that all commands available to the test suite have help.
   (Robert Collins, #177500)
 
+* ``ScriptRunner`` now strips off leading indentation from test scripts,
+  which previously caused "SyntaxError: No command for line".
+  (Martin Pool)
+
 * Relative imports in plugins are now handled correctly when using
   BZR_PLUGINS_AT. (Vincent Ladeuil, #588959)
 
-* ``bzr pull`` now works when a lp: URL is explicitly defined as the parent
-  or pull location in locations.conf or branch.conf.
-  (Gordon Tyler, #534787)
-
 Improvements
 ************
 

=== modified file 'bzrlib/tests/script.py'
--- bzrlib/tests/script.py	2010-02-23 07:43:11 +0000
+++ bzrlib/tests/script.py	2010-06-15 07:45:44 +0000
@@ -24,6 +24,7 @@
 import glob
 import os
 import shlex
+import textwrap
 from cStringIO import StringIO
 
 from bzrlib import (
@@ -73,6 +74,7 @@
     cmd_line = 1
     lineno = 0
     input, output, error = None, None, None
+    text = textwrap.dedent(text)
     for line in text.split('\n'):
         lineno += 1
         # Keep a copy for error reporting
@@ -475,3 +477,7 @@
     def run_command(self, cmd, input, output, error):
         return self.script_runner.run_command(self, cmd, input, output, error)
 
+
+def run_script(test_case, script_string):
+    """Run the given script within a testcase"""
+    return ScriptRunner().run_script(test_case, script_string)

=== modified file 'bzrlib/tests/test_script.py'
--- bzrlib/tests/test_script.py	2010-02-23 07:43:11 +0000
+++ bzrlib/tests/test_script.py	2010-06-15 07:45:44 +0000
@@ -51,6 +51,18 @@
             [(['cat', '>file'], 'content\n', None, None)],
             script._script_to_commands('$ cat >file\n<content\n'))
 
+    def test_indented(self):
+        # scripts are commonly given indented within the test source code, and
+        # common indentation is stripped off
+        story = """
+            $ bzr add
+            adding file
+            adding file2
+            """
+        self.assertEquals([(['bzr', 'add'], None,
+                            'adding file\nadding file2\n', None)],
+                          script._script_to_commands(story))
+
     def test_command_with_output(self):
         story = """
 $ bzr add

=== modified file 'doc/developers/testing.txt'
--- doc/developers/testing.txt	2010-06-04 03:09:35 +0000
+++ doc/developers/testing.txt	2010-06-15 07:45:44 +0000
@@ -395,20 +395,21 @@
 The actual use of ScriptRunner within a TestCase looks something like
 this::
 
-        def test_unshelve_keep(self):
-                # some setup here
-                sr = ScriptRunner()
-                sr.run_script(self, '''
-        $ bzr add file
-        $ bzr shelve --all -m Foo
-        $ bzr shelve --list
-        1: Foo
-        $ bzr unshelve --keep
-        $ bzr shelve --list
-        1: Foo
-        $ cat file
-        contents of file
-        ''')
+    from bzrlib.tests import script
+
+    def test_unshelve_keep(self):
+        # some setup here
+        script.run_script(self, '''
+            $ bzr add file
+            $ bzr shelve --all -m Foo
+            $ bzr shelve --list
+            1: Foo
+            $ bzr unshelve --keep
+            $ bzr shelve --list
+            1: Foo
+            $ cat file
+            contents of file
+            ''')
 
 
 Import tariff tests
@@ -872,4 +873,4 @@
 .. |--| unicode:: U+2014
 
 ..
-   vim: ft=rst tw=74 ai
+   vim: ft=rst tw=74 ai et sw=4