# Copyright (C) 2006-2012, 2016 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 update command of bzr."""

import os

from breezy import branch, osutils, tests, workingtree
from breezy.bzr import bzrdir
from breezy.tests.script import ScriptRunner


class TestUpdate(tests.TestCaseWithTransport):
    def test_update_standalone_trivial(self):
        self.make_branch_and_tree(".")
        out, err = self.run_bzr("update")
        self.assertEqual(
            "Tree is up to date at revision 0 of branch %s\n" % self.test_dir, err
        )
        self.assertEqual("", out)

    def test_update_quiet(self):
        self.make_branch_and_tree(".")
        out, err = self.run_bzr("update --quiet")
        self.assertEqual("", err)
        self.assertEqual("", out)

    def test_update_standalone_trivial_with_alias_up(self):
        self.make_branch_and_tree(".")
        out, err = self.run_bzr("up")
        self.assertEqual(
            "Tree is up to date at revision 0 of branch %s\n" % self.test_dir, err
        )
        self.assertEqual("", out)

    def test_update_up_to_date_light_checkout(self):
        self.make_branch_and_tree("branch")
        self.run_bzr("checkout --lightweight branch checkout")
        out, err = self.run_bzr("update checkout")
        self.assertEqual(
            "Tree is up to date at revision 0 of branch %s\n"
            % osutils.pathjoin(self.test_dir, "branch"),
            err,
        )
        self.assertEqual("", out)

    def test_update_up_to_date_checkout(self):
        self.make_branch_and_tree("branch")
        self.run_bzr("checkout branch checkout")
        sr = ScriptRunner()
        sr.run_script(
            self,
            """
$ brz update checkout
2>Tree is up to date at revision 0 of branch .../branch
""",
        )

    def test_update_out_of_date_standalone_tree(self):
        # FIXME the default format has to change for this to pass
        # because it currently uses the branch last-revision marker.
        self.make_branch_and_tree("branch")
        # make a checkout
        self.run_bzr("checkout --lightweight branch checkout")
        self.build_tree(["checkout/file"])
        self.run_bzr("add checkout/file")
        self.run_bzr("commit -m add-file checkout")
        # now branch should be out of date
        out, err = self.run_bzr("update branch")
        self.assertEqual("", out)
        self.assertEqualDiff(
            """+N  file
All changes applied successfully.
Updated to revision 1 of branch %s
"""
            % osutils.pathjoin(
                self.test_dir,
                "branch",
            ),
            err,
        )
        self.assertPathExists("branch/file")

    def test_update_out_of_date_light_checkout(self):
        self.make_branch_and_tree("branch")
        # make two checkouts
        self.run_bzr("checkout --lightweight branch checkout")
        self.run_bzr("checkout --lightweight branch checkout2")
        self.build_tree(["checkout/file"])
        self.run_bzr("add checkout/file")
        self.run_bzr("commit -m add-file checkout")
        # now checkout2 should be out of date
        out, err = self.run_bzr("update checkout2")
        self.assertEqualDiff(
            """+N  file
All changes applied successfully.
Updated to revision 1 of branch %s
"""
            % osutils.pathjoin(
                self.test_dir,
                "branch",
            ),
            err,
        )
        self.assertEqual("", out)

    def test_update_conflicts_returns_2(self):
        self.make_branch_and_tree("branch")
        # make two checkouts
        self.run_bzr("checkout --lightweight branch checkout")
        self.build_tree(["checkout/file"])
        self.run_bzr("add checkout/file")
        self.run_bzr("commit -m add-file checkout")
        self.run_bzr("checkout --lightweight branch checkout2")
        # now alter file in checkout
        with open("checkout/file", "w") as a_file:
            a_file.write("Foo")
        self.run_bzr("commit -m checnge-file checkout")
        # now checkout2 should be out of date
        # make a local change to file
        with open("checkout2/file", "w") as a_file:
            a_file.write("Bar")
        out, err = self.run_bzr("update checkout2", retcode=1)
        self.assertEqualDiff(
            """ M  file
Text conflict in file
1 conflicts encountered.
Updated to revision 2 of branch %s
"""
            % osutils.pathjoin(
                self.test_dir,
                "branch",
            ),
            err,
        )
        self.assertEqual("", out)

    def test_smoke_update_checkout_bound_branch_local_commits(self):
        # smoke test for doing an update of a checkout of a bound
        # branch with local commits.
        master = self.make_branch_and_tree("master")
        master.commit("first commit")
        # make a bound branch
        self.run_bzr("checkout master child")
        # check that out
        self.run_bzr("checkout --lightweight child checkout")
        # get an object form of the checkout to manipulate
        wt = workingtree.WorkingTree.open("checkout")
        # change master
        with open("master/file", "w") as a_file:
            a_file.write("Foo")
        master.add(["file"])
        master_tip = master.commit("add file")
        # change child
        with open("child/file_b", "w") as a_file:
            a_file.write("Foo")
        # get an object form of child
        child = workingtree.WorkingTree.open("child")
        child.add(["file_b"])
        child_tip = child.commit("add file_b", local=True)
        # check checkout
        with open("checkout/file_c", "w") as a_file:
            a_file.write("Foo")
        wt.add(["file_c"])

        # now, update checkout ->
        # get all three files and a pending merge.
        out, err = self.run_bzr("update checkout")
        self.assertEqual("", out)
        self.assertEqualDiff(
            """+N  file_b
All changes applied successfully.
+N  file
All changes applied successfully.
Updated to revision 2 of branch %s
Your local commits will now show as pending merges with 'brz status', and can be committed with 'brz commit'.
"""
            % osutils.pathjoin(
                self.test_dir,
                "master",
            ),
            err,
        )
        self.assertEqual([master_tip, child_tip], wt.get_parent_ids())
        self.assertPathExists("checkout/file")
        self.assertPathExists("checkout/file_b")
        self.assertPathExists("checkout/file_c")
        self.assertTrue(wt.has_filename("file_c"))

    def test_update_with_merges(self):
        # Test that 'brz update' works correctly when you have
        # an update in the master tree, and a lightweight checkout
        # which has merged another branch
        master = self.make_branch_and_tree("master")
        self.build_tree(["master/file"])
        master.add(["file"])
        master.commit("one", rev_id=b"m1")

        self.build_tree(["checkout1/"])
        checkout_dir = bzrdir.BzrDirMetaFormat1().initialize("checkout1")
        checkout_dir.set_branch_reference(master.branch)
        checkout1 = checkout_dir.create_workingtree(b"m1")

        # Create a second branch, with an extra commit
        other = master.controldir.sprout("other").open_workingtree()
        self.build_tree(["other/file2"])
        other.add(["file2"])
        other.commit("other2", rev_id=b"o2")

        # Create a new commit in the master branch
        self.build_tree(["master/file3"])
        master.add(["file3"])
        master.commit("f3", rev_id=b"m2")

        # Merge the other branch into checkout
        os.chdir("checkout1")
        self.run_bzr("merge ../other")

        self.assertEqual([b"o2"], checkout1.get_parent_ids()[1:])

        # At this point, 'commit' should fail, because we are out of date
        self.run_bzr_error(["please run 'brz update'"], "commit -m merged")

        # This should not report about local commits being pending
        # merges, because they were real merges
        out, err = self.run_bzr("update")
        self.assertEqual("", out)
        self.assertEqualDiff(
            """+N  file3
All changes applied successfully.
Updated to revision 2 of branch %s
"""
            % osutils.pathjoin(
                self.test_dir,
                "master",
            ),
            err,
        )
        # The pending merges should still be there
        self.assertEqual([b"o2"], checkout1.get_parent_ids()[1:])

    def test_readonly_lightweight_update(self):
        """Update a light checkout of a readonly branch"""
        tree = self.make_branch_and_tree("branch")
        readonly_branch = branch.Branch.open(self.get_readonly_url("branch"))
        checkout = readonly_branch.create_checkout("checkout", lightweight=True)
        tree.commit("empty commit")
        self.run_bzr("update checkout")

    def test_update_with_merge_merged_to_master(self):
        # Test that 'brz update' works correctly when you have
        # an update in the master tree, and a [lightweight or otherwise]
        # checkout which has merge a revision merged to master already.
        master = self.make_branch_and_tree("master")
        self.build_tree(["master/file"])
        master.add(["file"])
        master.commit("one", rev_id=b"m1")

        self.build_tree(["checkout1/"])
        checkout_dir = bzrdir.BzrDirMetaFormat1().initialize("checkout1")
        checkout_dir.set_branch_reference(master.branch)
        checkout1 = checkout_dir.create_workingtree(b"m1")

        # Create a second branch, with an extra commit
        other = master.controldir.sprout("other").open_workingtree()
        self.build_tree(["other/file2"])
        other.add(["file2"])
        other.commit("other2", rev_id=b"o2")

        # Merge the other branch into checkout -  'start reviewing a patch'
        checkout1.merge_from_branch(other.branch)
        self.assertEqual([b"o2"], checkout1.get_parent_ids()[1:])

        # Create a new commit in the master branch - 'someone else lands its'
        master.merge_from_branch(other.branch)
        master.commit("f3", rev_id=b"m2")

        # This should not report about local commits being pending
        # merges, because they were real merges (but are now gone).
        # It should perhaps report on them.
        out, err = self.run_bzr("update", working_dir="checkout1")
        self.assertEqual("", out)
        self.assertEqualDiff(
            """All changes applied successfully.
Updated to revision 2 of branch %s
"""
            % osutils.pathjoin(
                self.test_dir,
                "master",
            ),
            err,
        )
        # The pending merges should still be there
        self.assertEqual([], checkout1.get_parent_ids()[1:])

    def test_update_dash_r(self):
        master = self.make_branch_and_tree("master")
        os.chdir("master")
        self.build_tree(["./file1"])
        master.add(["file1"])
        master.commit("one", rev_id=b"m1")
        self.build_tree(["./file2"])
        master.add(["file2"])
        master.commit("two", rev_id=b"m2")

        sr = ScriptRunner()
        sr.run_script(
            self,
            """
$ brz update -r 1
2>-D  file2
2>All changes applied successfully.
2>Updated to revision 1 of .../master
""",
        )
        self.assertPathExists("./file1")
        self.assertPathDoesNotExist("./file2")
        self.assertEqual([b"m1"], master.get_parent_ids())

    def test_update_dash_r_outside_history(self):
        """Ensure that we can update -r to dotted revisions."""
        master = self.make_branch_and_tree("master")
        self.build_tree(["master/file1"])
        master.add(["file1"])
        master.commit("one", rev_id=b"m1")

        # Create a second branch, with extra commits
        other = master.controldir.sprout("other").open_workingtree()
        self.build_tree(["other/file2", "other/file3"])
        other.add(["file2"])
        other.commit("other2", rev_id=b"o2")
        other.add(["file3"])
        other.commit("other3", rev_id=b"o3")

        os.chdir("master")
        self.run_bzr("merge ../other")
        master.commit("merge", rev_id=b"merge")

        # Switch to o2. file3 was added only in o3 and should be deleted.
        out, err = self.run_bzr("update -r revid:o2")
        self.assertContainsRe(err, "-D\\s+file3")
        self.assertContainsRe(err, "All changes applied successfully\\.")
        self.assertContainsRe(err, "Updated to revision 1.1.1 of branch .*")

        # Switch back to latest
        out, err = self.run_bzr("update")
        self.assertContainsRe(err, "\\+N\\s+file3")
        self.assertContainsRe(err, "All changes applied successfully\\.")
        self.assertContainsRe(err, "Updated to revision 2 of branch .*")

    def test_update_dash_r_in_master(self):
        # Test that 'brz update' works correctly when you have
        # an update in the master tree,
        master = self.make_branch_and_tree("master")
        self.build_tree(["master/file1"])
        master.add(["file1"])
        master.commit("one", rev_id=b"m1")

        self.run_bzr("checkout master checkout")

        # add a revision in the master.
        self.build_tree(["master/file2"])
        master.add(["file2"])
        master.commit("two", rev_id=b"m2")

        os.chdir("checkout")
        sr = ScriptRunner()
        sr.run_script(
            self,
            """
$ brz update -r revid:m2
2>+N  file2
2>All changes applied successfully.
2>Updated to revision 2 of branch .../master
""",
        )

    def test_update_show_base(self):
        """brz update support --show-base

        see https://bugs.launchpad.net/bzr/+bug/202374"""

        tree = self.make_branch_and_tree(".")

        with open("hello", "w") as f:
            f.write("foo")
        tree.add("hello")
        tree.commit("fie")

        with open("hello", "w") as f:
            f.write("fee")
        tree.commit("fee")

        # tree.update() gives no such revision, so ...
        self.run_bzr(["update", "-r1"])

        # create conflict
        with open("hello", "w") as f:
            f.write("fie")

        out, err = self.run_bzr(["update", "--show-base"], retcode=1)

        # check for conflict notification
        self.assertContainsString(
            err, " M  hello\nText conflict in hello\n1 conflicts encountered.\n"
        )
        with open("hello", "rb") as f:
            self.assertEqualDiff(
                b"<<<<<<< TREE\n"
                b"fie||||||| BASE-REVISION\n"
                b"foo=======\n"
                b"fee>>>>>>> MERGE-SOURCE\n",
                f.read(),
            )

    def test_update_checkout_prevent_double_merge(self):
        """ "Launchpad bug 113809 in brz "update performs two merges"
        https://launchpad.net/bugs/113809"""
        master = self.make_branch_and_tree("master")
        self.build_tree_contents([("master/file", b"initial contents\n")])
        master.add(["file"])
        master.commit("one", rev_id=b"m1")

        checkout = master.branch.create_checkout("checkout")
        lightweight = checkout.branch.create_checkout("lightweight", lightweight=True)

        # time to create a mess
        # add a commit to the master
        self.build_tree_contents([("master/file", b"master\n")])
        master.commit("two", rev_id=b"m2")
        self.build_tree_contents([("master/file", b"master local changes\n")])

        # local commit on the checkout
        self.build_tree_contents([("checkout/file", b"checkout\n")])
        checkout.commit("tree", rev_id=b"c2", local=True)
        self.build_tree_contents([("checkout/file", b"checkout local changes\n")])

        # lightweight
        self.build_tree_contents([("lightweight/file", b"lightweight local changes\n")])

        # now update (and get conflicts)
        out, err = self.run_bzr("update lightweight", retcode=1)
        self.assertEqual("", out)
        # NB: these conflicts are actually in the source code
        self.assertFileEqual(
            """\
<<<<<<< TREE
lightweight local changes
=======
checkout
>>>>>>> MERGE-SOURCE
""",
            "lightweight/file",
        )

        # resolve it
        self.build_tree_contents([("lightweight/file", b"lightweight+checkout\n")])
        self.run_bzr("resolve lightweight/file")

        # check we get the second conflict
        out, err = self.run_bzr("update lightweight", retcode=1)
        self.assertEqual("", out)
        # NB: these conflicts are actually in the source code
        self.assertFileEqual(
            """\
<<<<<<< TREE
lightweight+checkout
=======
master
>>>>>>> MERGE-SOURCE
""",
            "lightweight/file",
        )

    def test_no_upgrade_single_file(self):
        """There's one basis revision per tree.

        Since you can't actually change the basis for a single file at the
        moment, we don't let you think you can.

        See bug 557886.
        """
        self.make_branch_and_tree(".")
        self.build_tree_contents([("a/",), ("a/file", b"content")])
        sr = ScriptRunner()
        sr.run_script(
            self,
            """
            $ brz update ./a
            2>brz: ERROR: brz update can only update a whole tree, not a file or subdirectory
            $ brz update ./a/file
            2>brz: ERROR: brz update can only update a whole tree, not a file or subdirectory
            $ brz update .
            2>Tree is up to date at revision 0 of branch ...
            $ cd a
            $ brz update .
            2>brz: ERROR: brz update can only update a whole tree, not a file or subdirectory
            # however, you can update the whole tree from a subdirectory
            $ brz update
            2>Tree is up to date at revision 0 of branch ...
            """,
        )
