# Copyright (C) 2007-2011 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

"""Tests for the BranchBuilder class."""

from .. import (
    branch as _mod_branch,
    revision as _mod_revision,
    tests,
    )
from ..bzr import (
    branch as _mod_bzrbranch,
    )
from ..branchbuilder import BranchBuilder


class TestBranchBuilder(tests.TestCaseWithMemoryTransport):

    def test_create(self):
        """Test the constructor api."""
        builder = BranchBuilder(self.get_transport().clone('foo'))
        # we dont care if the branch has been built or not at this point.

    def test_get_branch(self):
        """get_branch returns the created branch."""
        builder = BranchBuilder(self.get_transport().clone('foo'))
        branch = builder.get_branch()
        self.assertIsInstance(branch, _mod_branch.Branch)
        self.assertEqual(self.get_transport().clone('foo').base,
                         branch.base)
        self.assertEqual(
            (0, _mod_revision.NULL_REVISION),
            branch.last_revision_info())

    def test_format(self):
        """Making a BranchBuilder with a format option sets the branch type."""
        builder = BranchBuilder(self.get_transport(), format='dirstate-tags')
        branch = builder.get_branch()
        self.assertIsInstance(branch, _mod_bzrbranch.BzrBranch6)

    def test_build_one_commit(self):
        """doing build_commit causes a commit to happen."""
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id = builder.build_commit()
        branch = builder.get_branch()
        self.assertEqual((1, rev_id), branch.last_revision_info())
        self.assertEqual(
            'commit 1',
            branch.repository.get_revision(branch.last_revision()).message)

    def test_build_commit_timestamp(self):
        """You can set a date when committing."""
        builder = self.make_branch_builder('foo')
        rev_id = builder.build_commit(timestamp=1236043340)
        branch = builder.get_branch()
        self.assertEqual((1, rev_id), branch.last_revision_info())
        rev = branch.repository.get_revision(branch.last_revision())
        self.assertEqual(
            'commit 1',
            rev.message)
        self.assertEqual(
            1236043340,
            int(rev.timestamp))

    def test_build_two_commits(self):
        """The second commit has the right parents and message."""
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id1 = builder.build_commit()
        rev_id2 = builder.build_commit()
        branch = builder.get_branch()
        self.assertEqual((2, rev_id2), branch.last_revision_info())
        self.assertEqual(
            'commit 2',
            branch.repository.get_revision(branch.last_revision()).message)
        self.assertEqual(
            [rev_id1],
            branch.repository.get_revision(branch.last_revision()).parent_ids)

    def test_build_commit_parent_ids(self):
        """build_commit() takes a parent_ids argument."""
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id1 = builder.build_commit(
            parent_ids=[b"ghost"], allow_leftmost_as_ghost=True)
        rev_id2 = builder.build_commit(parent_ids=[])
        branch = builder.get_branch()
        self.assertEqual((1, rev_id2), branch.last_revision_info())
        self.assertEqual(
            [b"ghost"],
            branch.repository.get_revision(rev_id1).parent_ids)


class TestBranchBuilderBuildSnapshot(tests.TestCaseWithMemoryTransport):

    def assertTreeShape(self, expected_shape, tree):
        """Check that the tree shape matches expectations."""
        tree.lock_read()
        try:
            entries = [(path, ie.file_id, ie.kind)
                       for path, ie in tree.iter_entries_by_dir()]
        finally:
            tree.unlock()
        self.assertEqual(expected_shape, entries)

    def build_a_rev(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id1 = builder.build_snapshot(None,
                                         [('add', ('', b'a-root-id', 'directory', None)),
                                          ('add', ('a', b'a-id', 'file', b'contents'))],
                                         revision_id=b'A-id')
        self.assertEqual(b'A-id', rev_id1)
        return builder

    def test_add_one_file(self):
        builder = self.build_a_rev()
        branch = builder.get_branch()
        self.assertEqual((1, b'A-id'), branch.last_revision_info())
        rev_tree = branch.repository.revision_tree(b'A-id')
        rev_tree.lock_read()
        self.addCleanup(rev_tree.unlock)
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file')], rev_tree)
        self.assertEqual(b'contents', rev_tree.get_file_text('a'))

    def test_add_second_file(self):
        builder = self.build_a_rev()
        rev_id2 = builder.build_snapshot(None,
                                         [('add', ('b', b'b-id', 'file', b'content_b'))],
                                         revision_id=b'B-id')
        self.assertEqual(b'B-id', rev_id2)
        branch = builder.get_branch()
        self.assertEqual((2, rev_id2), branch.last_revision_info())
        rev_tree = branch.repository.revision_tree(rev_id2)
        rev_tree.lock_read()
        self.addCleanup(rev_tree.unlock)
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              (u'b', b'b-id', 'file')], rev_tree)
        self.assertEqual(b'content_b', rev_tree.get_file_text('b'))

    def test_add_empty_dir(self):
        builder = self.build_a_rev()
        rev_id2 = builder.build_snapshot(None,
                                         [('add', ('b', b'b-id', 'directory', None))],
                                         revision_id=b'B-id')
        rev_tree = builder.get_branch().repository.revision_tree(b'B-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              (u'b', b'b-id', 'directory'),
                              ], rev_tree)

    def test_commit_timestamp(self):
        builder = self.make_branch_builder('foo')
        rev_id = builder.build_snapshot(None,
                                        [('add', (u'', None, 'directory', None))],
                                        timestamp=1234567890)
        rev = builder.get_branch().repository.get_revision(rev_id)
        self.assertEqual(
            1234567890,
            int(rev.timestamp))

    def test_commit_message_default(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id = builder.build_snapshot(None,
                                        [('add', (u'', None, 'directory', None))])
        branch = builder.get_branch()
        rev = branch.repository.get_revision(rev_id)
        self.assertEqual(u'commit 1', rev.message)

    def test_commit_message_supplied(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id = builder.build_snapshot(None,
                                        [('add', (u'', None, 'directory', None))],
                                        message=u'Foo')
        branch = builder.get_branch()
        rev = branch.repository.get_revision(rev_id)
        self.assertEqual(u'Foo', rev.message)

    def test_commit_message_callback(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        rev_id = builder.build_snapshot(None,
                                        [('add', (u'', None, 'directory', None))],
                                        message_callback=lambda x: u'Foo')
        branch = builder.get_branch()
        rev = branch.repository.get_revision(rev_id)
        self.assertEqual(u'Foo', rev.message)

    def test_modify_file(self):
        builder = self.build_a_rev()
        rev_id2 = builder.build_snapshot(None,
                                         [('modify', ('a', b'new\ncontent\n'))],
                                         revision_id=b'B-id')
        self.assertEqual(b'B-id', rev_id2)
        branch = builder.get_branch()
        rev_tree = branch.repository.revision_tree(rev_id2)
        rev_tree.lock_read()
        self.addCleanup(rev_tree.unlock)
        self.assertEqual(b'new\ncontent\n',
                         rev_tree.get_file_text(rev_tree.id2path(b'a-id')))

    def test_delete_file(self):
        builder = self.build_a_rev()
        rev_id2 = builder.build_snapshot(None,
                                         [('unversion', 'a')], revision_id=b'B-id')
        self.assertEqual(b'B-id', rev_id2)
        branch = builder.get_branch()
        rev_tree = branch.repository.revision_tree(rev_id2)
        rev_tree.lock_read()
        self.addCleanup(rev_tree.unlock)
        self.assertTreeShape([(u'', b'a-root-id', 'directory')], rev_tree)

    def test_delete_directory(self):
        builder = self.build_a_rev()
        rev_id2 = builder.build_snapshot(None,
                                         [('add', ('b', b'b-id', 'directory', None)),
                                          ('add', ('b/c', b'c-id', 'file', b'foo\n')),
                                             ('add', ('b/d', b'd-id',
                                                      'directory', None)),
                                             ('add', ('b/d/e', b'e-id',
                                                      'file', b'eff\n')),
                                          ], revision_id=b'B-id')
        rev_tree = builder.get_branch().repository.revision_tree(b'B-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              (u'b', b'b-id', 'directory'),
                              (u'b/c', b'c-id', 'file'),
                              (u'b/d', b'd-id', 'directory'),
                              (u'b/d/e', b'e-id', 'file')], rev_tree)
        # Removing a directory removes all child dirs
        builder.build_snapshot(
            None, [('unversion', 'b')],
            revision_id=b'C-id')
        rev_tree = builder.get_branch().repository.revision_tree(b'C-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              ], rev_tree)

    def test_unknown_action(self):
        builder = self.build_a_rev()
        e = self.assertRaises(ValueError,
                              builder.build_snapshot, None, [
                                  ('weirdo', ('foo',))],
                              revision_id=b'B-id')
        self.assertEqual('Unknown build action: "weirdo"', str(e))

    def test_rename(self):
        builder = self.build_a_rev()
        builder.build_snapshot(None,
                               [('rename', ('a', 'b'))], revision_id=b'B-id')
        rev_tree = builder.get_branch().repository.revision_tree(b'B-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'b', b'a-id', 'file')], rev_tree)

    def test_rename_into_subdir(self):
        builder = self.build_a_rev()
        builder.build_snapshot(None,
                               [('add', ('dir', b'dir-id', 'directory', None)),
                                ('rename', ('a', 'dir/a'))], revision_id=b'B-id')
        rev_tree = builder.get_branch().repository.revision_tree(b'B-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'dir', b'dir-id', 'directory'),
                              (u'dir/a', b'a-id', 'file')], rev_tree)

    def test_rename_out_of_unversioned_subdir(self):
        builder = self.build_a_rev()
        builder.build_snapshot(None,
                               [('add', ('dir', b'dir-id', 'directory', None)),
                                ('rename', ('a', 'dir/a'))],
                               revision_id=b'B-id')
        builder.build_snapshot(None,
                               [('rename', ('dir/a', 'a')),
                                ('unversion', 'dir')], revision_id=b'C-id')
        rev_tree = builder.get_branch().repository.revision_tree(b'C-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file')], rev_tree)

    def test_set_parent(self):
        builder = self.build_a_rev()
        builder.start_series()
        self.addCleanup(builder.finish_series)
        builder.build_snapshot([b'A-id'],
                               [('modify', ('a', b'new\ncontent\n'))],
                               revision_id=b'B-id')
        builder.build_snapshot([b'A-id'],
                               [('add', ('c', b'c-id', 'file', b'alt\ncontent\n'))],
                               revision_id=b'C-id')
        # We should now have a graph:
        #   A
        #   |\
        #   C B
        # And not A => B => C
        repo = builder.get_branch().repository
        self.assertEqual({b'B-id': (b'A-id',), b'C-id': (b'A-id',)},
                         repo.get_parent_map([b'B-id', b'C-id']))
        b_tree = repo.revision_tree(b'B-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              ], b_tree)
        self.assertEqual(b'new\ncontent\n', b_tree.get_file_text('a'))

        # We should still be using the content from A in C, not from B
        c_tree = repo.revision_tree(b'C-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              (u'c', b'c-id', 'file'),
                              ], c_tree)
        self.assertEqual(b'contents', c_tree.get_file_text('a'))
        self.assertEqual(b'alt\ncontent\n', c_tree.get_file_text('c'))

    def test_set_merge_parent(self):
        builder = self.build_a_rev()
        builder.start_series()
        self.addCleanup(builder.finish_series)
        builder.build_snapshot([b'A-id'],
                               [('add', ('b', b'b-id', 'file', b'b\ncontent\n'))],
                               revision_id=b'B-id')
        builder.build_snapshot([b'A-id'],
                               [('add', ('c', b'c-id', 'file', b'alt\ncontent\n'))],
                               revision_id=b'C-id')
        builder.build_snapshot([b'B-id', b'C-id'], [], revision_id=b'D-id')
        repo = builder.get_branch().repository
        self.assertEqual({b'B-id': (b'A-id',), b'C-id': (b'A-id',),
                          b'D-id': (b'B-id', b'C-id')},
                         repo.get_parent_map([b'B-id', b'C-id', b'D-id']))
        d_tree = repo.revision_tree(b'D-id')
        # Note: by default a merge node does *not* pull in the changes from the
        #       merged tree, you have to supply it yourself.
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              (u'b', b'b-id', 'file'),
                              ], d_tree)

    def test_set_merge_parent_and_contents(self):
        builder = self.build_a_rev()
        builder.start_series()
        self.addCleanup(builder.finish_series)
        builder.build_snapshot([b'A-id'],
                               [('add', ('b', b'b-id', 'file', b'b\ncontent\n'))],
                               revision_id=b'B-id')
        builder.build_snapshot([b'A-id'],
                               [('add', ('c', b'c-id', 'file', b'alt\ncontent\n'))],
                               revision_id=b'C-id')
        builder.build_snapshot([b'B-id', b'C-id'],
                               [('add', ('c', b'c-id', 'file', b'alt\ncontent\n'))],
                               revision_id=b'D-id')
        repo = builder.get_branch().repository
        self.assertEqual({b'B-id': (b'A-id',), b'C-id': (b'A-id',),
                          b'D-id': (b'B-id', b'C-id')},
                         repo.get_parent_map([b'B-id', b'C-id', b'D-id']))
        d_tree = repo.revision_tree(b'D-id')
        self.assertTreeShape([(u'', b'a-root-id', 'directory'),
                              (u'a', b'a-id', 'file'),
                              (u'b', b'b-id', 'file'),
                              (u'c', b'c-id', 'file'),
                              ], d_tree)
        # Because we copied the exact text into *this* tree, the 'c' file
        # should look like it was not modified in the merge
        self.assertEqual(b'C-id', d_tree.get_file_revision('c'))

    def test_set_parent_to_null(self):
        builder = self.build_a_rev()
        builder.start_series()
        self.addCleanup(builder.finish_series)
        builder.build_snapshot([],
                               [('add', ('', None, 'directory', None))],
                               revision_id=b'B-id')
        # We should now have a graph:
        #   A B
        # And not A => B
        repo = builder.get_branch().repository
        self.assertEqual({b'A-id': (_mod_revision.NULL_REVISION,),
                          b'B-id': (_mod_revision.NULL_REVISION,), },
                         repo.get_parent_map([b'A-id', b'B-id']))

    def test_start_finish_series(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        builder.start_series()
        try:
            self.assertIsNot(None, builder._tree)
            self.assertEqual('w', builder._tree._lock_mode)
            self.assertTrue(builder._branch.is_locked())
        finally:
            builder.finish_series()
        self.assertIs(None, builder._tree)
        self.assertFalse(builder._branch.is_locked())

    def test_ghost_mainline_history(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        builder.start_series()
        try:
            builder.build_snapshot([b'ghost'],
                                   [('add', ('', b'ROOT_ID', 'directory', ''))],
                                   allow_leftmost_as_ghost=True, revision_id=b'tip')
        finally:
            builder.finish_series()
        b = builder.get_branch()
        b.lock_read()
        self.addCleanup(b.unlock)
        self.assertEqual((b'ghost',),
                         b.repository.get_graph().get_parent_map([b'tip'])[b'tip'])

    def test_unversion_root_add_new_root(self):
        builder = BranchBuilder(self.get_transport().clone('foo'))
        builder.start_series()
        builder.build_snapshot(None,
                               [('add', ('', b'TREE_ROOT', 'directory', ''))],
                               revision_id=b'rev-1')
        builder.build_snapshot(None,
                               [('unversion', ''),
                                ('add', ('', b'my-root', 'directory', ''))],
                               revision_id=b'rev-2')
        builder.finish_series()
        rev_tree = builder.get_branch().repository.revision_tree(b'rev-2')
        self.assertTreeShape([(u'', b'my-root', 'directory')], rev_tree)

    def test_empty_flush(self):
        """A flush with no actions before it is a no-op."""
        builder = BranchBuilder(self.get_transport().clone('foo'))
        builder.start_series()
        builder.build_snapshot(None,
                               [('add', ('', b'TREE_ROOT', 'directory', ''))],
                               revision_id=b'rev-1')
        builder.build_snapshot(None, [('flush', None)], revision_id=b'rev-2')
        builder.finish_series()
        rev_tree = builder.get_branch().repository.revision_tree(b'rev-2')
        self.assertTreeShape([(u'', b'TREE_ROOT', 'directory')], rev_tree)

    def test_kind_change(self):
        """It's possible to change the kind of an entry in a single snapshot
        with a bit of help from the 'flush' action.
        """
        builder = BranchBuilder(self.get_transport().clone('foo'))
        builder.start_series()
        builder.build_snapshot(None,
                               [('add', (u'', b'a-root-id', 'directory', None)),
                                ('add', (u'a', b'a-id', 'file', b'content\n'))],
                               revision_id=b'A-id')
        builder.build_snapshot(None,
                               [('unversion', 'a'),
                                ('flush', None),
                                   ('add', (u'a', b'a-id', 'directory', None))],
                               revision_id=b'B-id')
        builder.finish_series()
        rev_tree = builder.get_branch().repository.revision_tree(b'B-id')
        self.assertTreeShape(
            [(u'', b'a-root-id', 'directory'), (u'a', b'a-id', 'directory')],
            rev_tree)

    def test_pivot_root(self):
        """It's possible (albeit awkward) to move an existing dir to the root
        in a single snapshot by using unversion then flush then add.
        """
        builder = BranchBuilder(self.get_transport().clone('foo'))
        builder.start_series()
        builder.build_snapshot(None,
                               [('add', (u'', b'orig-root', 'directory', None)),
                                ('add', (u'dir', b'dir-id', 'directory', None))],
                               revision_id=b'A-id')
        builder.build_snapshot(None,
                               [('unversion', ''),  # implicitly unversions all children
                                ('flush', None),
                                   ('add', (u'', b'dir-id', 'directory', None))],
                               revision_id=b'B-id')
        builder.finish_series()
        rev_tree = builder.get_branch().repository.revision_tree(b'B-id')
        self.assertTreeShape([(u'', b'dir-id', 'directory')], rev_tree)
