dfa212ffd0
Add simple regression test to ensure that setting sequence.editor will not cause a hang, and add a timeout to interactive mode tests to ensure they are terminated with an error should they fail to complete reasonably quickly (suggesting a hang). Early release 0.9.0 had an issue where setting sequence.editor would cause git-upstream to hang, due to git-rebase attempting to launch the editor specified, while the console was being redirected by python's subprocess. At some point a behaviour change meant the config setting sequence.editor was no longer used by the python subprocess calling git-rebase. Instead the tool would launch the user specified editor directly (checking the git config settings for sequence.editor, then core.editor, and falling back to the environment variable EDITOR if neither were set), and would instead ensure that when finally calling git-rebase it would only use the special editor provided by git-upstream. However it's still important to check that setting sequence.editor does not cause any future problems such the code be refactored again. Change-Id: I303dced0d1a52791d18b39e8e6d342374e3d2eeb Related-Bug: #1394553
151 lines
6.1 KiB
Python
151 lines
6.1 KiB
Python
# Copyright (c) 2016 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 for the --interactive option to the 'import' command"""
|
|
|
|
import os
|
|
import subprocess
|
|
import threading
|
|
|
|
import mock
|
|
import psutil
|
|
from testscenarios import TestWithScenarios
|
|
from testtools.content import text_content
|
|
from testtools.matchers import Contains
|
|
from testtools.matchers import Equals
|
|
from testtools.matchers import Not
|
|
|
|
from git_upstream.lib.pygitcompat import Commit
|
|
from git_upstream import main
|
|
from git_upstream.tests.base import BaseTestCase
|
|
from git_upstream.tests.base import get_scenarios
|
|
|
|
|
|
@mock.patch.dict('os.environ', {'GIT_EDITOR': 'cat'})
|
|
class TestImportInteractiveCommand(TestWithScenarios, BaseTestCase):
|
|
|
|
scenarios = get_scenarios(os.path.join(os.path.dirname(__file__),
|
|
"interactive_scenarios"))
|
|
|
|
def setUp(self):
|
|
# add description in case parent setup fails.
|
|
self.addDetail('description', text_content(self.desc))
|
|
|
|
self.commands, self.parser = main.build_parsers()
|
|
script_cmdline = self.parser.get_default('script_cmdline')
|
|
script_cmdline[-1] = os.path.join(os.getcwd(), main.__file__)
|
|
self.parser.set_defaults(script_cmdline=script_cmdline)
|
|
|
|
# builds the tree to be tested
|
|
super(TestImportInteractiveCommand, self).setUp()
|
|
|
|
def test_interactive(self):
|
|
upstream_branch = self.branches['upstream'][0]
|
|
target_branch = self.branches['head'][0]
|
|
|
|
cmdline = self.parser.get_default('script_cmdline') + self.parser_args
|
|
|
|
# ensure interactive mode cannot hang tests
|
|
def kill(proc_pid):
|
|
process = psutil.Process(proc_pid)
|
|
for proc in process.children(recursive=True):
|
|
try:
|
|
proc.kill()
|
|
except OSError:
|
|
continue
|
|
try:
|
|
process.kill()
|
|
except OSError:
|
|
pass
|
|
|
|
def get_output(proc):
|
|
self.output = proc.communicate()[0]
|
|
|
|
proc = subprocess.Popen(cmdline,
|
|
stdin=open(os.devnull, "r"),
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.STDOUT, close_fds=True,
|
|
cwd=self.testrepo.path)
|
|
proc_thread = threading.Thread(target=get_output, args=[proc])
|
|
proc_thread.start()
|
|
proc_thread.join(getattr(self, 'timeout', 5))
|
|
if proc_thread.is_alive():
|
|
kill(proc.pid)
|
|
proc_thread.join()
|
|
self.addDetail('subprocess-output',
|
|
text_content(self.output.decode('utf-8')))
|
|
raise Exception('Process #%d killed after timeout' % proc.pid)
|
|
|
|
self.addDetail('subprocess-output',
|
|
text_content(self.output.decode('utf-8')))
|
|
|
|
self.assertThat(proc.returncode, Equals(0))
|
|
|
|
expected = getattr(self, 'expect_rebased', [])
|
|
if expected:
|
|
changes = list(Commit.iter_items(
|
|
self.repo, '%s..%s^2' % (upstream_branch, target_branch)))
|
|
self.assertThat(
|
|
len(changes), Equals(len(expected)),
|
|
"should only have seen %s changes, got: %s" %
|
|
(len(expected),
|
|
", ".join(["%s:%s" % (commit.hexsha,
|
|
commit.message.splitlines()[0])
|
|
for commit in changes])))
|
|
|
|
# expected should be listed in order from oldest to newest, so
|
|
# reverse changes to match as it would be newest to oldest.
|
|
changes.reverse()
|
|
for commit, node in zip(changes, expected):
|
|
subject = commit.message.splitlines()[0]
|
|
node_subject = self.gittree.graph[node].message.splitlines()[0]
|
|
self.assertThat(subject, Equals(node_subject),
|
|
"subject '%s' of commit '%s' does not match "
|
|
"subject '%s' of node '%s'" % (
|
|
subject, commit.hexsha, node_subject,
|
|
node))
|
|
import_branch = [head for head in self.repo.heads
|
|
if str(head).startswith("import") and
|
|
not str(head).endswith("-base")]
|
|
|
|
self.assertThat(self.git.rev_parse(import_branch),
|
|
Not(Equals(self.git.rev_parse(target_branch))),
|
|
"Import branch and target should have identical "
|
|
"contents, but not be the same")
|
|
|
|
# allow disabling of checking the merge commit contents
|
|
# as some tests won't result in an import
|
|
if getattr(self, 'check_merge', True):
|
|
commit_message = self.git.log(target_branch, n=1)
|
|
self.assertThat(commit_message,
|
|
Contains("of '%s' into '%s'" % (upstream_branch,
|
|
target_branch)))
|
|
# make sure the final state of merge is correct
|
|
self.assertThat(
|
|
self.repo.git.rev_parse("%s^{tree}" % target_branch),
|
|
Equals(self.repo.git.rev_parse(
|
|
"%s^2^{tree}" % target_branch)),
|
|
"--finish option failed to merge correctly")
|
|
|
|
# allow additional test specific verification methods below
|
|
extra_test_func = getattr(self, '_verify_%s' % self.name, None)
|
|
if extra_test_func:
|
|
extra_test_func()
|
|
|
|
def _verify_basic(self):
|
|
self.assertThat(
|
|
self.output.decode('utf-8'),
|
|
Contains("Successfully rebased and updated refs/heads/import/"))
|