/usr/lib/python3/dist-packages/jenkins_jobs/modules/metadata.py is in python3-jenkins-job-builder 1.3.0+2015.12.15.git136.959eb4b909-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 | # Copyright 2012 Hewlett-Packard Development Company, L.P.
#
# 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.
"""
The Metadata plugin module enables the ability to add metadata to the projects
that can be exposed to job environment.
Requires the Jenkins :jenkins-wiki:`Metadata Plugin <Metadata+plugin>`.
**Component**: metadata
:Macro: metadata
:Entry Point: jenkins_jobs.metadata
Example::
metadata:
- string:
name: FOO
value: bar
expose-to-env: true
"""
import xml.etree.ElementTree as XML
import jenkins_jobs.modules.base
def base_metadata(parser, xml_parent, data, mtype):
pdef = XML.SubElement(xml_parent, mtype)
XML.SubElement(pdef, 'name').text = data['name']
XML.SubElement(pdef, 'generated').text = 'false'
XML.SubElement(pdef, 'parent', attrib={"class": "job-metadata",
"reference": "../../.."})
exposed_to_env = XML.SubElement(pdef, 'exposedToEnvironment')
exposed_to_env.text = str(data.get('expose-to-env', False)).lower()
return pdef
def string_metadata(parser, xml_parent, data):
"""yaml: string
A string metadata.
:arg str name: the name of the metadata
:arg str value: the value of the metadata
:arg bool expose-to-env: expose to environment (optional)
Example::
metadata:
- string:
name: FOO
value: bar
expose-to-env: true
"""
pdef = base_metadata(parser, xml_parent, data,
'metadata-string')
value = data.get('value', '')
XML.SubElement(pdef, 'value').text = value
def number_metadata(parser, xml_parent, data):
"""yaml: number
A number metadata.
:arg str name: the name of the metadata
:arg str value: the value of the metadata
:arg bool expose-to-env: expose to environment (optional)
Example::
metadata:
- number:
name: FOO
value: 1
expose-to-env: true
"""
pdef = base_metadata(parser, xml_parent, data,
'metadata-number')
value = data.get('value', '')
XML.SubElement(pdef, 'value').text = value
def date_metadata(parser, xml_parent, data):
"""yaml: date
A date metadata
:arg str name: the name of the metadata
:arg str time: time value in millisec since 1970-01-01 00:00:00 UTC
:arg str timezone: time zone of the metadata
:arg bool expose-to-env: expose to environment (optional)
Example::
metadata:
- date:
name: FOO
value: 1371708900268
timezone: Australia/Melbourne
expose-to-env: true
"""
pdef = base_metadata(parser, xml_parent, data,
'metadata-date')
# TODO: convert time from any reasonable format into epoch
mval = XML.SubElement(pdef, 'value')
XML.SubElement(mval, 'time').text = data['time']
XML.SubElement(mval, 'timezone').text = data['timezone']
XML.SubElement(pdef, 'checked').text = 'true'
class Metadata(jenkins_jobs.modules.base.Base):
sequence = 21
component_type = 'metadata'
component_list_type = 'metadata'
def gen_xml(self, parser, xml_parent, data):
properties = xml_parent.find('properties')
if properties is None:
properties = XML.SubElement(xml_parent, 'properties')
metadata = data.get('metadata', [])
if metadata:
pdefp = XML.SubElement(properties,
'job-metadata', plugin="metadata@1.0b")
pdefs = XML.SubElement(pdefp, 'values')
for mdata in metadata:
self.registry.dispatch('metadata',
parser, pdefs, mdata)
|