kernel.git - Linux vanilla kernels for Fedora – https://fedoraproject.org/wiki/Kernel_Vanilla

diff options

Diffstat (limited to 'kernel.spec')

-rw-r--r--

223

1 files changed, 214 insertions, 9 deletions

# Copyright 2012 Hewlett-Packard Development Company, L.P. # Copyright 2012 Varnish Software AS # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. """ Builders define actions that the Jenkins job should execute. Examples include shell scripts or maven targets. The ``builders`` attribute in the :ref:`Job` definition accepts a list of builders to invoke. They may be components defined below, locally defined macros (using the top level definition of ``builder:``, or locally defined components found via the ``jenkins_jobs.builders`` entry point. **Component**: builders :Macro: builder :Entry Point: jenkins_jobs.builders Example:: job: name: test_job builders: - shell: "make test" """ import logging import xml.etree.ElementTree as XML from jenkins_jobs.errors import InvalidAttributeError from jenkins_jobs.errors import JenkinsJobsException from jenkins_jobs.errors import MissingAttributeError import jenkins_jobs.modules.base import jenkins_jobs.modules.helpers as helpers from jenkins_jobs.modules.helpers import append_git_revision_config import pkg_resources from jenkins_jobs.modules.helpers import cloudformation_init from jenkins_jobs.modules.helpers import cloudformation_region_dict from jenkins_jobs.modules.helpers import cloudformation_stack from jenkins_jobs.modules.helpers import config_file_provider_builder from jenkins_jobs.modules.helpers import config_file_provider_settings from jenkins_jobs.modules.helpers import convert_mapping_to_xml from jenkins_jobs.modules.helpers import copyartifact_build_selector from jenkins_jobs.modules import hudson_model from jenkins_jobs.modules.publishers import ssh logger = logging.getLogger(__name__) def shell(registry, xml_parent, data): """yaml: shell Execute a shell command. :arg str parameter: the shell command to execute Example: .. literalinclude:: /../../tests/builders/fixtures/shell.yaml :language: yaml """ shell = XML.SubElement(xml_parent, 'hudson.tasks.Shell') XML.SubElement(shell, 'command').text = data def python(registry, xml_parent, data): """yaml: python Execute a python command. Requires the Jenkins :jenkins-wiki:`Python plugin <Python+Plugin>`. :arg str parameter: the python command to execute Example: .. literalinclude:: /../../tests/builders/fixtures/python.yaml :language: yaml """ python = XML.SubElement(xml_parent, 'hudson.plugins.python.Python') XML.SubElement(python, 'command').text = data def copyartifact(registry, xml_parent, data): """yaml: copyartifact Copy artifact from another project. Requires the :jenkins-wiki:`Copy Artifact plugin <Copy+Artifact+Plugin>`. Please note using the multijob-build for which-build argument requires the :jenkins-wiki:`Multijob plugin <Multijob+Plugin>` :arg str project: Project to copy from :arg str filter: what files to copy :arg str target: Target base directory for copy, blank means use workspace :arg bool flatten: Flatten directories (default false) :arg bool optional: If the artifact is missing (for any reason) and optional is true, the build won't fail because of this builder (default false) :arg bool do-not-fingerprint: Disable automatic fingerprinting of copied artifacts (default false) :arg str which-build: which build to get artifacts from (optional, default last-successful) :which-build values: * **last-successful** * **last-completed** * **specific-build** * **last-saved** * **upstream-build** * **permalink** * **workspace-latest** * **build-param** * **downstream-build** * **multijob-build** :arg str build-number: specifies the build number to get when when specific-build is specified as which-build :arg str permalink: specifies the permalink to get when permalink is specified as which-build :permalink values: * **last** * **last-stable** * **last-successful** * **last-failed** * **last-unstable** * **last-unsuccessful** :arg bool stable: specifies to get only last stable build when last-successful is specified as which-build :arg bool fallback-to-last-successful: specifies to fallback to last successful build when upstream-build is specified as which-build :arg string param: specifies to use a build parameter to get the build when build-param is specified as which-build :arg str upstream-project-name: specifies the project name of downstream when downstream-build is specified as which-build :arg str upstream-build-number: specifies the number of the build to find its downstream build when downstream-build is specified as which-build :arg string parameter-filters: Filter matching jobs based on these parameters (optional) Example: .. literalinclude:: ../../tests/builders/fixtures/copy-artifact001.yaml :language: yaml Multijob Example: .. literalinclude:: ../../tests/builders/fixtures/copy-artifact004.yaml :language: yaml """ t = XML.SubElement(xml_parent, 'hudson.plugins.copyartifact.CopyArtifact') mappings = [ # Warning: this only works with copy artifact version 1.26+, # for copy artifact version 1.25- the 'projectName' element needs # to be used instead of 'project' ('project', 'project', None), ('filter', 'filter', ''), ('target', 'target', ''), ('flatten', 'flatten', False), ('optional', 'optional', False), ('do-not-fingerprint', 'doNotFingerprintArtifacts', False), ('parameter-filters', 'parameters', '') ] convert_mapping_to_xml(t, data, mappings, fail_required=True) copyartifact_build_selector(t, data) def change_assembly_version(registry, xml_parent, data): """yaml: change-assembly-version Change the assembly version. Requires the Jenkins :jenkins-wiki:`Change Assembly Version <Change+Assembly+Version>`. :arg str version: Set the new version number for replace (default 1.0.0) :arg str assemblyFile: The file name to search (default AssemblyInfo.cs) Minimal Example: .. literalinclude:: /../../tests/builders/fixtures/changeassemblyversion-minimal.yaml :language: yaml Full Example: .. literalinclude:: /../../tests/builders/fixtures/changeassemblyversion-full.yaml :language: yaml """ cav_builder_tag = ('org.jenkinsci.plugins.changeassemblyversion.' 'ChangeAssemblyVersion') cav = XML.SubElement(xml_parent, cav_builder_tag) mappings = [ ('version', 'task', '1.0.0'), ('assembly-file', 'assemblyFile', 'AssemblyInfo.cs'), ] convert_mapping_to_xml(cav, data, mappings, fail_required=True) def fingerprint(registry, xml_parent, data): """yaml: fingerprint Adds the ability to generate fingerprints as build steps instead of waiting for a build to complete. Requires the Jenkins :jenkins-wiki:`Fingerprint Plugin <Fingerprint+Plugin>`. :arg str targets: Files to fingerprint (default '') Full Example: .. literalinclude:: /../../tests/builders/fixtures/fingerprint-full.yaml :language: yaml Minimal Example: .. literalinclude:: /../../tests/builders/fixtures/fingerprint-minimal.yaml :language: yaml """ fingerprint = XML.SubElement( xml_parent, 'hudson.plugins.createfingerprint.CreateFingerprint') fingerprint.set('plugin', 'create-fingerprint') mapping = [('targets', 'targets', '')] convert_mapping_to_xml(fingerprint, data, mapping, fail_required=True) def ant(registry, xml_parent, data): """yaml: ant Execute an ant target. Requires the Jenkins :jenkins-wiki:`Ant Plugin <Ant+Plugin>`. To setup this builder you can either reference the list of targets or use named parameters. Below is a description of both forms: *1) Listing targets:* After the ant directive, simply pass as argument a space separated list of targets to build. :Parameter: space separated list of Ant targets Example to call two Ant targets: .. literalinclude:: ../../tests/builders/fixtures/ant001.yaml :language: yaml The build file would be whatever the Jenkins Ant Plugin is set to use per default (i.e build.xml in the workspace root). *2) Using named parameters:* :arg str targets: the space separated list of ANT targets. :arg str buildfile: the path to the ANT build file. :arg list properties: Passed to ant script using -Dkey=value (optional) :arg str ant-name: the name of the ant installation, (default 'default') (optional) :arg str java-opts: java options for ant, can have multiples, must be in quotes (optional) Example specifying the build file too and several targets: .. literalinclude:: ../../tests/builders/fixtures/ant002.yaml :language: yaml """ ant = XML.SubElement(xml_parent, 'hudson.tasks.Ant') if type(data) is str: # Support for short form: -ant: "target" data = {'targets': data} for setting, value in sorted(data.items()): if setting == 'targets': targets = XML.SubElement(ant, 'targets') targets.text = value if setting == 'buildfile': buildfile = XML.SubElement(ant, 'buildFile') buildfile.text = value if setting == 'properties': properties = data['properties'] prop_string = '' for prop, val in properties.items(): prop_string += "%s=%s\n" % (prop, val) prop_element = XML.SubElement(ant, 'properties') prop_element.text = prop_string if setting == 'java-opts': javaopts = data['java-opts'] jopt_string = ' '.join(javaopts) jopt_element = XML.SubElement(ant, 'antOpts') jopt_element.text = jopt_string XML.SubElement(ant, 'antName').text = data.get('ant-name', 'default') def trigger_remote(registry, xml_parent, data): """yaml: trigger-remote Trigger build of job on remote Jenkins instance. :jenkins-wiki:`Parameterized Remote Trigger Plugin <Parameterized+Remote+Trigger+Plugin>` Please note that this plugin requires system configuration on the Jenkins Master that is unavailable from individual job views; specifically, one must add remote jenkins servers whose 'Display Name' field are what make up valid fields on the `remote-jenkins-name` attribute below. :arg str remote-jenkins-name: the remote Jenkins server (required) :arg str job: the Jenkins project to trigger on the remote Jenkins server (required) :arg bool should-not-fail-build: if true, remote job failure will not lead current job to fail (default false) :arg bool prevent-remote-build-queue: if true, wait to trigger remote builds until no other builds (default false) :arg bool block: whether to wait for the trigger jobs to finish or not (default true) :arg str poll-interval: polling interval in seconds for checking statues of triggered remote job, only necessary if current job is configured to block (default 10) :arg str connection-retry-limit: number of connection attempts to remote Jenkins server before giving up. (default 5) :arg str predefined-parameters: predefined parameters to send to the remote job when triggering it (optional) :arg str property-file: file in workspace of current job containing additional parameters to be set on remote job (optional) Example: .. literalinclude:: /../../tests/builders/fixtures/trigger-remote/trigger-remote001.yaml :language: yaml """ triggerr = XML.SubElement(xml_parent, 'org.jenkinsci.plugins.' 'ParameterizedRemoteTrigger.' 'RemoteBuildConfiguration') XML.SubElement(triggerr, 'remoteJenkinsName').text = data.get('remote-jenkins-name') XML.SubElement(triggerr, 'token').text = data.get('token', '') for attribute in ['job', 'remote-jenkins-name']: if attribute not in data: raise MissingAttributeError(attribute, "builders.trigger-remote") if data[attribute] == '': raise InvalidAttributeError(attribute, data[attribute], "builders.trigger-remote") XML.SubElement(triggerr, 'job').text = data.get('job') XML.SubElement(triggerr, 'shouldNotFailBuild').text = str( data.get('should-not-fail-build', False)).lower() XML.SubElement(triggerr, 'pollInterval').text = str(data.get('poll-interval', 10)) XML.SubElement(triggerr, 'connectionRetryLimit').text = str( data.get('connection-retry-limit', 5)) XML.SubElement(triggerr, 'preventRemoteBuildQueue').text = str( data.get('prevent-remote-build-queue', False)).lower() XML.SubElement(triggerr, 'blockBuildUntilComplete').text = str( data.get('block', True)).lower() if 'predefined-parameters' in data: parameters = XML.SubElement(triggerr, 'parameters') parameters.text = data.get('predefined-parameters', '') params_list = parameters.text.split("\n") parameter_list = XML.SubElement(triggerr, 'parameterList') for param in params_list: if param == '': continue tmp = XML.SubElement(parameter_list, 'string') tmp.text = param if 'property-file' in data and data['property-file'] != '': XML.SubElement(triggerr, 'loadParamsFromFile').text = 'true' XML.SubElement(triggerr, 'parameterFile').text = data.get('property-file') else: XML.SubElement(triggerr, 'loadParamsFromFile').text = 'false' XML.SubElement(triggerr, 'overrideAuth').text = "false" def trigger_builds(registry, xml_parent, data): """yaml: trigger-builds Trigger builds of other jobs. Requires the Jenkins :jenkins-wiki:`Parameterized Trigger Plugin <Parameterized+Trigger+Plugin>`. :arg list project: the Jenkins project to trigger :arg str predefined-parameters: key/value pairs to be passed to the job (optional) :arg list bool-parameters: :Bool: * **name** (`str`) -- Parameter name * **value** (`bool`) -- Value to set (default false) :arg str property-file: Pass properties from file to the other job (optional) :arg bool property-file-fail-on-missing: Don't trigger if any files are missing (default true) :arg bool current-parameters: Whether to include the parameters passed to the current build to the triggered job. :arg str node-label-name: Define a name for the NodeLabel parameter to be set. Used in conjunction with node-label. Requires NodeLabel Parameter Plugin (optional) :arg str node-label: Label of the nodes where build should be triggered. Used in conjunction with node-label-name. Requires NodeLabel Parameter Plugin (optional) :arg str restrict-matrix-project: Filter that restricts the subset of the combinations that the triggered job will run (optional) :arg bool svn-revision: Whether to pass the svn revision to the triggered job (optional) :arg dict git-revision: Passes git revision to the triggered job (optional). * **combine-queued-commits** (bool): Whether to combine queued git hashes or not (default false) :arg bool block: whether to wait for the triggered jobs to finish or not (default false) :arg dict block-thresholds: Fail builds and/or mark as failed or unstable based on thresholds. Only apply if block parameter is true (optional) :block-thresholds: * **build-step-failure-threshold** (`str`) - build step failure threshold, valid values are 'never', 'SUCCESS', 'UNSTABLE', or 'FAILURE'. (default 'FAILURE') * **unstable-threshold** (`str`) - unstable threshold, valid values are 'never', 'SUCCESS', 'UNSTABLE', or 'FAILURE'. (default 'UNSTABLE') * **failure-threshold** (`str`) - overall failure threshold, valid values are 'never', 'SUCCESS', 'UNSTABLE', or 'FAILURE'. (default 'FAILURE') :arg bool same-node: Use the same node for the triggered builds that was used for this build (optional) :arg list parameter-factories: list of parameter factories :Factory: * **factory** (`str`) **filebuild** -- For every property file, invoke one build * **file-pattern** (`str`) -- File wildcard pattern * **no-files-found-action** (`str`) -- Action to perform when no files found. Valid values 'FAIL', 'SKIP', or 'NOPARMS'. (default 'SKIP') :Factory: * **factory** (`str`) **binaryfile** -- For every matching file, invoke one build * **file-pattern** (`str`) -- Artifact ID of the artifact * **no-files-found-action** (`str`) -- Action to perform when no files found. Valid values 'FAIL', 'SKIP', or 'NOPARMS'. (default 'SKIP') :Factory: * **factory** (`str`) **counterbuild** -- Invoke i=0...N builds * **from** (`int`) -- Artifact ID of the artifact * **to** (`int`) -- Version of the artifact * **step** (`int`) -- Classifier of the artifact * **parameters** (`str`) -- KEY=value pairs, one per line (default '') * **validation-fail** (`str`) -- Action to perform when stepping validation fails. Valid values 'FAIL', 'SKIP', or 'NOPARMS'. (default 'FAIL') :Factory: * **factory** (`str`) **allnodesforlabel** -- Trigger a build on all nodes having specific label. Requires NodeLabel Parameter Plugin (optional) * **name** (`str`) -- Name of the parameter to set (optional) * **node-label** (`str`) -- Label of the nodes where build should be triggered * **ignore-offline-nodes** (`bool`) -- Don't trigger build on offline nodes (default true) :Factory: * **factory** (`str`) **allonlinenodes** -- Trigger a build on every online node. Requires NodeLabel Parameter Plugin (optional) Examples: Basic usage with yaml list of projects. .. literalinclude:: /../../tests/builders/fixtures/trigger-builds/project-list.yaml :language: yaml Basic usage with passing svn revision through. .. literalinclude:: /../../tests/builders/fixtures/trigger-builds001.yaml :language: yaml Basic usage with passing git revision through. .. literalinclude:: /../../tests/builders/fixtures/trigger-builds006.yaml :language: yaml Example with all supported parameter factories. .. literalinclude:: /../../tests/builders/fixtures/trigger-builds-configfactory-multi.yaml :language: yaml """ tbuilder = XML.SubElement(xml_parent, 'hudson.plugins.parameterizedtrigger.' 'TriggerBuilder') configs = XML.SubElement(tbuilder, 'configs') for project_def in data: if 'project' not in project_def or project_def['project'] == '': logger.debug("No project specified - skipping trigger-build") continue tconfig = XML.SubElement(configs, 'hudson.plugins.parameterizedtrigger.' 'BlockableBuildTriggerConfig') tconfigs = XML.SubElement(tconfig, 'configs') if(project_def.get('current-parameters')): XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'CurrentBuildParameters') if(project_def.get('svn-revision')): XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'SubversionRevisionBuildParameters') if(project_def.get('git-revision')): append_git_revision_config(tconfigs, project_def['git-revision']) if(project_def.get('same-node')): XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'NodeParameters') if 'property-file' in project_def: params = XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'FileBuildParameters') propertiesFile = XML.SubElement(params, 'propertiesFile') propertiesFile.text = project_def['property-file'] failTriggerOnMissing = XML.SubElement(params, 'failTriggerOnMissing') failTriggerOnMissing.text = str(project_def.get( 'property-file-fail-on-missing', True)).lower() if 'predefined-parameters' in project_def: params = XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'PredefinedBuildParameters') properties = XML.SubElement(params, 'properties') properties.text = project_def['predefined-parameters'] if 'bool-parameters' in project_def: params = XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'BooleanParameters') configs = XML.SubElement(params, 'configs') for bool_param in project_def['bool-parameters']: param = XML.SubElement(configs, 'hudson.plugins.parameterizedtrigger.' 'BooleanParameterConfig') XML.SubElement(param, 'name').text = str(bool_param['name']) XML.SubElement(param, 'value').text = str( bool_param.get('value', False)).lower() if 'node-label-name' in project_def and 'node-label' in project_def: node = XML.SubElement(tconfigs, 'org.jvnet.jenkins.plugins.' 'nodelabelparameter.parameterizedtrigger.' 'NodeLabelBuildParameter') XML.SubElement(node, 'name').text = project_def['node-label-name'] XML.SubElement(node, 'nodeLabel').text = project_def['node-label'] if 'restrict-matrix-project' in project_def: params = XML.SubElement(tconfigs, 'hudson.plugins.parameterizedtrigger.' 'matrix.MatrixSubsetBuildParameters') XML.SubElement(params, 'filter').text = project_def[ 'restrict-matrix-project'] if(len(list(tconfigs)) == 0): tconfigs.set('class', 'java.util.Collections$EmptyList') if 'parameter-factories' in project_def: fconfigs = XML.SubElement(tconfig, 'configFactories') supported_factories = ['filebuild', 'binaryfile', 'counterbuild', 'allnodesforlabel', 'allonlinenodes'] supported_actions = ['SKIP', 'NOPARMS', 'FAIL'] for factory in project_def['parameter-factories']: if factory['factory'] not in supported_factories: raise InvalidAttributeError('factory', factory['factory'], supported_factories) if factory['factory'] == 'filebuild': params = XML.SubElement( fconfigs, 'hudson.plugins.parameterizedtrigger.' 'FileBuildParameterFactory') if factory['factory'] == 'binaryfile': params = XML.SubElement( fconfigs, 'hudson.plugins.parameterizedtrigger.' 'BinaryFileParameterFactory') parameterName = XML.SubElement(params, 'parameterName') parameterName.text = factory['parameter-name'] if (factory['factory'] == 'filebuild' or factory['factory'] == 'binaryfile'): filePattern = XML.SubElement(params, 'filePattern') filePattern.text = factory['file-pattern'] noFilesFoundAction = XML.SubElement( params, 'noFilesFoundAction') noFilesFoundActionValue = str(factory.get( 'no-files-found-action', 'SKIP')) if noFilesFoundActionValue not in supported_actions: raise InvalidAttributeError('no-files-found-action', noFilesFoundActionValue, supported_actions) noFilesFoundAction.text = noFilesFoundActionValue if factory['factory'] == 'counterbuild': params = XML.SubElement( fconfigs, 'hudson.plugins.parameterizedtrigger.' 'CounterBuildParameterFactory') fromProperty = XML.SubElement(params, 'from') fromProperty.text = str(factory['from']) toProperty = XML.SubElement(params, 'to') toProperty.text = str(factory['to']) stepProperty = XML.SubElement(params, 'step') stepProperty.text = str(factory['step']) paramExpr = XML.SubElement(params, 'paramExpr') paramExpr.text = str(factory.get( 'parameters', '')) validationFail = XML.SubElement(params, 'validationFail') validationFailValue = str(factory.get( 'validation-fail', 'FAIL')) if validationFailValue not in supported_actions: raise InvalidAttributeError('validation-fail', validationFailValue, supported_actions) validationFail.text = validationFailValue if factory['factory'] == 'allnodesforlabel': params = XML.SubElement( fconfigs, 'org.jvnet.jenkins.plugins.nodelabelparameter.' 'parameterizedtrigger.' 'AllNodesForLabelBuildParameterFactory') nameProperty = XML.SubElement(params, 'name') nameProperty.text = str(factory.get( 'name', '')) nodeLabel = XML.SubElement(params, 'nodeLabel') nodeLabel.text = str(factory['node-label']) ignoreOfflineNodes = XML.SubElement( params, 'ignoreOfflineNodes') ignoreOfflineNodes.text = str(factory.get( 'ignore-offline-nodes', True)).lower() if factory['factory'] == 'allonlinenodes': params = XML.SubElement( fconfigs, 'org.jvnet.jenkins.plugins.nodelabelparameter.' 'parameterizedtrigger.' 'AllNodesBuildParameterFactory') projects = XML.SubElement(tconfig, 'projects') if isinstance(project_def['project'], list): projects.text = ",".join(project_def['project']) else: projects.text = project_def['project'] condition = XML.SubElement(tconfig, 'condition') condition.text = 'ALWAYS' trigger_with_no_params = XML.SubElement(tconfig, 'triggerWithNoParameters') trigger_with_no_params.text = 'false' build_all_nodes_with_label = XML.SubElement(tconfig, 'buildAllNodesWithLabel') build_all_nodes_with_label.text = 'false' block = project_def.get('block', False) if block: block = XML.SubElement(tconfig, 'block') supported_thresholds = [['build-step-failure-threshold', 'buildStepFailureThreshold', 'FAILURE'], ['unstable-threshold', 'unstableThreshold', 'UNSTABLE'], ['failure-threshold', 'failureThreshold', 'FAILURE']] supported_threshold_values = ['never', hudson_model.SUCCESS['name'], hudson_model.UNSTABLE['name'], hudson_model.FAILURE['name']] thrsh = project_def.get('block-thresholds', False) for toptname, txmltag, tvalue in supported_thresholds: if thrsh: tvalue = thrsh.get(toptname, tvalue) if tvalue.lower() == supported_threshold_values[0]: continue if tvalue.upper() not in supported_threshold_values: raise InvalidAttributeError(toptname, tvalue, supported_threshold_values) th = XML.SubElement(block, txmltag) XML.SubElement(th, 'name').text = hudson_model.THRESHOLDS[ tvalue.upper()]['name'] XML.SubElement(th, 'ordinal').text = hudson_model.THRESHOLDS[ tvalue.upper()]['ordinal'] XML.SubElement(th, 'color').text = hudson_model.THRESHOLDS[ tvalue.upper()]['color'] XML.SubElement(th, 'completeBuild').text = "true" # If configs is empty, remove the entire tbuilder tree. if(len(configs) == 0): logger.debug("Pruning empty TriggerBuilder tree.") xml_parent.remove(tbuilder) def builders_from(registry, xml_parent, data): """yaml: builders-from Use builders from another project. Requires the Jenkins :jenkins-wiki:`Template Project Plugin <Template+Project+Plugin>`. :arg str projectName: the name of the other project Example: .. literalinclude:: ../../tests/builders/fixtures/builders-from.yaml :language: yaml """ pbs = XML.SubElement(xml_parent, 'hudson.plugins.templateproject.ProxyBuilder') XML.SubElement(pbs, 'projectName').text = data def http_request(registry, xml_parent, data): """yaml: http-request This plugin sends a http request to an url with some parameters. Requires the Jenkins :jenkins-wiki:`HTTP Request Plugin <HTTP+Request+Plugin>`. :arg str url: Specify an URL to be requested (required) :arg str mode: The http mode of the request (default GET) :mode values: * **GET** * **POST** * **PUT** * **DELETE** * **HEAD** :arg str content-type: Add 'Content-type: foo' HTTP request headers where foo is the http content-type the request is using. (default NOT_SET) :arg str accept-type: Add 'Accept: foo' HTTP request headers where foo is the http content-type to accept (default NOT_SET) :content-type and accept-type values: * **NOT_SET** * **TEXT_HTML** * **APPLICATION_JSON** * **APPLICATION_TAR** * **APPLICATION_ZIP** * **APPLICATION_OCTETSTREAM** :arg str output-file: Name of the file in which to write response data (default '') :arg int time-out: Specify a timeout value in seconds (default 0) :arg bool console-log: This allows you to turn off writing the response body to the log (default false) :arg bool pass-build: Should build parameters be passed to the URL being called (default false) :arg str valid-response-codes: Configure response code to mark an execution as success. You can configure simple code such as "200" or multiple codes separeted by comma(',') e.g. "200,404,500" Interval of codes should be in format From:To e.g. "100:399". The default (as if empty) is to fail to 4xx and 5xx. That means success from 100 to 399 "100:399" To ignore any response code use "100:599". (default '') :arg str valid-response-content: If set response must contain this string to mark an execution as success (default '') :arg str authentication-key: Authentication that will be used before this request. Authentications are created in global configuration under a key name that is selected here. :arg list custom-headers: list of header parameters :custom-header: * **name** (`str`) -- Name of the header * **value** (`str`) -- Value of the header Example: .. literalinclude:: ../../tests/builders/fixtures/http-request-minimal.yaml :language: yaml .. literalinclude:: ../../tests/builders/fixtures/http-request-complete.yaml :language: yaml """ http_request = XML.SubElement(xml_parent, 'jenkins.plugins.http__request.HttpRequest') http_request.set('plugin', 'http_request') valid_modes = ['GET', 'POST', 'PUT', 'DELETE', 'HEAD'] valid_types = ['NOT_SET', 'TEXT_HTML', 'APPLICATION_JSON', 'APPLICATION_TAR', 'APPLICATION_ZIP', 'APPLICATION_OCTETSTREAM'] mappings = [ ('url', 'url', None), ('mode', 'httpMode', 'GET', valid_modes), ('content-type', 'contentType', 'NOT_SET', valid_types), ('accept-type', 'acceptType', 'NOT_SET', valid_types), ('output-file', 'outputFile', ''), ('console-log', 'consoleLogResponseBody', False), ('pass-build', 'passBuildParameters', False), ('time-out', 'timeout', 0), ('valid-response-codes', 'validResponseCodes', ''), ('valid-response-content', 'validResponseContent', '')] convert_mapping_to_xml(http_request, data, mappings, fail_required=True) if 'authentication-key' in data: XML.SubElement( http_request, 'authentication').text = data['authentication-key'] if 'custom-headers' in data: customHeader = XML.SubElement(http_request, 'customHeaders') header_mappings = [ ('name', 'name', None), ('value', 'value', None) ] for customhead in data['custom-headers']: pair = XML.SubElement(customHeader, 'pair') convert_mapping_to_xml(pair, customhead, header_mappings, fail_required=True) def inject(registry, xml_parent, data): """yaml: inject Inject an environment for the job. Requires the Jenkins :jenkins-wiki:`EnvInject Plugin <EnvInject+Plugin>`. :arg str properties-file: the name of the property file (optional) :arg str properties-content: the properties content (optional) :arg str script-file: the name of a script file to run (optional) :arg str script-content: the script content (optional) Example: .. literalinclude:: ../../tests/builders/fixtures/inject.yaml :language: yaml """ eib = XML.SubElement(xml_parent, 'EnvInjectBuilder') info = XML.SubElement(eib, 'info') jenkins_jobs.modules.base.add_nonblank_xml_subelement( info, 'propertiesFilePath', data.get('properties-file')) jenkins_jobs.modules.base.add_nonblank_xml_subelement( info, 'propertiesContent', data.get('properties-content')) jenkins_jobs.modules.base.add_nonblank_xml_subelement( info, 'scriptFilePath', data.get('script-file')) jenkins_jobs.modules.base.add_nonblank_xml_subelement( info, 'scriptContent', data.get('script-content')) def kmap(registry, xml_parent, data): """yaml: kmap Publish mobile applications to your Keivox KMAP Private Mobile App Store. Requires the Jenkins :jenkins-wiki:`Keivox KMAP Private Mobile App Store Plugin <Keivox+KMAP+Private+Mobile+App+Store+Plugin>`. :arg str username: KMAP's user email with permissions to upload/publish applications to KMAP (required) :arg str password: Password for the KMAP user uploading/publishing applications (required) :arg str url: KMAP's url. This url must always end with "/kmap-client/". For example: http://testing.keivox.com/kmap-client/ (required) :arg str categories: Categories' names. If you want to add the application to more than one category, write the categories between commas. (required) :arg str file-path: Path to the application's file (required) :arg str app-name: KMAP's application name (required) :arg str bundle: Bundle indentifier (default '') :arg str version: Application's version (required) :arg str description: Application's description (default '') :arg str icon-path: Path to the application's icon (default '') :arg bool publish-optional: Publish application after it has been uploaded to KMAP (default false) :publish-optional: * **groups** ('str') -- groups' names to publish the application (default '') * **users** ('str') -- users' names to publish the application (default '') * **notify-users** ('bool') -- Send notifications to the users and groups when publishing the application (default false) Minimal Example: .. literalinclude:: ../../tests/builders/fixtures/kmap-minimal.yaml :language: yaml Full Example: .. literalinclude:: ../../tests/builders/fixtures/kmap-full.yaml :language: yaml """ kmap = XML.SubElement( xml_parent, 'org.jenkinsci.plugins.KmapJenkinsBuilder') kmap.set('plugin', 'kmap-jenkins') publish = data.get('publish-optional', False) mapping = [ ('username', 'username', None), ('password', 'password', None), ('url', 'kmapClient', None), ('categories', 'categories', None), ('file-path', 'filePath', None), ('app-name', 'appName', None), ('bundle', 'bundle', ''), ('version', 'version', None), ('description', 'description', ''), ('icon-path', 'iconPath', ''), ] convert_mapping_to_xml(kmap, data, mapping, fail_required=True) if publish is True: publish_optional = XML.SubElement(kmap, 'publishOptional') publish_mapping = [ ('groups', 'teams', ''), ('users', 'users', ''), ('notify-users', 'sendNotifications', False), ] convert_mapping_to_xml( publish_optional, data, publish_mapping, fail_required=True) def artifact_resolver(registry, xml_parent, data): """yaml: artifact-resolver Allows one to resolve artifacts from a maven repository like nexus (without having maven installed) Requires the Jenkins :jenkins-wiki:`Repository Connector Plugin <Repository+Connector+Plugin>`. :arg bool fail-on-error: Whether to fail the build on error (default false) :arg bool repository-logging: Enable repository logging (default false) :arg str target-directory: Where to resolve artifacts to :arg list artifacts: list of artifacts to resolve :Artifact: * **group-id** (`str`) -- Group ID of the artifact * **artifact-id** (`str`) -- Artifact ID of the artifact * **version** (`str`) -- Version of the artifact * **classifier** (`str`) -- Classifier of the artifact (default '') * **extension** (`str`) -- Extension of the artifact (default 'jar') * **target-file-name** (`str`) -- What to name the artifact (default '') Example: .. literalinclude:: ../../tests/builders/fixtures/artifact-resolver.yaml :language: yaml """ ar = XML.SubElement(xml_parent, 'org.jvnet.hudson.plugins.repositoryconnector.' 'ArtifactResolver') XML.SubElement(ar, 'targetDirectory').text = data['target-directory'] artifacttop = XML.SubElement(ar, 'artifacts') artifacts = data['artifacts'] for artifact in artifacts: rcartifact = XML.SubElement(artifacttop, 'org.jvnet.hudson.plugins.' 'repositoryconnector.Artifact') XML.SubElement(rcartifact, 'groupId').text = artifact['group-id'] XML.SubElement(rcartifact, 'artifactId').text = artifact['artifact-id'] XML.SubElement(rcartifact, 'classifier').text = artifact.get( 'classifier', '') XML.SubElement(rcartifact, 'version').text = artifact['version'] XML.SubElement(rcartifact, 'extension').text = artifact.get( 'extension', 'jar') XML.SubElement(rcartifact, 'targetFileName').text = artifact.get( 'target-file-name', '') XML.SubElement(ar, 'failOnError').text = str(data.get( 'fail-on-error', False)).lower() XML.SubElement(ar, 'enableRepoLogging').text = str(data.get( 'repository-logging', False)).lower() XML.SubElement(ar, 'snapshotUpdatePolicy').text = 'never' XML.SubElement(ar, 'releaseUpdatePolicy').text = 'never' XML.SubElement(ar, 'snapshotChecksumPolicy').text = 'warn' XML.SubElement(ar, 'releaseChecksumPolicy').text = 'warn' def doxygen(registry, xml_parent, data): """yaml: doxygen Builds doxygen HTML documentation. Requires the Jenkins :jenkins-wiki:`Doxygen plugin <Doxygen+Plugin>`. :arg str doxyfile: The doxyfile path (required) :arg str install: The doxygen installation to use (required) :arg bool ignore-failure: Keep executing build even on doxygen generation failure (default false) :arg bool unstable-warning: Mark the build as unstable if warnings are generated (default false) Example: .. literalinclude:: /../../tests/builders/fixtures/doxygen001.yaml :language: yaml """ doxygen = XML.SubElement(xml_parent, 'hudson.plugins.doxygen.DoxygenBuilder') mappings = [ ('doxyfile', 'doxyfilePath', None), ('install', 'installationName', None), ('ignore-failure', 'continueOnBuildFailure', False), ('unstable-warning', 'unstableIfWarnings', False) ] convert_mapping_to_xml(doxygen, data, mappings, fail_required=True) def gradle(registry, xml_parent, data): """yaml: gradle Execute gradle tasks. Requires the Jenkins :jenkins-wiki:`Gradle Plugin <Gradle+Plugin>`. :arg str tasks: List of tasks to execute :arg str gradle-name: Use a custom gradle name (default '') :arg bool wrapper: use gradle wrapper (default false) :arg bool executable: make gradlew executable (default false) :arg list switches: Switches for gradle, can have multiples :arg bool use-root-dir: Whether to run the gradle script from the top level directory or from a different location (default false) :arg str root-build-script-dir: If your workspace has the top-level build.gradle in somewhere other than the module root directory, specify the path (relative to the module root) here, such as ${workspace}/parent/ instead of just ${workspace}. :arg str build-file: name of gradle build script (default 'build.gradle') Example: .. literalinclude:: ../../tests/builders/fixtures/gradle.yaml :language: yaml """ gradle = XML.SubElement(xml_parent, 'hudson.plugins.gradle.Gradle') XML.SubElement(gradle, 'description').text = '' mappings = [ ('build-file', 'buildFile', 'build.gradle'), ('tasks', 'tasks', None), ('root-build-script-dir', 'rootBuildScriptDir', ''), ('gradle-name', 'gradleName', ''), ('wrapper', 'useWrapper', False), ('executable', 'makeExecutable', False), ('use-root-dir', 'fromRootBuildScriptDir', False), ] convert_mapping_to_xml(gradle, data, mappings, fail_required=True) XML.SubElement(gradle, 'switches').text = '\n'.join( data.get('switches', [])) def _groovy_common_scriptSource(data): """Helper function to generate the XML element common to groovy builders """ scriptSource = XML.Element("scriptSource") if 'command' in data and 'file' in data: raise JenkinsJobsException("Use just one of 'command' or 'file'") if 'command' in data: command = XML.SubElement(scriptSource, 'command') command.text = str(data['command']) scriptSource.set('class', 'hudson.plugins.groovy.StringScriptSource') elif 'file' in data: scriptFile = XML.SubElement(scriptSource, 'scriptFile') scriptFile.text = str(data['file']) scriptSource.set('class', 'hudson.plugins.groovy.FileScriptSource') else: raise JenkinsJobsException("A groovy command or file is required") return scriptSource def groovy(registry, xml_parent, data): """yaml: groovy Execute a groovy script or command. Requires the Jenkins :jenkins-wiki:`Groovy Plugin <Groovy+plugin>`. :arg str file: Groovy file to run. (Alternative: you can chose a command instead) :arg str command: Groovy command to run. (Alternative: you can chose a script file instead) :arg str version: Groovy version to use. (default '(Default)') :arg str parameters: Parameters for the Groovy executable. (default '') :arg str script-parameters: These parameters will be passed to the script. (default '') :arg str properties: Instead of passing properties using the -D parameter you can define them here. (default '') :arg str java-opts: Direct access to JAVA_OPTS. Properties allows only -D properties, while sometimes also other properties like -XX need to be setup. It can be done here. This line is appended at the end of JAVA_OPTS string. (default '') :arg str class-path: Specify script classpath here. Each line is one class path item. (default '') Minimal Example: .. literalinclude:: ../../tests/builders/fixtures/groovy-minimal.yaml :language: yaml Full Example: .. literalinclude:: ../../tests/builders/fixtures/groovy-full.yaml :language: yaml """ root_tag = 'hudson.plugins.groovy.Groovy' groovy = XML.SubElement(xml_parent, root_tag) groovy.append(_groovy_common_scriptSource(data)) mappings = [ ('version', 'groovyName', '(Default)'), ('parameters', 'parameters', ''), ('script-parameters', 'scriptParameters', ''), ('properties', 'properties', ''), ('java-opts', 'javaOpts', ''), ('class-path', 'classPath', '') ] convert_mapping_to_xml(groovy, data, mappings, fail_required=True) def system_groovy(registry, xml_parent, data): """yaml: system-groovy Execute a system groovy script or command. Requires the Jenkins :jenkins-wiki:`Groovy Plugin <Groovy+plugin>`. :arg str file: Groovy file to run. (Alternative: you can chose a command instead) :arg str command: Groovy command to run. (Alternative: you can chose a script file instead) :arg str bindings: Define variable bindings (in the properties file format). Specified variables can be addressed from the script. (optional) :arg str class-path: Specify script classpath here. Each line is one class path item. (optional) Examples: .. literalinclude:: ../../tests/builders/fixtures/system-groovy001.yaml :language: yaml .. literalinclude:: ../../tests/builders/fixtures/system-groovy002.yaml :language: yaml """ root_tag = 'hudson.plugins.groovy.SystemGroovy' sysgroovy = XML.SubElement(xml_parent, root_tag) sysgroovy.append(_groovy_common_scriptSource(data)) XML.SubElement(sysgroovy, 'bindings').text = str(data.get('bindings', "")) XML.SubElement(sysgroovy, 'classpath').text = str( data.get('class-path', "")) def batch(registry, xml_parent, data): """yaml: batch Execute a batch command. :Parameter: the batch command to execute Example: .. literalinclude:: ../../tests/builders/fixtures/batch.yaml :language: yaml """ batch = XML.SubElement(xml_parent, 'hudson.tasks.BatchFile') XML.SubElement(batch, 'command').text = data def powershell(registry, xml_parent, data): """yaml: powershell Execute a powershell command. Requires the :jenkins-wiki:`Powershell Plugin <PowerShell+Plugin>`. :Parameter: the powershell command to execute Example: .. literalinclude:: ../../tests/builders/fixtures/powershell.yaml :language: yaml """ ps = XML.SubElement(xml_parent, 'hudson.plugins.powershell.PowerShell') XML.SubElement(ps, 'command').text = data def msbuild(registry, xml_parent, data): """yaml: msbuild Build .NET project using msbuild. Requires the :jenkins-wiki:`Jenkins MSBuild Plugin <MSBuild+Plugin>`. :arg str msbuild-version: which msbuild configured in Jenkins to use (default '(Default)') :arg str solution-file: location of the solution file to build (required) :arg str extra-parameters: extra parameters to pass to msbuild (default '') :arg bool pass-build-variables: should build variables be passed to msbuild (default true) :arg bool continue-on-build-failure: should the build continue if msbuild returns an error (default false) :arg bool unstable-if-warnings: If set to true and warnings on compilation, the build will be unstable (>=1.20) (default false) Full Example: .. literalinclude:: ../../tests/builders/fixtures/msbuild-full.yaml :language: yaml Minimal Example: .. literalinclude:: ../../tests/builders/fixtures/msbuild-minimal.yaml :language: yaml """ msbuilder = XML.SubElement(xml_parent, 'hudson.plugins.msbuild.MsBuildBuilder') msbuilder.set('plugin', 'msbuild') mapping = [ ('msbuild-version', 'msBuildName', '(Default)'), ('solution-file', 'msBuildFile', None), ('extra-parameters', 'cmdLineArgs', ''), ('pass-build-variables', 'buildVariablesAsProperties', True), ('continue-on-build-failure', 'continueOnBuildFailure', False), ('unstable-if-warnings', 'unstableIfWarnings', False) ] convert_mapping_to_xml(msbuilder, data, mapping, fail_required=True) def create_builders(registry, step): dummy_parent = XML.Element("dummy") registry.dispatch('builder', dummy_parent, step) return list(dummy_parent) def conditional_step(registry, xml_parent, data): """yaml: conditional-step Conditionally execute some build steps. Requires the Jenkins :jenkins-wiki:`Conditional BuildStep Plugin <Conditional+BuildStep+Plugin>`. Depending on the number of declared steps, a `Conditional step (single)` or a `Conditional steps (multiple)` is created in Jenkins. :arg str condition-kind: Condition kind that must be verified before the steps are executed. Valid values and their additional attributes are described in the conditions_ table. :arg str on-evaluation-failure: What should be the outcome of the build if the evaluation of the condition fails. Possible values are `fail`, `mark-unstable`, `run-and-mark-unstable`, `run` and `dont-run`. (default 'fail'). :arg list steps: List of steps to run if the condition is verified. Items in the list can be any builder known by Jenkins Job Builder. .. _conditions: ================== ==================================================== Condition kind Description ================== ==================================================== always Condition is always verified never Condition is never verified boolean-expression Run the step if the expression expends to a representation of true :condition-expression: Expression to expand (required) build-cause Run if the current build has a specific cause :cause: The cause why the build was triggered. Following causes are supported - :USER_CAUSE: build was triggered by a manual interaction. (default) :SCM_CAUSE: build was triggered by a SCM change. :TIMER_CAUSE: build was triggered by a timer. :CLI_CAUSE: build was triggered by via CLI interface :REMOTE_CAUSE: build was triggered via remote interface. :UPSTREAM_CAUSE: build was triggered by an upstream project. Following supported if XTrigger plugin installed: :FS_CAUSE: build was triggered by a file system change (FSTrigger Plugin). :URL_CAUSE: build was triggered by a URL change (URLTrigger Plugin) :IVY_CAUSE: build triggered by an Ivy dependency version has change (IvyTrigger Plugin) :SCRIPT_CAUSE: build was triggered by a script (ScriptTrigger Plugin) :BUILDRESULT_CAUSE: build was triggered by a result of an other job (BuildResultTrigger Plugin) :exclusive-cause: (bool) There might by multiple casues causing a build to be triggered, with this true, the cause must be the only one causing this build this build to be triggered. (default false) day-of-week Only run on specific days of the week. :day-selector: Days you want the build to run on. Following values are supported - :weekend: Saturday and Sunday (default). :weekday: Monday - Friday. :select-days: Selected days, defined by 'days' below. :days: True for days for which the build should run. Definition needed only for 'select-days' day-selector, at the same level as day-selector. Define the days to run under this. :SUN: Run on Sunday (default false) :MON: Run on Monday (default false) :TUES: Run on Tuesday (default false) :WED: Run on Wednesday (default false) :THURS: Run on Thursday (default false) :FRI: Run on Friday (default false) :SAT: Run on Saturday (default false) :use-build-time: (bool) Use the build time instead of the the time that the condition is evaluated. (default false) execution-node Run only on selected nodes. :nodes: (list) List of nodes to execute on. (required) strings-match Run the step if two strings match :condition-string1: First string (optional) :condition-string2: Second string (optional) :condition-case-insensitive: Case insensitive (default false) current-status Run the build step if the current build status is within the configured range :condition-worst: Accepted values are SUCCESS, UNSTABLE, FAILURE, NOT_BUILD, ABORTED (default SUCCESS) :condition-best: Accepted values are SUCCESS, UNSTABLE, FAILURE, NOT_BUILD, ABORTED (default SUCCESS) shell Run the step if the shell command succeed :condition-command: Shell command to execute (optional) windows-shell Similar to shell, except that commands will be executed by cmd, under Windows :condition-command: Command to execute (optional) file-exists Run the step if a file exists :condition-filename: Check existence of this file (required) :condition-basedir: If condition-filename is relative, it will be considered relative to either `workspace`, `artifact-directory`, or `jenkins-home`. (default 'workspace') files-match Run if one or more files match the selectors. :include-pattern: (list str) List of Includes Patterns. Since the separator in the patterns is hardcoded as ',', any use of ',' would need escaping. (optional) :exclude-pattern: (list str) List of Excludes Patterns. Since the separator in the patterns is hardcoded as ',', any use of ',' would need escaping. (optional) :condition-basedir: Accepted values are `workspace`, `artifact-directory`, or `jenkins-home`. (default 'workspace') num-comp Run if the numerical comparison is true. :lhs: Left Hand Side. Must evaluate to a number. (required) :rhs: Right Hand Side. Must evaluate to a number. (required) :comparator: Accepted values are `less-than`, `greater-than`, `equal`, `not-equal`, `less-than-equal`, `greater-than-equal`. (default 'less-than') regex-match Run if the Expression matches the Label. :regex: The regular expression used to match the label (optional) :label: The label that will be tested by the regular expression. (optional) time Only run during a certain period of the day. :earliest-hour: Starting hour (default "09") :earliest-min: Starting min (default "00") :latest-hour: Ending hour (default "17") :latest-min: Ending min (default "30") :use-build-time: (bool) Use the build time instead of the the time that the condition is evaluated. (default false) not Run the step if the inverse of the condition-operand is true :condition-operand: Condition to evaluate. Can be any supported conditional-step condition. (required) and Run the step if logical and of all conditional-operands is true :condition-operands: (list) Conditions to evaluate. Can be any supported conditional-step condition. (required) or Run the step if logical or of all conditional-operands is true :condition-operands: (list) Conditions to evaluate. Can be any supported conditional-step condition. (required) ================== ==================================================== Example: .. literalinclude:: /../../tests/builders/fixtures/conditional-step-success-failure.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-not-file-exists.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-day-of-week001.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-day-of-week003.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-time.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-regex-match.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-or.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/conditional-step-and.yaml :language: yaml """ def build_condition(cdata, cond_root_tag): kind = cdata['condition-kind'] ctag = XML.SubElement(cond_root_tag, condition_tag) core_prefix = 'org.jenkins_ci.plugins.run_condition.core.' logic_prefix = 'org.jenkins_ci.plugins.run_condition.logic.' if kind == "always": ctag.set('class', core_prefix + 'AlwaysRun') elif kind == "never": ctag.set('class', core_prefix + 'NeverRun') elif kind == "boolean-expression": ctag.set('class', core_prefix + 'BooleanCondition') try: XML.SubElement(ctag, "token").text = ( cdata['condition-expression']) except KeyError: raise MissingAttributeError('condition-expression') elif kind == "build-cause": ctag.set('class', core_prefix + 'CauseCondition') cause_list = ('USER_CAUSE', 'SCM_CAUSE', 'TIMER_CAUSE', 'CLI_CAUSE', 'REMOTE_CAUSE', 'UPSTREAM_CAUSE', 'FS_CAUSE', 'URL_CAUSE', 'IVY_CAUSE', 'SCRIPT_CAUSE', 'BUILDRESULT_CAUSE') cause_name = cdata.get('cause', 'USER_CAUSE') if cause_name not in cause_list: raise InvalidAttributeError('cause', cause_name, cause_list) XML.SubElement(ctag, "buildCause").text = cause_name XML.SubElement(ctag, "exclusiveCause").text = str(cdata.get( 'exclusive-cause', False)).lower() elif kind == "day-of-week": ctag.set('class', core_prefix + 'DayCondition') day_selector_class_prefix = core_prefix + 'DayCondition$' day_selector_classes = { 'weekend': day_selector_class_prefix + 'Weekend', 'weekday': day_selector_class_prefix + 'Weekday', 'select-days': day_selector_class_prefix + 'SelectDays', } day_selector = cdata.get('day-selector', 'weekend') if day_selector not in day_selector_classes: raise InvalidAttributeError('day-selector', day_selector, day_selector_classes) day_selector_tag = XML.SubElement(ctag, "daySelector") day_selector_tag.set('class', day_selector_classes[day_selector]) if day_selector == "select-days": days_tag = XML.SubElement(day_selector_tag, "days") day_tag_text = ('org.jenkins__ci.plugins.run__condition.' 'core.DayCondition_-Day') inp_days = cdata.get('days') if cdata.get('days') else {} days = ['SUN', 'MON', 'TUES', 'WED', 'THURS', 'FRI', 'SAT'] for day_no, day in enumerate(days, 1): day_tag = XML.SubElement(days_tag, day_tag_text) XML.SubElement(day_tag, "day").text = str(day_no) XML.SubElement(day_tag, "selected").text = str( inp_days.get(day, False)).lower() XML.SubElement(ctag, "useBuildTime").text = str(cdata.get( 'use-build-time', False)).lower() elif kind == "execution-node": ctag.set('class', core_prefix + 'NodeCondition') allowed_nodes_tag = XML.SubElement(ctag, "allowedNodes") try: nodes_list = cdata['nodes'] except KeyError: raise MissingAttributeError('nodes') for node in nodes_list: node_tag = XML.SubElement(allowed_nodes_tag, "string") node_tag.text = node elif kind == "strings-match": ctag.set('class', core_prefix + 'StringsMatchCondition') XML.SubElement(ctag, "arg1").text = cdata.get( 'condition-string1', '') XML.SubElement(ctag, "arg2").text = cdata.get( 'condition-string2', '') XML.SubElement(ctag, "ignoreCase").text = str(cdata.get( 'condition-case-insensitive', False)).lower() elif kind == "current-status": ctag.set('class', core_prefix + 'StatusCondition') wr = XML.SubElement(ctag, 'worstResult') wr_name = cdata.get('condition-worst', 'SUCCESS') if wr_name not in hudson_model.THRESHOLDS: raise InvalidAttributeError('condition-worst', wr_name, hudson_model.THRESHOLDS.keys()) wr_threshold = hudson_model.THRESHOLDS[wr_name] XML.SubElement(wr, "name").text = wr_threshold['name'] XML.SubElement(wr, "ordinal").text = wr_threshold['ordinal'] XML.SubElement(wr, "color").text = wr_threshold['color'] XML.SubElement(wr, "completeBuild").text = str( wr_threshold['complete']).lower() br = XML.SubElement(ctag, 'bestResult') br_name = cdata.get('condition-best', 'SUCCESS') if br_name not in hudson_model.THRESHOLDS: raise InvalidAttributeError('condition-best', br_name, hudson_model.THRESHOLDS.keys()) br_threshold = hudson_model.THRESHOLDS[br_name] XML.SubElement(br, "name").text = br_threshold['name'] XML.SubElement(br, "ordinal").text = br_threshold['ordinal'] XML.SubElement(br, "color").text = br_threshold['color'] XML.SubElement(br, "completeBuild").text = str( wr_threshold['complete']).lower() elif kind == "shell": ctag.set('class', 'org.jenkins_ci.plugins.run_condition.contributed.' 'ShellCondition') XML.SubElement(ctag, "command").text = cdata.get( 'condition-command', '') elif kind == "windows-shell": ctag.set('class', 'org.jenkins_ci.plugins.run_condition.contributed.' 'BatchFileCondition') XML.SubElement(ctag, "command").text = cdata.get( 'condition-command', '') elif kind == "file-exists" or kind == "files-match": if kind == "file-exists": ctag.set('class', core_prefix + 'FileExistsCondition') try: XML.SubElement(ctag, "file").text = ( cdata['condition-filename']) except KeyError: raise MissingAttributeError('condition-filename') else: ctag.set('class', core_prefix + 'FilesMatchCondition') XML.SubElement(ctag, "includes").text = ",".join(cdata.get( 'include-pattern', '')) XML.SubElement(ctag, "excludes").text = ",".join(cdata.get( 'exclude-pattern', '')) basedir_class_prefix = ('org.jenkins_ci.plugins.run_condition.' 'common.BaseDirectory$') basedir_classes = { 'workspace': basedir_class_prefix + 'Workspace', 'artifact-directory': basedir_class_prefix + 'ArtifactsDir', 'jenkins-home': basedir_class_prefix + 'JenkinsHome' } basedir = cdata.get('condition-basedir', 'workspace') if basedir not in basedir_classes: raise InvalidAttributeError('condition-basedir', basedir, basedir_classes) XML.SubElement(ctag, "baseDir").set('class', basedir_classes[basedir]) elif kind == "num-comp": ctag.set('class', core_prefix + 'NumericalComparisonCondition') try: XML.SubElement(ctag, "lhs").text = cdata['lhs'] XML.SubElement(ctag, "rhs").text = cdata['rhs'] except KeyError as e: raise MissingAttributeError(e.args[0]) comp_class_prefix = core_prefix + 'NumericalComparisonCondition$' comp_classes = { 'less-than': comp_class_prefix + 'LessThan', 'greater-than': comp_class_prefix + 'GreaterThan', 'equal': comp_class_prefix + 'EqualTo', 'not-equal': comp_class_prefix + 'NotEqualTo', 'less-than-equal': comp_class_prefix + 'LessThanOrEqualTo', 'greater-than-equal': comp_class_prefix + 'GreaterThanOrEqualTo' } comp = cdata.get('comparator', 'less-than') if comp not in comp_classes: raise InvalidAttributeError('comparator', comp, comp_classes) XML.SubElement(ctag, "comparator").set('class', comp_classes[comp]) elif kind == "regex-match": ctag.set('class', core_prefix + 'ExpressionCondition') XML.SubElement(ctag, "expression").text = cdata.get('regex', '') XML.SubElement(ctag, "label").text = cdata.get('label', '') elif kind == "time": ctag.set('class', core_prefix + 'TimeCondition') XML.SubElement(ctag, "earliestHours").text = cdata.get( 'earliest-hour', '09') XML.SubElement(ctag, "earliestMinutes").text = cdata.get( 'earliest-min', '00') XML.SubElement(ctag, "latestHours").text = cdata.get( 'latest-hour', '17') XML.SubElement(ctag, "latestMinutes").text = cdata.get( 'latest-min', '30') XML.SubElement(ctag, "useBuildTime").text = str(cdata.get( 'use-build-time', False)).lower() elif kind == "not": ctag.set('class', logic_prefix + 'Not') try: notcondition = cdata['condition-operand'] except KeyError: raise MissingAttributeError('condition-operand') build_condition(notcondition, ctag) elif kind == "and" or "or": if kind == "and": ctag.set('class', logic_prefix + 'And') else: ctag.set('class', logic_prefix + 'Or') conditions_tag = XML.SubElement(ctag, "conditions") container_tag_text = ('org.jenkins__ci.plugins.run__condition.' 'logic.ConditionContainer') try: conditions_list = cdata['condition-operands'] except KeyError: raise MissingAttributeError('condition-operands') for condition in conditions_list: conditions_container_tag = XML.SubElement(conditions_tag, container_tag_text) build_condition(condition, conditions_container_tag) def build_step(parent, step): for edited_node in create_builders(registry, step): if not has_multiple_steps: edited_node.set('class', edited_node.tag) edited_node.tag = 'buildStep' parent.append(edited_node) cond_builder_tag = ('org.jenkinsci.plugins.conditionalbuildstep.' 'singlestep.SingleConditionalBuilder') cond_builders_tag = ('org.jenkinsci.plugins.conditionalbuildstep.' 'ConditionalBuilder') steps = data['steps'] has_multiple_steps = len(steps) > 1 if has_multiple_steps: root_tag = XML.SubElement(xml_parent, cond_builders_tag) steps_parent = XML.SubElement(root_tag, "conditionalbuilders") condition_tag = "runCondition" else: root_tag = XML.SubElement(xml_parent, cond_builder_tag) steps_parent = root_tag condition_tag = "condition" build_condition(data, root_tag) evaluation_classes_pkg = 'org.jenkins_ci.plugins.run_condition' evaluation_classes = { 'fail': evaluation_classes_pkg + '.BuildStepRunner$Fail', 'mark-unstable': evaluation_classes_pkg + '.BuildStepRunner$Unstable', 'run-and-mark-unstable': evaluation_classes_pkg + '.BuildStepRunner$RunUnstable', 'run': evaluation_classes_pkg + '.BuildStepRunner$Run', 'dont-run': evaluation_classes_pkg + '.BuildStepRunner$DontRun', } evaluation_class = evaluation_classes[data.get('on-evaluation-failure', 'fail')] XML.SubElement(root_tag, "runner").set('class', evaluation_class) for step in steps: build_step(steps_parent, step) def maven_builder(registry, xml_parent, data): """yaml: maven-builder Execute Maven3 builder Allows your build jobs to deploy artifacts automatically to Artifactory. Requires the Jenkins :jenkins-wiki:`Artifactory Plugin <Artifactory+Plugin>`. :arg str name: Name of maven installation from the configuration (required) :arg str pom: Location of pom.xml (default 'pom.xml') :arg str goals: Goals to execute (required) :arg str maven-opts: Additional options for maven (default '') Example: .. literalinclude:: /../../tests/builders/fixtures/maven-builder001.yaml :language: yaml """ maven = XML.SubElement(xml_parent, 'org.jfrog.hudson.maven3.Maven3Builder') mapping = [ ('name', 'mavenName', None), ('goals', 'goals', None), ('pom', 'rootPom', 'pom.xml'), ('maven-opts', 'mavenOpts', ''), ] convert_mapping_to_xml(maven, data, mapping, fail_required=True) def maven_target(registry, xml_parent, data): """yaml: maven-target Execute top-level Maven targets. Requires the Jenkins :jenkins-wiki:`Config File Provider Plugin <Config+File+Provider+Plugin>` for the Config File Provider "settings" and "global-settings" config. :arg str goals: Goals to execute :arg str properties: Properties for maven, can have multiples :arg str pom: Location of pom.xml (default 'pom.xml') :arg bool private-repository: Use private maven repository for this job (default false) :arg str maven-version: Installation of maven which should be used (optional) :arg str java-opts: java options for maven, can have multiples, must be in quotes (optional) :arg str settings: Path to use as user settings.xml It is possible to provide a ConfigFileProvider settings file, such as see CFP Example below. (optional) :arg str settings-type: Type of settings file file|cfp. (default file) :arg str global-settings: Path to use as global settings.xml It is possible to provide a ConfigFileProvider settings file, such as see CFP Example below. (optional) :arg str global-settings-type: Type of settings file file|cfp. (default file) Example: .. literalinclude:: /../../tests/builders/fixtures/maven-target-doc.yaml :language: yaml CFP Example: .. literalinclude:: /../../tests/builders/fixtures/maven-target002.yaml :language: yaml """ maven = XML.SubElement(xml_parent, 'hudson.tasks.Maven') XML.SubElement(maven, 'targets').text = data['goals'] prop_string = '\n'.join(data.get('properties', [])) XML.SubElement(maven, 'properties').text = prop_string if 'maven-version' in data: XML.SubElement(maven, 'mavenName').text = str(data['maven-version']) if 'pom' in data: XML.SubElement(maven, 'pom').text = str(data['pom']) use_private = str(data.get('private-repository', False)).lower() XML.SubElement(maven, 'usePrivateRepository').text = use_private if 'java-opts' in data: javaoptions = ' '.join(data.get('java-opts', [])) XML.SubElement(maven, 'jvmOptions').text = javaoptions config_file_provider_settings(maven, data) def multijob(registry, xml_parent, data): """yaml: multijob Define a multijob phase. Requires the Jenkins :jenkins-wiki:`Multijob Plugin <Multijob+Plugin>`. This builder may only be used in :py:class:`jenkins_jobs.modules.project_multijob.MultiJob` projects. :arg str name: MultiJob phase name :arg str condition: when to trigger the other job. Can be: 'SUCCESSFUL', 'UNSTABLE', 'COMPLETED', 'FAILURE', 'ALWAYS'. (default 'SUCCESSFUL') :arg list projects: list of projects to include in the MultiJob phase :Project: * **name** (`str`) -- Project name * **current-parameters** (`bool`) -- Pass current build parameters to the other job (default false) * **node-label-name** (`str`) -- Define a list of nodes on which the job should be allowed to be executed on. Requires NodeLabel Parameter Plugin (optional) * **node-label** (`str`) -- Define a label of 'Restrict where this project can be run' on the fly. Requires NodeLabel Parameter Plugin (optional) * **node-parameters** (`bool`) -- Use the same Node for the triggered builds that was used for this build. (optional) * **git-revision** (`bool`) -- Pass current git-revision to the other job (default false) * **property-file** (`str`) -- Pass properties from file to the other job (optional) * **predefined-parameters** (`str`) -- Pass predefined parameters to the other job (optional) * **abort-all-job** (`bool`) -- Kill allsubs job and the phase job, if this subjob is killed (default false) * **enable-condition** (`str`) -- Condition to run the job in groovy script format (optional) * **kill-phase-on** (`str`) -- Stop the phase execution on specific job status. Can be 'FAILURE', 'UNSTABLE', 'NEVER'. (optional) * **restrict-matrix-project** (`str`) -- Filter that restricts the subset of the combinations that the downstream project will run (optional) * **retry** (`dict`): Enable retry strategy (optional) :retry: * **max-retry** (`int`) -- Max number of retries (default 0) * **strategy-path** (`str`) -- Parsing rules path (required) Example: .. literalinclude:: /../../tests/builders/fixtures/multibuild.yaml :language: yaml """ builder = XML.SubElement(xml_parent, 'com.tikal.jenkins.plugins.multijob.' 'MultiJobBuilder') XML.SubElement(builder, 'phaseName').text = data['name'] condition = data.get('condition', 'SUCCESSFUL') conditions_available = ('SUCCESSFUL', 'UNSTABLE', 'COMPLETED', 'FAILURE', 'ALWAYS') if condition not in conditions_available: raise JenkinsJobsException('Multijob condition must be one of: %s.' % ', '.join(conditions_available)) XML.SubElement(builder, 'continuationCondition').text = condition phaseJobs = XML.SubElement(builder, 'phaseJobs') kill_status_list = ('FAILURE', 'UNSTABLE', 'NEVER') for project in data.get('projects', []): phaseJob = XML.SubElement(phaseJobs, 'com.tikal.jenkins.plugins.' 'multijob.PhaseJobsConfig') XML.SubElement(phaseJob, 'jobName').text = project['name'] # Pass through the current build params currParams = str(project.get('current-parameters', False)).lower() XML.SubElement(phaseJob, 'currParams').text = currParams # Pass through other params configs = XML.SubElement(phaseJob, 'configs') nodeLabelName = project.get('node-label-name') nodeLabel = project.get('node-label') if (nodeLabelName and nodeLabel): node = XML.SubElement( configs, 'org.jvnet.jenkins.plugins.nodelabelparameter.' 'parameterizedtrigger.NodeLabelBuildParameter') XML.SubElement(node, 'name').text = nodeLabelName XML.SubElement(node, 'nodeLabel').text = nodeLabel # Node parameter if project.get('node-parameters', False): XML.SubElement(configs, 'hudson.plugins.parameterizedtrigger.' 'NodeParameters') # Git Revision if project.get('git-revision', False): param = XML.SubElement(configs, 'hudson.plugins.git.' 'GitRevisionBuildParameters') combine = XML.SubElement(param, 'combineQueuedCommits') combine.text = 'false' # Properties File properties_file = project.get('property-file', False) if properties_file: param = XML.SubElement(configs, 'hudson.plugins.parameterizedtrigger.' 'FileBuildParameters') propertiesFile = XML.SubElement(param, 'propertiesFile') propertiesFile.text = properties_file failOnMissing = XML.SubElement(param, 'failTriggerOnMissing') failOnMissing.text = 'true' # Predefined Parameters predefined_parameters = project.get('predefined-parameters', False) if predefined_parameters: param = XML.SubElement(configs, 'hudson.plugins.parameterizedtrigger.' 'PredefinedBuildParameters') properties = XML.SubElement(param, 'properties') properties.text = predefined_parameters # Abort all other job abortAllJob = str(project.get('abort-all-job', False)).lower() XML.SubElement(phaseJob, 'abortAllJob').text = abortAllJob # Retry job retry = project.get('retry', False) if retry: try: rules_path = str(retry['strategy-path']) XML.SubElement(phaseJob, 'parsingRulesPath').text = rules_path except KeyError: raise MissingAttributeError('strategy-path') max_retry = retry.get('max-retry', 0) XML.SubElement(phaseJob, 'maxRetries').text = str(int(max_retry)) XML.SubElement(phaseJob, 'enableRetryStrategy').text = 'true' else: XML.SubElement(phaseJob, 'enableRetryStrategy').text = 'false' # Restrict matrix jobs to a subset if project.get('restrict-matrix-project') is not None: subset = XML.SubElement( configs, 'hudson.plugins.parameterizedtrigger.' 'matrix.MatrixSubsetBuildParameters') XML.SubElement( subset, 'filter').text = project['restrict-matrix-project'] # Enable Condition enable_condition = project.get('enable-condition') if enable_condition is not None: XML.SubElement( phaseJob, 'enableCondition' ).text = 'true' XML.SubElement( phaseJob, 'condition' ).text = enable_condition # Kill phase on job status kill_status = project.get('kill-phase-on') if kill_status is not None: kill_status = kill_status.upper() if kill_status not in kill_status_list: raise JenkinsJobsException( 'multijob kill-phase-on must be one of: %s' + ','.join(kill_status_list)) XML.SubElement( phaseJob, 'killPhaseOnJobResultCondition' ).text = kill_status def config_file_provider(registry, xml_parent, data): """yaml: config-file-provider Provide configuration files (i.e., settings.xml for maven etc.) which will be copied to the job's workspace. Requires the Jenkins :jenkins-wiki:`Config File Provider Plugin <Config+File+Provider+Plugin>`. :arg list files: List of managed config files made up of three parameters :files: * **file-id** (`str`) -- The identifier for the managed config file * **target** (`str`) -- Define where the file should be created (default '') * **variable** (`str`) -- Define an environment variable to be used (default '') Example: .. literalinclude:: ../../tests/builders/fixtures/config-file-provider01.yaml :language: yaml """ cfp = XML.SubElement(xml_parent, 'org.jenkinsci.plugins.configfiles.builder.' 'ConfigFileBuildStep') cfp.set('plugin', 'config-file-provider') config_file_provider_builder(cfp, data) def grails(registry, xml_parent, data): """yaml: grails Execute a grails build step. Requires the :jenkins-wiki:`Jenkins Grails Plugin <Grails+Plugin>`. :arg bool use-wrapper: Use a grails wrapper (default false) :arg str name: Select a grails installation to use (default '(Default)') :arg bool force-upgrade: Run 'grails upgrade --non-interactive' first (default false) :arg bool non-interactive: append --non-interactive to all build targets (default false) :arg str targets: Specify target(s) to run separated by spaces (required) :arg str server-port: Specify a value for the server.port system property (default '') :arg str work-dir: Specify a value for the grails.work.dir system property (default '') :arg str project-dir: Specify a value for the grails.project.work.dir system property (default '') :arg str base-dir: Specify a path to the root of the Grails project (default '') :arg str properties: Additional system properties to set (default '') :arg bool plain-output: append --plain-output to all build targets (default false) :arg bool stack-trace: append --stack-trace to all build targets (default false) :arg bool verbose: append --verbose to all build targets (default false) :arg bool refresh-dependencies: append --refresh-dependencies to all build targets (default false) Full Example: .. literalinclude:: ../../tests/builders/fixtures/grails-full.yaml :language: yaml Minimal Example: .. literalinclude:: ../../tests/builders/fixtures/grails-minimal.yaml :language: yaml """ grails = XML.SubElement(xml_parent, 'com.g2one.hudson.grails.' 'GrailsBuilder') grails.set('plugin', 'grails') mappings = [ ('targets', 'targets', None), ('name', 'name', '(Default)'), ('work-dir', 'grailsWorkDir', ''), ('project-dir', 'projectWorkDir', ''), ('base-dir', 'projectBaseDir', ''), ('server-port', 'serverPort', ''), ('properties', 'properties', ''), ('force-upgrade', 'forceUpgrade', False), ('non-interactive', 'nonInteractive', False), ('use-wrapper', 'useWrapper', False), ('plain-output', 'plainOutput', False), ('stack-trace', 'stackTrace', False), ('verbose', 'verbose', False), ('refresh-dependencies', 'refreshDependencies', False), ] convert_mapping_to_xml(grails, data, mappings, fail_required=True) def sbt(registry, xml_parent, data): """yaml: sbt Execute a sbt build step. Requires the Jenkins :jenkins-wiki:`Sbt Plugin <sbt+plugin>`. :arg str name: Select a sbt installation to use. If no name is provided, the first in the list of defined SBT builders will be used. (default to first in list) :arg str jvm-flags: Parameters to pass to the JVM (default '') :arg str actions: Select the sbt tasks to execute (default '') :arg str sbt-flags: Add flags to SBT launcher (default '-Dsbt.log.noformat=true') :arg str subdir-path: Path relative to workspace to run sbt in (default '') Example: .. literalinclude:: ../../tests/builders/fixtures/sbt.yaml :language: yaml """ sbt = XML.SubElement(xml_parent, 'org.jvnet.hudson.plugins.' 'SbtPluginBuilder') mappings = [ ('name', 'name', ''), ('jvm-flags', 'jvmFlags', ''), ('sbt-flags', 'sbtFlags', '-Dsbt.log.noformat=true'), ('actions', 'actions', ''), ('subdir-path', 'subdirPath', ''), ] convert_mapping_to_xml(sbt, data, mappings, fail_required=True) def critical_block_start(registry, xml_parent, data): """yaml: critical-block-start Designate the start of a critical block. Must be used in conjuction with critical-block-end. Must also add a build wrapper (exclusion), specifying the resources that control the critical block. Otherwise, this will have no effect. Requires Jenkins :jenkins-wiki:`Exclusion Plugin <Exclusion-Plugin>`. Example: .. literalinclude:: ../../tests/yamlparser/fixtures/critical_block_complete001.yaml :language: yaml """ cbs = XML.SubElement( xml_parent, 'org.jvnet.hudson.plugins.exclusion.CriticalBlockStart') cbs.set('plugin', 'Exclusion') def critical_block_end(registry, xml_parent, data): """yaml: critical-block-end Designate the end of a critical block. Must be used in conjuction with critical-block-start. Must also add a build wrapper (exclusion), specifying the resources that control the critical block. Otherwise, this will have no effect. Requires Jenkins :jenkins-wiki:`Exclusion Plugin <Exclusion-Plugin>`. Example: .. literalinclude:: ../../tests/yamlparser/fixtures/critical_block_complete001.yaml :language: yaml """ cbs = XML.SubElement( xml_parent, 'org.jvnet.hudson.plugins.exclusion.CriticalBlockEnd') cbs.set('plugin', 'Exclusion') def publish_over_ssh(registry, xml_parent, data): """yaml: publish-over-ssh Send files or execute commands over SSH. Requires the Jenkins :jenkins-wiki:`Publish over SSH Plugin <Publish+Over+SSH+Plugin>`. :arg str site: name of the ssh site :arg str target: destination directory :arg bool target-is-date-format: whether target is a date format. If true, raw text should be quoted (default false) :arg bool clean-remote: should the remote directory be deleted before transferring files (default false) :arg str source: source path specifier :arg str command: a command to execute on the remote server (optional) :arg int timeout: timeout in milliseconds for the Exec command (optional) :arg bool use-pty: run the exec command in pseudo TTY (default false) :arg str excludes: excluded file pattern (optional) :arg str remove-prefix: prefix to remove from uploaded file paths (optional) :arg bool fail-on-error: fail the build if an error occurs (default false) Example: .. literalinclude:: /../../tests/builders/fixtures/publish-over-ssh.yaml :language: yaml """ ssh(registry, xml_parent, data) def saltstack(parser, xml_parent, data): """yaml: saltstack Send a message to Salt API. Requires the :jenkins-wiki:`saltstack plugin <saltstack-plugin>`. :arg str servername: Salt master server name (required) :arg str authtype: Authentication type ('pam' or 'ldap', default 'pam') :arg str credentials: Credentials ID for which to authenticate to Salt master (required) :arg str target: Target minions (default '') :arg str targettype: Target type ('glob', 'pcre', 'list', 'grain', 'pillar', 'nodegroup', 'range', or 'compound', default 'glob') :arg str function: Function to execute (default '') :arg str arguments: Salt function arguments (default '') :arg str kwarguments: Salt keyword arguments (default '') :arg bool saveoutput: Save Salt return data into environment variable (default false) :arg str clientinterface: Client interface type ('local', 'local-batch', or 'runner', default 'local') :arg bool wait: Wait for completion of command (default false) :arg str polltime: Number of seconds to wait before polling job completion status (default '') :arg str batchsize: Salt batch size, absolute value or %-age (default 100%) :arg str mods: Mods to runner (default '') :arg bool setpillardata: Set Pillar data (default false) :arg str pillarkey: Pillar key (default '') :arg str pillarvalue: Pillar value (default '') Minimal Example: .. literalinclude:: ../../tests/builders/fixtures/saltstack-minimal.yaml :language: yaml Full Example: .. literalinclude:: ../../tests/builders/fixtures/saltstack-full.yaml :language: yaml """ saltstack = XML.SubElement(xml_parent, 'com.waytta.SaltAPIBuilder') supported_auth_types = ['pam', 'ldap'] supported_target_types = ['glob', 'pcre', 'list', 'grain', 'pillar', 'nodegroup', 'range', 'compound'] supported_client_interfaces = ['local', 'local-batch', 'runner'] mapping = [ ('servername', 'servername', None), ('credentials', 'credentialsId', None), ('authtype', 'authtype', 'pam', supported_auth_types), ('target', 'target', ''), ('targettype', 'targettype', 'glob', supported_target_types), ('clientinterface', 'clientInterface', 'local', supported_client_interfaces), ('function', 'function', ''), ('arguments', 'arguments', ''), ('kwarguments', 'kwarguments', ''), ('setpillardata', 'usePillar', False), ('pillarkey', 'pillarkey', ''), ('pillarvalue', 'pillarvalue', ''), ('wait', 'blockbuild', False), ('polltime', 'jobPollTime', ''), ('batchsize', 'batchSize', '100%'), ('mods', 'mods', ''), ('saveoutput', 'saveEnvVar', False) ] helpers.convert_mapping_to_xml(saltstack, data, mapping, fail_required=True) clientInterface = data.get('clientinterface', 'local') blockbuild = str(data.get('wait', False)).lower() jobPollTime = str(data.get('polltime', '')) batchSize = data.get('batchsize', '100%') mods = data.get('mods', '') usePillar = str(data.get('setpillardata', False)).lower() # Build the clientInterfaces structure, based on the # clientinterface setting clientInterfaces = XML.SubElement(saltstack, 'clientInterfaces') XML.SubElement(clientInterfaces, 'nullObject').text = 'false' ci_attrib = { 'class': 'org.apache.commons.collections.map.ListOrderedMap', 'serialization': 'custom' } properties = XML.SubElement(clientInterfaces, 'properties', ci_attrib) lomElement = 'org.apache.commons.collections.map.ListOrderedMap' listOrderedMap = XML.SubElement(properties, lomElement) default = XML.SubElement(listOrderedMap, 'default') ordered_map = XML.SubElement(listOrderedMap, 'map') insertOrder = XML.SubElement(default, 'insertOrder') ci_config = [] if clientInterface == 'local': ci_config = [ ('blockbuild', blockbuild), ('jobPollTime', jobPollTime), ('clientInterface', clientInterface) ] elif clientInterface == 'local-batch': ci_config = [ ('batchSize', batchSize), ('clientInterface', clientInterface) ] elif clientInterface == 'runner': ci_config = [ ('mods', mods), ('clientInterface', clientInterface) ] if usePillar == 'true': ci_config.append(('usePillar', usePillar)) pillar_cfg = [ ('pillarkey', data.get('pillarkey')), ('pillarvalue', data.get('pillarvalue')) ] for emt, value in ci_config: XML.SubElement(insertOrder, 'string').text = emt entry = XML.SubElement(ordered_map, 'entry') XML.SubElement(entry, 'string').text = emt # Special handling when usePillar == true, requires additional # structure in the builder XML if emt != 'usePillar': XML.SubElement(entry, 'string').text = value else: jsonobj = XML.SubElement(entry, 'net.sf.json.JSONObject') XML.SubElement(jsonobj, 'nullObject').text = 'false' pillarProps = XML.SubElement(jsonobj, 'properties', ci_attrib) XML.SubElement(pillarProps, 'unserializable-parents') pillarLom = XML.SubElement(pillarProps, lomElement) pillarDefault = XML.SubElement(pillarLom, 'default') pillarMap = XML.SubElement(pillarLom, 'map') pillarInsertOrder = XML.SubElement(pillarDefault, 'insertOrder') for pemt, value in pillar_cfg: XML.SubElement(pillarInsertOrder, 'string').text = pemt pillarEntry = XML.SubElement(pillarMap, 'entry') XML.SubElement(pillarEntry, 'string').text = pemt XML.SubElement(pillarEntry, 'string').text = value class Builders(jenkins_jobs.modules.base.Base): sequence = 60 component_type = 'builder' component_list_type = 'builders' def gen_xml(self, xml_parent, data): for alias in ['prebuilders', 'builders', 'postbuilders']: if alias in data: builders = XML.SubElement(xml_parent, alias) for builder in data[alias]: self.registry.dispatch('builder', builders, builder) # Make sure freestyle projects always have a <builders> entry # or Jenkins v1.472 (at least) will NPE. project_type = data.get('project-type', 'freestyle') if project_type in ('freestyle', 'matrix') and 'builders' not in data: XML.SubElement(xml_parent, 'builders') def shining_panda(registry, xml_parent, data): """yaml: shining-panda Execute a command inside various python environments. Requires the Jenkins :jenkins-wiki:`ShiningPanda plugin <ShiningPanda+Plugin>`. :arg str build-environment: Building environment to set up (required). :build-environment values: * **python**: Use a python installation configured in Jenkins. * **custom**: Use a manually installed python. * **virtualenv**: Create a virtualenv For the **python** environment :arg str python-version: Name of the python installation to use. Must match one of the configured installations on server configuration (default 'System-CPython-2.7') For the **custom** environment: :arg str home: path to the home folder of the custom installation (required) For the **virtualenv** environment: :arg str python-version: Name of the python installation to use. Must match one of the configured installations on server configuration (default 'System-CPython-2.7') :arg str name: Name of this virtualenv. Two virtualenv builders with the same name will use the same virtualenv installation (optional) :arg bool clear: If true, delete and recreate virtualenv on each build. (default false) :arg bool use-distribute: if true use distribute, if false use setuptools. (default true) :arg bool system-site-packages: if true, give access to the global site-packages directory to the virtualenv. (default false) Common to all environments: :arg str nature: Nature of the command field. (default shell) :nature values: * **shell**: execute the Command contents with default shell * **xshell**: like **shell** but performs platform conversion first * **python**: execute the Command contents with the Python executable :arg str command: The command to execute :arg bool ignore-exit-code: mark the build as failure if any of the commands exits with a non-zero exit code. (default false) Examples: .. literalinclude:: /../../tests/builders/fixtures/shining-panda-pythonenv.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/shining-panda-customenv.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/shining-panda-virtualenv.yaml :language: yaml """ pluginelementpart = 'jenkins.plugins.shiningpanda.builders.' buildenvdict = {'custom': 'CustomPythonBuilder', 'virtualenv': 'VirtualenvBuilder', 'python': 'PythonBuilder'} envs = (buildenvdict.keys()) try: buildenv = data['build-environment'] except KeyError: raise MissingAttributeError('build-environment') if buildenv not in envs: raise InvalidAttributeError('build-environment', buildenv, envs) t = XML.SubElement(xml_parent, '%s%s' % (pluginelementpart, buildenvdict[buildenv])) if buildenv in ('python', 'virtualenv'): XML.SubElement(t, 'pythonName').text = data.get("python-version", "System-CPython-2.7") if buildenv in ('custom'): try: homevalue = data["home"] except KeyError: raise JenkinsJobsException("'home' argument is required for the" " 'custom' environment") XML.SubElement(t, 'home').text = homevalue if buildenv in ('virtualenv'): XML.SubElement(t, 'home').text = data.get("name", "") clear = data.get("clear", False) XML.SubElement(t, 'clear').text = str(clear).lower() use_distribute = data.get('use-distribute', False) XML.SubElement(t, 'useDistribute').text = str(use_distribute).lower() system_site_packages = data.get('system-site-packages', False) XML.SubElement(t, 'systemSitePackages').text = str( system_site_packages).lower() # Common arguments nature = data.get('nature', 'shell') naturetuple = ('shell', 'xshell', 'python') if nature not in naturetuple: raise InvalidAttributeError('nature', nature, naturetuple) XML.SubElement(t, 'nature').text = nature XML.SubElement(t, 'command').text = data.get("command", "") ignore_exit_code = data.get('ignore-exit-code', False) XML.SubElement(t, 'ignoreExitCode').text = str(ignore_exit_code).lower() def tox(registry, xml_parent, data): """yaml: tox Use tox to build a multi-configuration project. Requires the Jenkins :jenkins-wiki:`ShiningPanda plugin <ShiningPanda+Plugin>`. :arg str ini: The TOX configuration file path (default tox.ini) :arg bool recreate: If true, create a new environment each time (default false) :arg str toxenv-pattern: The pattern used to build the TOXENV environment variable. (optional) Example: .. literalinclude:: /../../tests/builders/fixtures/tox001.yaml :language: yaml """ pluginelement = 'jenkins.plugins.shiningpanda.builders.ToxBuilder' t = XML.SubElement(xml_parent, pluginelement) XML.SubElement(t, 'toxIni').text = data.get('ini', 'tox.ini') XML.SubElement(t, 'recreate').text = str( data.get('recreate', False)).lower() pattern = data.get('toxenv-pattern') if pattern: XML.SubElement(t, 'toxenvPattern').text = pattern def managed_script(registry, xml_parent, data): """yaml: managed-script This step allows to reference and execute a centrally managed script within your build. Requires the Jenkins :jenkins-wiki:`Managed Script Plugin <Managed+Script+Plugin>`. :arg str script-id: Id of script to execute (required) :arg str type: Type of managed file (default script) :type values: * **batch**: Execute managed windows batch * **script**: Execute managed script :arg list args: Arguments to be passed to referenced script Example: .. literalinclude:: /../../tests/builders/fixtures/managed-script.yaml :language: yaml .. literalinclude:: /../../tests/builders/fixtures/managed-winbatch.yaml :language: yaml """ step_type = data.get('type', 'script').lower() if step_type == 'script': step = 'ScriptBuildStep' script_tag = 'buildStepId' elif step_type == 'batch': step = 'WinBatchBuildStep' script_tag = 'command' else: raise InvalidAttributeError('type', step_type, ['script', 'batch']) ms = XML.SubElement(xml_parent, 'org.jenkinsci.plugins.managedscripts.' + step) try: script_id = data['script-id'] except KeyError: raise MissingAttributeError('script-id') XML.SubElement(ms, script_tag).text = script_id args = XML.SubElement(ms, 'buildStepArgs') for arg in data.get('args', []): XML.SubElement(args, 'string').text = arg def cmake(registry, xml_parent, data): """yaml: cmake Execute a CMake target. Requires the Jenkins :jenkins-wiki:`CMake Plugin <CMake+Plugin>`. This builder is compatible with both versions 2.x and 1.x of the plugin. When specifying paramenters from both versions only the ones from the installed version in Jenkins will be used, and the rest will be ignored. :arg str source-dir: the source code directory relative to the workspace directory. (required) :arg str build-type: Sets the "build type" option for CMake (default "Debug"). :arg str preload-script: Path to a CMake preload script file. (optional) :arg str other-arguments: Other arguments to be added to the CMake call. (optional) :arg bool clean-build-dir: If true, delete the build directory before each build (default false). :arg list generator: The makefile generator (default "Unix Makefiles"). :type Possible generators: * **Borland Makefiles** * **CodeBlocks - MinGW Makefiles** * **CodeBlocks - Unix Makefiles**


context:
space:
mode: