File: label.py

package info (click to toggle)
python-jenkinsapi 0.3.14-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 420 kB
  • sloc: python: 4,241; makefile: 3
file content (50 lines) | stat: -rw-r--r-- 1,345 bytes parent folder | download
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
"""
Module for jenkinsapi labels
"""

from jenkinsapi.jenkinsbase import JenkinsBase
import logging

log = logging.getLogger(__name__)


class Label(JenkinsBase):
    """
    Class to hold information on labels that tied to a collection of jobs
    """

    def __init__(self, baseurl, labelname, jenkins_obj):
        """
        Init a label object by providing all relevant pointers to it
        :param baseurl: basic url for querying information on a node
        :param labelname: name of the label
        :param jenkins_obj: ref to the jenkins obj
        :return: Label obj
        """
        self.labelname = labelname
        self.jenkins = jenkins_obj
        self.baseurl = baseurl
        JenkinsBase.__init__(self, baseurl)

    def __str__(self):
        return "%s" % (self.labelname)

    def get_jenkins_obj(self):
        return self.jenkins

    def is_online(self):
        return not self.poll(tree="offline")["offline"]

    def get_tied_jobs(self):
        """
        Get a list of jobs.
        """
        if self.get_tied_job_names():
            for job in self.get_tied_job_names():
                yield self.get_jenkins_obj().get_job(job["name"])

    def get_tied_job_names(self):
        """
        Get a list of the name of tied jobs.
        """
        return self.poll(tree="tiedJobs[name]")["tiedJobs"]