tests/git_cl_test.py

#!/usr/bin/env python
# Copyright (c) 2011 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Unit tests for git_cl.py."""

import os
import StringIO
import sys
import unittest

sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

from testing_support.auto_stub import TestCase

import git_cl
import subprocess2


class TestGitCl(TestCase):
  def setUp(self):
    super(TestGitCl, self).setUp()
    self.calls = []
    self._calls_done = 0
    def mock_call(args, **kwargs):
      expected_args, result = self.calls.pop(0)
      self.assertEquals(
          expected_args,
          args,
          '@%d  Expected: %r   Actual: %r' % (
            self._calls_done, expected_args, args))
      self._calls_done += 1
      return result
    self.mock(subprocess2, 'call', mock_call)
    self.mock(subprocess2, 'check_call', mock_call)
    self.mock(subprocess2, 'check_output', mock_call)
    self.mock(subprocess2, 'communicate', mock_call)
    self.mock(subprocess2, 'Popen', mock_call)

    self.mock(git_cl, 'FindCodereviewSettingsFile', lambda: '')

    class PresubmitMock(object):
      def __init__(self, *args, **kwargs):
        self.reviewers = []
      @staticmethod
      def should_continue():
        return True
    self.mock(git_cl.presubmit_support, 'DoPresubmitChecks', PresubmitMock)

    class RietveldMock(object):
      def __init__(self, *args, **kwargs):
        pass
    self.mock(git_cl.rietveld, 'Rietveld', RietveldMock)

    self.mock(git_cl.upload, 'RealMain', self.fail)

    class WatchlistsMock(object):
      def __init__(self, _):
        pass
      @staticmethod
      def GetWatchersForPaths(_):
        return ['joe@example.com']
    self.mock(git_cl.watchlists, 'Watchlists', WatchlistsMock)
    # It's important to reset settings to not have inter-tests interference.
    git_cl.settings = None

  def tearDown(self):
    if not self.has_failed():
      self.assertEquals([], self.calls)
    super(TestGitCl, self).tearDown()

  @classmethod
  def _upload_calls(cls):
    return cls._git_base_calls() + cls._git_upload_calls()

  @staticmethod
  def _git_base_calls():
    return [
        (['git', 'update-index', '--refresh', '-q'], ''),
        (['git', 'diff-index', 'HEAD'], ''),
        (['git', 'config', 'rietveld.server'], 'codereview.example.com'),
        (['git', 'symbolic-ref', 'HEAD'], 'master'),
        (['git', 'config', 'branch.master.merge'], 'master'),
        (['git', 'config', 'branch.master.remote'], 'origin'),
        (['git', 'rev-parse', '--show-cdup'], ''),
        (['git', 'rev-parse', 'HEAD'], '12345'),
        (['git', 'diff', '--name-status', '-r', 'master...', '.'],
          'M\t.gitignore\n'),
        (['git', 'rev-parse', '--git-dir'], '.git'),
        (['git', 'config', 'branch.master.rietveldissue'], ''),
        (['git', 'config', 'branch.master.rietveldpatchset'], ''),
        (['git', 'log', '--pretty=format:%s%n%n%b', 'master...'], 'foo'),
        (['git', 'config', 'user.email'], 'me@example.com'),
        (['git', 'diff', '--no-ext-diff', '--stat', '-M', 'master...'], '+dat'),
        (['git', 'log', '--pretty=format:%s\n\n%b', 'master..'], 'desc\n'),
    ]

  @staticmethod
  def _git_upload_calls():
    return [
        (['git', 'config', 'rietveld.cc'], ''),
        (['git', 'config', '--get-regexp', '^svn-remote\\.'], (('', None), 0)),
        (['git', 'rev-parse', '--show-cdup'], ''),
        (['git', 'svn', 'info'], ''),
        (['git', 'config', 'branch.master.rietveldissue', '1'], ''),
        (['git', 'config', 'branch.master.rietveldserver',
          'http://codereview.example.com'], ''),
        (['git', 'config', 'branch.master.rietveldpatchset', '2'], ''),
    ]

  @staticmethod
  def _cmd_line(description, args):
    """Returns the upload command line passed to upload.RealMain()."""
    msg = description.split('\n', 1)[0]
    return [
        'upload', '--assume_yes', '--server',
        'http://codereview.example.com',
        '--message', msg,
        '--description', description
    ] + args + [
        '--cc', 'joe@example.com',
        'master...'
    ]

  def _run_reviewer_test(
      self,
      upload_args,
      expected_description,
      returned_description,
      final_description,
      reviewers):
    """Generic reviewer test framework."""
    self.calls = self._upload_calls()
    def RunEditor(desc, _):
      self.assertEquals(
          '# Enter a description of the change.\n'
          '# This will displayed on the codereview site.\n'
          '# The first line will also be used as the subject of the review.\n' +
          expected_description,
          desc)
      return returned_description
    self.mock(git_cl.gclient_utils, 'RunEditor', RunEditor)
    def check_upload(args):
      self.assertEquals(self._cmd_line(final_description, reviewers), args)
      return 1, 2
    self.mock(git_cl.upload, 'RealMain', check_upload)
    git_cl.main(['upload'] + upload_args)

  def test_no_reviewer(self):
    self._run_reviewer_test(
        [],
        'desc\n\nBUG=\nTEST=\n',
        '# Blah blah comment.\ndesc\n\nBUG=\nTEST=\n',
        'desc\n\nBUG=\nTEST=\n',
        [])

  def test_reviewers_cmd_line(self):
    # Reviewer is passed as-is
    description = 'desc\n\nR=foo@example.com\nBUG=\nTEST=\n'
    self._run_reviewer_test(
        ['-r' 'foo@example.com'],
        description,
        '\n%s\n' % description,
        description,
        ['--reviewers', 'foo@example.com'])

  def test_reviewer_tbr_overriden(self):
    # Reviewer is overriden with TBR
    # Also verifies the regexp work without a trailing LF
    description = 'Foo Bar\nTBR=reviewer@example.com\n'
    self._run_reviewer_test(
        ['-r' 'foo@example.com'],
        'desc\n\nR=foo@example.com\nBUG=\nTEST=\n',
        description.strip('\n'),
        description,
        ['--reviewers', 'reviewer@example.com'])

  def test_reviewer_multiple(self):
    # Handles multiple R= or TBR= lines.
    description = (
        'Foo Bar\nTBR=reviewer@example.com\nBUG=\nR=another@example.com\n')
    self._run_reviewer_test(
        [],
        'desc\n\nBUG=\nTEST=\n',
        description,
        description,
        ['--reviewers', 'reviewer@example.com,another@example.com'])

  def test_reviewer_send_mail(self):
    # --send-mail can be used without -r if R= is used
    description = 'Foo Bar\nR=reviewer@example.com\n'
    self._run_reviewer_test(
        ['--send-mail'],
        'desc\n\nBUG=\nTEST=\n',
        description.strip('\n'),
        description,
        ['--reviewers', 'reviewer@example.com', '--send_mail'])

  def test_reviewer_send_mail_no_rev(self):
    # Fails without a reviewer.
    class FileMock(object):
      buf = StringIO.StringIO()
      def write(self, content):
        self.buf.write(content)

    mock = FileMock()
    try:
      self.calls = self._git_base_calls()
      def RunEditor(desc, _):
        return desc
      self.mock(git_cl.gclient_utils, 'RunEditor', RunEditor)
      self.mock(sys, 'stderr', mock)
      git_cl.main(['upload', '--send-mail'])
      self.fail()
    except SystemExit:
      self.assertEquals(
          'Must specify reviewers to send email.\n', mock.buf.getvalue())


if __name__ == '__main__':
  unittest.main()