~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

"""Tests for lock-breaking user interface"""

import os

import bzrlib

from bzrlib import (

    errors,

    lockdir,

    )

from bzrlib.branch import Branch

from bzrlib.bzrdir import BzrDir

from bzrlib.tests.blackbox import ExternalBase

class TestBreakLock(ExternalBase):

    # General principal for break-lock: All the elements that might be locked

    # by a bzr operation on PATH, are candidates that break-lock may unlock.

    # so pathologically if we have a lightweight checkout A, of branch B, which

    # is bound to location C, the following things should be checked for locks

    # to break:

    # wt = WorkingTree(A)

    # wt.branch

    # wt.branch.repository

    # wt.branch.get_master_branch()

    # wt.branch.get_master_branch().repository

    # so for smoke tests all we need is a bound branch with a checkout of that

    # and we can then use different urls to test individual cases, for as much

    # granularity as needed.

    def setUp(self):

        super(TestBreakLock, self).setUp()

        self.build_tree(

            ['master-repo/',

             'master-repo/master-branch/',

             'repo/',

             'repo/branch/',

             'checkout/'])

        bzrlib.bzrdir.BzrDir.create('master-repo').create_repository()

        self.master_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience(

            'master-repo/master-branch')

        bzrlib.bzrdir.BzrDir.create('repo').create_repository()

        local_branch = bzrlib.bzrdir.BzrDir.create_branch_convenience('repo/branch')

        local_branch.bind(self.master_branch)

        checkoutdir = bzrlib.bzrdir.BzrDir.create('checkout')

        bzrlib.branch.BranchReferenceFormat().initialize(

            checkoutdir, local_branch)

        self.wt = checkoutdir.create_workingtree()

    def test_break_lock_help(self):

        out, err = self.run_bzr('break-lock', '--help')

        # shouldn't fail and should not produce error output

        self.assertEqual('', err)

    def test_break_lock_everything_locked(self):

        ### if everything is locked, we should be able to unlock the lot.

        # sketch of test:

        # lock the lot:

        self.wt.lock_write()

        self.master_branch.lock_write()

        # run the break-lock

        # we need 5 yes's - wt, branch, repo, bound branch, bound repo.

        self.run_bzr('break-lock', 'checkout', stdin="y\ny\ny\ny\ny\n")

        # a new tree instance should be lockable

        wt = bzrlib.workingtree.WorkingTree.open('checkout')

        wt.lock_write()

        wt.unlock()

        # and a new instance of the master branch 

        mb = wt.branch.get_master_branch()

        mb.lock_write()

        mb.unlock()

        self.assertRaises(errors.LockBroken, self.wt.unlock)

        self.assertRaises(errors.LockBroken, self.master_branch.unlock)

    def test_saying_no_leaves_it_locked(self):

        ### if 'no' is answered, objects should remain locked.

        self.wt.lock_write()

        try:

            self.master_branch.lock_write()

            try:

                # run the break-lock

                # we need 5 yes's - wt, branch, repo, bound branch, bound repo.

                self.run_bzr('break-lock', 'checkout', stdin="n\nn\nn\nn\nn\n")

                # The default timeout to wait for LockContention is 5 minutes.

                # we need to override this temporarily.

                # TODO: jam 20060927 When we have per repository/branch/tree

                #       timeouts set the value of the repository,

                #       rather than setting the global default.

                orig_default = lockdir._DEFAULT_TIMEOUT_SECONDS

                try:

                    lockdir._DEFAULT_TIMEOUT_SECONDS = 1

                    # a new tree instance should not be lockable

                    wt = bzrlib.workingtree.WorkingTree.open('checkout')

                    self.assertRaises(errors.LockContention, wt.lock_write)

                    # and a new instance of the master branch 

                    mb = wt.branch.get_master_branch()

                    self.assertRaises(errors.LockContention, mb.lock_write)

                finally:

                    lockdir._DEFAULT_TIMEOUT_SECONDS = orig_default

                # unlock our branches normally.

            finally:

                self.master_branch.unlock()

        finally:

            self.wt.unlock()

class TestBreakLockOldBranch(ExternalBase):

    def test_break_lock_format_5_bzrdir(self):

        # break lock on a format 5 bzrdir should just return

        self.make_branch_and_tree('foo', format=bzrlib.bzrdir.BzrDirFormat5())

        out, err = self.run_bzr('break-lock', 'foo')

        self.assertEqual('', out)

        self.assertEqual('', err)