rhodecode.controllers.compare

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    compare controller for pylons showing differences between two

    repos, branches, bookmarks or tips

    :created_on: May 6, 2012

    :author: marcink

    :copyright: (C) 2010-2012 Marcin Kuzminski <marcin@python-works.com>

    :license: GPLv3, see COPYING for more details.

"""

# 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 3 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, see <http://www.gnu.org/licenses/>.

import logging

import traceback

from webob.exc import HTTPNotFound

from pylons import request, response, session, tmpl_context as c, url

from pylons.controllers.util import abort, redirect

from pylons.i18n.translation import _

from rhodecode.lib.vcs.exceptions import EmptyRepositoryError, RepositoryError

from rhodecode.lib import helpers as h

from rhodecode.lib.base import BaseRepoController, render

from rhodecode.lib.auth import LoginRequired, HasRepoPermissionAnyDecorator

from rhodecode.lib import diffs

from rhodecode.model.db import Repository

from rhodecode.model.pull_request import PullRequestModel

from webob.exc import HTTPBadRequest

from rhodecode.lib.utils2 import str2bool

from rhodecode.lib.diffs import LimitedDiffContainer

from rhodecode.lib.vcs.backends.base import EmptyChangeset

log = logging.getLogger(__name__)

class CompareController(BaseRepoController):

    @LoginRequired()

    @HasRepoPermissionAnyDecorator('repository.read', 'repository.write',

                                   'repository.admin')

    def __before__(self):

        super(CompareController, self).__before__()

    def __get_cs_or_redirect(self, rev, repo, redirect_after=True,

                             partial=False):

        """

        Safe way to get changeset if error occur it redirects to changeset with

        proper message. If partial is set then don't do redirect raise Exception

        instead

        :param rev: revision to fetch

        :param repo: repo instance

        """

        try:

            type_, rev = rev

            return repo.scm_instance.get_changeset(rev)

        except EmptyRepositoryError, e:

            if not redirect_after:

                return None

            h.flash(h.literal(_('There are no changesets yet')),

                    category='warning')

            redirect(url('summary_home', repo_name=repo.repo_name))

        except RepositoryError, e:

            log.error(traceback.format_exc())

            h.flash(str(e), category='warning')

            if not partial:

                redirect(h.url('summary_home', repo_name=repo.repo_name))

            raise HTTPBadRequest()

    def index(self, org_ref_type, org_ref, other_ref_type, other_ref):

        org_repo = c.rhodecode_db_repo.repo_name

        org_ref = (org_ref_type, org_ref)

        other_ref = (other_ref_type, other_ref)

        other_repo = request.GET.get('other_repo', org_repo)

        c.fulldiff = fulldiff = request.GET.get('fulldiff')

        rev_start = request.GET.get('rev_start')

        rev_end = request.GET.get('rev_end')

        c.swap_url = h.url('compare_url', as_form=request.GET.get('as_form'),

            repo_name=other_repo,

            org_ref_type=other_ref[0], org_ref=other_ref[1],

            other_ref_type=org_ref[0], other_ref=org_ref[1])

        c.org_repo = org_repo = Repository.get_by_repo_name(org_repo)

        c.other_repo = other_repo = Repository.get_by_repo_name(other_repo)

        if c.org_repo is None:

            log.error('Could not find org repo %s' % org_repo)

            raise HTTPNotFound

        if c.other_repo is None:

            log.error('Could not find other repo %s' % other_repo)

            raise HTTPNotFound

        if c.org_repo != c.other_repo and h.is_git(c.rhodecode_repo):

            log.error('compare of two remote repos not available for GIT REPOS')

            raise HTTPNotFound

        if c.org_repo.scm_instance.alias != c.other_repo.scm_instance.alias:

            log.error('compare of two different kind of remote repos not available')

            raise HTTPNotFound

        partial = request.environ.get('HTTP_X_PARTIAL_XHR')

        self.__get_cs_or_redirect(rev=org_ref, repo=org_repo, partial=partial)

        self.__get_cs_or_redirect(rev=other_ref, repo=other_repo, partial=partial)

        if rev_start and rev_end:

            #replace our org_ref with given CS

            org_ref = ('rev', rev_start)

            other_ref = ('rev', rev_end)

        c.cs_ranges = PullRequestModel().get_compare_data(

                                    org_repo, org_ref, other_repo, other_ref,

                                    )

        c.statuses = c.rhodecode_db_repo.statuses([x.raw_id for x in

                                                   c.cs_ranges])

        c.target_repo = c.repo_name

        # defines that we need hidden inputs with changesets

        c.as_form = request.GET.get('as_form', False)

        if partial:

            return render('compare/compare_cs.html')

        c.org_ref = org_ref[1]

        c.other_ref = other_ref[1]

        if c.cs_ranges and c.org_repo != c.other_repo:

            # case we want a simple diff without incoming changesets, just

            # for review purposes. Make the diff on the forked repo, with

            # revision that is common ancestor

            _org_ref = org_ref

            org_ref = ('rev', getattr(c.cs_ranges[0].parents[0]

                                      if c.cs_ranges[0].parents

                                      else EmptyChangeset(), 'raw_id'))

            log.debug('Changed org_ref from %s to %s' % (_org_ref, org_ref))

            other_repo = org_repo

        diff_limit = self.cut_off_limit if not fulldiff else None

        _diff = diffs.differ(org_repo, org_ref, other_repo, other_ref)

        diff_processor = diffs.DiffProcessor(_diff or '', format='gitdiff',

                                             diff_limit=diff_limit)

        _parsed = diff_processor.prepare()

        c.limited_diff = False

        if isinstance(_parsed, LimitedDiffContainer):

            c.limited_diff = True

        c.files = []

        c.changes = {}

        c.lines_added = 0

        c.lines_deleted = 0

        for f in _parsed:

            st = f['stats']

            if st[0] != 'b':

                c.lines_added += st[0]

                c.lines_deleted += st[1]

            fid = h.FID('', f['filename'])

            c.files.append([fid, f['operation'], f['filename'], f['stats']])

            diff = diff_processor.as_html(enable_comments=False, parsed_lines=[f])

            c.changes[fid] = [f['operation'], f['filename'], diff]

        return render('compare/compare_diff.html')

        _REPO = parent

    form_data = dict(

        repo_name=fork_name,

        repo_name_full=fork_name,

        repo_group=None,

        repo_type=vcs_type,

        description='',

        private=False,

        copy_permissions=False,

        landing_rev='tip',

        update_after_clone=False,

        fork_parent_id=Repository.get_by_repo_name(_REPO),

    )

    repo = RepoModel().create_fork(form_data, cur_user=TEST_USER_ADMIN_LOGIN)

    Session().commit()

    return Repository.get_by_repo_name(fork_name)

def _commit_change(repo, filename, content, message, vcs_type, parent=None, newfile=False):

    repo = Repository.get_by_repo_name(repo)

    _cs = parent

    if not parent:

        _cs = EmptyChangeset(alias=vcs_type)

    if newfile:

        cs = ScmModel().create_node(

            repo=repo.scm_instance, repo_name=repo.repo_name,

            cs=_cs, user=TEST_USER_ADMIN_LOGIN,

            author=TEST_USER_ADMIN_LOGIN,

            message=message,

            content=content,

            f_path=filename

        )

    else:

        cs = ScmModel().commit_change(

            repo=repo.scm_instance, repo_name=repo.repo_name,

            cs=parent, user=TEST_USER_ADMIN_LOGIN,

            author=TEST_USER_ADMIN_LOGIN,

            message=message,

            content=content,

            f_path=filename

        )

    return cs

class TestCompareController(TestController):

    def test_compare_forks_on_branch_extra_commits_hg(self):

        self.log_user()

        repo1 = RepoModel().create_repo(repo_name='one', repo_type='hg',

                                        description='diff-test',

                                        owner=TEST_USER_ADMIN_LOGIN)

        r1_id = repo1.repo_id

        Session().commit()

        #commit something !

        cs0 = _commit_change(repo1.repo_name, filename='file1', content='line1\n',

                             message='commit1', vcs_type='hg', parent=None, newfile=True)

        #fork this repo

        repo2 = _fork_repo('one-fork', 'hg', parent='one')

        Session().commit()

        r2_id = repo2.repo_id

        #add two extra commit into fork

        cs1 = _commit_change(repo2.repo_name, filename='file1', content='line1\nline2\n',

                             message='commit2', vcs_type='hg', parent=cs0)

        cs2 = _commit_change(repo2.repo_name, filename='file1', content='line1\nline2\nline3\n',

                             message='commit3', vcs_type='hg', parent=cs1)

        rev1 = 'default'

        rev2 = 'default'

        response = self.app.get(url(controller='compare', action='index',

                                    repo_name=repo2.repo_name,

                                    org_ref_type="branch",

                                    org_ref=rev1,

                                    other_repo=repo1.repo_name,

                                    other_ref_type="branch",

                                    other_ref=rev2,

                                    ))

        try:

            response.mustcontain('%s@%s -> %s@%s' % (repo2.repo_name, rev1, repo1.repo_name, rev2))

            response.mustcontain("""Showing 2 commits""")

            response.mustcontain("""1 file changed with 2 insertions and 0 deletions""")

            response.mustcontain("""<div class="message tooltip" title="commit2" style="white-space:normal">commit2</div>""")

            response.mustcontain("""<div class="message tooltip" title="commit3" style="white-space:normal">commit3</div>""")

            response.mustcontain("""<a href="/%s/changeset/%s">r1:%s</a>""" % (repo2.repo_name, cs1.raw_id, cs1.short_id))

            response.mustcontain("""<a href="/%s/changeset/%s">r2:%s</a>""" % (repo2.repo_name, cs2.raw_id, cs2.short_id))

            ## files

            response.mustcontain("""<a href="/%s/compare/branch@%s...branch@%s?other_repo=%s#C--826e8142e6ba">file1</a>""" % (repo2.repo_name, rev1, rev2, repo1.repo_name))

        finally:

            RepoModel().delete(r2_id)

            RepoModel().delete(r1_id)

    def test_compare_forks_on_branch_extra_commits_origin_has_incomming_hg(self):

        self.log_user()

        repo1 = RepoModel().create_repo(repo_name='one', repo_type='hg',

                                        description='diff-test',

                                        owner=TEST_USER_ADMIN_LOGIN)

        r1_id = repo1.repo_id

        Session().commit()

        #commit something !

        cs0 = _commit_change(repo1.repo_name, filename='file1', content='line1\n',

                             message='commit1', vcs_type='hg', parent=None, newfile=True)

        #fork this repo

        repo2 = _fork_repo('one-fork', 'hg', parent='one')

        Session().commit()

        #now commit something to origin repo

        cs1_prim = _commit_change(repo1.repo_name, filename='file2', content='line1file2\n',

                                  message='commit2', vcs_type='hg', parent=cs0, newfile=True)

        r2_id = repo2.repo_id

        #add two extra commit into fork

        cs1 = _commit_change(repo2.repo_name, filename='file1', content='line1\nline2\n',

                             message='commit2', vcs_type='hg', parent=cs0)

        cs2 = _commit_change(repo2.repo_name, filename='file1', content='line1\nline2\nline3\n',

                             message='commit3', vcs_type='hg', parent=cs1)

        rev1 = 'default'

        rev2 = 'default'

        response = self.app.get(url(controller='compare', action='index',

                                    repo_name=repo2.repo_name,

                                    org_ref_type="branch",

                                    org_ref=rev1,

                                    other_repo=repo1.repo_name,

                                    other_ref_type="branch",

                                    other_ref=rev2,

                                    ))

        try:

            response.mustcontain('%s@%s -> %s@%s' % (repo2.repo_name, rev1, repo1.repo_name, rev2))

            response.mustcontain("""Showing 2 commits""")

            response.mustcontain("""1 file changed with 2 insertions and 0 deletions""")

            response.mustcontain("""<div class="message tooltip" title="commit2" style="white-space:normal">commit2</div>""")

            response.mustcontain("""<div class="message tooltip" title="commit3" style="white-space:normal">commit3</div>""")

            response.mustcontain("""<a href="/%s/changeset/%s">r1:%s</a>""" % (repo2.repo_name, cs1.raw_id, cs1.short_id))

            response.mustcontain("""<a href="/%s/changeset/%s">r2:%s</a>""" % (repo2.repo_name, cs2.raw_id, cs2.short_id))

            ## files

            response.mustcontain("""<a href="/%s/compare/branch@%s...branch@%s?other_repo=%s#C--826e8142e6ba">file1</a>""" % (repo2.repo_name, rev1, rev2, repo1.repo_name))

        finally:

            RepoModel().delete(r2_id)

            RepoModel().delete(r1_id)

#    def test_compare_remote_repos_remote_flag_off(self):

#        self.log_user()

#        _fork_repo(HG_FORK, 'hg')

#

#        rev1 = '56349e29c2af'

#        rev2 = '7d4bc8ec6be5'

#

#        response = self.app.get(url(controller='compare', action='index',

#                                    repo_name=HG_REPO,

#                                    org_ref_type="rev",

#                                    org_ref=rev1,

#                                    other_ref_type="rev",

#                                    other_ref=rev2,

#                                    repo=HG_FORK,

#                                    bundle=False,

#                                    ))

#

#        try:

#            response.mustcontain('%s@%s -> %s@%s' % (HG_REPO, rev1, HG_FORK, rev2))

#            ## outgoing changesets between those revisions

#

#            response.mustcontain("""<a href="/%s/changeset/2dda4e345facb0ccff1a191052dd1606dba6781d">r4:2dda4e345fac</a>""" % (HG_REPO))

#            response.mustcontain("""<a href="/%s/changeset/6fff84722075f1607a30f436523403845f84cd9e">r5:6fff84722075</a>""" % (HG_REPO))

#            response.mustcontain("""<a href="/%s/changeset/7d4bc8ec6be56c0f10425afb40b6fc315a4c25e7">r6:%s</a>""" % (HG_REPO, rev2))

#

#            ## files

#            response.mustcontain("""<a href="/%s/compare/rev@%s...rev@%s#C--9c390eb52cd6">vcs/backends/hg.py</a>""" % (HG_REPO, rev1, rev2))

#            response.mustcontain("""<a href="/%s/compare/rev@%s...rev@%s#C--41b41c1f2796">vcs/backends/__init__.py</a>""" % (HG_REPO, rev1, rev2))

#            response.mustcontain("""<a href="/%s/compare/rev@%s...rev@%s#C--2f574d260608">vcs/backends/base.py</a>""" % (HG_REPO, rev1, rev2))

#        finally:

#            RepoModel().delete(HG_FORK)

#

#    def test_compare_remote_branches_hg(self):

#        self.log_user()

#

#        _fork_repo(HG_FORK, 'hg')

#

#        rev1 = '56349e29c2af'

#        rev2 = '7d4bc8ec6be5'

#

#        response = self.app.get(url(controller='compare', action='index',

#                                    repo_name=HG_REPO,

#                                    org_ref_type="rev",

#                                    org_ref=rev1,

#                                    other_ref_type="rev",

#                                    other_ref=rev2,

#                                    repo=HG_FORK,

#                                    ))

#

#        try:

#            response.mustcontain('%s@%s -> %s@%s' % (HG_REPO, rev1, HG_FORK, rev2))

#            ## outgoing changesets between those revisions

#

#            response.mustcontain("""<a href="/%s/changeset/2dda4e345facb0ccff1a191052dd1606dba6781d">r4:2dda4e345fac</a>""" % (HG_REPO))

#            response.mustcontain("""<a href="/%s/changeset/6fff84722075f1607a30f436523403845f84cd9e">r5:6fff84722075</a>""" % (HG_REPO))

#            response.mustcontain("""<a href="/%s/changeset/7d4bc8ec6be56c0f10425afb40b6fc315a4c25e7">r6:%s</a>""" % (HG_REPO, rev2))

#

#            ## files

#            response.mustcontain("""<a href="/%s/compare/rev@%s...rev@%s#C--9c390eb52cd6">vcs/backends/hg.py</a>""" % (HG_REPO, rev1, rev2))

#            response.mustcontain("""<a href="/%s/compare/rev@%s...rev@%s#C--41b41c1f2796">vcs/backends/__init__.py</a>""" % (HG_REPO, rev1, rev2))

#            response.mustcontain("""<a href="/%s/compare/rev@%s...rev@%s#C--2f574d260608">vcs/backends/base.py</a>""" % (HG_REPO, rev1, rev2))

#        finally:

#            RepoModel().delete(HG_FORK)

#

#    def test_org_repo_new_commits_after_forking_simple_diff(self):

#        self.log_user()

#

#        repo1 = RepoModel().create_repo(repo_name='one', repo_type='hg',

#                                        description='diff-test',

#                                        owner=TEST_USER_ADMIN_LOGIN)

#

#        Session().commit()

#        r1_id = repo1.repo_id

#        r1_name = repo1.repo_name

#

#        #commit something initially !

#        cs0 = ScmModel().create_node(

#            repo=repo1.scm_instance, repo_name=r1_name,

#            cs=EmptyChangeset(alias='hg'), user=TEST_USER_ADMIN_LOGIN,

#            author=TEST_USER_ADMIN_LOGIN,

#            message='commit1',

#            content='line1',

#            f_path='file1'

#        )

#        Session().commit()

#        self.assertEqual(repo1.scm_instance.revisions, [cs0.raw_id])

#        #fork the repo1

#        repo2 = RepoModel().create_repo(repo_name='one-fork', repo_type='hg',