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 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
|
from unittest import mock
import pytest
from briefcase.commands.run import LogFilter
from briefcase.exceptions import BriefcaseCommandError, BriefcaseTestSuiteFailure
def test_run_app(run_command, first_app):
"""An app can have its logs streamed."""
popen = mock.MagicMock()
popen.poll = mock.MagicMock(return_value=0)
clean_filter = mock.MagicMock()
# Invoke the stop func as part of streaming. This is to satisfy coverage.
def mock_stream(label, popen_process, stop_func, filter_func):
stop_func()
run_command.tools.subprocess.stream_output = mock.MagicMock(side_effect=mock_stream)
# Stream the app logs
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=mock.ANY,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_run_app_custom_stop_func(run_command, first_app):
"""An app with a custom stop function can have its logs streamed."""
popen = mock.MagicMock()
popen.poll = mock.MagicMock(return_value=0)
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Stream the app logs
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_test_mode_success(run_command, first_app):
"""An app can be streamed in test mode."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app resulting in a test suite success
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.returncode = 0
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
# Stream the app logs
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=True,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_test_mode_failure(run_command, first_app):
"""An app can be streamed in test mode, resulting in test failure."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app resulting in a test suite success
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.returncode = 1
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
# Streaming the app logs causes a test suite failure
with pytest.raises(BriefcaseTestSuiteFailure):
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=True,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_test_mode_no_result(run_command, first_app):
"""An app can be streamed in test mode, but with no test result being found."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app but not finding a test result.
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.success = None
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
# Stream the app logs raises an error
with pytest.raises(
BriefcaseCommandError,
match=r"Test suite didn't report a result.",
):
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=True,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_test_mode_custom_filters(run_command, first_app):
"""An app can define custom success/failure regexes."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app resulting in a test suite success
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.returncode = 0
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
first_app.exit_regex = "THIS IS WHAT SUCCESS LOOKS LIKE"
# Stream the app logs
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=True,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == "THIS IS WHAT SUCCESS LOOKS LIKE"
def test_run_app_failure(run_command, first_app):
"""If an app exits with a bad exit code, that is raised as an error."""
popen = mock.MagicMock()
popen.returncode = 1
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Streaming the app logs raises an error
with pytest.raises(
BriefcaseCommandError,
match=r"Problem running app first.",
):
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_run_app_log_stream_stream_failure(run_command, first_app):
"""If a log stream returns an error code, the log filter requires it is ignored."""
popen = mock.MagicMock()
popen.returncode = 1
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# The log stream raises an error code, but that doesn't raise an error
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
log_stream=True,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="log stream",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_run_app_log_stream_success(run_command, first_app):
"""If a log streamed app returns successfully, no problem is surfaced."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app and returning successfully
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.returncode = 0
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
# Stream the app logs returns success
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
log_stream=True,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="log stream",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_run_app_log_stream_failure(run_command, first_app):
"""If a log streamed app exits with a failure code, the error is surfaced."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app resulting in a test suite success
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.returncode = 1
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
# Streaming the app logs causes a test suite failure
with pytest.raises(
BriefcaseCommandError,
match=r"Problem running app first.",
):
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
log_stream=True,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="log stream",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_run_app_log_stream_no_result(run_command, first_app):
"""If a log streamed app returns no result, no problem is surfaced."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock effect of streaming the app but not finding a test result.
def mock_stream_output(label, popen_process, filter_func, **kwargs):
filter_func.returncode = None
run_command.tools.subprocess.stream_output.side_effect = mock_stream_output
# Streaming the app logs doesn't raise an error
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
log_stream=True,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="log stream",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
def test_run_app_ctrl_c(run_command, first_app):
"""An app can have its logs streamed, but be interrupted."""
popen = mock.MagicMock()
popen.returncode = 0
clean_filter = mock.MagicMock()
stop_func = mock.MagicMock()
run_command.tools.subprocess.stream_output = mock.MagicMock()
# Mock a CTRL-C
run_command.tools.subprocess.stream_output.side_effect = KeyboardInterrupt
# Stream the app logs
run_command._stream_app_logs(
first_app,
popen=popen,
test_mode=False,
clean_filter=clean_filter,
clean_output=False,
stop_func=stop_func,
)
# The log was streamed
run_command.tools.subprocess.stream_output.assert_called_once_with(
label="first",
popen_process=popen,
filter_func=mock.ANY,
stop_func=stop_func,
)
# The filter function has the properties we'd expect
filter_func = run_command.tools.subprocess.stream_output.mock_calls[0].kwargs[
"filter_func"
]
assert not filter_func.clean_output
assert filter_func.clean_filter == clean_filter
assert filter_func.exit_filter.regex.pattern == LogFilter.DEFAULT_EXIT_REGEX
|