#!/usr/bin/env python
# -*- coding: utf-8 -*-
###############################################################################
# The MIT License
#
# Copyright (c) 2016 Grigory Chernyshev
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
###############################################################################
import csv
from six import StringIO
from yagocd.resources import BaseManager
from yagocd.util import RequireParamMixin, since
@since('14.3.0')
[docs]class PropertyManager(BaseManager, RequireParamMixin):
"""
The properties API allows managing of job properties.
`Official documentation. <https://api.go.cd/current/#properties>`_
:versionadded: 14.3.0.
This class implements dictionary like methods for similar use.
"""
RESOURCE_PATH = '{base_api}/properties/{pipeline_name}/{pipeline_counter}/{stage_name}/{stage_counter}/{job_name}'
PATH_PARAMETERS = ['pipeline_name', 'pipeline_counter', 'stage_name', 'stage_counter', 'job_name']
def __init__(
self,
session,
pipeline_name=None,
pipeline_counter=None,
stage_name=None,
stage_counter=None,
job_name=None
):
"""
Constructs instance of ``PropertyManager``.
Parameters to the constructor and methods of the class could be duplicated. That is because of two use cases
of this class:
1. When the class being instantiated from :class:`yagocd.client.Client`, we don't know all the necessary
parameters yet, but we need an instance to work with. So we skip parameters instantiation in constructor,
but require them for each method.
2. When the class being used from :class:`yagocd.resources.job.JobInstance` - in this case we already
know all required parameters, so we can instantiate `PropertyManager` with them.
:param session: session object from client.
:type session: yagocd.session.Session.
:param pipeline_name: name of the pipeline.
:param pipeline_counter: pipeline counter.
:param stage_name: name of the stage.
:param stage_counter: stage counter.
:param job_name: name of the job.
"""
super(PropertyManager, self).__init__(session)
self.base_api = self._session.base_api(api_path='')
self._pipeline_name = pipeline_name
self._pipeline_counter = pipeline_counter
self._stage_name = stage_name
self._stage_counter = stage_counter
self._job_name = job_name
def __len__(self):
return len(self.list())
def __iter__(self):
"""
Method for iterating over all properties.
:return: dictionary of properties.
:rtype: dict[str, str]
"""
return iter(self.list())
def __getitem__(self, name):
"""
Method for accessing to specific property in array-like manner by name.
Method for downloading artifact or directory zip by given path.
:param name: name of property to get.
:return: single property as a dictionary.
"""
return self.get(name=name)
def __contains__(self, key):
return key in self.list()
[docs] def keys(self):
return self.list().keys()
[docs] def values(self):
return self.list().values()
[docs] def items(self):
return self.list().items()
[docs] def list(
self,
pipeline_name=None,
pipeline_counter=None,
stage_name=None,
stage_counter=None,
job_name=None
):
"""
Lists all job properties.
:versionadded: 14.3.0.
:param pipeline_name: name of the pipeline.
:param pipeline_counter: pipeline counter.
:param stage_name: name of the stage.
:param stage_counter: stage counter.
:param job_name: name of the job.
:return: dictionary of properties.
:rtype: dict[str, str]
"""
func_args = locals()
parameters = {p: self._require_param(p, func_args) for p in self.PATH_PARAMETERS}
response = self._session.get(
path=self.RESOURCE_PATH.format(base_api=self.base_api, **parameters),
headers={'Accept': 'application/json'},
)
text = StringIO(response.text)
parsed = list(csv.reader(text))
properties = dict(zip(parsed[0], parsed[1]))
return properties
[docs] def get(
self,
name,
pipeline_name=None,
pipeline_counter=None,
stage_name=None,
stage_counter=None,
job_name=None
):
"""
Gets a property value by it's name.
:info: You can use keyword `latest` as a pipeline counter or a stage counter.
:versionadded: 14.3.0.
:param name: name of property to get.
:param pipeline_name: name of the pipeline.
:param pipeline_counter: pipeline counter.
:param stage_name: name of the stage.
:param stage_counter: stage counter.
:param job_name: name of the job.
:return: value of requested property.
"""
func_args = locals()
parameters = {p: self._require_param(p, func_args) for p in self.PATH_PARAMETERS}
response = self._session.get(
path=self._session.urljoin(self.RESOURCE_PATH, name).format(base_api=self.base_api, **parameters),
headers={'Accept': 'application/json'},
)
text = StringIO(response.text)
parsed = list(csv.reader(text))
try:
return parsed[1][0]
except IndexError:
return None
[docs] def historical(self, pipeline_name=None, stage_name=None, job_name=None, limit_pipeline=None, limit_count=None):
"""
Get historical properties.
:info: `limitPipeline` and `limitCount` are optional parameters. The default value of
`limitPipeline` is latest pipeline instance’s counter. The default value of `limitCount` is `100`.
:versionadded: 14.3.0.
:param pipeline_name: name of the pipeline.
:param stage_name: name of the stage.
:param job_name: name of the job.
:param limit_pipeline: pipeline limit for returned properties.
:param limit_count: count limit for returned properties.
:return: list of dictionaries as historical values.
"""
func_args = locals()
parameters = {
'pipelineName': self._require_param('pipeline_name', func_args),
'stageName': self._require_param('stage_name', func_args),
'jobName': self._require_param('job_name', func_args),
}
if limit_pipeline is not None:
parameters['limitPipeline'] = limit_pipeline
if limit_count is not None:
parameters['limitCount'] = limit_count
response = self._session.get(
path='{base_api}/properties/search'.format(base_api=self.base_api),
params=parameters,
headers={'Accept': 'application/json'},
)
text = StringIO(response.text)
result = list(csv.DictReader(text))
return result
[docs] def create(
self,
name,
value,
pipeline_name=None,
pipeline_counter=None,
stage_name=None,
stage_counter=None,
job_name=None
):
"""
Defines a property on a specific job instance.
:versionadded: 14.3.0.
:param name: name of property.
:param value: value of property.
:param pipeline_name: name of the pipeline.
:param pipeline_counter: pipeline counter.
:param stage_name: name of the stage.
:param stage_counter: stage counter.
:param job_name: name of the job.
:return: an acknowledgement that the property was created.
"""
func_args = locals()
parameters = {p: self._require_param(p, func_args) for p in self.PATH_PARAMETERS}
response = self._session.post(
path=self._session.urljoin(self.RESOURCE_PATH, name).format(base_api=self.base_api, **parameters),
data={'value': value},
headers={
'Accept': 'application/json',
'Confirm': 'true'
},
)
return response.text