/usr/lib/python3/dist-packages/plainbox/abc.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 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 | # 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/>.
"""
:mod:`plainbox.abc` -- abstract base classes
============================================
Those classes are actually implemented in the plainbox.impl package. This
module is here so that the essential API concepts are in a single spot and are
easier to understand (by not being mixed with additional source code).
.. note::
This module has API stability guarantees. We are not going to break or
introduce backwards incompatible interfaces here without following our API
deprecation policy. All existing features will be retained for at least
three releases. All deprecated symbols will warn when they will cease to be
available.
"""
from abc import ABCMeta, abstractproperty, abstractmethod
class ITextSource(metaclass=ABCMeta):
"""
An abstract source of text.
Concrete instances of this class are used by
:class:`plainbox.impl.rfc822.Origin` to keep track of where each entry of a
RFC822-like document came from.
"""
class IJobDefinition(metaclass=ABCMeta):
"""
Job definition that contains a mixture of meta-data and executable
information that can be consumed by the job runner to produce results.
"""
# XXX: All IO methods to save/load this would be in a helper class/function
# that would also handle format detection, serialization and validation.
@abstractproperty
def plugin(self):
"""
Name of the job interpreter.
Various interpreters are provided by the job runner.
"""
@abstractproperty
def name(self):
"""
Name of the job
"""
@abstractproperty
def summary(self):
"""
Short (one line) description of the job
"""
@abstractproperty
def id(self):
"""
Unique job identifier
The identifier is unique within the provider a job belongs to
"""
@abstractproperty
def requires(self):
"""
List of expressions that need to be true for this job to be available
This value can be None
"""
@abstractproperty
def command(self):
"""
The shell command to execute to perform the job.
The return code, standard output and standard error streams are
automatically recorded and processed, depending on the plugin type.
This value can be None
"""
@abstractproperty
def description(self):
"""
Human-readable description of the job.
This field is typically used to include execution and verification
steps for manual and human-assisted tests.
This value can be None
"""
@abstractproperty
def depends(self):
"""
Comma-delimited dependency expression
This field can be used to express job dependencies. If a job depends on
another job it can only start if the other job had ran and succeeded.
This is the original data as provided when constructed. Use
get_direct_dependencies() to obtain the parsed equivalent.
This value can be None
"""
class IJobResult(metaclass=ABCMeta):
"""
Class for representing results from a single job
"""
# XXX: We could also store stuff like job duration and other meta-data but
# I wanted to avoid polluting this proposal with mundane details
# The outcome of a job is a one-word classification how how it ran. There
# are several values that were not used in the original implementation but
# their existence helps to organize and implement plainbox. They are
# discussed below to make their intended meaning more detailed than is
# possible from the variable name alone.
#
# The None outcome - a job that basically did not run at all.
OUTCOME_NONE = None
# The pass and fail outcomes are the two most essential, and externally
# visible, job outcomes. They can be provided by either automated or manual
# "classifier" - a script or a person that clicks a "pass" or "fail"
# button.
OUTCOME_PASS = 'pass'
OUTCOME_FAIL = 'fail'
# The skip outcome is used when the operator selected a job but then
# skipped it. This is typically used for a manual job that is tedious or
# was selected by accident.
OUTCOME_SKIP = 'skip'
# The not supported outcome is used when a job was about to run but a
# dependency or resource requirement prevent it from running. XXX: perhaps
# this should be called "not available", not supported has the "unsupported
# code" feeling associated with it.
OUTCOME_NOT_SUPPORTED = 'not-supported'
# A temporary state that should be removed later on, used to indicate that
# job runner is not implemented but the job "ran" so to speak.
OUTCOME_NOT_IMPLEMENTED = 'not-implemented'
# A temporary state before the user decides on the outcome of a manual
# job or any other job that requires manual verification
OUTCOME_UNDECIDED = 'undecided'
# List of all valid values of OUTCOME_xxx
ALL_OUTCOME_LIST = [
OUTCOME_NONE,
OUTCOME_PASS,
OUTCOME_FAIL,
OUTCOME_SKIP,
OUTCOME_NOT_SUPPORTED,
OUTCOME_NOT_IMPLEMENTED,
OUTCOME_UNDECIDED,
]
@abstractproperty
def outcome(self):
"""
Outcome of the test.
The result of either automatic or manual verification. Depending on the
plugin (test type). Available values are defined as class properties
above.
"""
@abstractproperty
def comments(self):
"""
The comment that was added by the user, if any
"""
@abstractproperty
def io_log(self):
"""
A sequence of tuples (delay, stream-name, data) where delay is the
delay since the previous message seconds (typically a fractional
number), stream name is either 'stdout' or 'stderr' and data is the
bytes object that was obtained from that stream.
"""
# XXX: it could also encode 'stdin' if the user was presented with a
# console to type in and we sent that to the process.
# XXX: This interface is low-level but captures everything that has
# occurred and is text-safe. You can call an utility function to
# convert that to a text string that most closely represents what a
# user would see, having ran this command in the terminal.
@abstractproperty
def return_code(self):
"""
Command return code.
This is the return code of the process started to execute the command
from the job definition. It can also encode the signal that the
process was killed with, if any.
"""
@abstractmethod
def get_io_log(self):
"""
Compute and return the sequence of IOLogRecord objects.
:returns:
A sequence of tuples (delay, stream-name, data) where delay is the
delay since the previous message seconds (typically a fractional
number), stream name is either 'stdout' or 'stderr' and data is the
bytes object that was obtained from that stream.
"""
class IJobQualifier(metaclass=ABCMeta):
"""
An opaque qualifier for a job definition.
This is an abstraction for matching jobs definitions to names, patterns and
other means of selecting jobs.
There are two ways to use a qualifier object. The naive, direct, old API
can simply check if a qualifier designates a particular job (if it selects
it and marks for subsequent execution). This API works fine for certain
tasks but it was found that it is insufficient to implement so-called
whitelist ordering, where the order of jobs in a whitelist is preserved
when selecting that whitelist for execution. This spawned the second,
lower-level API, that gives portable visibility into composite qualifiers
(such as a whitelist) and distinct select, deselect vote so that full range
of current expressiveness can be preserved.
:attr VOTE_EXCLUDE:
(0) vote indicating that a job should *not* be included for
selection. It overwrites any other votes.
:attr VOTE_INCLUDE:
(1) vote indicating that a job should be included for selection. It is
overridden by VOTE_EXCLUDE.
:attr VOTE_IGNORE:
(2) vote indicating that a job should neither be included nor excluded
for selection. This is a neutral value overridden by all other votes.
"""
# NOTE: VOTE_xxx are sorted by priority, lowest being the most important
# one. When multiple votes are cast, the one with lowest value (highest
# priority) takes precedence. When adding additional votes keep this in
# mind.
VOTE_EXCLUDE = 0
VOTE_INCLUDE = 1
VOTE_IGNORE = 2
@abstractmethod
def get_vote(self, job):
"""
Get one of the :attr:`VOTE_IGNORE`, :attr:`VOTE_INCLUDE`,
:attr:`VOTE_EXCLUDE` votes that this qualifier associated with the
specified job.
:param job:
A IJobDefinition instance that is to be visited
:returns:
one of the ``VOTE_xxx`` constants
.. versionadded: 0.5
"""
@abstractmethod
def get_primitive_qualifiers(self):
"""
Return a list of primitives that constitute this qualifier.
:returns:
A list of IJobQualifier objects that each is the smallest,
indivisible entity.
When each vote cast by those qualifiers is applied sequentially to
a given job then the result is the same as the return value of the
:meth:`designates()` method. The resulting list has more structure
and this structure may matter to job ordering when a list of jobs
is matched against a list of qualifiers. The resulting sets are
identical but ordering of results is more accurately reflected by
iterating over the fine structure of each qualifier.
.. versionadded: 0.5
"""
@abstractproperty
def is_primitive(self):
"""
property indicating that a qualifier is not divisible by calling
:meth:`get_primitive_qualifiers()`.
If a qualifier is not primitive it can be replaced with a list of
qualifiers it produces by the call to the aforementioned method.
.. versionadded: 0.5
"""
@abstractmethod
def designates(self, job):
"""
Check if this qualifier designates the specified
:class:`plainbox.abc.IJobDefinition`
:returns True: if the qualifier designates the specified job
:returns False: otherwise
"""
class IJobRunner(metaclass=ABCMeta):
"""
Something that can run a job definition and produce results.
You can run many jobs with one runner, each time you'll get additional
result object. Typically you will need to connect the runner to a user
interface but headless mode is also possible.
"""
@abstractmethod
def run_job(self, job):
"""
Run the specified job.
Calling this method may block for arbitrary amount of time. User
interfaces should ensure that it runs in a separate thread.
The return value is a JobResult object that contains all the data that
was captured during the execution of the job. Some jobs may not return
a JobResult value.
"""
# XXX: threads suck, could we make this fully asynchronous? The only
# thing that we really want is to know when the command has stopped
# executing. We could expose the underlying process mechanics so that
# QT/GTK applications could tie that directly into their event loop.
class IUserInterfaceIO(metaclass=ABCMeta):
"""
Base class that allows job runner to interact with the user interface.
"""
@abstractmethod
def get_manual_verification_outcome(self):
"""
Get the outcome of the manual verification, as according to the user
May raise NotImplementedError if the user interface cannot provide this
answer.
"""
class IProviderBackend1(metaclass=ABCMeta):
"""
Provider for the current type of tests.
This class provides the APIs required by the internal implementation
that are not considered normal public APIs. The only consumer of the
those methods and properties are internal to plainbox.
"""
@abstractproperty
def CHECKBOX_SHARE(self):
"""
Return the required value of CHECKBOX_SHARE environment variable.
.. note::
This variable is only required by one script.
It would be nice to remove this later on.
"""
@abstractproperty
def extra_PYTHONPATH(self):
"""
Return additional entry for PYTHONPATH, if needed.
This entry is required for CheckBox scripts to import the correct
CheckBox python libraries.
.. note::
The result may be None
"""
@abstractproperty
def bin_dir(self):
"""
directory where all the executables needed by this provider reside
"""
@abstractproperty
def jobs_dir(self):
"""
Return an absolute path of the jobs directory
"""
@abstractproperty
def whitelists_dir(self):
"""
Return an absolute path of the whitelist directory
"""
@abstractproperty
def data_dir(self):
"""
absolute path of the data directory
"""
@abstractproperty
def base_dir(self):
"""
absolute path of the base directory with other directories.
May be None
"""
@abstractproperty
def secure(self):
"""
flag indicating that this provider was loaded from the secure portion
of PROVIDERPATH and thus can be used with the
plainbox-trusted-launcher-1.
"""
class IProvider1(metaclass=ABCMeta):
"""
Provider for the current type of tests
Also known as the 'checkbox-like' provider.
"""
@abstractproperty
def name(self):
"""
name of this provider
This name should be dbus-friendly. It should not be localizable.
"""
@abstractproperty
def namespace(self):
"""
namespace component of the provider name
This property defines the namespace in which all provider jobs are
defined in. Jobs within one namespace do not need to be fully qualified
by prefixing their partial identifier with provider namespace (so all
stays 'as-is'). Jobs that need to interact with other provider
namespaces need to use the fully qualified job identifier instead.
The identifier is defined as the part of the provider name, up to the
colon. This effectively gives organizations flat namespace within one
year-domain pair and allows to create private namespaces by using
sub-domains.
"""
@abstractproperty
def version(self):
"""
version of this provider
"""
@abstractproperty
def description(self):
"""
description of this provider
"""
@abstractproperty
def gettext_domain(self):
"""
the name of the gettext domain associated with this provider
This value may be empty, in such case provider data cannot be localized
for the user environment.
"""
@abstractproperty
def locale_dir(self):
"""
absolute path of the directory with locale data
The value is applicable as argument bindtextdomain()
"""
@abstractmethod
def get_builtin_jobs(self):
"""
Load and parse all of the job definitions of this provider.
:returns:
A sorted list of JobDefinition objects
:raises RFC822SyntaxError:
if any of the loaded files was not valid RFC822
:raises IOError, OSError:
if there were any problems accessing files or directories.
Note that OSError is silently ignored when the `jobs_dir`
directory is missing.
..note::
This method should not be used anymore. Consider transitioning your
code to :meth:`load_all_jobs()` which is more reliable.
"""
@abstractmethod
def load_all_jobs(self):
"""
Load and parse all of the job definitions of this provider.
Unlike :meth:`get_builtin_jobs()` this method does not stop after the
first problem encountered and instead collects all of the problems into
a list which is returned alongside the job list.
:returns:
Pair (job_list, problem_list) where each job_list is a sorted list
of JobDefinition objects and each item from problem_list is an
exception.
"""
@abstractmethod
def get_builtin_whitelists(self):
"""
Load all the built-in whitelists and return them
"""
def get_all_executables(self):
"""
Discover and return all executables offered by this provider
"""
class ISessionStateController(metaclass=ABCMeta):
"""
Interface for session state controller classes.
Session state controller classes cooperate with
:class:`~plainbox.impl.session.state.SessionState` and
:class:`~plainbox.impl.depmgr.DependencySolver` classes and implement
knowledge unique to particular job semantics. Before execution the
controller can influence job runnability (by setting inhibitors). After
execution the controller can observe the result and influence session state
"""
@abstractmethod
def get_dependency_set(self, job):
"""
Get the set of direct dependencies of a particular job.
:param job:
A IJobDefinition instance that is to be visited
:returns:
set of pairs (dep_type, job_name)
Returns a set of pairs (dep_type, job_name) that describe all
dependencies of the specified job. The first element in the pair,
dep_type, is either DEP_TYPE_DIRECT or DEP_TYPE_RESOURCE. The second
element is the name of the job.
"""
@abstractmethod
def get_inhibitor_list(self, session_state, job):
"""
Get a list of readiness inhibitors that inhibit a particular job.
:param session_state:
A SessionState instance that is used to interrogate the
state of the session where it matters for a particular
job. Currently this is used to access resources and job
results.
:param job:
A JobDefinition instance
:returns:
List of JobReadinessInhibitor
"""
@abstractmethod
def observe_result(self, session_state, job, result):
"""
Notice the specified test result and update readiness state.
:param session_state:
A SessionState object
:param job:
A JobDefinition object
:param result:
A IJobResult object
This function updates the internal result collection with the data from
the specified test result. Results can safely override older results.
Results also change the ready map (jobs that can run) because of
dependency relations.
"""
class IExecutionController(metaclass=ABCMeta):
"""
Interface for job execution controller clases.
Execution controllers encapsulate knowledge on how to run command
associated with a particular job. Some executors might run the command
directly, others might delegate the task to a helper program or perform
some special-cased customization to the execution environment.
"""
@abstractmethod
def execute_job(self, job, config, extcmd_popen):
"""
Execute the specified job using the specified subprocess-like object
:param job:
The JobDefinition to execute
:param config:
A PlainBoxConfig instance which can be used to load missing
environment definitions that apply to all jobs. It is used to
provide values for missing environment variables that are required
by the job (as expressed by the environ key in the job definition
file).
:param extcmd_popen:
A subprocess.Popen like object
:returns:
The return code of the command, as returned by subprocess.call()
"""
@abstractmethod
def get_score(self, job):
"""
Compute how applicable this controller is for the specified job.
:returns:
A numeric score, or None if the controller cannot run this job.
The higher the value, the more applicable this controller is.
"""
class IBuildSystem(metaclass=ABCMeta):
"""
A pluggable build system definition
PlainBox uses build systems to assist provider authors in
building additional executables from source code. To facilitate
support for a specific language or toolkit a build system may
detect it and offer proper commands without the test developer
having to copy/paste those commands from provider to provider.
PlainBox discovers providers from the ``plainbox.buildsystem``
entry point. Each entry point there must be a class implementing
this interface.
"""
@abstractmethod
def probe(self, src_dir: str) -> int:
"""
Look at the source directory and determine how applicable this build
system is.
:param src_dir:
absolute path of the directory with source code
:returns:
the suitability value, 0 if the build system doesn't support
sources of the particular kind, all values greater than zero
indicate some level of suitability. The largest return value wins.
The return value is a number. Values closer to zero mean that the build
system is not suitable, values closer to one mean the build system is
more suitable. Value of 0 mean that the build system is totally
unsuitable and will not be applied, even if no other choices are
available.
The idea is that multiple build systems may recognize a source
directory but since the system is extensible, other people may come up
with more suitable build system that spots additional files and returns
a score better than the average.
"""
@abstractmethod
def get_build_command(self, src_dir: str, build_dir: str) -> str:
"""
Get shell command to build the sources.
:param src_dir:
absolute path of the source directory
:param build_dir:
absolute path of the build directory
:returns:
shell command to execute
With the given source and build directory, come up with a piece of
shell that knows how to build stuff so that it ends up in the build
directory.
.. note::
The command will be executed in build_dir.
"""
class ISessionStateTransport(metaclass=ABCMeta):
"""
Interface for transports that send test data somewhere.
They handle just the transmission portion of data sending; exporters are
expected to produce data in the proper format (e.g. json, xml).
Each transport can have specific parameters that are required for the
other end to properly process received information (like system
identification, authorization data and so on), and that don't semantically
belong in the test data as produced by the exporter. Additionally
each transport needs to be told *where* to send test data. This is
transport-dependent; things like a HTTP endpoint, IP address, port
are good examples.
"""
@abstractmethod
def __init__(self, where, option_string):
"""
Initialize the transport object
:param where:
a string encoding the destination location
:param option_string:
a string of additonal configuration for the transport
:raises ValueError:
if any of the arguments are somehow invalid
"""
@abstractmethod
def send(self, data, config=None, session_state=None):
"""
Send data somewhere.
:param data:
a stream-like object of data to send (read only)
:param config:
a PlainBoxConfig object (optional)
:param session_state:
the session for which this transport is associated with
the data being sent (optional)
:raises ValueError:
if any of the arguments are somehow invalid
:raises TransportError:
if any transport-specific problem arises
:returns:
a dictionary with additional items, see notes below
.. note::
The return value is especially vague specifically to allow various
transports to express whatever they may need to express for a
particular vertical use case yet still to allow most of the code to
just work with all transports.
It is expected that certain keys in the returned dictionary will
gain special semantics that can be further standardized. As of this
writing there are no standard keys.
"""
|