/usr/lib/python3/dist-packages/plainbox/impl/session/resume.py is in python3-plainbox 0.25-1.
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 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 | # This file is part of Checkbox.
#
# Copyright 2012, 2013, 2014 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/>.
"""
Session resume handling.
:mod:`plainbox.impl.session.resume` -- session resume handling
==============================================================
This module contains classes that can resume a dormant session from
a binary representation. See docs for the suspend module for details.
The resume logic provides a compromise between usefulness and correctness
so two assumptions are made:
* We assume that a checksum of a job changes when their behavior changes.
This way we can detect when job definitions were updated after
suspending but before resuming.
* We assume that software and hardware *may* change while the session is
suspended but this is not something that framework (PlainBox) is
concerned with. Applications should provide job definitions that
are capable of detecting this and acting appropriately.
This is true since the user may install additional packages
or upgrade existing packages. The user can also add or remove pluggable
hardware. Lastly actual machine suspend (or hibernate) and resume *may*
cause alterations to the hardware as it is visible from within
the system. In any case the framework does not care about this.
"""
from collections import deque
import base64
import binascii
import gzip
import json
import logging
import os
import re
from plainbox.i18n import gettext as _
from plainbox.impl.result import DiskJobResult
from plainbox.impl.result import IOLogRecord
from plainbox.impl.result import MemoryJobResult
from plainbox.impl.result import OUTCOME_METADATA_MAP
from plainbox.impl.secure.origin import Origin
from plainbox.impl.secure.qualifiers import SimpleQualifier
from plainbox.impl.session.state import SessionMetaData
from plainbox.impl.session.state import SessionState
logger = logging.getLogger("plainbox.session.resume")
class SessionResumeError(Exception):
"""
Base for all session resume exceptions.
Base class for exceptions that can be raised when attempting to
resume a dormant session.
"""
class CorruptedSessionError(SessionResumeError):
"""
Exception raised when suspended session is corrupted.
Exception raised when :class:`SessionResumeHelper` cannot decode
the session byte stream. This exception will be raised with additional
context that captures the actual underlying cause. Having this exception
class makes it easier to handle resume errors.
"""
class IncompatibleSessionError(SessionResumeError):
"""
Exception raised when suspended session is correct but incompatible.
Exception raised when :class:`SessionResumeHelper` comes across malformed
or unsupported data that was (presumably) produced by
:class:`SessionSuspendHelper`
"""
class IncompatibleJobError(SessionResumeError):
"""
Exception raised when suspended session needs a different version of a job.
Exception raised when :class:`SessionResumeHelper` detects that the set of
jobs it knows about is incompatible with what was saved before.
"""
class BrokenReferenceToExternalFile(SessionResumeError):
"""
Exception raised when suspended session needs an external file that's gone.
Exception raised when :class:`SessionResumeHelper` detects that a file
needed by the session to resume is not present. This is typically used to
signal inaccessible log files.
"""
class EnvelopeUnpackMixIn:
"""
A mix-in class capable of unpacking the envelope of the session storage.
This class assists in unpacking the "envelope" in which the session data is
actually stored. The envelope is simply gzip but other kinds of envelope
can be added later.
"""
def unpack_envelope(self, data):
"""
Unpack the binary envelope and get access to a JSON object.
:param data:
Bytes representing the dormant session
:returns:
the JSON representation of a session stored in the envelope
:raises CorruptedSessionError:
if the representation of the session is corrupted in any way
"""
try:
data = gzip.decompress(data)
except IOError:
raise CorruptedSessionError(_("Cannot decompress session data"))
try:
text = data.decode("UTF-8")
except UnicodeDecodeError:
raise CorruptedSessionError(_("Cannot decode session text"))
try:
return json.loads(text)
except ValueError:
raise CorruptedSessionError(_("Cannot interpret session JSON"))
class SessionPeekHelper(EnvelopeUnpackMixIn):
"""A helper class to peek at session state meta-data quickly."""
def peek(self, data):
"""
Peek at the meta-data of a dormant session.
:param data:
Bytes representing the dormant session
:returns:
a SessionMetaData object
:raises CorruptedSessionError:
if the representation of the session is corrupted in any way
:raises IncompatibleSessionError:
if session serialization format is not supported
"""
json_repr = self.unpack_envelope(data)
return self._peek_json(json_repr)
def _peek_json(self, json_repr):
"""
Resume a SessionMetaData object from the JSON representation.
This method is called by :meth:`peek()` after the initial envelope
and parsing is done. The only error conditions that can happen
are related to semantic incompatibilities or corrupted internal state.
"""
logger.debug(_("Peeking at json... (see below)"))
logger.debug(json.dumps(json_repr, indent=4))
_validate(json_repr, value_type=dict)
version = _validate(json_repr, key="version", choice=[1])
if version == 1:
return SessionPeekHelper1().peek_json(json_repr)
elif version == 2:
return SessionPeekHelper2().peek_json(json_repr)
elif version == 3:
return SessionPeekHelper3().peek_json(json_repr)
elif version == 4:
return SessionPeekHelper4().peek_json(json_repr)
elif version == 5:
return SessionPeekHelper5().peek_json(json_repr)
elif version == 6:
return SessionPeekHelper6().peek_json(json_repr)
else:
raise IncompatibleSessionError(
_("Unsupported version {}").format(version))
class SessionResumeHelper(EnvelopeUnpackMixIn):
"""
Helper class for implementing session resume feature.
This class is a facade that does enough of the resume process to know which
version is being resumed and delegate the rest of the process to an
appropriate, format specific, resume class.
"""
def __init__(
self, job_list: 'List[JobDefinition]',
flags: 'Optional[Iterable[str]]', location: 'Optional[str]'
):
"""
Initialize the helper with a list of known jobs and support data.
:param job_list:
List of known jobs
:param flags:
Any iterable object with string versions of resume support flags.
This can be None, if the application doesn't wish to enable any of
the feature flags.
:param location:
Location of the session directory. This is the same as
``session_dir`` in the corresponding suspend API. It is also the
same as ``storage.location`` (where ``storage`` is a
:class:`plainbox.impl.session.storage.SessionStorage` object.
Applicable flags are ``FLAG_FILE_REFERENCE_CHECKS_S``,
``FLAG_REWRITE_LOG_PATHNAMES_S`` and ``FLAG_IGNORE_JOB_CHECKSUMS_S``.
Their meaning is described below.
``FLAG_FILE_REFERENCE_CHECKS_S``:
Flag controlling reference checks from within the session file to
external files. If enabled such checks are performed and can cause
additional exceptions to be raised. Currently this only affects the
representation of the DiskJobResult instances.
``FLAG_REWRITE_LOG_PATHNAMES_S``:
Flag controlling rewriting of log file pathnames. It depends on the
location to be non-None and then rewrites pathnames of all them
missing log files to be relative to the session storage location.
It effectively depends on FLAG_FILE_REFERENCE_CHECKS_F being set at
the same time, otherwise it is ignored.
``FLAG_IGNORE_JOB_CHECKSUMS_S``:
Flag controlling integrity checks between jobs present at resume
time and jobs present at suspend time. Since providers cannot be
serialized (nor should they) this integrity check prevents anyone
from resuming a session if job definitions have changed. Using this
flag effectively disables that check.
"""
self.job_list = job_list
logger.debug("Session Resume Helper started with jobs: %r", job_list)
self.flags = flags
self.location = location
def resume(self, data, early_cb=None):
"""
Resume a dormant session.
:param data:
Bytes representing the dormant session
:param early_cb:
A callback that allows the caller to "see" the session object
early, before the bulk of resume operation happens. This method can
be used to register signal listeners on the new session before this
method call returns. The callback accepts one argument, session,
which is being resumed.
:returns:
resumed session instance
:rtype:
:class:`~plainbox.impl.session.state.SessionState`
This method validates the representation of a dormant session and
re-creates an identical SessionState instance. It can fail in multiple
ways, some of which are a part of normal operation and should always be
handled (:class:`IncompatibleJobError` and
:class:`IncompatibleJobError`). Applications may wish to capture
:class:`SessionResumeError` as a generic base exception for all the
possible problems.
:raises CorruptedSessionError:
if the representation of the session is corrupted in any way
:raises IncompatibleSessionError:
if session serialization format is not supported
:raises IncompatibleJobError:
if serialized jobs are not the same as current jobs
"""
json_repr = self.unpack_envelope(data)
return self._resume_json(json_repr, early_cb)
def _resume_json(self, json_repr, early_cb=None):
"""
Resume a SessionState object from the JSON representation.
This method is called by :meth:`resume()` after the initial envelope
and parsing is done. The only error conditions that can happen
are related to semantic incompatibilities or corrupted internal state.
"""
logger.debug(_("Resuming from json... (see below)"))
logger.debug(json.dumps(json_repr, indent=4))
_validate(json_repr, value_type=dict)
version = _validate(json_repr, key="version", choice=[1])
if version == 1:
helper = SessionResumeHelper1(
self.job_list, self.flags, self.location)
elif version == 2:
helper = SessionResumeHelper2(
self.job_list, self.flags, self.location)
elif version == 3:
helper = SessionResumeHelper3(
self.job_list, self.flags, self.location)
elif version == 4:
helper = SessionResumeHelper4(
self.job_list, self.flags, self.location)
elif version == 5:
helper = SessionResumeHelper5(
self.job_list, self.flags, self.location)
elif version == 6:
helper = SessionResumeHelper6(
self.job_list, self.flags, self.location)
else:
raise IncompatibleSessionError(
_("Unsupported version {}").format(version))
return helper.resume_json(json_repr, early_cb)
class ResumeDiscardQualifier(SimpleQualifier):
"""
Qualifier for jobs that need to be discarded after resume.
A job qualifier that designates jobs that should be removed
after doing a session resume.
"""
def __init__(self, retain_id_set):
"""
Initialize the qualifier.
:param retain_id_set:
The set of job identifiers that should be retained on resume.
"""
super().__init__(Origin.get_caller_origin())
self._retain_id_set = frozenset(retain_id_set)
def get_simple_match(self, job):
"""Check if a job should be listed by this qualifier."""
return job.id not in self._retain_id_set
class MetaDataHelper1MixIn:
"""Mix-in class for working with v1 meta-data."""
@classmethod
def _restore_SessionState_metadata(cls, metadata, session_repr):
"""
Reconstruct the session state meta-data.
Extract meta-data information from the representation of the session
and set it in the given session object
"""
# Get the representation of the meta-data
metadata_repr = _validate(
session_repr, key='metadata', value_type=dict)
# Set each bit back to the session
metadata.title = _validate(
metadata_repr, key='title', value_type=str, value_none=True)
metadata.flags = set([
_validate(
flag, value_type=str,
value_type_msg=_("Each flag must be a string"))
for flag in _validate(
metadata_repr, key='flags', value_type=list)])
metadata.running_job_name = _validate(
metadata_repr, key='running_job_name', value_type=str,
value_none=True)
class MetaDataHelper2MixIn(MetaDataHelper1MixIn):
"""Mix-in class for working with v2 meta-data."""
@classmethod
def _restore_SessionState_metadata(cls, metadata, session_repr):
"""
Reconstruct the session state meta-data.
Extract meta-data information from the representation of the session
and set it in the given session object
"""
super()._restore_SessionState_metadata(metadata, session_repr)
# Get the representation of the meta-data
metadata_repr = _validate(
session_repr, key='metadata', value_type=dict)
app_blob = _validate(
metadata_repr, key='app_blob', value_type=str,
value_none=True)
if app_blob is not None:
try:
app_blob = app_blob.encode("ASCII")
except UnicodeEncodeError:
# TRANSLATORS: please don't translate app_blob
raise CorruptedSessionError(_("app_blob is not ASCII"))
try:
app_blob = base64.standard_b64decode(app_blob)
except binascii.Error:
# TRANSLATORS: please don't translate app_blob
raise CorruptedSessionError(_("Cannot base64 decode app_blob"))
metadata.app_blob = app_blob
class MetaDataHelper3MixIn(MetaDataHelper2MixIn):
"""Mix-in class for working with v3 meta-data."""
@classmethod
def _restore_SessionState_metadata(cls, metadata, session_repr):
"""
Reconstruct the session state meta-data.
Extract meta-data information from the representation of the session
and set it in the given session object
"""
super()._restore_SessionState_metadata(metadata, session_repr)
# Get the representation of the meta-data
metadata_repr = _validate(
session_repr, key='metadata', value_type=dict)
metadata.app_id = _validate(
metadata_repr, key='app_id', value_type=str,
value_none=True)
class SessionPeekHelper1(MetaDataHelper1MixIn):
"""
Helper class for implementing session peek feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper1` which has
been pre-processed by :class:`SessionPeekHelper` (to strip the initial
envelope).
The only goal of this class is to reconstruct session state meta-data.
"""
def peek_json(self, json_repr):
"""
Resume a SessionState object from the JSON representation.
This method is called by :meth:`peek()` after the initial envelope and
parsing is done. The only error conditions that can happen are related
to semantic incompatibilities or corrupted internal state.
"""
_validate(json_repr, key="version", choice=[1])
session_repr = _validate(json_repr, key='session', value_type=dict)
metadata = SessionMetaData()
self._restore_SessionState_metadata(metadata, session_repr)
return metadata
def _build_SessionState(self, session_repr, early_cb=None):
"""
Reconstruct the session state object.
This method creates a fresh SessionState instance and restores
jobs, results, meta-data and desired job list using helper methods.
"""
logger.debug(_("Starting to restore metadata..."))
metadata = SessionMetaData()
self._peek_SessionState_metadata(metadata, session_repr)
return metadata
class SessionPeekHelper2(MetaDataHelper2MixIn, SessionPeekHelper1):
"""
Helper class for implementing session peek feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper1` which has
been pre-processed by :class:`SessionPeekHelper` (to strip the initial
envelope).
The only goal of this class is to reconstruct session state meta-data.
"""
class SessionPeekHelper3(MetaDataHelper3MixIn, SessionPeekHelper2):
"""
Helper class for implementing session peek feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper1` which has
been pre-processed by :class:`SessionPeekHelper` (to strip the initial
envelope).
The only goal of this class is to reconstruct session state meta-data.
"""
class SessionPeekHelper4(SessionPeekHelper3):
"""
Helper class for implementing session peek feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper1` which has
been pre-processed by :class:`SessionPeekHelper` (to strip the initial
envelope).
The only goal of this class is to reconstruct session state meta-data.
"""
class SessionPeekHelper5(SessionPeekHelper4):
"""
Helper class for implementing session peek feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper5` which has
been pre-processed by :class:`SessionPeekHelper` (to strip the initial
envelope).
The only goal of this class is to reconstruct session state meta-data.
"""
class SessionPeekHelper6(SessionPeekHelper5):
"""
Helper class for implementing session peek feature
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper6` which has
been pre-processed by :class:`SessionPeekHelper` (to strip the initial
envelope).
The only goal of this class is to reconstruct session state meta-data.
"""
class SessionResumeHelper1(MetaDataHelper1MixIn):
"""
Helper class for implementing session resume feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper1` which has
been pre-processed by :class:`SessionResumeHelper` (to strip the initial
envelope).
Due to the constraints of what can be represented in a suspended session,
this class cannot work in isolation. It must operate with a list of know
jobs.
Since (most of the) jobs are being provided externally (as they represent
the non-serialized parts of checkbox or other job providers) several
failure modes are possible. Those are documented in :meth:`resume()`
"""
# Flag controlling reference checks from within the session file to
# external files. If enabled such checks are performed and can cause
# additional exceptions to be raised. Currently this only affects the
# representation of the DiskJobResult instances.
FLAG_FILE_REFERENCE_CHECKS_S = 'file-reference-checks'
FLAG_FILE_REFERENCE_CHECKS_F = 0x01
# Flag controlling rewriting of log file pathnames. It depends on the
# location to be non-None and then rewrites pathnames of all them missing
# log files to be relative to the session storage location. It effectively
# depends on FLAG_FILE_REFERENCE_CHECKS_F being set at the same time,
# otherwise it is ignored.
FLAG_REWRITE_LOG_PATHNAMES_S = 'rewrite-log-pathnames'
FLAG_REWRITE_LOG_PATHNAMES_F = 0x02
# Flag controlling integrity checks between jobs present at resume time and
# jobs present at suspend time. Since providers cannot be serialized (nor
# should they) this integrity check prevents anyone from resuming a session
# if job definitions have changed. Using this flag effectively disables
# that check.
FLAG_IGNORE_JOB_CHECKSUMS_S = 'ignore-job-checksums'
FLAG_IGNORE_JOB_CHECKSUMS_F = 0x04
def __init__(
self, job_list: 'List[JobDefinition]',
flags: 'Optional[Iterable[str]]', location: 'Optional[str]'
):
"""
Initialize the helper with a list of known jobs and support data.
:param job_list:
List of known jobs
:param flags:
Any iterable object with string versions of resume support flags.
This can be None, if the application doesn't wish to enable any of
the feature flags.
:param location:
Location of the session directory. This is the same as
``session_dir`` in the corresponding suspend API. It is also the
same as ``storage.location`` (where ``storage`` is a
:class:`plainbox.impl.session.storage.SessionStorage` object.
See :meth:`SessionResumeHelper.__init__()` for description and meaning
of each flag.
"""
self.job_list = job_list
self.flags = 0
self.location = location
# Convert flag string constants into numeric flags
if flags is not None:
if self.FLAG_FILE_REFERENCE_CHECKS_S in flags:
self.flags |= self.FLAG_FILE_REFERENCE_CHECKS_F
if self.FLAG_REWRITE_LOG_PATHNAMES_S in flags:
self.flags |= self.FLAG_REWRITE_LOG_PATHNAMES_F
if self.FLAG_IGNORE_JOB_CHECKSUMS_S in flags:
self.flags |= self.FLAG_IGNORE_JOB_CHECKSUMS_F
def resume_json(self, json_repr, early_cb=None):
"""
Resume a SessionState object from the JSON representation.
This method is called by :meth:`resume()` after the initial envelope
and parsing is done. The only error conditions that can happen
are related to semantic incompatibilities or corrupted internal state.
"""
_validate(json_repr, key="version", choice=[1])
session_repr = _validate(json_repr, key='session', value_type=dict)
return self._build_SessionState(session_repr, early_cb)
def _build_SessionState(self, session_repr, early_cb=None):
"""
Reconstruct the session state object.
This method creates a fresh SessionState instance and restores
jobs, results, meta-data and desired job list using helper methods.
"""
# Construct a fresh session object.
session = SessionState(self.job_list)
logger.debug(_("Constructed new session for resume %r"), session)
# Give early_cb a chance to see the session before we start resuming.
# This way applications can see, among other things, generated jobs
# as they are added to the session, by registering appropriate signal
# handlers on the freshly-constructed session instance.
if early_cb is not None:
logger.debug(_("Invoking early callback %r"), early_cb)
new_session = early_cb(session)
if new_session is not None:
logger.debug(
_("Using different session for resume: %r"), new_session)
session = new_session
# Restore bits and pieces of state
logger.debug(
_("Starting to restore jobs and results to %r..."), session)
self._restore_SessionState_jobs_and_results(session, session_repr)
logger.debug(_("Starting to restore metadata..."))
self._restore_SessionState_metadata(session.metadata, session_repr)
logger.debug(_("restored metadata %r"), session.metadata)
logger.debug(_("Starting to restore desired job list..."))
self._restore_SessionState_desired_job_list(session, session_repr)
logger.debug(_("Starting to restore job list..."))
self._restore_SessionState_job_list(session, session_repr)
# Return whatever we've got
logger.debug(_("Resume complete!"))
return session
def _restore_SessionState_jobs_and_results(self, session, session_repr):
"""
Process representation of a session and restore jobs and results.
This method reconstructs all jobs and results in several stages.
The first pass just goes over all the jobs and results and restores
all of the non-generated jobs using :meth:`_process_job()` method.
Any jobs that cannot be processed (generated job) is saved for further
processing.
"""
# Representation of all of the job definitions
jobs_repr = _validate(session_repr, key='jobs', value_type=dict)
# Representation of all of the job results
results_repr = _validate(session_repr, key='results', value_type=dict)
# List of jobs (ids) that could not be processed on the first pass
leftover_jobs = deque()
# Run a first pass through jobs and results. Anything that didn't
# work (generated jobs) gets added to leftover_jobs list.
# To make this bit deterministic (we like determinism) we're always
# going to process job results in alphabetic orderer.
first_pass_list = sorted(
set(jobs_repr.keys()) | set(results_repr.keys()))
for job_id in first_pass_list:
try:
self._process_job(session, jobs_repr, results_repr, job_id)
except KeyError:
leftover_jobs.append(job_id)
# Process leftovers. For each iteration the leftover_jobs list should
# shrink or we're not making any progress. If that happens we've got
# undefined jobs (in general the session is corrupted)
while leftover_jobs:
# Append a sentinel object so that we can know when we're
# done "iterating" over the collection once.
# Also: https://twitter.com/zygoon/status/370213046678872065
leftover_jobs.append(None)
leftover_shrunk = False
while leftover_jobs: # pragma: no branch
job_id = leftover_jobs.popleft()
# Treat the sentinel None object as the end of the iteration
if job_id is None:
break
try:
self._process_job(
session, jobs_repr, results_repr, job_id)
except KeyError as exc:
logger.debug("Seen KeyError for %r", exc)
leftover_jobs.append(job_id)
else:
leftover_shrunk = True
# Check if we're making any progress.
# We don't want to keep spinning on a list of some bogus jobs
# that nothing generated so we need an end condition for that case
if not leftover_shrunk:
raise CorruptedSessionError(
_("Unknown jobs remaining: {}").format(
", ".join(leftover_jobs)))
def _process_job(self, session, jobs_repr, results_repr, job_id):
"""
Process all representation details associated with a particular job.
This method takes a session object, representation of all the jobs
and all the results (and a job id) and tries to reconstruct the
state associated with that job in the session object.
Jobs are verified to match existing (known) jobs. Results are
rebuilt from their representation and presented back to the session
for processing (this restores resources and generated jobs).
This method can fail in normal operation, when the job that was
being processed is a generated job and has not been reintroduced into
the session. When that happens a KeyError is raised.
.. note::
Since the representation format for results can support storing
and restoring a list of results (per job) but the SessionState
cannot yet do that the implementation of this method restores
the state of the _last_ result object only.
"""
_validate(job_id, value_type=str)
# Get the checksum from the representation
checksum = _validate(
jobs_repr, key=job_id, value_type=str)
# Look up the actual job definition in the session.
# This can raise KeyError but it is okay, callers expect that
job = session.job_state_map[job_id].job
# Check if job definition has not changed
if job.checksum != checksum:
if self.flags & self.FLAG_IGNORE_JOB_CHECKSUMS_F:
logger.warning(_("Ignoring changes to job %r)"), job_id)
else:
raise IncompatibleJobError(
_("Definition of job {!r} has changed").format(job_id))
# The result may not be there. This method is called for all the jobs
# we're supposed to check but not all such jobs need to have results
if job.id not in results_repr:
return
# Collect all of the result objects into result_list
result_list = []
result_list_repr = _validate(
results_repr, key=job_id, value_type=list, value_none=True)
for result_repr in result_list_repr:
_validate(result_repr, value_type=dict)
result = self._build_JobResult(
result_repr, self.flags, self.location)
result_list.append(result)
# Replay each result, one by one
for result in result_list:
logger.debug(_("calling update_job_result(%r, %r)"), job, result)
session.update_job_result(job, result)
@classmethod
def _restore_SessionState_desired_job_list(cls, session, session_repr):
"""
Reconstruct the list of desired jobs.
Extract the representation of desired_job_list from the session and
set it back to the session object. This method should be called after
all the jobs are discovered.
:raises CorruptedSessionError:
if desired_job_list refers to unknown job
"""
# List of all the _ids_ of the jobs that were selected
desired_job_list = [
_validate(
job_id, value_type=str,
value_type_msg=_("Each job id must be a string"))
for job_id in _validate(
session_repr, key='desired_job_list', value_type=list)]
# Restore job selection
logger.debug(
_("calling update_desired_job_list(%r)"), desired_job_list)
try:
session.update_desired_job_list([
session.job_state_map[job_id].job
for job_id in desired_job_list])
except KeyError as exc:
raise CorruptedSessionError(
_("'desired_job_list' refers to unknown job {!r}").format(
exc.args[0]))
@classmethod
def _restore_SessionState_mandatory_job_list(cls, session, session_repr):
"""
Extract the representation of mandatory_job_list from the session and
set it back to the session object. This method should be called after
all the jobs are discovered.
:raises CorruptedSessionError:
if mandatory_job_list refers to unknown job
"""
# List of all the _ids_ of the jobs that were selected
mandatory_job_list = [
_validate(
job_id, value_type=str,
value_type_msg=_("Each job id must be a string"))
for job_id in _validate(
session_repr, key='mandatory_job_list', value_type=list)]
# Restore job selection
logger.debug(
_("calling update_mandatory_job_list(%r)"), mandatory_job_list)
try:
session.update_mandatory_job_list([
session.job_state_map[job_id].job
for job_id in mandatory_job_list])
except KeyError as exc:
raise CorruptedSessionError(
_("'mandatory_job_list' refers to unknown job {!r}").format(
exc.args[0]))
@classmethod
def _restore_SessionState_job_list(cls, session, session_repr):
"""
Reconstruct the list of known jobs.
Trim job_list so that it has only those jobs that are mentioned by the
session representation. This should never fail as anything that might
go wrong must have gone wrong before.
"""
# Representation of all of the important job definitions
jobs_repr = _validate(session_repr, key='jobs', value_type=dict)
# Qualifier ready to select jobs to remove
qualifier = ResumeDiscardQualifier(
# This qualifier must select jobs that we want to KEEP:
# - All of the jobs that we need to run (aka, the desired jobs
# list). This is pretty obvious and it is exactly what must
# be preserved or trim_job_list() will complain
set([job.id for job in session.run_list])
# - All of the jobs that have representation (aka checksum).
# We want those jobs because they have results (or they would not
# end up in the list as of format v4). If they have results we
# just have to keep them. Perhaps the session had a different
# selection earlier, who knows.
| set(jobs_repr)
)
try:
# NOTE: this should never raise ValueError (which signals that we
# tried to remove a job which is in the run list) because it should
# only remove jobs that were not in the representation and any job
# in the run list must be in the representation already.
session.trim_job_list(qualifier)
except ValueError:
logger.error("BUG in session resume logic / assumptions")
raise
@classmethod
def _build_JobResult(cls, result_repr, flags, location):
"""
Reconstruct a single job result.
Convert the representation of MemoryJobResult or DiskJobResult
back into an actual instance.
"""
# Load all common attributes...
outcome = _validate(
result_repr, key='outcome', value_type=str,
value_choice=sorted(
OUTCOME_METADATA_MAP.keys(),
key=lambda outcome: outcome or "none"
), value_none=True)
comments = _validate(
result_repr, key='comments', value_type=str, value_none=True)
return_code = _validate(
result_repr, key='return_code', value_type=int, value_none=True)
execution_duration = _validate(
result_repr, key='execution_duration', value_type=float,
value_none=True)
# Construct either DiskJobResult or MemoryJobResult
if 'io_log_filename' in result_repr:
io_log_filename = cls._load_io_log_filename(
result_repr, flags, location)
if (flags & cls.FLAG_FILE_REFERENCE_CHECKS_F
and not os.path.isfile(io_log_filename)
and flags & cls.FLAG_REWRITE_LOG_PATHNAMES_F):
io_log_filename2 = cls._rewrite_pathname(io_log_filename,
location)
logger.warning(_("Rewrote file name from %r to %r"),
io_log_filename, io_log_filename2)
io_log_filename = io_log_filename2
if (flags & cls.FLAG_FILE_REFERENCE_CHECKS_F
and not os.path.isfile(io_log_filename)):
raise BrokenReferenceToExternalFile(
_("cannot access file: {!r}").format(io_log_filename))
return DiskJobResult({
'outcome': outcome,
'comments': comments,
'execution_duration': execution_duration,
'io_log_filename': io_log_filename,
'return_code': return_code
})
else:
io_log = [
cls._build_IOLogRecord(record_repr)
for record_repr in _validate(
result_repr, key='io_log', value_type=list)]
return MemoryJobResult({
'outcome': outcome,
'comments': comments,
'execution_duration': execution_duration,
'io_log': io_log,
'return_code': return_code
})
@classmethod
def _load_io_log_filename(cls, result_repr, flags, location):
return _validate(result_repr, key='io_log_filename', value_type=str)
@classmethod
def _rewrite_pathname(cls, pathname, location):
return re.sub(
'.*\/\.cache\/plainbox\/sessions/[^//]+', location, pathname)
@classmethod
def _build_IOLogRecord(cls, record_repr):
"""Convert the representation of IOLogRecord back the object."""
_validate(record_repr, value_type=list)
delay = _validate(record_repr, key=0, value_type=float)
if delay < 0:
# TRANSLATORS: please keep delay untranslated
raise CorruptedSessionError(_("delay cannot be negative"))
stream_name = _validate(
record_repr, key=1, value_type=str,
value_choice=['stdout', 'stderr'])
data = _validate(record_repr, key=2, value_type=str)
# Each data item is a base64 string created by encoding the bytes and
# converting them to ASCII. To get the original we need to undo that
# operation.
try:
data = data.encode("ASCII")
except UnicodeEncodeError:
raise CorruptedSessionError(
_("record data {!r} is not ASCII").format(data))
try:
data = base64.standard_b64decode(data)
except binascii.Error:
raise CorruptedSessionError(
_("record data {!r} is not correct base64").format(data))
return IOLogRecord(delay, stream_name, data)
class SessionResumeHelper2(MetaDataHelper2MixIn, SessionResumeHelper1):
"""
Helper class for implementing session resume feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper2` which has
been pre-processed by :class:`SessionResumeHelper` (to strip the initial
envelope).
Due to the constraints of what can be represented in a suspended session,
this class cannot work in isolation. It must operate with a list of know
jobs.
Since (most of the) jobs are being provided externally (as they represent
the non-serialized parts of checkbox or other job providers) several
failure modes are possible. Those are documented in :meth:`resume()`
"""
class SessionResumeHelper3(MetaDataHelper3MixIn, SessionResumeHelper2):
"""
Helper class for implementing session resume feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper3` which has
been pre-processed by :class:`SessionResumeHelper` (to strip the initial
envelope).
Due to the constraints of what can be represented in a suspended session,
this class cannot work in isolation. It must operate with a list of know
jobs.
Since (most of the) jobs are being provided externally (as they represent
the non-serialized parts of checkbox or other job providers) several
failure modes are possible. Those are documented in :meth:`resume()`
"""
class SessionResumeHelper4(SessionResumeHelper3):
"""
Helper class for implementing session resume feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper4` which has
been pre-processed by :class:`SessionResumeHelper` (to strip the initial
envelope).
Due to the constraints of what can be represented in a suspended session,
this class cannot work in isolation. It must operate with a list of know
jobs.
Since (most of the) jobs are being provided externally (as they represent
the non-serialized parts of checkbox or other job providers) several
failure modes are possible. Those are documented in :meth:`resume()`
"""
class SessionResumeHelper5(SessionResumeHelper4):
"""
Helper class for implementing session resume feature.
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper5` which has
been pre-processed by :class:`SessionResumeHelper` (to strip the initial
envelope).
Due to the constraints of what can be represented in a suspended session,
this class cannot work in isolation. It must operate with a list of know
jobs.
Since (most of the) jobs are being provided externally (as they represent
the non-serialized parts of checkbox or other job providers) several
failure modes are possible. Those are documented in :meth:`resume()`
"""
@classmethod
def _load_io_log_filename(cls, result_repr, flags, location):
io_log_filename = super()._load_io_log_filename(
result_repr, flags, location)
if os.path.isabs(io_log_filename):
return io_log_filename
if location is None:
raise ValueError("Location must be a directory name")
return os.path.join(location, io_log_filename)
class SessionResumeHelper6(SessionResumeHelper5):
"""
Helper class for implementing session resume feature
This class works with data constructed by
:class:`~plainbox.impl.session.suspend.SessionSuspendHelper5` which has
been pre-processed by :class:`SessionResumeHelper` (to strip the initial
envelope).
Due to the constraints of what can be represented in a suspended session,
this class cannot work in isolation. It must operate with a list of know
jobs.
Since (most of the) jobs are being provided externally (as they represent
the non-serialized parts of checkbox or other job providers) several
failure modes are possible. Those are documented in :meth:`resume()`
"""
def _build_SessionState(self, session_repr, early_cb=None):
"""
Reconstruct the session state object.
This method creates a fresh SessionState instance and restores
jobs, results, meta-data and desired job list using helper methods.
"""
# Construct a fresh session object.
session = SessionState(self.job_list)
logger.debug(_("Constructed new session for resume %r"), session)
# Give early_cb a chance to see the session before we start resuming.
# This way applications can see, among other things, generated jobs
# as they are added to the session, by registering appropriate signal
# handlers on the freshly-constructed session instance.
if early_cb is not None:
logger.debug(_("Invoking early callback %r"), early_cb)
new_session = early_cb(session)
if new_session is not None:
logger.debug(
_("Using different session for resume: %r"), new_session)
session = new_session
# Restore bits and pieces of state
logger.debug(
_("Starting to restore jobs and results to %r..."), session)
self._restore_SessionState_jobs_and_results(session, session_repr)
logger.debug(_("Starting to restore metadata..."))
self._restore_SessionState_metadata(session.metadata, session_repr)
logger.debug(_("restored metadata %r"), session.metadata)
logger.debug(_("Starting to restore mandatory job list..."))
self._restore_SessionState_mandatory_job_list(session, session_repr)
logger.debug(_("Starting to restore desired job list..."))
self._restore_SessionState_desired_job_list(session, session_repr)
logger.debug(_("Starting to restore job list..."))
self._restore_SessionState_job_list(session, session_repr)
# Return whatever we've got
logger.debug(_("Resume complete!"))
return session
def _validate(obj, **flags):
"""Multi-purpose extraction and validation function."""
# Fetch data from the container OR use json_repr directly
if 'key' in flags:
key = flags['key']
obj_name = _("key {!r}").format(key)
try:
value = obj[key]
except (TypeError, IndexError, KeyError):
error_msg = flags.get(
"missing_key_msg",
_("Missing value for key {!r}").format(key))
raise CorruptedSessionError(error_msg)
else:
value = obj
obj_name = _("object")
# Check if value can be None (defaulting to "no")
value_none = flags.get('value_none', False)
if value is None and value_none is False:
error_msg = flags.get(
"value_none_msg",
_("Value of {} cannot be None").format(obj_name))
raise CorruptedSessionError(error_msg)
# Check if value is of correct type
if value is not None and "value_type" in flags:
value_type = flags['value_type']
if not isinstance(value, value_type):
error_msg = flags.get(
"value_type_msg",
_("Value of {} is of incorrect type {}").format(
obj_name, type(value).__name__))
raise CorruptedSessionError(error_msg)
# Check if value is in the set of correct values
if "value_choice" in flags:
value_choice = flags['value_choice']
if value not in value_choice:
error_msg = flags.get(
"value_choice_msg",
_("Value for {} not in allowed set {!r}").format(
obj_name, value_choice))
raise CorruptedSessionError(error_msg)
return value
|