/usr/lib/python3/dist-packages/plainbox/impl/session/test_suspend.py is in python3-plainbox 0.5.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 | # This file is part of Checkbox.
#
# Copyright 2012, 2013 Canonical Ltd.
# Written by:
# Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
#
# Checkbox is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 3,
# as published by the Free Software Foundation.
#
# Checkbox is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Checkbox. If not, see <http://www.gnu.org/licenses/>.
"""
:mod:`plainbox.impl.session.test_suspend`
=========================================
Test definitions for :mod:`plainbox.impl.session.suspend` module
"""
from functools import partial
from unittest import TestCase
import gzip
from plainbox.impl.job import JobDefinition
from plainbox.impl.result import DiskJobResult
from plainbox.impl.result import IOLogRecord
from plainbox.impl.result import MemoryJobResult
from plainbox.impl.session.state import SessionMetaData
from plainbox.impl.session.state import SessionState
from plainbox.impl.session.suspend import SessionSuspendHelper1
from plainbox.impl.session.suspend import SessionSuspendHelper2
from plainbox.impl.session.suspend import SessionSuspendHelper3
from plainbox.vendor import mock
class BaseJobResultTestsTestsMixIn:
"""
Mix-in that tests a number of shared aspects of DiskJobResult
and MemoryJobResult. To use sub-class this mix-in with TestCase
and set ``repr_method`` and ``TESTED_CLS`` to something sensible.
:cvar:`repr_method`` should be one of
:meth:`plainbox.impl.session.suspend.SessionSuspendHelper.
_repr_DiskJobResult()`, :meth:`plainbox.impl.session.suspend.
SessionSuspendHelper._repr_MemoryJobResult()`.
:cvar:`TESTED_CLS` should be one of
:class:`plainbox.impl.result.MemoryJobResult`
or :class:`plainbox.impl.result.DiskJobResult`
"""
def setUp(self):
self.helper = SessionSuspendHelper1()
self.empty_result = self.TESTED_CLS({})
self.typical_result = self.TESTED_CLS({
"outcome": self.TESTED_CLS.OUTCOME_PASS,
"execution_duration": 42.5,
"comments": "the screen was corrupted",
"return_code": 1,
# NOTE: those are actually specific to TESTED_CLS but it is
# a simple hack that gets the job done
"io_log_filename": "/nonexistent.log",
"io_log": [
(0, 'stdout', b'first part\n'),
(0.1, 'stdout', b'second part\n'),
]
})
def test_repr_xxxJobResult_outcome(self):
"""
verify that DiskJobResult.outcome is serialized correctly
"""
data = self.repr_method(self.typical_result)
self.assertEqual(data['outcome'], DiskJobResult.OUTCOME_PASS)
def test_repr_xxxJobResult_execution_duration(self):
"""
verify that DiskJobResult.execution_duration is serialized correctly
"""
data = self.repr_method(self.typical_result)
self.assertAlmostEqual(data['execution_duration'], 42.5)
def test_repr_xxxJobResult_comments(self):
"""
verify that DiskJobResult.comments is serialized correctly
"""
data = self.repr_method(self.typical_result)
self.assertEqual(data['comments'], "the screen was corrupted")
def test_repr_xxxJobResult_return_code(self):
"""
verify that DiskJobResult.return_code is serialized correctly
"""
data = self.repr_method(self.typical_result)
self.assertEqual(data['return_code'], 1)
class SuspendMemoryJobResultTests(BaseJobResultTestsTestsMixIn, TestCase):
"""
Tests that check how MemoryJobResult is represented by SessionSuspendHelper
"""
TESTED_CLS = MemoryJobResult
def setUp(self):
super(SuspendMemoryJobResultTests, self).setUp()
self.repr_method = self.helper._repr_MemoryJobResult
def test_repr_MemoryJobResult_empty(self):
"""
verify that the representation of an empty MemoryJobResult is okay
"""
data = self.repr_method(self.empty_result)
self.assertEqual(data, {
"outcome": None,
"execution_duration": None,
"comments": None,
"return_code": None,
"io_log": [],
})
def test_repr_MemoryJobResult_io_log(self):
"""
verify that MemoryJobResult.io_log is serialized correctly
"""
data = self.helper._repr_MemoryJobResult(self.typical_result)
self.assertEqual(data['io_log'], [
[0, 'stdout', 'Zmlyc3QgcGFydAo='],
[0.1, 'stdout', 'c2Vjb25kIHBhcnQK'],
])
class SuspendDiskJobResultTests(BaseJobResultTestsTestsMixIn, TestCase):
"""
Tests that check how DiskJobResult is represented by SessionSuspendHelper
"""
TESTED_CLS = DiskJobResult
def setUp(self):
super(SuspendDiskJobResultTests, self).setUp()
self.repr_method = self.helper._repr_DiskJobResult
def test_repr_DiskJobResult_empty(self):
"""
verify that the representation of an empty DiskJobResult is okay
"""
data = self.repr_method(self.empty_result)
self.assertEqual(data, {
"outcome": None,
"execution_duration": None,
"comments": None,
"return_code": None,
"io_log_filename": None,
})
def test_repr_DiskJobResult_io_log_filename(self):
"""
verify that DiskJobResult.io_log_filename is serialized correctly
"""
data = self.helper._repr_DiskJobResult(self.typical_result)
self.assertEqual(data['io_log_filename'], "/nonexistent.log")
class SessionSuspendHelper1Tests(TestCase):
"""
Tests for various methods of SessionSuspendHelper
"""
def setUp(self):
self.helper = SessionSuspendHelper1()
def test_repr_IOLogRecord(self):
"""
verify that the representation of IOLogRecord is okay
"""
record = IOLogRecord(0.0, "stdout", b"binary data")
data = self.helper._repr_IOLogRecord(record)
self.assertEqual(data, [0.0, "stdout", "YmluYXJ5IGRhdGE="])
@mock.patch('plainbox.impl.session.suspend.SessionSuspendHelper')
def test_repr_JobResult_with_MemoryJobResult(self, mocked_helper):
"""
verify that _repr_JobResult() called with MemoryJobResult
calls _repr_MemoryJobResult
"""
result = MemoryJobResult({})
self.helper._repr_JobResult(result)
mocked_helper._repr_MemoryJobResult.assertCalledOnceWith(result)
@mock.patch('plainbox.impl.session.suspend.SessionSuspendHelper')
def test_repr_JobResult_with_DiskJobResult(self, mocked_helper):
"""
verify that _repr_JobResult() called with DiskJobResult
calls _repr_DiskJobResult
"""
result = DiskJobResult({})
self.helper._repr_JobResult(result)
mocked_helper._repr_DiskJobResult.assertCalledOnceWith(result)
def test_repr_JobResult_with_junk(self):
"""
verify that _repr_JobResult() raises TypeError when
called with something other than JobResult instances
"""
with self.assertRaises(TypeError):
self.helper._repr_JobResult(None)
def test_repr_SessionMetaData_empty_metadata(self):
"""
verify that representation of empty SessionMetaData is okay
"""
# all defaults with empty values
data = self.helper._repr_SessionMetaData(SessionMetaData())
self.assertEqual(data, {
'title': None,
'flags': [],
'running_job_name': None
})
def test_repr_SessionMetaData_typical_metadata(self):
"""
verify that representation of typical SessionMetaData is okay
"""
# no surprises here, just the same data copied over
data = self.helper._repr_SessionMetaData(SessionMetaData(
title='USB Testing session',
flags=['incomplete'],
running_job_name='usb/detect'
))
self.assertEqual(data, {
'title': 'USB Testing session',
'flags': ['incomplete'],
'running_job_name': 'usb/detect',
})
def test_repr_SessionState_empty_session(self):
"""
verify that representation of empty SessionState is okay
"""
data = self.helper._repr_SessionState(SessionState([]))
self.assertEqual(data, {
'jobs': {},
'results': {},
'desired_job_list': [],
'metadata': {
'title': None,
'flags': [],
'running_job_name': None,
},
})
def test_json_repr_has_version_field(self):
"""
verify that the json representation has the 'version' field
"""
data = self.helper._json_repr(SessionState([]))
self.assertIn("version", data)
def test_json_repr_current_version(self):
"""
verify what the version field is
"""
data = self.helper._json_repr(SessionState([]))
self.assertEqual(data['version'], 1)
def test_json_repr_stores_session_state(self):
"""
verify that the json representation has the 'session' field
"""
data = self.helper._json_repr(SessionState([]))
self.assertIn("session", data)
def test_suspend(self):
"""
verify that the suspend() method returns gzipped JSON representation
"""
data = self.helper.suspend(SessionState([]))
# XXX: we cannot really test what the compressed data looks like
# because apparently python3.2 gzip output is non-deterministic.
# It seems to be an instance of the gzip bug that was fixed a few
# years ago.
#
# I've filed a bug on python3.2 in Ubuntu and Python upstream project
# https://bugs.launchpad.net/ubuntu/+source/python3.2/+bug/871083
#
# In the meantime we can only test that we got bytes out
self.assertIsInstance(data, bytes)
# And that we can gzip uncompress them and get what we expected
self.assertEqual(gzip.decompress(data), (
b'{"session":{"desired_job_list":[],"jobs":{},"metadata":'
b'{"flags":[],"running_job_name":null,"title":null},"results":{}'
b'},"version":1}'))
class GeneratedJobSuspendTests(TestCase):
"""
Tests that check how SessionSuspendHelper behaves when faced with
generated jobs. This tests sets up the following job hierarchy:
__category__
\-> generator
\-> generated
The "__category__" job is a typical "catter" job that cats an existing
job from somewhere else in the filesystem. This type of generated job
is used often for category assignment.
The "generator" job is a typical non-catter job that actually creates
new jobs in some way. In this test it generates a job called "generated".
"""
def setUp(self):
# Crete a "__category__" job
self.category_job = JobDefinition({
"plugin": "local",
"id": "__category__"
})
# Create a "generator" job
self.generator_job = JobDefinition({
"plugin": "local",
"id": "generator"
})
# Keep a variable for the (future) generated job
self.generated_job = None
# Create a result for the "__category__" job.
# It must define a verbatim copy of the "generator" job
self.category_result = MemoryJobResult({
"io_log": [
(0.0, "stdout", b'plugin:local\n'),
(0.1, "stdout", b'id:generator\n'),
]
})
# Create a result for the "generator" job.
# It will define the "generated" job
self.generator_result = MemoryJobResult({
"io_log": [(0.0, 'stdout', b'id:generated')]
})
# Create a session that knows about the two jobs that exist
# directly as files (__category__ and generator)
self.session_state = SessionState([
self.category_job, self.generator_job])
# Select both of them for execution.
self.session_state.update_desired_job_list([
self.category_job, self.generator_job])
# "execute" the "__category__" job by showing the session the result
self.session_state.update_job_result(
self.category_job, self.category_result)
# Ensure that the generator job gained the "via" attribute
# This is how we know the code above has no typos or anything.
self.assertEqual(
self.generator_job.via, self.category_job.checksum)
# "execute" the "generator" job by showing the session the result.
# Connect the 'on_job_added' signal to a helper function that
# extracts the "generated" job
def job_added(self, job):
self.generated_job = job
# Use partial to supply 'self' from the class into the function above
self.session_state.on_job_added.connect(partial(job_added, self))
# Show the result of the "generator" job to the session,
# this will define the "generated" job, fire the signal
# and call our callback
self.session_state.update_job_result(
self.generator_job, self.generator_result)
# Ensure that we got the generated_job variable assigned
# (by the event/signal handled above)
self.assertIsNot(self.generated_job, None)
# Now the stage is set for testing. Let's create the suspend helper
# and use the data we've defined so far to create JSON-friendly
# description of the session state.
self.helper = SessionSuspendHelper1()
self.data = self.helper._repr_SessionState(self.session_state)
def test_state_tracked_for_all_jobs(self):
"""
verify that 'state' keeps track of all three jobs
"""
self.assertIn(self.category_job.id, self.data['jobs'])
self.assertIn(self.generator_job.id, self.data['jobs'])
self.assertIn(self.generated_job.id, self.data['jobs'])
def test_category_job_result_is_saved(self):
"""
verify that the 'category' job result was saved
"""
# This result is essential to re-create the association
# with the 'generator' job. In theory we could get it from
# the 'via' attribute but that is only true for category assignment
# where the child job already exists and is defined on the
# filesystem. This would not work in the case of truly generated jobs
# so for consistency it is done the same way.
self.assertEqual(
self.data['results']['__category__'], [{
'comments': None,
'execution_duration': None,
'outcome': None,
'return_code': None,
'io_log': [
[0.0, 'stdout', 'cGx1Z2luOmxvY2FsCg=='],
[0.1, 'stdout', 'aWQ6Z2VuZXJhdG9yCg==']
]
}]
)
def test_generator_job_result_is_saved(self):
"""
verify that the 'generator' job result was saved
"""
self.assertEqual(
self.data['results']['generator'], [{
'comments': None,
'execution_duration': None,
'outcome': None,
'return_code': None,
'io_log': [
[0.0, 'stdout', 'aWQ6Z2VuZXJhdGVk'],
]
}]
)
def test_generated_job_result_is_saved(self):
"""
verify that the 'generated' job result was saved
"""
# This is the implicit "empty" result that all jobs have
self.assertEqual(
self.data['results']['generated'], [{
'comments': None,
'execution_duration': None,
'outcome': None,
'return_code': None,
'io_log': []
}]
)
def test_sanity_check(self):
"""
verify that the whole suspend data looks right
"""
# This test is pretty much a "eyeball" inspection test
# where we can see everything at a glance and not have to
# deduce how each part looks like from the tests above.
#
# All the data below is verbatim copy of the generated suspend data
# that was created when this test was written. The only modification
# was wrapping of the checksums in ( ) to make them wrap correctly
# so that the file can stay PEP-8 clean
self.maxDiff = None
self.assertEqual(self.data, {
'jobs': {
'__category__': (
'e2475434e4c0b2c825541430e526fe0565780dfeb67'
'050f3b7f3453aa3cc439b'),
'generator': (
'b2aa7b7c4298678cebfdbe30f4aae5be97d320910a5'
'b4dd312606099f35c03b6'),
'generated': (
'57b395e91bb4af94143eb19586bd18e4013efc5e60d'
'6050d9ec0bea15dd19489'),
},
'results': {
'__category__': [{
'comments': None,
'execution_duration': None,
'io_log': [
[0.0, 'stdout', 'cGx1Z2luOmxvY2FsCg=='],
[0.1, 'stdout', 'aWQ6Z2VuZXJhdG9yCg==']],
'outcome': None,
'return_code': None,
}],
'generator': [{
'comments': None,
'execution_duration': None,
'io_log': [
[0.0, 'stdout', 'aWQ6Z2VuZXJhdGVk']],
'outcome': None,
'return_code': None,
}],
'generated': [{
'comments': None,
'execution_duration': None,
'io_log': [],
'outcome': None,
'return_code': None,
}]
},
'desired_job_list': ['__category__', 'generator'],
'metadata': {
'flags': [],
'running_job_name': None,
'title': None
},
})
class SessionSuspendHelper2Tests(SessionSuspendHelper1Tests):
"""
Tests for various methods of SessionSuspendHelper2
"""
def setUp(self):
self.helper = SessionSuspendHelper2()
def test_json_repr_current_version(self):
"""
verify what the version field is
"""
data = self.helper._json_repr(SessionState([]))
self.assertEqual(data['version'], 2)
def test_repr_SessionMetaData_empty_metadata(self):
"""
verify that representation of empty SessionMetaData is okay
"""
# all defaults with empty values
data = self.helper._repr_SessionMetaData(SessionMetaData())
self.assertEqual(data, {
'title': None,
'flags': [],
'running_job_name': None,
'app_blob': None
})
def test_repr_SessionMetaData_typical_metadata(self):
"""
verify that representation of typical SessionMetaData is okay
"""
# no surprises here, just the same data copied over
data = self.helper._repr_SessionMetaData(SessionMetaData(
title='USB Testing session',
flags=['incomplete'],
running_job_name='usb/detect',
app_blob=b'blob',
))
self.assertEqual(data, {
'title': 'USB Testing session',
'flags': ['incomplete'],
'running_job_name': 'usb/detect',
'app_blob': 'YmxvYg==',
})
def test_repr_SessionState_empty_session(self):
"""
verify that representation of empty SessionState is okay
"""
data = self.helper._repr_SessionState(SessionState([]))
self.assertEqual(data, {
'jobs': {},
'results': {},
'desired_job_list': [],
'metadata': {
'title': None,
'flags': [],
'running_job_name': None,
'app_blob': None,
},
})
def test_suspend(self):
"""
verify that the suspend() method returns gzipped JSON representation
"""
data = self.helper.suspend(SessionState([]))
# XXX: we cannot really test what the compressed data looks like
# because apparently python3.2 gzip output is non-deterministic.
# It seems to be an instance of the gzip bug that was fixed a few
# years ago.
#
# I've filed a bug on python3.2 in Ubuntu and Python upstream project
# https://bugs.launchpad.net/ubuntu/+source/python3.2/+bug/871083
#
# In the meantime we can only test that we got bytes out
self.assertIsInstance(data, bytes)
# And that we can gzip uncompress them and get what we expected
self.assertEqual(gzip.decompress(data), (
b'{"session":{"desired_job_list":[],"jobs":{},"metadata":'
b'{"app_blob":null,"flags":[],"running_job_name":null,"title":null'
b'},"results":{}},"version":2}'))
class SessionSuspendHelper3Tests(SessionSuspendHelper2Tests):
"""
Tests for various methods of SessionSuspendHelper3
"""
def setUp(self):
self.helper = SessionSuspendHelper3()
def test_json_repr_current_version(self):
"""
verify what the version field is
"""
data = self.helper._json_repr(SessionState([]))
self.assertEqual(data['version'], 3)
def test_repr_SessionMetaData_empty_metadata(self):
"""
verify that representation of empty SessionMetaData is okay
"""
# all defaults with empty values
data = self.helper._repr_SessionMetaData(SessionMetaData())
self.assertEqual(data, {
'title': None,
'flags': [],
'running_job_name': None,
'app_blob': None,
'app_id': None
})
def test_repr_SessionMetaData_typical_metadata(self):
"""
verify that representation of typical SessionMetaData is okay
"""
# no surprises here, just the same data copied over
data = self.helper._repr_SessionMetaData(SessionMetaData(
title='USB Testing session',
flags=['incomplete'],
running_job_name='usb/detect',
app_blob=b'blob',
app_id='com.canonical.certification.plainbox',
))
self.assertEqual(data, {
'title': 'USB Testing session',
'flags': ['incomplete'],
'running_job_name': 'usb/detect',
'app_blob': 'YmxvYg==',
'app_id': 'com.canonical.certification.plainbox'
})
def test_repr_SessionState_empty_session(self):
"""
verify that representation of empty SessionState is okay
"""
data = self.helper._repr_SessionState(SessionState([]))
self.assertEqual(data, {
'jobs': {},
'results': {},
'desired_job_list': [],
'metadata': {
'title': None,
'flags': [],
'running_job_name': None,
'app_blob': None,
'app_id': None,
},
})
def test_suspend(self):
"""
verify that the suspend() method returns gzipped JSON representation
"""
data = self.helper.suspend(SessionState([]))
# XXX: we cannot really test what the compressed data looks like
# because apparently python3.2 gzip output is non-deterministic.
# It seems to be an instance of the gzip bug that was fixed a few
# years ago.
#
# I've filed a bug on python3.2 in Ubuntu and Python upstream project
# https://bugs.launchpad.net/ubuntu/+source/python3.2/+bug/871083
#
# In the meantime we can only test that we got bytes out
self.assertIsInstance(data, bytes)
# And that we can gzip uncompress them and get what we expected
self.assertEqual(gzip.decompress(data), (
b'{"session":{"desired_job_list":[],"jobs":{},"metadata":'
b'{"app_blob":null,"app_id":null,"flags":[],'
b'"running_job_name":null,"title":null},"results":{}},'
b'"version":3}'))
|