1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
|
import unittest
import click
from click.testing import CliRunner as CLIRunner
from click import utils as click_utils
import mock
from packaging import version
from git_pw import patch
@mock.patch('git_pw.api.detail')
@mock.patch('git_pw.api.download')
@mock.patch('git_pw.utils.git_am')
class ApplyTestCase(unittest.TestCase):
def test_apply(self, mock_git_am, mock_download, mock_detail):
"""Validate behavior with no arguments."""
rsp = {'mbox': 'hello, world'}
mock_detail.return_value = rsp
mock_download.return_value = object()
runner = CLIRunner()
result = runner.invoke(patch.apply_cmd, ['123'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(rsp['mbox'], {'series': '*'})
mock_git_am.assert_called_once_with(mock_download.return_value, ())
def test_apply_with_series(self, mock_git_am, mock_download, mock_detail):
"""Validate behavior with a specific series."""
rsp = {'mbox': 'hello, world'}
mock_detail.return_value = rsp
mock_download.return_value = object()
runner = CLIRunner()
result = runner.invoke(patch.apply_cmd, ['123', '--series', 3])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(rsp['mbox'], {'series': 3})
mock_git_am.assert_called_once_with(mock_download.return_value, ())
def test_apply_without_deps(self, mock_git_am, mock_download, mock_detail):
"""Validate behavior without using dependencies."""
rsp = {'mbox': 'hello, world'}
mock_detail.return_value = rsp
mock_download.return_value = object()
runner = CLIRunner()
result = runner.invoke(patch.apply_cmd, ['123', '--no-deps'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(rsp['mbox'], {'series': None})
mock_git_am.assert_called_once_with(mock_download.return_value, ())
def test_apply_with_args(self, mock_git_am, mock_download, mock_detail):
"""Validate passthrough of arbitrary arguments to git-am."""
rsp = {'mbox': 'hello, world'}
mock_detail.return_value = rsp
mock_download.return_value = object()
runner = CLIRunner()
result = runner.invoke(patch.apply_cmd, ['123', '-3'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(rsp['mbox'], {'series': '*'})
mock_git_am.assert_called_once_with(mock_download.return_value,
('-3',))
@mock.patch('git_pw.api.detail')
@mock.patch('git_pw.api.download')
@mock.patch('git_pw.patch.LOG')
class DownloadTestCase(unittest.TestCase):
def test_download(self, mock_log, mock_download, mock_detail):
"""Validate standard behavior."""
rsp = {'mbox': 'hello, world', 'diff': 'test'}
mock_detail.return_value = rsp
mock_download.return_value = '/tmp/abc123.patch'
runner = CLIRunner()
result = runner.invoke(patch.download_cmd, ['123'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(rsp['mbox'], output=None)
assert mock_log.info.called
def test_download_diff(self, mock_log, mock_download, mock_detail):
"""Validate behavior if downloading a diff instead of mbox."""
rsp = {'mbox': 'hello, world', 'diff': 'test'}
mock_detail.return_value = rsp
runner = CLIRunner()
result = runner.invoke(patch.download_cmd, ['123', '--diff'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(
rsp['mbox'].replace('mbox', 'raw'), output=None,
)
assert mock_log.info.called
def test_download_to_file(self, mock_log, mock_download, mock_detail):
"""Validate behavior if downloading to a specific file."""
rsp = {'mbox': 'hello, world', 'diff': 'test'}
mock_detail.return_value = rsp
runner = CLIRunner()
result = runner.invoke(patch.download_cmd, ['123', 'test.patch'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_called_once_with(rsp['mbox'], output=mock.ANY)
assert isinstance(
mock_download.call_args[1]['output'], click_utils.LazyFile,
)
assert mock_log.info.called
def test_download_diff_to_file(self, mock_log, mock_download, mock_detail):
"""Validate behavior if downloading a diff to a specific file."""
rsp = {'mbox': 'hello, world', 'diff': b'test'}
mock_detail.return_value = rsp
runner = CLIRunner()
with runner.isolated_filesystem():
result = runner.invoke(patch.download_cmd,
['123', '--diff', 'test.diff'])
assert result.exit_code == 0, result
with open('test.diff') as output:
assert [rsp['diff'].decode()] == output.readlines()
mock_detail.assert_called_once_with('patches', 123)
mock_download.assert_not_called()
assert mock_log.info.called
class ShowTestCase(unittest.TestCase):
@staticmethod
def _get_patch(**kwargs):
rsp = {
'id': 123,
'msgid': 'hello@example.com',
'date': '2017-01-01 00:00:00',
'name': 'Sample patch',
'submitter': {
'name': 'foo',
'email': 'foo@bar.com',
},
'state': 'new',
'archived': False,
'project': {
'name': 'bar',
},
'delegate': {
'username': 'johndoe',
},
'commit_ref': None,
'series': [
{
'id': 321,
'name': 'Sample series',
}
],
}
rsp.update(**kwargs)
return rsp
@mock.patch('git_pw.api.detail')
def test_show(self, mock_detail):
"""Validate standard behavior."""
rsp = self._get_patch()
mock_detail.return_value = rsp
runner = CLIRunner()
result = runner.invoke(patch.show_cmd, ['123'])
assert result.exit_code == 0, result
mock_detail.assert_called_once_with('patches', 123)
@mock.patch('git_pw.api.update')
@mock.patch.object(patch, '_show_patch')
@mock.patch.object(patch, '_get_states')
class UpdateTestCase(unittest.TestCase):
@staticmethod
def _get_person(**kwargs):
rsp = {
'id': 1,
'name': 'John Doe',
'email': 'john@example.com',
}
rsp.update(**kwargs)
return rsp
def test_update_no_arguments(self, mock_states, mock_show, mock_update):
"""Validate behavior with no arguments."""
runner = CLIRunner()
result = runner.invoke(patch.update_cmd, ['123'])
assert result.exit_code == 0, result
mock_update.assert_called_once_with('patches', 123, [])
mock_show.assert_called_once_with(mock_update.return_value, None)
def test_update_with_arguments(self, mock_states, mock_show, mock_update):
"""Validate behavior with all arguments except delegate."""
mock_states.return_value = ['new']
runner = CLIRunner()
result = runner.invoke(patch.update_cmd, [
'123', '--commit-ref', '3ed8fb12', '--state', 'new',
'--archived', '1', '--format', 'table'])
assert result.exit_code == 0, result
mock_update.assert_called_once_with('patches', 123, [
('commit_ref', '3ed8fb12'), ('state', 'new'), ('archived', True)])
mock_show.assert_called_once_with(mock_update.return_value, 'table')
def test_update_with_invalid_state(
self, mock_states, mock_show, mock_update):
"""Validate behavior with invalid state."""
mock_states.return_value = ['foo']
runner = CLIRunner()
result = runner.invoke(patch.update_cmd, [
'123', '--state', 'bar'])
assert result.exit_code == 2, result
if version.parse(click.__version__) >= version.Version('7.1'):
assert "Invalid value for '--state'" in result.output, result
else:
assert 'Invalid value for "--state"' in result.output, result
@mock.patch('git_pw.api.index')
def test_update_with_delegate(
self, mock_index, mock_states, mock_show, mock_update):
"""Validate behavior with delegate argument."""
mock_index.return_value = [self._get_person()]
runner = CLIRunner()
result = runner.invoke(patch.update_cmd, [
'123', '--delegate', 'doe@example.com'])
assert result.exit_code == 0, result
mock_index.assert_called_once_with('users', [('q', 'doe@example.com')])
mock_update.assert_called_once_with('patches', 123, [
('delegate', mock_index.return_value[0]['id'])])
mock_show.assert_called_once_with(mock_update.return_value, None)
@mock.patch('git_pw.api.version', return_value=(1, 0))
@mock.patch('git_pw.api.index')
@mock.patch('git_pw.utils.echo_via_pager')
class ListTestCase(unittest.TestCase):
@staticmethod
def _get_patch(**kwargs):
return ShowTestCase._get_patch(**kwargs)
@staticmethod
def _get_person(**kwargs):
rsp = {
'id': 1,
'name': 'John Doe',
'email': 'john@example.com',
}
rsp.update(**kwargs)
return rsp
@staticmethod
def _get_users(**kwargs):
rsp = {
'id': 1,
'username': 'john.doe',
'email': 'john@example.com',
}
rsp.update(**kwargs)
return rsp
def test_list(self, mock_echo, mock_index, mock_version):
"""Validate standard behavior."""
rsp = [self._get_patch()]
mock_index.return_value = rsp
runner = CLIRunner()
result = runner.invoke(patch.list_cmd, [])
assert result.exit_code == 0, result
mock_index.assert_called_once_with('patches', [
('state', 'under-review'), ('state', 'new'), ('q', None),
('archived', 'false'), ('page', None), ('per_page', None),
('order', '-date')])
def test_list_with_formatting(self, mock_echo, mock_index, mock_version):
rsp = [self._get_patch()]
mock_index.return_value = rsp
runner = CLIRunner()
result = runner.invoke(patch.list_cmd, [
'--format', 'simple', '--column', 'ID', '--column', 'Name'])
assert result.exit_code == 0, result
mock_echo.assert_called_once_with(mock.ANY, ('ID', 'Name'),
fmt='simple')
def test_list_with_filters(self, mock_echo, mock_index, mock_version):
"""Validate behavior with filters applied.
Apply all filters, including those for pagination.
"""
submitter_rsp = [self._get_person()]
delegate_rsp = [self._get_person()]
patch_rsp = [self._get_patch()]
mock_index.side_effect = [submitter_rsp, delegate_rsp, patch_rsp]
runner = CLIRunner()
result = runner.invoke(patch.list_cmd, [
'--state', 'new', '--submitter', 'john@example.com',
'--submitter', '2', '--delegate', 'doe@example.com',
'--delegate', '2', '--hash', 'foo', '--archived',
'--limit', 1, '--page', 1, '--sort', '-name', 'test'])
assert result.exit_code == 0, result
calls = [
mock.call('people', [('q', 'john@example.com')]),
mock.call('users', [('q', 'doe@example.com')]),
mock.call('patches', [
('state', 'new'), ('submitter', 1), ('submitter', '2'),
('delegate', 1), ('delegate', '2'), ('hash', 'foo'),
('q', 'test'),
('archived', 'true'), ('page', 1), ('per_page', 1),
('order', '-name')])]
mock_index.assert_has_calls(calls)
@mock.patch('git_pw.api.LOG')
def test_list_with_wildcard_filters(self, mock_log, mock_echo, mock_index,
mock_version):
"""Validate behavior with a "wildcard" filter.
Patchwork API v1.0 did not support multiple filters correctly. Ensure
the user is warned as necessary if a filter has multiple matches.
"""
people_rsp = [self._get_person(), self._get_person()]
patch_rsp = [self._get_patch()]
mock_index.side_effect = [people_rsp, patch_rsp]
runner = CLIRunner()
runner.invoke(patch.list_cmd, ['--submitter', 'john@example.com'])
assert mock_log.warning.called
@mock.patch('git_pw.api.LOG')
def test_list_with_multiple_filters(self, mock_log, mock_echo, mock_index,
mock_version):
"""Validate behavior with use of multiple filters.
Patchwork API v1.0 did not support multiple filters correctly. Ensure
the user is warned as necessary if they specify multiple filters.
"""
people_rsp = [self._get_person()]
user_rsp = [self._get_users()]
patch_rsp = [self._get_patch()]
mock_index.side_effect = [people_rsp, people_rsp, user_rsp, user_rsp,
patch_rsp]
runner = CLIRunner()
result = runner.invoke(patch.list_cmd, [
'--submitter', 'John Doe', '--submitter', 'Jimmy Foo',
'--delegate', 'foo', '--delegate', 'bar'])
assert result.exit_code == 0, result
assert mock_log.warning.called
@mock.patch('git_pw.api.LOG')
def test_list_api_v1_1(self, mock_log, mock_echo, mock_index,
mock_version):
"""Validate behavior with API v1.1."""
mock_version.return_value = (1, 1)
people_rsp = [self._get_person()]
user_rsp = [self._get_users()]
patch_rsp = [self._get_patch()]
mock_index.side_effect = [people_rsp, user_rsp, patch_rsp]
runner = CLIRunner()
result = runner.invoke(patch.list_cmd, [
'--submitter', 'jimmy@example.com', '--submitter', 'John Doe',
'--delegate', 'foo', '--delegate', 'john@example.com'])
assert result.exit_code == 0, result
# We should have only made a single call to each of '/users' and
# '/people' (for the user specified by an email address and the
# submitter specified by name, respectively) since API v1.1 supports
# filtering of users with username and people with emails natively
calls = [
mock.call('people', [('q', 'John Doe')]),
mock.call('users', [('q', 'john@example.com')]),
mock.call('patches', [
('state', 'under-review'), ('state', 'new'),
('submitter', 'jimmy@example.com'), ('submitter', 1),
('delegate', 'foo'), ('delegate', 1),
('q', None), ('archived', 'false'), ('page', None),
('per_page', None), ('order', '-date')])]
mock_index.assert_has_calls(calls)
# We shouldn't see a warning about multiple versions either
assert not mock_log.warning.called
|