# Copyright (c) 2012, 2013, 2014 Hewlett-Packard Development Company, L.P.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Tests the supersede module"""

from git import GitCommandError

from git_upstream.lib.supersede import Supersede
from git_upstream.lib.supersede import SupersedeError
from git_upstream.tests import base


class TestSupersede(base.BaseTestCase):
    """Test case for Supersede class"""

    first_commit = "bd6b9eefe961abe8c15cb5dc6905b92e14714a4e"
    second_commit = "05fac847a5629e36050dcd69b9a782b2645d3cc7"
    invalid_commit = "this_is_an_invalid_commit"
    first_change_ids = ("Ia028d7afc9df2a599a52b1b17858037fab4e3f44",)
    second_change_ids = ("Iebd1f5aa789dcd9574a00bb8837e4596bf55fa88",
                         "I4ab003213c40b0375283a15e2967d11e0351feb1")
    invalid_change_ids = ("this_is_an_invalid_change_id",)

    change_ids_branch = "master"
    invalid_change_ids_branch = "this_is_an_invalid_change_ids_branch"
    note_ref = 'refs/notes/upstream-merge'

    def setUp(self):
        super(TestSupersede, self).setUp()
        self.first_commit = self.repo.commit()
        self.testrepo.add_commits(change_ids=self.first_change_ids)
        self.second_commit = self.repo.commit()
        self.testrepo.add_commits(change_ids=self.second_change_ids)

    def test_valid_parameters(self):
        """Test supersede initialization and read properties"""

        t = Supersede(git_object=self.first_commit,
                      change_ids=self.first_change_ids,
                      upstream_branch=self.change_ids_branch)

        self.assertEqual(t.commit, self.first_commit)
        self.assertNotEqual(t.commit, self.second_commit)
        self.assertEqual(str(t.change_ids_branch),
                         self.change_ids_branch)
        self.assertNotEqual(str(t.change_ids_branch),
                            self.invalid_change_ids_branch)

    def test_invalid_commit(self):
        """Test supersede initialization with invalid commit"""

        self.assertRaises(SupersedeError, Supersede,
                          git_object=self.invalid_commit,
                          change_ids=self.first_change_ids,
                          upstream_branch=self.change_ids_branch)

    def test_multiple_change_id(self):
        """Test supersede initialization with multiple change ids"""

        t = Supersede(git_object=self.first_commit,
                      change_ids=self.second_change_ids,
                      upstream_branch=self.change_ids_branch)

        self.assertEqual(t.commit, self.first_commit)
        self.assertNotEqual(t.commit, self.second_commit)

    def test_invalid_cids(self):
        """Test supersede initialization with invalid cids"""

        self.assertRaises(SupersedeError, Supersede,
                          git_object=self.first_commit,
                          change_ids=self.invalid_change_ids,
                          upstream_branch=self.change_ids_branch)

    def test_default_upstream_branch(self):
        """Test supersede initialization with no branch name"""

        self.assertRaises(SupersedeError, Supersede,
                          git_object=self.first_commit,
                          change_ids=self.invalid_change_ids,
                          upstream_branch=self.invalid_change_ids_branch)

    def test_no_upstream_branch(self):
        """Test supersede initialization with invalid branch name"""

        self.assertRaises(SupersedeError, Supersede,
                          git_object=self.first_commit,
                          change_ids=self.invalid_change_ids)

    def test_mark(self):
        """Test Supersede mark"""

        t = Supersede(git_object=self.first_commit,
                      change_ids=self.first_change_ids,
                      upstream_branch=self.change_ids_branch)

        try:
            # Older git versions don't support --ignore-missing
            self.repo.git.notes('--ref', self.note_ref, 'remove',
                                self.first_commit)
        except GitCommandError:
            pass

        t.mark()

        self.assertRegexpMatches(
            '^Superseded-by: %s' % self.first_change_ids,
            self.repo.git.notes('--ref', self.note_ref, 'show',
                                self.first_commit)
        )

        self.repo.git.notes('--ref', self.note_ref, 'remove',
                            self.first_commit)