File: executor.py

package info (click to toggle)
python-jenkinsapi 0.3.17-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,500 kB
  • sloc: python: 10,001; xml: 50; makefile: 31; sh: 26
file content (67 lines) | stat: -rw-r--r-- 1,889 bytes parent folder | download | duplicates (2)
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
"""
Module for jenkinsapi Executer class
"""

from __future__ import annotations

from jenkinsapi.jenkinsbase import JenkinsBase
import logging

log = logging.getLogger(__name__)


class Executor(JenkinsBase):
    """
    Class to hold information on nodes that are attached as slaves to the
    master jenkins instance
    """

    def __init__(
        self, baseurl: str, nodename: str, jenkins_obj: "Jenkins", number: int
    ) -> None:
        """
        Init a node object by providing all relevant pointers to it
        :param baseurl: basic url for querying information on a node
        :param nodename: hostname of the node
        :param jenkins_obj: ref to the jenkins obj
        :return: Node obj
        """
        self.nodename: str = nodename
        self.number: int = number
        self.jenkins: "Jenkins" = jenkins_obj
        self.baseurl: str = baseurl
        JenkinsBase.__init__(self, baseurl)

    def __str__(self) -> str:
        return f"{self.nodename} {self.number}"

    def get_jenkins_obj(self) -> "Jenkins":
        return self.jenkins

    def get_progress(self) -> str:
        """Returns percentage"""
        return self.poll(tree="progress")["progress"]

    def get_number(self) -> int:
        """
        Get Executor number.
        """
        return self.poll(tree="number")["number"]

    def is_idle(self) -> bool:
        """
        Returns Boolean: whether Executor is idle or not.
        """
        return self.poll(tree="idle")["idle"]

    def likely_stuck(self) -> bool:
        """
        Returns Boolean: whether Executor is likely stuck or not.
        """
        return self.poll(tree="likelyStuck")["likelyStuck"]

    def get_current_executable(self) -> str:
        """
        Returns the current Queue.Task this executor is running.
        """
        return self.poll(tree="currentExecutable")["currentExecutable"]