def test_environ_editor(self):
file_dict = {self.fb: ['1\n', '2\n', '3\n']}
diff_dict = {}
subprocess.call = self.fake_edit
with open(self.fb, 'w') as handle:
handle.writelines(file_dict[self.fb])
result = Result.from_values('origin', 'msg', self.fb)
# Some users have the ``EDITOR`` environment variable set, so
# we should remove that temporarily.
if 'EDITOR' in os.environ:
del os.environ['EDITOR']
reload(coalib.results.result_actions.OpenEditorAction)
# Currently an ``editor`` param is required, so this will raise
# a ``TypeError``.
from coalib.results.result_actions.OpenEditorAction import (
OpenEditorAction)
action = OpenEditorAction()
with self.assertRaises(TypeError):
action.apply(result, file_dict, diff_dict)
# If we reload the module after setting the ``$EDITOR`` variable,
# we should be able apply the action without an explicit variable.
os.environ['EDITOR'] = 'vim'
reload(coalib.results.result_actions.OpenEditorAction)
from coalib.results.result_actions.OpenEditorAction import (
OpenEditorAction)
action = OpenEditorAction()
action.apply(result, file_dict, diff_dict)
def test_apply_rename(self):
# Initial file contents, *before* a patch was applied
file_dict = {self.fa: ['1\n', '2\n', '3\n']}
# A patch that was applied for some reason to make things complicated
file_diff_dict = {}
diff = Diff(file_dict[self.fa], rename=self.fa + '.renamed')
diff.change_line(3, '3\n', '3_changed\n')
ApplyPatchAction().apply(
Result('origin', 'msg', diffs={self.fa: diff}), file_dict,
file_diff_dict)
# End file contents after the patch and the OpenEditorAction was
# applied
expected_file_dict = {self.fa: ['1\n', '3_changed\n']}
section = Section('')
section.append(Setting('editor', 'vim'))
uut = OpenEditorAction()
subprocess.call = self.fake_edit
diff_dict = uut.apply_from_section(
Result.from_values('origin', 'msg', self.fa), file_dict,
file_diff_dict, section)
for filename in diff_dict:
file_dict[filename] = (file_diff_dict[filename].modified)
self.assertEqual(file_dict, expected_file_dict)
open(self.fa, 'w').close()
def test_open_files_at_position_vim(self):
uut = OpenEditorAction()
result_mock = Result.from_values(
'test', '', self.fa, line=12, column=8,
)
with unittest.mock.patch('subprocess.call') as call:
uut.apply(result_mock, {self.fa: ''}, {}, editor='vim')
call.assert_called_with(
['vim', self.fa, '+12']
)
def test_open_files_at_position_no_position(self):
uut = OpenEditorAction()
result_mock = Result.from_values(
'test', '', self.fa, line=None, column=None,
)
with unittest.mock.patch('subprocess.call') as call:
uut.apply(result_mock, {self.fa: ''}, {}, editor='subl')
call.assert_called_with(
['subl', '--wait', '{0}:1:1'.format(self.fa)],
stdout=subprocess.PIPE
)
def test_subl(self):
file_dict = {self.fa: []}
section = Section('')
section.append(Setting('editor', 'subl'))
uut = OpenEditorAction()
subprocess.call = self.fake_edit_subl
diff_dict = uut.apply_from_section(
Result.from_values('origin', 'msg', self.fa),
file_dict,
{},
section)
file_dict[self.fa] = diff_dict[self.fa].modified
self.assertEqual(file_dict, file_dict)
def test_unknown_editor_warning(self):
logger = logging.getLogger()
uut = OpenEditorAction()
result_mock = Result.from_values(
'test', '', self.fa, line=None, column=None,
)
with unittest.mock.patch('subprocess.call'):
with self.assertLogs(logger, 'WARNING') as log:
uut.apply(result_mock, {self.fa: ''}, {}, editor='gouda-edit')
self.assertEqual(1, len(log.output))
self.assertIn(
'The editor "gouda-edit" is unknown to coala.',
log.output[0]
)
def test_build_editor_call_args_spaced_filename():
uut = OpenEditorAction()
editor_info = {
'args': '--bar --baz',
'file_arg_template': '{filename} +{line}'
}
filenames = {
'foo and bar.py': {
'filename': 'foo and bar.py',
'line': 10,
'column': 6
}
}
assert (uut.build_editor_call_args('foo', editor_info, filenames) == [
'foo', '--bar', '--baz', 'foo and bar.py', '+10'
])
def test_apply(self):
# Initial file contents, *before* a patch was applied
file_dict = {
self.fa: ['1\n', '2\n', '3\n'],
self.fb: ['1\n', '2\n', '3\n'],
'f_c': ['1\n', '2\n', '3\n']}
# A patch that was applied for some reason to make things complicated
diff_dict = {self.fb: Diff(file_dict[self.fb])}
diff_dict[self.fb].change_line(3, '3\n', '3_changed\n')
# File contents after the patch was applied, that's what's in the files
current_file_dict = {
filename: diff_dict[filename].modified
if filename in diff_dict else file_dict[filename]
for filename in (self.fa, self.fb)}
for filename in current_file_dict:
with open(filename, 'w') as handle:
handle.writelines(current_file_dict[filename])
# End file contents after the patch and the OpenEditorAction was
# applied
expected_file_dict = {
self.fa: ['1\n', '3\n'],
self.fb: ['1\n', '3_changed\n'],
'f_c': ['1\n', '2\n', '3\n']}
section = Section('')
section.append(Setting('editor', 'vim'))
uut = OpenEditorAction()
subprocess.call = self.fake_edit
diff_dict = uut.apply_from_section(
Result.from_values('origin', 'msg', self.fa),
file_dict,
diff_dict,
section)
diff_dict = uut.apply_from_section(
Result.from_values('origin', 'msg', self.fb),
file_dict,
diff_dict,
section)
for filename in diff_dict:
file_dict[filename] = (
diff_dict[filename].modified)
self.assertEqual(file_dict, expected_file_dict)
def test_build_editor_call_args_multiple_filename():
uut = OpenEditorAction()
editor_info = {'file_arg_template': '{filename}:{line}:{column}'}
filenames = {
'foo and bar.py': {
'filename': 'foo and bar.py',
'line': 10,
'column': 6
},
'bang bong.py': {
'filename': 'bang bong.py',
'line': 14,
'column': 8
}
}
assert (set(uut.build_editor_call_args(
'foo', editor_info,
filenames)) == set(['foo', 'foo and bar.py:10:6',
'bang bong.py:14:8']))
