Queue class to represent the Jenkins queue: lists the items and deletes them

diff --git a/jenkinsapi/jenkins.py b/jenkinsapi/jenkins.py
index d5cc530..cb4b0b1 100644 (file)
--- a/jenkinsapi/jenkins.py
+++ b/jenkinsapi/jenkins.py
@@ -3,6 +3,7 @@ from jenkinsapi.fingerprint import Fingerprint
 from jenkinsapi.jenkinsbase import JenkinsBase
 from jenkinsapi.job import Job
 from jenkinsapi.node import Node
+from jenkinsapi.queue import Queue
 from jenkinsapi.view import View
 from jenkinsapi import config
 from utils.urlopener import mkurlopener, mkopener, NoAuto302Handler
@@ -338,6 +339,14 @@ class Jenkins(JenkinsBase):
         url = "%(baseurl)s/computer/%(nodename)s" % {'baseurl': self.baseurl, 'nodename': urllib.quote(nodename)}
         return url
 
+    def get_queue_url(self):
+        url = "%(baseurl)s/queue/" % {'baseurl': self.get_base_server_url()}
+        return url
+
+    def get_queue(self):
+        queue_url = self.get_queue_url()
+        return Queue(queue_url, self)
+
     def has_node(self, nodename):
         """
         Does a node by the name specified exist

diff --git a/jenkinsapi/job.py b/jenkinsapi/job.py
index b2b2767..52b5b24 100644 (file)
--- a/jenkinsapi/job.py
+++ b/jenkinsapi/job.py
@@ -401,8 +401,8 @@ class Job(JenkinsBase):
         if not self.is_queued():
             raise NotInQueue()
         queue_id = self._data['queueItem']['id']
-        cancelurl = urlparse.urljoin(self.get_jenkins_obj().get_base_server_url(),
-                                     'queue/cancelItem?id=%s' % queue_id)
+        cancelurl = urlparse.urljoin(self.get_jenkins_obj().get_queue().baseurl,
+                                     'cancelItem?id=%s' % queue_id)
         try:
             self.post_data(cancelurl, '')
         except urllib2.HTTPError:

diff --git a/jenkinsapi/queue.py b/jenkinsapi/queue.py
new file mode 100644 (file)
index 0000000..164c81c
--- /dev/null
+++ b/jenkinsapi/queue.py
@@ -0,0 +1,55 @@
+from jenkinsapi.jenkinsbase import JenkinsBase
+import logging
+import urlparse
+import urllib2
+
+log = logging.getLogger(__name__)
+
+class Queue(JenkinsBase):
+    """
+    Class that represents the Jenkins queue
+    """
+
+    def __init__(self, baseurl, jenkins_obj):
+        """
+        Init the Jenkins queue object
+        :param baseurl: basic url for the queue
+        :param jenkins_obj: ref to the jenkins obj
+        """
+        self.jenkins = jenkins_obj
+        JenkinsBase.__init__(self, baseurl)
+
+    def get_jenkins_obj(self):
+        return self.jenkins
+
+    def get_queue_items(self, job_name = None):
+        if not job_name:
+            return [QueueItem(**item) for item in self._data['items']]
+        else:
+            return [QueueItem(**item) for item in self._data['items']
+                   if item['task']['name'] == job_name]
+
+    def delete_item(self, queue_item):
+        self.delete_item_by_id(queue_item.id)
+
+    def delete_item_by_id(self, item_id):
+        deleteurl = urlparse.urljoin(self.baseurl,
+                                     'cancelItem?id=%s' % item_id)
+        try:
+            self.post_data(deleteurl, '')
+        except urllib2.HTTPError:
+            # The request doesn't have a response, so it returns 404,
+            # it's the expected behaviour
+            pass
+
+
+class QueueItem(object):
+    """
+    Flexible class to handle queue items. If the Jenkins API changes this support
+    those changes
+    """
+
+    def __init__(self, **kwargs):
+        for arg in kwargs:
+            setattr(self, arg, kwargs[arg])
+