/usr/lib/python3/dist-packages/plainbox/impl/unit/job.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 | # This file is part of Checkbox.
#
# Copyright 2012-2014 Canonical Ltd.
# Written by:
# Zygmunt Krynicki <zygmunt.krynicki@canonical.com>
# Sylvain Pineau <sylvain.pineau@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.unit.job` -- job unit
=========================================
"""
import logging
import re
import os
from plainbox.abc import IJobDefinition
from plainbox.i18n import gettext as _
from plainbox.i18n import gettext_noop as N_
from plainbox.impl.resource import ResourceProgram
from plainbox.impl.resource import parse_imports_stmt
from plainbox.impl.secure.origin import JobOutputTextSource
from plainbox.impl.secure.origin import Origin
from plainbox.impl.symbol import SymbolDef
from plainbox.impl.unit._legacy import JobDefinitionLegacyAPI
from plainbox.impl.unit.unit_with_id import UnitWithId
from plainbox.impl.unit.validators import CorrectFieldValueValidator
from plainbox.impl.unit.validators import DeprecatedFieldValidator
from plainbox.impl.unit.validators import PresentFieldValidator
from plainbox.impl.unit.validators import ReferenceConstraint
from plainbox.impl.unit.validators import ShellProgramValidator
from plainbox.impl.unit.validators import TemplateInvariantFieldValidator
from plainbox.impl.unit.validators import TemplateVariantFieldValidator
from plainbox.impl.unit.validators import TranslatableFieldValidator
from plainbox.impl.unit.validators import UnitReferenceValidator
from plainbox.impl.unit.validators import UntranslatableFieldValidator
from plainbox.impl.unit.validators import UselessFieldValidator
from plainbox.impl.validation import Problem
from plainbox.impl.validation import Severity
from plainbox.impl.xparsers import Error
from plainbox.impl.xparsers import Text
from plainbox.impl.xparsers import Visitor
from plainbox.impl.xparsers import WordList
__all__ = ['JobDefinition', 'propertywithsymbols']
logger = logging.getLogger("plainbox.unit.job")
class propertywithsymbols(property):
"""
A property that also keeps a group of symbols around
"""
def __init__(self, fget=None, fset=None, fdel=None, doc=None,
symbols=None):
"""
Initializes the property with the specified values
"""
super(propertywithsymbols, self).__init__(fget, fset, fdel, doc)
self.__doc__ = doc
self.symbols = symbols
def __getattr__(self, attr):
"""
Internal implementation detail.
Exposes all of the attributes of the SymbolDef group as attributes of
the property. The way __getattr__() works it can never hide any
existing attributes so it is safe not to break the property.
"""
return getattr(self.symbols, attr)
def __call__(self, fget):
"""
Internal implementation detail.
Used to construct the decorator with fget defined to the decorated
function.
"""
return propertywithsymbols(
fget, self.fset, self.fdel, self.__doc__ or fget.__doc__,
symbols=self.symbols)
class _PluginValues(SymbolDef):
"""
Symbols for each value of the JobDefinition.plugin field
"""
attachment = 'attachment'
local = 'local'
resource = 'resource'
manual = 'manual'
user_verify = "user-verify"
user_interact = "user-interact"
user_interact_verify = "user-interact-verify"
shell = 'shell'
qml = 'qml'
class _CertificationStatusValues(SymbolDef):
"""
Symbols for each value of the JobDefinition.certification_status field
Particular values have the following meanings.
unspecified:
One of the new possible certification status values. This value means
that a job was not analyzed in the context of certification status
classification and it has no classification at this time. This is also
the implicit certification status for all jobs.
not-part-of-certification:
One of the new possible certification status values. This value means
that a given job may fail and this will not affect the certification
process in any way. Typically jobs with this certification status are
not executed during the certification process. In the past this was
informally referred to as a *blacklist item*.
non-blocker:
One of the new possible certification status values. This value means
that a given job may fail and while that should be regarded as a
possible future problem it will not block the certification process. In
the past this was informally referred to as a *graylist item*.
Canonical reserves the right to promote jobs from the *non-blocker* to
*blocker*.
blocker:
One of the new possible certification status values. This value means
that a given job must pass for the certification process to succeed. In
the past this was informally referred to as a *whitelist item*. The
term *blocker* was chosen to disambiguate the meaning of the two
concepts.
"""
unspecified = 'unspecified'
not_part_of_certification = 'not-part-of-certification'
non_blocker = 'non-blocker'
blocker = 'blocker'
class JobDefinition(UnitWithId, JobDefinitionLegacyAPI, IJobDefinition):
"""
Job definition class.
Thin wrapper around the RFC822 record that defines a checkbox job
definition
"""
def __init__(self, data, origin=None, provider=None, controller=None,
raw_data=None, parameters=None, field_offset_map=None):
"""
Initialize a new JobDefinition instance.
:param data:
Normalized data that makes up this job definition
:param origin:
An (optional) Origin object. If omitted a fake origin object is
created. Normally the origin object should be obtained from the
RFC822Record object.
:param provider:
An (optional) Provider1 object. If omitted it defaults to None but
the actual job definition is not suitable for execution. All job
definitions are expected to have a provider.
:param controller:
An (optional) session state controller. If omitted a checkbox
session state controller is implicitly used. The controller defines
how this job influences the session it executes in.
:param raw_data:
An (optional) raw version of data, without whitespace
normalization. If omitted then raw_data is assumed to be data.
:param parameters:
An (optional) dictionary of parameters. Parameters allow for unit
properties to be altered while maintaining a single definition.
This is required to obtain translated summary and description
fields, while having a single translated base text and any
variation in the available parameters.
:param field_offset_map:
An optional dictionary with offsets (in line numbers) of each
field. Line numbers are relative to the value of origin.line_start
.. note::
You should almost always use :meth:`from_rfc822_record()` instead.
"""
if origin is None:
origin = Origin.get_caller_origin()
super().__init__(data, raw_data=raw_data, origin=origin,
provider=provider, parameters=parameters,
field_offset_map=field_offset_map)
# NOTE: controllers cannot be customized for instantiated templates so
# I wonder if we should start hard-coding it in. Nothing seems to be
# using custom controller functionality anymore.
if controller is None:
# XXX: moved here because of cyclic imports
from plainbox.impl.ctrl import checkbox_session_state_ctrl
controller = checkbox_session_state_ctrl
self._resource_program = None
self._controller = controller
@classmethod
def instantiate_template(cls, data, raw_data, origin, provider,
parameters, field_offset_map):
"""
Instantiate this unit from a template.
The point of this method is to have a fixed API, regardless of what the
API of a particular unit class ``__init__`` method actually looks like.
It is easier to standardize on a new method that to patch all of the
initializers, code using them and tests to have an uniform initializer.
"""
# This assertion is a low-cost trick to ensure that we override this
# method in all of the subclasses to ensure that the initializer is
# called with correctly-ordered arguments.
assert cls is JobDefinition, \
"{}.instantiate_template() not customized".format(cls.__name__)
return cls(data, origin, provider, None, raw_data, parameters,
field_offset_map)
def __str__(self):
return self.summary
def __repr__(self):
return "<JobDefinition id:{!r} plugin:{!r}>".format(
self.id, self.plugin)
@property
def unit(self):
"""
the value of the unit field (overridden)
The return value is always 'job'
"""
return 'job'
@property
def partial_id(self):
"""
Identifier of this job, without the provider name
This field should not be used anymore, except for display
"""
return self.get_record_value('id', self.get_record_value('name'))
@propertywithsymbols(symbols=_PluginValues)
def plugin(self):
plugin = self.get_record_value('plugin')
if plugin is None and 'simple' in self.get_flag_set():
plugin = 'shell'
return plugin
@property
def summary(self):
return self.get_record_value('summary', self.partial_id)
@property
def description(self):
# since version 0.17 description field should be replaced with
# purpose/steps/verification fields. To keep backwards compability
# description will be generated by combining new ones if description
# field is missing
description = self.get_record_value('description')
if description is None:
# try combining purpose/steps/verification fields
description = ""
for stage in ['purpose', 'steps', 'verification']:
stage_value = self.get_record_value(stage)
if stage_value is not None:
description += stage.upper() + ':\n' + stage_value + '\n'
description = description.strip()
if not description:
# combining new description yielded empty string
description = None
return description
@property
def purpose(self):
return self.get_record_value('purpose')
@property
def steps(self):
return self.get_record_value('steps')
@property
def verification(self):
return self.get_record_value('verification')
@property
def requires(self):
return self.get_record_value('requires')
@property
def depends(self):
return self.get_record_value('depends')
@property
def after(self):
return self.get_record_value('after')
@property
def command(self):
return self.get_record_value('command')
@property
def environ(self):
return self.get_record_value('environ')
@property
def user(self):
return self.get_record_value('user')
@property
def flags(self):
return self.get_record_value('flags')
@property
def shell(self):
"""
Shell that is used to interpret the command
Defaults to 'bash' for checkbox compatibility.
"""
return self.get_record_value('shell', 'bash')
@property
def imports(self):
return self.get_record_value('imports')
@property
def category_id(self):
"""
fully qualified identifier of the category unit this job belongs to
.. note::
Jobs that don't have an explicit category association, also known
as the natural category, automatically get assigned to the special,
built-in 2013.com.canonical.plainbox::uncategorised category.
Note that to get the definition of that special category unit
applications need to include one of the special providers exposed
as :func:`plainbox.impl.providers.special:get_categories()`.
"""
return self.qualify_id(
self.get_record_value(
'category_id', '2013.com.canonical.plainbox::uncategorised'))
@property
def qml_file(self):
"""
path to a QML file that implements tests UI for this job
This property exposes a path to QML file that follows the Plainbox QML
Test Specification. The file will be loaded either in the native test
shell of the application using plainbox or with a helper, generic
loader for all command-line applications.
To use this property, the plugin type should be set to 'qml'.
"""
qml_file = self.get_record_value('qml_file')
if qml_file is not None and self.provider is not None:
return os.path.join(self.provider.data_dir, qml_file)
@propertywithsymbols(symbols=_CertificationStatusValues)
def certification_status(self):
"""
Get the natural certification status of this job.
The default certification status of all jobs is
``CertificationStatus.unspecified``
.. note::
Remember that the certification status can be overridden by a test
plan. You should, instead, consider the effective certification
status that can be obtained from :class:`JobState`.
"""
return self.get_record_value('certification-status', 'unspecified')
@property
def estimated_duration(self):
"""
estimated duration of this job in seconds.
The value may be None, which indicates that the duration is basically
unknown. Fractional numbers are allowed and indicate fractions of a
second.
"""
value = self.get_record_value('estimated_duration')
# NOTE: Some tests do that, I'd rather not change them now
if isinstance(value, (int, float)):
return value
elif value is None:
return None
match = re.match('^(\d+h)?[ :]*(\d+m)?[ :]*(\d+s)?$', value)
if match:
g_hours = match.group(1)
if g_hours:
assert g_hours.endswith('h')
hours = int(g_hours[:-1])
else:
hours = 0
g_minutes = match.group(2)
if g_minutes:
assert g_minutes.endswith('m')
minutes = int(g_minutes[:-1])
else:
minutes = 0
g_seconds = match.group(3)
if g_seconds:
assert g_seconds.endswith('s')
seconds = int(g_seconds[:-1])
else:
seconds = 0
return seconds + minutes * 60 + hours * 3600
else:
try:
return float(value)
except ValueError:
pass
@property
def controller(self):
"""
The controller object associated with this JobDefinition
"""
return self._controller
def tr_summary(self):
"""
Get the translated version of :meth:`summary`
"""
return self.get_translated_record_value('summary', self.partial_id)
def tr_description(self):
"""
Get the translated version of :meth:`description`
"""
tr_description = self.get_translated_record_value('description')
if tr_description is None:
# try combining purpose/steps/verification fields
tr_stages = {
'purpose': _('PURPOSE'),
'steps': _('STEPS'),
'verification': _('VERIFICATION')
}
tr_description = ""
for stage in ['purpose', 'steps', 'verification']:
stage_value = self.get_translated_record_value(stage)
if stage_value is not None:
tr_description += (tr_stages[stage] + ':\n' +
stage_value + '\n')
tr_description = tr_description.strip()
if not tr_description:
# combining new description yielded empty string
tr_description = None
return tr_description
def tr_purpose(self):
"""
Get the translated version of :meth:`purpose`
"""
return self.get_translated_record_value('purpose')
def tr_steps(self):
"""
Get the translated version of :meth:`steps`
"""
return self.get_translated_record_value('steps')
def tr_verification(self):
"""
Get the translated version of :meth:`verification`
"""
return self.get_translated_record_value('verification')
def get_environ_settings(self):
"""
Return a set of requested environment variables
"""
if self.environ is not None:
return {variable for variable in re.split('[\s,]+', self.environ)}
else:
return set()
def get_flag_set(self):
"""
Return a set of flags associated with this job
"""
if self.flags is not None:
return {flag for flag in re.split('[\s,]+', self.flags)}
else:
return set()
def get_imported_jobs(self):
"""
Parse the 'imports' line and compute the imported symbols.
Return generator for a sequence of pairs (job_id, identifier) that
describe the imported job identifiers from arbitrary namespace.
The syntax of each imports line is:
IMPORT_STMT :: "from" <NAMESPACE> "import" <PARTIAL_ID>
| "from" <NAMESPACE> "import" <PARTIAL_ID>
AS <IDENTIFIER>
"""
imports = self.imports or ""
return parse_imports_stmt(imports)
@property
def automated(self):
"""
Whether the job is fully automated and runs without any
intervention from the user
"""
return self.plugin in ['shell', 'resource',
'attachment', 'local']
@property
def startup_user_interaction_required(self):
"""
The job needs to be started explicitly by the test operator. This is
intended for things that may be timing-sensitive or may require the
tester to understand the necessary manipulations that he or she may
have to perform ahead of time.
The test operator may select to skip certain tests, in that case the
outcome is skip.
"""
return self.plugin in ['manual', 'user-interact',
'user-interact-verify']
def get_resource_program(self):
"""
Return a ResourceProgram based on the 'requires' expression.
The program instance is cached in the JobDefinition and is not
compiled or validated on subsequent calls.
:returns:
ResourceProgram if one is available or None
:raises ResourceProgramError:
If the program definition is incorrect
"""
if self.requires is not None and self._resource_program is None:
if self._provider is not None:
implicit_namespace = self._provider.namespace
else:
implicit_namespace = None
if self.imports is not None:
imports = list(self.get_imported_jobs())
else:
imports = None
self._resource_program = ResourceProgram(
self.requires, implicit_namespace, imports)
return self._resource_program
def get_direct_dependencies(self):
"""
Compute and return a set of direct dependencies
To combat a simple mistake where the jobs are space-delimited any
mixture of white-space (including newlines) and commas are allowed.
"""
deps = set()
if self.depends is None:
return deps
class V(Visitor):
def visit_Text_node(visitor, node: Text):
deps.add(self.qualify_id(node.text))
def visit_Error_node(visitor, node: Error):
logger.warning(_("unable to parse depends: %s"), node.msg)
V().visit(WordList.parse(self.depends))
return deps
def get_after_dependencies(self):
"""
Compute and return a set of after dependencies.
After dependencies express the desire that given job A runs after a
given job B. This is spelled out as::
id: A
after: B
id: B
To combat a simple mistake where the jobs are space-delimited any
mixture of white-space (including newlines) and commas are allowed.
"""
deps = set()
if self.after is None:
return deps
class V(Visitor):
def visit_Text_node(visitor, node: Text):
deps.add(self.qualify_id(node.text))
def visit_Error_node(visitor, node: Error):
logger.warning(_("unable to parse depends: %s"), node.msg)
V().visit(WordList.parse(self.after))
return deps
def get_resource_dependencies(self):
"""
Compute and return a set of resource dependencies
"""
program = self.get_resource_program()
if program:
return program.required_resources
else:
return set()
def get_category_id(self):
"""
Get the fully-qualified category id that this job belongs to
"""
maybe_partial_id = self.category_id
if maybe_partial_id is not None:
return self.qualify_id(maybe_partial_id)
@classmethod
def from_rfc822_record(cls, record, provider=None):
"""
Create a JobDefinition instance from rfc822 record. The resulting
instance may not be valid but will always be created. Only valid jobs
should be executed.
The record must be a RFC822Record instance.
"""
# Strip the trailing newlines form all the raw values coming from the
# RFC822 parser. We don't need them and they don't match gettext keys
# (xgettext strips out those newlines)
return cls(record.data, record.origin, provider=provider, raw_data={
key: value.rstrip('\n')
for key, value in record.raw_data.items()
}, field_offset_map=record.field_offset_map)
def create_child_job_from_record(self, record):
"""
Create a new JobDefinition from RFC822 record.
This method should only be used to create additional jobs from local
jobs (plugin local). This ensures that the child job shares the
embedded provider reference.
"""
if not isinstance(record.origin.source, JobOutputTextSource):
# TRANSLATORS: don't translate record.origin or JobOutputTextSource
raise ValueError(_("record.origin must be a JobOutputTextSource"))
if record.origin.source.job is not self:
# TRANSLATORS: don't translate record.origin.source.job
raise ValueError(_("record.origin.source.job must be this job"))
return self.from_rfc822_record(record, self.provider)
class Meta:
name = N_('job')
class fields(SymbolDef):
"""
Symbols for each field that a JobDefinition can have
"""
name = 'name'
summary = 'summary'
plugin = 'plugin'
command = 'command'
description = 'description'
user = 'user'
environ = 'environ'
estimated_duration = 'estimated_duration'
depends = 'depends'
after = 'after'
requires = 'requires'
shell = 'shell'
imports = 'imports'
flags = 'flags'
category_id = 'category_id'
purpose = 'purpose'
steps = 'steps'
verification = 'verification'
qml_file = 'qml_file'
certification_status = 'certification_status'
field_validators = {
fields.name: [
UntranslatableFieldValidator,
TemplateVariantFieldValidator,
DeprecatedFieldValidator(
_("use 'id' and 'summary' instead of 'name'")),
],
# NOTE: 'id' validators are "inherited" so we don't have it here
fields.summary: [
TranslatableFieldValidator,
TemplateVariantFieldValidator,
PresentFieldValidator(severity=Severity.advice),
# We want the summary to be a single line
CorrectFieldValueValidator(
lambda summary: summary.count("\n") == 0,
Problem.wrong, Severity.warning,
message=_("please use only one line"),
onlyif=lambda unit: unit.summary is not None),
# We want the summary to be relatively short
CorrectFieldValueValidator(
lambda summary: len(summary) <= 80,
Problem.wrong, Severity.warning,
message=_("please stay under 80 characters"),
onlyif=lambda unit: unit.summary is not None),
],
fields.plugin: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
PresentFieldValidator,
CorrectFieldValueValidator(
lambda plugin: (
plugin in JobDefinition.plugin.get_all_symbols()),
message=_('valid values are: {}').format(
', '.join(str(sym) for sym in sorted(
_PluginValues.get_all_symbols())))),
CorrectFieldValueValidator(
lambda plugin: plugin != 'local',
Problem.deprecated, Severity.advice,
message=_("please migrate to job templates, "
"see plainbox-template-unit(7) for details")),
CorrectFieldValueValidator(
lambda plugin: plugin != 'user-verify',
Problem.deprecated, Severity.advice,
message=_("please migrate to user-interact-verify")),
],
fields.command: [
UntranslatableFieldValidator,
# All jobs except for manual must have a command
PresentFieldValidator(
message=_("command is mandatory for non-manual jobs"),
onlyif=lambda unit: unit.plugin not in ('manual', 'qml')),
# Manual jobs cannot have a command
UselessFieldValidator(
message=_("command on a manual or qml job makes no sense"),
onlyif=lambda unit: unit.plugin in ('manual', 'qml')),
# We don't want to refer to CHECKBOX_SHARE anymore
CorrectFieldValueValidator(
lambda command: "CHECKBOX_SHARE" not in command,
Problem.deprecated, Severity.advice,
message=_("please use PLAINBOX_PROVIDER_DATA"
" instead of CHECKBOX_SHARE"),
onlyif=lambda unit: unit.command is not None),
# We don't want to refer to CHECKBOX_DATA anymore
CorrectFieldValueValidator(
lambda command: "CHECKBOX_DATA" not in command,
Problem.deprecated, Severity.advice,
message=_("please use PLAINBOX_SESSION_SHARE"
" instead of CHECKBOX_DATA"),
onlyif=lambda unit: unit.command is not None),
# We want to catch silly mistakes that shlex can detect
ShellProgramValidator,
],
fields.description: [
TranslatableFieldValidator,
TemplateVariantFieldValidator,
# Description is mandatory for manual jobs
PresentFieldValidator(
message=_("manual jobs must have a description field, or a"
" set of purpose, steps, and verification "
"fields"),
onlyif=lambda unit: unit.plugin == 'manual' and
unit.purpose is None and unit.steps is None and
unit.verification is None
),
# Description or a set of purpose, steps and verification
# fields is recommended for all other jobs
PresentFieldValidator(
severity=Severity.advice,
message=_("all jobs should have a description field, or a "
"set of purpose, steps and verification fields"),
onlyif=lambda unit: (
'simple' not in unit.get_flag_set() and
unit.plugin != 'manual' and (
unit.purpose is None and
unit.steps is None and
unit.verification is None))),
],
fields.purpose: [
TranslatableFieldValidator,
PresentFieldValidator(
severity=Severity.advice,
message=("please use purpose, steps, and verification"
" fields. See http://plainbox.readthedocs.org"
"/en/latest/author/faq.html#faq-2"),
onlyif=lambda unit:
unit.startup_user_interaction_required and
unit.get_record_value('summary') is None),
],
fields.steps: [
TranslatableFieldValidator,
PresentFieldValidator(
severity=Severity.advice,
message=("please use purpose, steps, and verification"
" fields. See http://plainbox.readthedocs.org"
"/en/latest/author/faq.html#faq-2"),
onlyif=lambda unit:
unit.startup_user_interaction_required),
],
fields.verification: [
TranslatableFieldValidator,
PresentFieldValidator(
severity=Severity.advice,
message=("please use purpose, steps, and verification"
" fields. See http://plainbox.readthedocs.org"
"/en/latest/author/faq.html#faq-2"),
onlyif=lambda unit: unit.plugin in (
'manual', 'user-verify', 'user-interact-verify')),
],
fields.user: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
# User should be either None or 'root'
CorrectFieldValueValidator(
message=_("user can only be 'root'"),
correct_fn=lambda user: user in (None, 'root')),
# User is useless without a command to run
UselessFieldValidator(
message=_("user without a command makes no sense"),
onlyif=lambda unit: unit.command is None)
],
fields.environ: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
# Environ is useless without a command to run
UselessFieldValidator(
message=_("environ without a command makes no sense"),
onlyif=lambda unit: unit.command is None),
],
fields.estimated_duration: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
PresentFieldValidator(
severity=Severity.advice,
onlyif=lambda unit: 'simple' not in unit.get_flag_set()
),
CorrectFieldValueValidator(
lambda duration: float(duration) > 0,
message="value must be a positive number",
onlyif=lambda unit: (
unit.get_record_value('estimated_duration'))),
],
fields.depends: [
UntranslatableFieldValidator,
CorrectFieldValueValidator(
lambda value, unit: (
unit.get_direct_dependencies() is not None)),
UnitReferenceValidator(
lambda unit: unit.get_direct_dependencies(),
constraints=[
ReferenceConstraint(
lambda referrer, referee: referee.unit == 'job',
message=_("the referenced unit is not a job"))])
# TODO: should not refer to deprecated jobs,
# onlyif job itself is not deprecated
],
fields.after: [
UntranslatableFieldValidator,
CorrectFieldValueValidator(
lambda value, unit: (
unit.get_after_dependencies() is not None)),
UnitReferenceValidator(
lambda unit: unit.get_after_dependencies(),
constraints=[
ReferenceConstraint(
lambda referrer, referee: referee.unit == 'job',
message=_("the referenced unit is not a job"))])
],
fields.requires: [
UntranslatableFieldValidator,
CorrectFieldValueValidator(
lambda value, unit: unit.get_resource_program(),
onlyif=lambda unit: unit.requires is not None),
UnitReferenceValidator(
lambda unit: unit.get_resource_dependencies(),
constraints=[
ReferenceConstraint(
lambda referrer, referee: referee.unit == 'job',
message=_("the referenced unit is not a job")),
ReferenceConstraint(
lambda referrer, referee: (
referee.plugin == 'resource'),
onlyif=lambda referrer, referee: (
referee.unit == 'job'),
message=_(
"the referenced job is not a resource job")),
]),
# TODO: should not refer to deprecated jobs,
# onlyif job itself is not deprecated
],
fields.shell: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
# Shell should be only '/bin/sh', or None (which gives bash)
CorrectFieldValueValidator(
lambda shell: shell in ('/bin/sh', '/bin/bash', 'bash'),
message=_("only /bin/sh and /bin/bash are allowed")),
],
fields.imports: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
CorrectFieldValueValidator(
lambda value, unit: (
list(unit.get_imported_jobs()) is not None)),
UnitReferenceValidator(
lambda unit: [
job_id
for job_id, identifier in unit.get_imported_jobs()],
constraints=[
ReferenceConstraint(
lambda referrer, referee: referee.unit == 'job',
message=_("the referenced unit is not a job"))]),
# TODO: should not refer to deprecated jobs,
# onlyif job itself is not deprecated
],
fields.category_id: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
UnitReferenceValidator(
lambda unit: (
[unit.get_category_id()] if unit.category_id else ()),
constraints=[
ReferenceConstraint(
lambda referrer, referee: (
referee.unit == 'category'),
message=_(
"the referenced unit is not a category"))]),
# TODO: should not refer to deprecated categories,
# onlyif job itself is not deprecated
],
fields.flags: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
CorrectFieldValueValidator(
lambda value, unit: (
'simple' in unit.get_flag_set() or
'preserve-locale' in unit.get_flag_set()),
Problem.expected_i18n, Severity.advice,
message=_(
'please ensure that the command supports'
' non-C locale then set the preserve-locale flag'
),
onlyif=lambda unit: unit.command),
CorrectFieldValueValidator(
lambda value, unit: (
not ('explicit-fail' in unit.get_flag_set() and
unit.plugin in {
'shell', 'user-interact', 'attachment',
'local', 'resource'})),
Problem.useless, Severity.advice,
message=_('explicit-fail makes no sense for job which '
'outcome is automatically determined.')
),
# The has-leftovers flag is useless without a command
CorrectFieldValueValidator(
lambda value, unit: (
'has-leftovers' not in unit.get_flag_set()),
Problem.useless, Severity.advice,
message=_(
'has-leftovers makes no sense without a command'
),
onlyif=lambda unit: unit.command is None),
],
fields.qml_file: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
PresentFieldValidator(
onlyif=lambda unit: unit.plugin == 'qml'),
CorrectFieldValueValidator(
lambda value: value.endswith('.qml'),
Problem.wrong, Severity.advice,
message=_('use the .qml extension for all QML files'),
onlyif=lambda unit: (unit.plugin == 'qml' and
unit.qml_file)),
CorrectFieldValueValidator(
lambda value, unit: os.path.isfile(unit.qml_file),
message=_('please point to an existing QML file'),
onlyif=lambda unit: (unit.plugin == 'qml' and
unit.qml_file)),
],
fields.certification_status: [
UntranslatableFieldValidator,
TemplateInvariantFieldValidator,
CorrectFieldValueValidator(
lambda certification_status: (
certification_status in
_CertificationStatusValues.get_all_symbols()),
message=_('valid values are: {}').format(
', '.join(str(sym) for sym in sorted(
_CertificationStatusValues.get_all_symbols())))),
],
}
|