Merge lp:~frankban/lpsetup/bug-1023895-init-repo-no-checkout into lp:lpsetup

[Francesco Banconi]

Add --no-checkout option to init-repo and other fixes.

== Changes ==

*handle_directories* now handles relative paths. E.g. it is possible to use a relative path for the target repository *init-repo* command line argument. Also updated the relevant TestCase.

Added the *handle_branch_and_checkout* handler: it validates branch and checkout names.

s/CHECKOUT_DIR/LP_REPOSITORY_DIR everywhere.

Added `--no-checkout` option to *init-repo*: it creates a "normal" non-lightweight checkout.

The runtime errors that can be generated by `bzr` calls in *init-repo* are now handled and raise an *ExecutionError*. To avoid race conditions this error handling is done by the step itself and not by the handlers.
The *fetch()* step now tries a lot: it contains 3 similar try/except blocks that could be abstracted, for instance, with a code like this::

    def bzrcall(args, error=''):
        """Execute bzr passing *args*.

        If the bzr command fails, raise an ExecutionError containing the given
        *error* + the original bzr failure message.
        """
        cmd = ['bzr'] + list(args)
        try:
            call(*cmd)
        except subprocess.CalledProcessError as err:
            raise exceptions.ExecutionError(error + err.output)

I decided to leave the explicit calls in *fetch()*: please feel free to suggest another approach.

Fixed *setup_bzr_locations*: now the step correctly handles a custom branch name that can be passed as an argument.

Implemented an integration TestCase for *init-repo*. The tests create a fake test branch and use it as source bzr repository. The template directory used to create the fake branch is placed in `lpsetup/tests/test-branch/`: right now it contains only a test file, but in the future it can be used as a "mocked" Launchpad branch. 3 tests are currently implemented: init-repo with tree, without tree, and bazaar location checks.

Created a *BackupFile* context manager, useful to backup and restore a single file: in this branch it is used to preserve bazaar's `locations.conf`.

Added tests for the *capture* context manager.

Added the helper function *create_test_branch()*: create a temporary fake test branch.

`setup.cfg` excludes *create_test_branch* and includes *utils*.

[Benji York (benji)]

This branch looks good. There is one thing that needs to be fixed (see
below) and one thing for future consideration (farther below).

The (pre-existing) code that replaces "~" with namespace.home_dir should
use os.path.expanduser() instead. The reason is that just replacing all
tilde characters with the current user's home directory can generate
incorrect results. For example, these strings would not be handled
correctly:

    "~user/foo" --> "/home/useruser/foo"
    "~/foo~bar" --> "/home/user/foouserbar"

Using the users actual bzr config (locations.conf) for tests feels a bit
brittle. Perhaps in the future we can override $HOME instead and
provide our own (fully controlled and non-precious) file hierarchy for
the tests to run against.

review: Approve (code)

[Francesco Banconi (frankban)]

Thanks Benji, I updated the branch following your suggestions.

[Benji York (benji)]

Looks good.

review: Approve (code)

[Launchpad QA Bot (lpqabot)]

The attempt to merge lp:~frankban/lpsetup/bug-1023895-init-repo-no-checkout into lp:lpsetup failed. Below is the output from the failed tests.

nose.plugins.cover: ERROR: Coverage not available: unable to import coverage module
.....................................EEE..........EE.....................................................................
======================================================================
ERROR: disabled_test_bazaar_locations (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 73, in setUp
    self.source = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmp53p8Un', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_no_trees (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 73, in setUp
    self.source = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmpFnoZP3', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_with_trees (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 73, in setUp
    self.source = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmpXemNXl', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_revno (lpsetup.tests.utils.CreateTestBranchTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 87, in setUp
    self.branch_path = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py"...

[Launchpad QA Bot (lpqabot)]

The attempt to merge lp:~frankban/lpsetup/bug-1023895-init-repo-no-checkout into lp:lpsetup failed. Below is the output from the failed tests.

nose.plugins.cover: ERROR: Coverage not available: unable to import coverage module
.....................................EEE..........EE.....................................................................
======================================================================
ERROR: test_bazaar_locations (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 73, in setUp
    self.source = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmpGk18KX', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_no_trees (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 73, in setUp
    self.source = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmpfSq6XO', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_with_trees (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 73, in setUp
    self.source = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmp4yLDfS', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_revno (lpsetup.tests.utils.CreateTestBranchTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 87, in setUp
    self.branch_path = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79...

[Launchpad QA Bot (lpqabot)]

The attempt to merge lp:~frankban/lpsetup/bug-1023895-init-repo-no-checkout into lp:lpsetup failed. Below is the output from the failed tests.

nose.plugins.cover: ERROR: Coverage not available: unable to import coverage module
.....................................F............EE.....................................................................
======================================================================
ERROR: test_revno (lpsetup.tests.utils.CreateTestBranchTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 87, in setUp
    self.branch_path = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmpIGoZpV', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
ERROR: test_working_tree (lpsetup.tests.utils.CreateTestBranchTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 87, in setUp
    self.branch_path = create_test_branch()
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/utils.py", line 79, in create_test_branch
    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
  File "/usr/lib/python2.7/dist-packages/shelltoolbox/__init__.py", line 452, in run
    raise exception
CalledProcessError: Command '['bzr', 'commit', '/mnt/tarmac-tmp/tmpdoiaQC', '-m', 'Initial commit.']' returned non-zero exit status 3

======================================================================
FAIL: test_bazaar_locations (lpsetup.tests.subcommands.test_initrepo.IntegrationTest)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/home/tarmac/repos/lpsetup/trunk/lpsetup/tests/subcommands/test_initrepo.py", line 169, in test_bazaar_locations
    self.assertItemsEqual(options.items(), parser.items(section))
AssertionError: Element counts were not equal:
First has 1, Second has 0: ('push_location', 'lp:~lpqabot/launchpad')
First has 1, Second has 0: ('public_branch', 'bzr+ssh://bazaar.launchpad.net/~lpqabot/launchpad')
First has 0, Second has 1: ('push_location', 'lp:~tarmac/launchpad')
First has 0, Second has 1: ('public_branch', 'bzr+ssh://bazaar.launchpad.net/~tarmac/launchpad')
    """Fail immediately, with the given message."""
>> raise self.failureException("Element counts were not equal:\nFirst has 1, Second has 0: ('push_location', 'lp:~lpqabot/launchpad')\nFirst has 1, Second has 0: ('public_branch', 'bzr+ssh://bazaar.launchpad.net/~lpqabot/launchpad')\nFirst has 0, Second has 1: ('push_location', 'lp:~tarmac/launchpad')\nFirst has 0, Second has 1: ('public_branch', 'bzr+ssh://bazaar.launchpad.net/~tarmac/launchpad')")

-------...

[lp:~frankban/lpsetup/bug-1023895-init-repo-no-checkout]

77. By Francesco Banconi on 2012-07-17

Fixed CreateTestBranchTest: set the bzr user id.

78. By Francesco Banconi on 2012-07-17

Fixed IntegrationTest.test_bazaar_locations: use the real lpuser.

79. By Francesco Banconi on 2012-07-17

Fixed handle_directories relative path test to actually change the current dir.

80. By Francesco Banconi on 2012-07-17

Skipping tests if lpuser is not set up.

=== modified file 'lpsetup/handlers.py'
--- lpsetup/handlers.py	2012-07-13 16:01:13 +0000
+++ lpsetup/handlers.py	2012-07-17 10:49:22 +0000
@@ -21,6 +21,7 @@
 
 from shelltoolbox import (
     bzr_whois,
+    environ,
     get_user_home,
     run,
     user_exists,
@@ -234,8 +235,16 @@
             err = ("argument directory cannot contain "
                    "spaces: '{0}'".format(directory))
             raise ValidationError(err)
-
-        directory = directory.replace('~', namespace.home_dir)
+        # To expand the "~" construction, *os.path.expanduser* tries
+        # to use the "HOME" environment variable.
+        # Using *shelltoolbox.environ*, here we replace the original env var
+        # with the home dir already present in the namespace, for 2 reasons:
+        # - it is possible that we don't need the current user's home
+        #   (e.g. lpsetup is run as root)
+        # - it is possible that we need the home of a non-existent user
+        #   (e.g. lpsetup needs to create the user specified using `--user`)
+        with environ(HOME=namespace.home_dir):
+            directory = os.path.expanduser(directory)
         directory = os.path.abspath(directory)
         if not directory.startswith(namespace.home_dir + os.path.sep):
             raise ValidationError(
@@ -279,3 +288,33 @@
 def handle_working_dir(namespace):
     """Handle path to the working directory."""
     namespace.working_dir = normalize_path(namespace.working_dir)
+
+
+def handle_branch_and_checkout(namespace):
+    """Handle branch and checkout names.
+
+    Raise *ValidationError* if::
+
+    - branch/checkout name is '.' or '..'
+    - branch/checkout name contains '/'
+    - lightweight checkout is used and branch and checkout have the same name
+
+    The namespace must contain the following names::
+
+        - branch_name
+        - checkout_name
+
+    This handler does not modify the namespace.
+    """
+    branch_name = namespace.branch_name
+    checkout_name = namespace.checkout_name
+    for name in (branch_name, checkout_name):
+        if name in ('.', '..') or '/' in name:
+            raise ValidationError(
+                'invalid name "{0}": branch or checkout names can not '
+                'be "." or ".." and can not contain "/"'.format(name))
+    is_lightweight = not getattr(namespace, 'no_checkout', False)
+    if is_lightweight and (checkout_name == branch_name):
+        raise ValidationError(
+            'branch and checkout: can not use the same name ({0}).'.format(
+                checkout_name))

=== modified file 'lpsetup/settings.py'
--- lpsetup/settings.py	2012-07-11 15:47:34 +0000
+++ lpsetup/settings.py	2012-07-17 10:49:22 +0000
@@ -15,7 +15,6 @@
     )
 # a2enmod requires apache2.2-common
 BASE_PACKAGES = ['ssh', 'bzr', 'apache2.2-common']
-CHECKOUT_DIR = '~/launchpad/lp-branches'
 DEPENDENCIES_DIR = '~/launchpad/lp-sourcedeps'
 HOSTS_CONTENT = (
     ('127.0.0.88',
@@ -39,22 +38,23 @@
     )
 LP_BZR_LOCATIONS = {
     '{repository}': {
-        'submit_branch': '{checkout_dir}',
+        'submit_branch': '{branch_dir}',
         'public_branch': 'bzr+ssh://bazaar.launchpad.net/~{lpuser}/launchpad',
         'public_branch:policy': 'appendpath',
         'push_location': 'lp:~{lpuser}/launchpad',
         'push_location:policy': 'appendpath',
-        'merge_target': '{checkout_dir}',
+        'merge_target': '{branch_dir}',
         'submit_to': '[e-mail]',
         },
-    '{checkout_dir}': {
+    '{branch_dir}': {
         'public_branch':
             'bzr+ssh://bazaar.launchpad.net/~launchpad-pqm/launchpad/devel',
         }
     }
 LP_BRANCH_NAME = 'devel'
 LP_CHECKOUT_NAME = 'sandbox'
-LP_CODE_DIR = os.path.join(CHECKOUT_DIR, LP_CHECKOUT_NAME)
+LP_REPOSITORY_DIR = '~/launchpad/lp-branches'
+LP_CODE_DIR = os.path.join(LP_REPOSITORY_DIR, LP_CHECKOUT_NAME)
 LP_PACKAGES = [
     # "launchpad-database-dependencies-9.1" can be removed once 8.x is
     # no longer an option in "launchpad-developer-dependencies.

=== modified file 'lpsetup/subcommands/initrepo.py'
--- lpsetup/subcommands/initrepo.py	2012-07-12 18:23:37 +0000
+++ lpsetup/subcommands/initrepo.py	2012-07-17 10:49:22 +0000
@@ -19,16 +19,20 @@
     ]
 
 import os
+import subprocess
 
 from shelltoolbox import mkdirs
 
-from lpsetup import argparser
-from lpsetup import handlers
+from lpsetup import (
+    argparser,
+    exceptions,
+    handlers,
+    )
 from lpsetup.settings import (
-    CHECKOUT_DIR,
     LP_BRANCH_NAME,
     LP_BZR_LOCATIONS,
     LP_CHECKOUT_NAME,
+    LP_REPOSITORY_DIR,
     )
 from lpsetup.utils import (
     call,
@@ -37,23 +41,42 @@
     )
 
 
-def fetch(source, repository, branch_name, checkout_name):
+def fetch(source, repository, branch_name, checkout_name, no_checkout):
     """Create a repo for the Launchpad code and retrieve it."""
     # XXX should we warn if root?
     # Set up the repository.
     mkdirs(repository)
-    call('bzr', 'init-repo', repository, '--no-trees')
+    is_lightweight = not no_checkout
+    no_trees = '--no-trees' if is_lightweight else None
+    # Initialize the repository.
+    try:
+        call('bzr', 'init-repo', '--quiet', repository, no_trees)
+    except subprocess.CalledProcessError as err:
+        msg = 'Error: unable to initialize the repository: '
+        raise exceptions.ExecutionError(msg + err.output)
     # Set up the codebase.
     branch_dir = os.path.join(repository, branch_name)
-    checkout_dir = os.path.join(repository, checkout_name)
-    call('bzr', 'branch', source, branch_dir)
-    call('bzr', 'co', '--lightweight', branch_dir, checkout_dir)
-
-
-def setup_bzr_locations(lpuser, repository, template=LP_BZR_LOCATIONS):
+    # Retrieve the branch.
+    try:
+        call('bzr', 'branch', source, branch_dir)
+    except subprocess.CalledProcessError as err:
+        msg = 'Error: unable to branch source: '
+        raise exceptions.ExecutionError(msg + err.output)
+    if is_lightweight:
+        checkout_dir = os.path.join(repository, checkout_name)
+        # Create a lightweight checkout.
+        try:
+            call('bzr', 'co', '--lightweight', branch_dir, checkout_dir)
+        except subprocess.CalledProcessError as err:
+            msg = 'Error: unable to create the lightweight checkout: '
+            raise exceptions.ExecutionError(msg + err.output)
+
+
+def setup_bzr_locations(
+    lpuser, repository, branch_name, template=LP_BZR_LOCATIONS):
     """Set up bazaar locations."""
     context = {
-        'checkout_dir': os.path.join(repository, LP_BRANCH_NAME),
+        'branch_dir': os.path.join(repository, branch_name),
         'repository': repository,
         'lpuser': lpuser,
         }
@@ -78,8 +101,10 @@
     """Get the Launchpad code and dependent source code."""
 
     steps = (
-        (fetch, 'source', 'repository', 'branch_name', 'checkout_name'),
-        (setup_bzr_locations, 'lpuser', 'repository'),
+        (fetch,
+         'source', 'repository', 'branch_name', 'checkout_name',
+         'no_checkout'),
+        (setup_bzr_locations, 'lpuser', 'repository', 'branch_name'),
         )
 
     help = __doc__
@@ -87,6 +112,7 @@
         handlers.handle_user,
         handlers.handle_lpuser_from_lplogin,
         handlers.handle_directories,
+        handlers.handle_branch_and_checkout,
         handlers.handle_source,
         )
 
@@ -107,14 +133,19 @@
                 'Defaults to {0}.'.format(LP_BRANCH_NAME))
         parser.add_argument(
             '--checkout-name', default=LP_CHECKOUT_NAME,
-            help='Create a checkout with the given name.  Defaults to {0}.'
-                .format(LP_CHECKOUT_NAME))
+            help='Create a checkout with the given name. '
+                 'Ignored if --no-checkout is specified. '
+                 'Defaults to {0}.'.format(LP_CHECKOUT_NAME))
         parser.add_argument(
-            '-r', '--repository', default=CHECKOUT_DIR,
-            help='The directory of the Launchpad repository to be updated. '
+            '-r', '--repository', default=LP_REPOSITORY_DIR,
+            help='The directory of the Launchpad repository to be created. '
                  'The directory must reside under the home directory of the '
                  'given user (see -u argument). '
-                 '[DEFAULT={0}]'.format(CHECKOUT_DIR))
+                 '[DEFAULT={0}]'.format(LP_REPOSITORY_DIR))
+        parser.add_argument(
+            '--no-checkout', action='store_true', dest='no_checkout',
+            default=False, help='Initialize a bzr repository with trees and '
+            'do not create a lightweight checkout.')
 
     def add_arguments(self, parser):
         super(SubCommand, self).add_arguments(parser)

=== modified file 'lpsetup/tests/subcommands/test_initrepo.py'
--- lpsetup/tests/subcommands/test_initrepo.py	2012-07-05 18:38:51 +0000
+++ lpsetup/tests/subcommands/test_initrepo.py	2012-07-17 10:49:22 +0000
@@ -4,39 +4,67 @@
 
 """Tests for the initrepo subcommand."""
 
+import os
+import shutil
+import subprocess
+import tempfile
 import unittest
 
-from lpsetup import handlers
+from shelltoolbox import (
+    environ,
+    run,
+    )
+
+from lpsetup import (
+    cli,
+    handlers,
+    )
 from lpsetup.subcommands import initrepo
 from lpsetup.tests.utils import (
+    create_test_branch,
     get_random_string,
     StepsBasedSubCommandTestMixin,
     )
+from lpsetup.utils import ConfigParser
+
+
+try:
+    lpuser = run('bzr', 'launchpad-login').strip()
+except subprocess.CalledProcessError:
+    lpuser = None
+# Create a decorator to skip tests if lp login is not set.
+skip_if_no_lpuser = unittest.skipIf(
+    lpuser is None,
+    'You need to set up a Launchpad login is needed to run this test.')
 
 
 fetch_step = (initrepo.fetch,
-    ['source', 'repository', 'branch_name', 'checkout_name'])
+    ['source', 'repository', 'branch_name', 'checkout_name', 'no_checkout'])
 setup_bzr_locations_step = (initrepo.setup_bzr_locations,
-                            ['lpuser', 'repository'])
+    ['lpuser', 'repository', 'branch_name'])
 
 
 def get_arguments():
     return (
         '--source', get_random_string(),
+        '--repository', get_random_string(),
         '--branch-name', get_random_string(),
         '--checkout-name', get_random_string(),
+        '--no-checkout',
         )
 
 
+@skip_if_no_lpuser
 class InitrepoTest(StepsBasedSubCommandTestMixin, unittest.TestCase):
 
-    sub_command_name = 'initrepo'
+    sub_command_name = 'init-repo'
     sub_command_class = initrepo.SubCommand
     expected_arguments = get_arguments()
     expected_handlers = (
         handlers.handle_user,
         handlers.handle_lpuser_from_lplogin,
         handlers.handle_directories,
+        handlers.handle_branch_and_checkout,
         handlers.handle_source,
         )
     expected_steps = (
@@ -44,3 +72,106 @@
         setup_bzr_locations_step,
         )
     needs_root = False
+
+
+@skip_if_no_lpuser
+class IntegrationTest(unittest.TestCase):
+
+    def setUp(self):
+        """Create a fake source bzr branch under `/tmp/`."""
+        # The command init-repo updates `~/.bazaar/locations.conf`:
+        # the tests need to preserve that file using a temporary home dir.
+        self.temp_home = tempfile.mkdtemp()
+        with environ(HOME=self.temp_home):
+            # A Bazaar user id is needed to commit changes.
+            run('bzr', 'whoami', 'Example User <[e-mail]>')
+            # A Launchpad login is needed to run init-repo.
+            run('bzr', 'launchpad-login', lpuser)
+            # Create the source branch. This is done in the cm block because
+            # we want bzr to use info stored in the temp home.
+            self.source = create_test_branch()
+        # Schedule removal of created directories.
+        self.addCleanup(shutil.rmtree, self.temp_home)
+        self.addCleanup(shutil.rmtree, self.source)
+        # The target repository (containing the branch and the checkout)
+        # must be placed inside the user home, otherwise init-repo exits
+        # with a ValidationError.
+        self.repository = tempfile.mktemp(dir=os.path.expanduser('~'))
+        branch_name = 'branch-' + get_random_string()
+        checkout_name = 'checkout-' + get_random_string()
+        self.cmd = (
+            'init-repo',
+            '--source', self.source,
+            '--repository', self.repository,
+            '--branch-name', branch_name,
+            '--checkout-name', checkout_name,
+            )
+        self.branch = os.path.join(self.repository, branch_name)
+        self.checkout = os.path.join(self.repository, checkout_name)
+
+    def tearDown(self):
+        """Remove the target repository."""
+        if os.path.isdir(self.repository):
+            shutil.rmtree(self.repository)
+
+    def assertIsBranch(self, path, no_tree=False):
+        """Assert the given *path* is a valid bzr branch.
+
+        If *no_tree* is True, also check the *path* does not contain
+        a working tree.
+        If *no_tree* is False, also check the *path* contains the test file.
+        """
+        if not os.path.isdir(path):
+            self.fail(path + ' is not a directory')
+        contents = os.listdir(path)
+        if '.bzr' not in contents:
+            self.fail(path + ' is not a bzr repository')
+        if no_tree:
+            if len(contents) > 1:
+                self.fail(path + ' contains a working tree')
+        elif 'test-file' not in contents:
+            self.fail(path + ' does not contain a working tree')
+
+    def test_no_trees(self):
+        # Ensure a lightweight checkout is correctly created by init-repo.
+        with environ(HOME=self.temp_home):
+            retcode = cli.main(self.cmd)
+        self.assertIsNone(retcode)
+        # The branch is created without tree.
+        self.assertIsBranch(self.branch, no_tree=True)
+        # The checkout is created with tree.
+        self.assertIsBranch(self.checkout, no_tree=False)
+
+    def test_with_trees(self):
+        # Ensure a "normal" branch is correctly created by init-repo.
+        with environ(HOME=self.temp_home):
+            retcode = cli.main(self.cmd + ('--no-checkout',))
+        self.assertIsNone(retcode)
+        # The branch is created with tree.
+        self.assertIsBranch(self.branch, no_tree=False)
+
+    def test_bazaar_locations(self):
+        # Ensure the file `~/.bazaar/locations.conf` is correctly updated.
+        expected_locations = {
+            self.repository: {
+                'merge_target': self.branch,
+                'public_branch': 'bzr+ssh://bazaar.launchpad.net/~{}/'
+                                 'launchpad'.format(lpuser),
+                'public_branch:policy': 'appendpath',
+                'push_location': 'lp:~{}/launchpad'.format(lpuser),
+                'push_location:policy': 'appendpath',
+                'submit_branch': self.branch,
+                'submit_to': '[e-mail]',
+                },
+            self.branch: {
+                'public_branch': 'bzr+ssh://bazaar.launchpad.net/'
+                                 '~launchpad-pqm/launchpad/devel',
+                },
+            }
+        with environ(HOME=self.temp_home):
+            cli.main(self.cmd)
+            path = os.path.join(self.temp_home, '.bazaar', 'locations.conf')
+            parser = ConfigParser()
+            parser.read(path)
+            for section, options in expected_locations.items():
+                self.assertItemsEqual(options.items(), parser.items(section))

=== added directory 'lpsetup/tests/test-branch'
=== added file 'lpsetup/tests/test-branch/test-file'
=== modified file 'lpsetup/tests/test_handlers.py'
--- lpsetup/tests/test_handlers.py	2012-07-09 21:18:21 +0000
+++ lpsetup/tests/test_handlers.py	2012-07-17 10:49:22 +0000
@@ -7,11 +7,15 @@
 import argparse
 from contextlib import contextmanager
 import getpass
+import os
 import pwd
 import unittest
 
+from shelltoolbox import cd
+
 from lpsetup.exceptions import ValidationError
 from lpsetup.handlers import (
+    handle_branch_and_checkout,
     handle_directories,
     handle_lpuser_as_username,
     handle_ssh_keys,
@@ -61,9 +65,48 @@
                 raise TypeError
 
 
+class HandleBranchAndCheckoutTest(HandlersTestMixin, unittest.TestCase):
+
+    def test_valid_arguments(self):
+        # The validation succeed if there are no conflicts in arguments.
+        namespace = argparse.Namespace(
+            branch_name='branch',
+            checkout_name='checkout')
+        handle_branch_and_checkout(namespace)
+
+    def test_checkout_equals_branch(self):
+        # The validation fails if checkout and branch have the same name.
+        namespace = argparse.Namespace(
+            branch_name='branch',
+            checkout_name='branch')
+        with self.assertNotValid('checkout'):
+            handle_branch_and_checkout(namespace)
+
+    def test_checkout_equals_branch_without_trees(self):
+        # The validation succeed if checkout and branch have the same name
+        # but `--no-checkout` is specified.
+        namespace = argparse.Namespace(
+            branch_name='branch',
+            checkout_name='branch',
+            no_checkout=True)
+        handle_branch_and_checkout(namespace)
+
+    def test_invalid_names(self):
+        # The validation fails if the branch/checkout name is '.' or '..',
+        # or if it contains '/'.
+        for kwargs in (
+            {'branch_name': '.', 'checkout_name': 'checkout'},
+            {'branch_name': 'branch', 'checkout_name': '..'},
+            {'branch_name': '../', 'checkout_name': 'checkout'},
+            {'branch_name': 'branch', 'checkout_name': 'check/out'},
+            ):
+            with self.assertNotValid('invalid name'):
+                handle_branch_and_checkout(argparse.Namespace(**kwargs))
+
+
 class HandleDirectoriesTest(HandlersTestMixin, unittest.TestCase):
 
-    home_dir = '/home/foo'
+    home_dir = os.path.expanduser('~')
     dependencies_dir = '~/launchpad/deps'
 
     def test_home_is_expanded(self):
@@ -72,9 +115,20 @@
             repository='~/launchpad', home_dir=self.home_dir,
             dependencies_dir=self.dependencies_dir)
         handle_directories(namespace)
-        self.assertEqual('/home/foo/launchpad', namespace.repository)
-        self.assertEqual(
-            '/home/foo/launchpad/deps', namespace.dependencies_dir)
+        self.assertEqual(
+            os.path.join(self.home_dir, 'launchpad'),
+            namespace.repository)
+        self.assertEqual(
+            os.path.join(self.home_dir, 'launchpad', 'deps'),
+            namespace.dependencies_dir)
+
+    def test_tilde_expanded_only_when_needed(self):
+        # Ensure the "~" construction is expanded only when it represents
+        # the home directory of the user.
+        repository = '~repository/~'
+        namespace = argparse.Namespace(
+            repository=repository, home_dir=self.home_dir)
+        self.assertEqual(repository, namespace.repository)
 
     def test_directory_not_in_home(self):
         # The validation fails for directories not residing inside the home.
@@ -90,6 +144,28 @@
         with self.assertNotValid('directory'):
             handle_directories(namespace)
 
+    def test_relative_path(self):
+        # Ensure relative paths are correctly expanded.
+        namespace = argparse.Namespace(
+            repository='launchpad', home_dir=self.home_dir,
+            dependencies_dir='launchpad/../deps')
+        with cd(self.home_dir):
+            handle_directories(namespace)
+            cwd = os.getcwd()
+            self.assertEqual(
+                os.path.join(cwd, 'launchpad'),
+                namespace.repository)
+            self.assertEqual(
+                os.path.join(cwd, 'deps'),
+                namespace.dependencies_dir)
+
+    def test_invalid_relative_path(self):
+        # The validation fails if a relative path points outside the home.
+        namespace = argparse.Namespace(
+            repository='~/../', home_dir=self.home_dir)
+        with self.assertNotValid('repository'):
+            handle_directories(namespace)
+
 
 class HandleLPUserTest(unittest.TestCase):
 

=== modified file 'lpsetup/tests/utils.py'
--- lpsetup/tests/utils.py	2012-06-27 09:20:50 +0000
+++ lpsetup/tests/utils.py	2012-07-17 10:49:22 +0000
@@ -15,13 +15,23 @@
 
 from contextlib import contextmanager
 from functools import partial
+import os
 import random
+import shutil
 import string
 from StringIO import StringIO
 import sys
+import tempfile
+import unittest
+
+from shelltoolbox import (
+    environ,
+    run,
+    )
 
 from lpsetup import argparser
 from lpsetup.tests import examples
+from lpsetup.utils import call
 
 
 @contextmanager
@@ -39,6 +49,65 @@
 capture_error = partial(capture, 'stderr')
 
 
+class CaptureTest(unittest.TestCase):
+    """Tests for the *capture* context manager."""
+
+    message = 'message'
+
+    def test_capture_output(self):
+        with capture_output() as stream:
+            print self.message
+        self.assertEqual(self.message + '\n', stream.getvalue())
+
+    def test_capture_error(self):
+        with capture_error() as stream:
+            print >> sys.stderr, self.message
+        self.assertEqual(self.message + '\n', stream.getvalue())
+
+
+def create_test_branch(template_dir=None):
+    """Create a temporary test branch containing files in *template_dir*.
+
+    If *template_dir* is None, the files in `lpsetup/tests/test-branch`
+    are used.
+
+    Return the path of the newly created branch.
+    """
+    if template_dir is None:
+        template_dir = os.path.join(os.path.dirname(__file__), 'test-branch')
+    branch_path = tempfile.mktemp()
+    shutil.copytree(template_dir, branch_path)
+    call('bzr', 'init', '--quiet', branch_path)
+    call('bzr', 'add', '--quiet', branch_path)
+    call('bzr', 'commit', branch_path, '-m', 'Initial commit.')
+    return branch_path
+
+
+class CreateTestBranchTest(unittest.TestCase):
+    """Tests for the *create_test_branch* helper function."""
+
+    def setUp(self):
+        # Create a Bazaar user id inside a temporary home.
+        self.temp_home = tempfile.mkdtemp()
+        with environ(HOME=self.temp_home):
+            run('bzr', 'whoami', 'Example User <[e-mail]>')
+            self.branch_path = create_test_branch()
+
+    def tearDown(self):
+        shutil.rmtree(self.temp_home)
+        shutil.rmtree(self.branch_path)
+
+    def test_revno(self):
+        # Ensure the bzr branch is correctly created and contains a revision.
+        revno = run('bzr', 'revno', self.branch_path)
+        self.assertEqual(1, int(revno.strip()))
+
+    def test_working_tree(self):
+        # Ensure the working tree is present in the newly created branch.
+        test_file_path = os.path.join(self.branch_path, 'test-file')
+        self.assertTrue(os.path.exists(test_file_path))
+
+
 def get_random_string(size=10):
     """Return a random string to be used in tests."""
     return ''.join(random.sample(string.ascii_letters, size))

=== modified file 'setup.cfg'
--- setup.cfg	2012-07-11 18:37:31 +0000
+++ setup.cfg	2012-07-17 10:49:22 +0000
@@ -1,10 +1,11 @@
 [nosetests]
+# Specifying 'where' should not be required but it is a work-around
+# for a problem presented by having 'ignore-files'.
+where=lpsetup
+exclude=handle_testing|create_test_branch
+include=utils
 detailed-errors=1
-exclude=handle_testing
 with-coverage=1
 cover-package=lpsetup
 with-doctest=1
-# Specifying 'where' should not be required but it is a work-around
-# for a problem presented by having 'ignore-files'.
-where=lpsetup
 ignore-files=disabled*