Merge pull request phwitservices#1 from akardes/master

Configurable api version and protocol

README.md

@@ -7,7 +7,9 @@ The properties file has the format
 {
 	"RUNDECKSERVER": "rundeck server name or IP address",
 	"PORT": 4440,
+	"SSL": false,
 	"API_KEY": "API Key with correct privileges",
+	"API_VERSION": 17,
 	"PAGE_SIZE": 1000,
 	"MAXIMUM_DAYS": 90,
 	"TIMEOUT": 60,
@@ -21,4 +23,6 @@ The other settings should be OK for most installs.
 
 If the job keeps timing out try setting a smaller PAGE_SIZE which will query jobs in smaller batches. The first time you run this script it will probably take a while, if you run it regularly after that then the number of deletions should be lower and the script will therefore execute more quickly.
 
-The script is tested and working on v2.4.0-1 "americano indigo briefcase". I've tried on a v2.2 installation but the job execution format seems to be different.
+The script is tested and working on v2.4.0-1 "americano indigo briefcase" and 2.6.6 "cafe bonbon fuchsia phone".  Remember to configure the api version corresponding to your Rundeck version.
+
+I've tried on a v2.2 installation but the job execution format seems to be different.

RundeckLogfileCleanup.py

@@ -1,145 +1,151 @@
-#!/usr/bin/python
-import requests
-import xml.etree.ElementTree as ET
-import time
-import json
-import sys
-
-# Returns list of all the project names
-def get_projects():
-    global PROPERTIES
-    global HEADERS
-    project_names = []
-    try:
-        url = URL + 'projects'
-        r = requests.get(url, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])
-        root = ET.fromstring(r.text)
-        for project in root:	
-            for name in project.findall('name'):
-                project_names.append(name.text)
-    except:
-        print "Problem with project listing {0}".format(r)
-        pass
-    return project_names   
-
-# Returns list of all the jobids
-def get_jobs_for_project(project_name):
-    global PROPERTIES
-    global HEADERS
-    job_ids = []
-    try:
-        url = URL + 'jobs'
-        payload = { 'project':  project_name }
-        r = requests.get(url, params=payload, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])    
-        root = ET.fromstring(r.text)	
-        for job in root:
-            job_ids.append( (job.attrib['id'],job.find('name').text) )
-    except:
-        print "Problem with job listing {0}".format(r)
-        pass
-    return job_ids
-
-# API call to get a page of the executions for a particular job id      
-def get_executions_for_job(job_id,page):
-    global PROPERTIES
-    global HEADERS
-    root = None
-    try:
-        url = URL + 'job/'+job_id+'/executions'
-        r = requests.get(url, params={'max':PROPERTIES['PAGE_SIZE'],'offset':page*PROPERTIES['PAGE_SIZE']}, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])
-        root = ET.fromstring(r.text)
-    except:
-        print "Problem with execution listing {0}".format(r)
-        pass
-    return root
-
-#
-# Return a dictionary of execute ids & dates
-#
-def get_execution_dates(root):
-    execid_dates = {}
-    try:
-        for execution in root:
-            execution_id = execution.get('id')
-            for date in execution.findall('date-ended'):
-                execution_date = date.get('unixtime')
-            execid_dates[execution_id] = execution_date
-    except:
-        pass
-    return execid_dates
-
-#API call to delete an execution by ID
-def delete_execution(execution_id):
-    global PROPERTIES
-    global HEADERS
-    url = URL + 'execution/'+execution_id
-    try:
-        r = requests.delete(url, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])
-        if PROPERTIES['VERBOSE']:
-            print "            Deleted execution id {0} {1} {2}".format( execution_id, r.text, r )
-    except:
-        pass
-
-#API call to bulk delete executions by ID
-def delete_executions(execution_ids):
-    global PROPERTIES
-    global HEADERS
-    url = URL + 'executions/delete'
-    try:
-        r = requests.post(url, headers=HEADERS, data= json.dumps({'ids':execution_ids}) , verify=False,timeout=PROPERTIES['DELETE_TIMEOUT'])
-        if PROPERTIES['VERBOSE']:
-            print "            Deleted execution ids {0}".format( execution_ids, r.text, r )
-    except:
-        try:
-            print "Problem with execution deletion {0}".format(r)
-        except:
-            pass
-        pass
-
-def delete_test(execution_date):
-    global PROPERTIES
-    global TODAY
-    millis_in_one_day = 1000*60*60*24
-    return ((TODAY - execution_date) > millis_in_one_day * PROPERTIES['MAXIMUM_DAYS'])
-
-def check_deletion(execid_dates):
-    delete= ()
-    for exec_id, exec_date in execid_dates.iteritems():
-        if delete_test( int(exec_date) ):
-            delete  += (exec_id,)
-    print "        Delete {0} jobs from this page".format( len(delete) )
-    return delete
-
-#
-# Main
-#
-setting_filename = sys.argv[1] if len(sys.argv)>1 else 'properties.json'
-with open(setting_filename,'r') as props_file:    
-    PROPERTIES = json.load( props_file )
-
-API_VERSION = 12
-URL = 'http://{0}:{1}/api/{2}/'.format( PROPERTIES['RUNDECKSERVER'],PROPERTIES['PORT'],API_VERSION)
-HEADERS = {'Content-Type': 'application/json','X-RunDeck-Auth-Token': PROPERTIES['API_KEY'] }
-
-TODAY = int(round(time.time() * 1000))
-
-for project in get_projects():
-    print project
-    for (jobid,jobname) in get_jobs_for_project(project):
-        print "    {0}".format(jobname)
-        page = 0
-        deleteable = ()
-        more = True
-        while more :
-            try:
-                execution_root = get_executions_for_job(jobid,page)
-                print "        Page {0} got {1} jobs".format(page,execution_root.attrib['count'])
-                page += 1
-                deleteable += check_deletion(get_execution_dates(execution_root))
-                more = int(execution_root.attrib['count']) == PROPERTIES['PAGE_SIZE']
-            except:
-                print "Problem with executions {0} {1}".format(execution_root,sys.exc_info()[0])
-                more = False
-        if (len(deleteable) > 0 ):
-            print "        Deleting {0} jobs in total".format( len(deleteable) )
-            delete_executions(deleteable)
+#!/usr/bin/python
+import requests
+from requests.packages.urllib3.exceptions import InsecureRequestWarning
+import xml.etree.ElementTree as ET
+import time
+import json
+import sys
+
+# Returns list of all the project names
+def get_projects():
+    global PROPERTIES
+    global HEADERS
+    project_names = []
+    try:
+        url = URL + 'projects'
+        r = requests.get(url, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])
+        root = ET.fromstring(r.text)
+        for project in root:	
+            for name in project.findall('name'):
+                project_names.append(name.text)
+    except:
+        print "Problem with project listing {0}".format(r)
+        pass
+    return project_names   
+
+# Returns list of all the jobids
+def get_jobs_for_project(project_name):
+    global PROPERTIES
+    global HEADERS
+    job_ids = []
+    try:
+        url = URL + 'jobs'
+        payload = { 'project':  project_name }
+        r = requests.get(url, params=payload, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])    
+        root = ET.fromstring(r.text)	
+        for job in root:
+            job_ids.append( (job.attrib['id'],job.find('name').text) )
+    except:
+        print "Problem with job listing {0}".format(r)
+        pass
+    return job_ids
+
+# API call to get a page of the executions for a particular job id      
+def get_executions_for_job(job_id,page):
+    global PROPERTIES
+    global HEADERS
+    root = None
+    try:
+        url = URL + 'job/'+job_id+'/executions'
+        r = requests.get(url, params={'max':PROPERTIES['PAGE_SIZE'],'offset':page*PROPERTIES['PAGE_SIZE']}, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])
+        root = ET.fromstring(r.text)
+    except:
+        print "Problem with execution listing {0}".format(r)
+        pass
+    return root
+
+#
+# Return a dictionary of execute ids & dates
+#
+def get_execution_dates(root):
+    execid_dates = {}
+    try:
+        for execution in root:
+            execution_id = execution.get('id')
+            for date in execution.findall('date-ended'):
+                execution_date = date.get('unixtime')
+            execid_dates[execution_id] = execution_date
+    except:
+        pass
+    return execid_dates
+
+#API call to delete an execution by ID
+def delete_execution(execution_id):
+    global PROPERTIES
+    global HEADERS
+    url = URL + 'execution/'+execution_id
+    try:
+        r = requests.delete(url, headers=HEADERS, verify=False,timeout=PROPERTIES['TIMEOUT'])
+        if PROPERTIES['VERBOSE']:
+            print "            Deleted execution id {0} {1} {2}".format( execution_id, r.text, r )
+    except:
+        pass
+
+#API call to bulk delete executions by ID
+def delete_executions(execution_ids):
+    global PROPERTIES
+    global HEADERS
+    url = URL + 'executions/delete'
+    try:
+        r = requests.post(url, headers=HEADERS, data= json.dumps({'ids':execution_ids}) , verify=False,timeout=PROPERTIES['DELETE_TIMEOUT'])
+        if PROPERTIES['VERBOSE']:
+            print "            Deleted execution ids {0}".format( execution_ids, r.text, r )
+    except:
+        try:
+            print "Problem with execution deletion {0}".format(r)
+        except:
+            pass
+        pass
+
+def delete_test(execution_date):
+    global PROPERTIES
+    global TODAY
+    millis_in_one_day = 1000*60*60*24
+    return ((TODAY - execution_date) > millis_in_one_day * PROPERTIES['MAXIMUM_DAYS'])
+
+def check_deletion(execid_dates):
+    delete= ()
+    for exec_id, exec_date in execid_dates.iteritems():
+        if delete_test( int(exec_date) ):
+            delete  += (exec_id,)
+    print "        Delete {0} jobs from this page".format( len(delete) )
+    return delete
+
+#
+# Main
+#
+setting_filename = sys.argv[1] if len(sys.argv)>1 else 'properties.json'
+with open(setting_filename,'r') as props_file:    
+    PROPERTIES = json.load( props_file )
+
+protocol='http'
+if PROPERTIES['SSL']:
+	protocol='https'
+	# disable warnings about unverified https connections
+	requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
+
+URL = '{0}://{1}:{2}/api/{3}/'.format(protocol,PROPERTIES['RUNDECKSERVER'],PROPERTIES['PORT'],PROPERTIES['API_VERSION'])
+HEADERS = {'Content-Type': 'application/json','X-RunDeck-Auth-Token': PROPERTIES['API_KEY'] }
+
+TODAY = int(round(time.time() * 1000))
+
+for project in get_projects():
+    print project
+    for (jobid,jobname) in get_jobs_for_project(project):
+        print "    {0}".format(jobname)
+        page = 0
+        deleteable = ()
+        more = True
+        while more :
+            try:
+                execution_root = get_executions_for_job(jobid,page)
+                print "        Page {0} got {1} jobs".format(page,execution_root.attrib['count'])
+                page += 1
+                deleteable += check_deletion(get_execution_dates(execution_root))
+                more = int(execution_root.attrib['count']) == PROPERTIES['PAGE_SIZE']
+            except:
+                print "Problem with executions {0} {1}".format(execution_root,sys.exc_info()[0])
+                more = False
+        if (len(deleteable) > 0 ):
+            print "        Deleting {0} jobs in total".format( len(deleteable) )
+            delete_executions(deleteable)

properties.json

@@ -1,7 +1,9 @@
 {
 	"RUNDECKSERVER": "rundeck server name or IP address",
 	"PORT": 4440,
+	"SSL": false,
 	"API_KEY": "API Key with correct privileges",
+	"API_VERSION": "17",
 	"PAGE_SIZE": 1000,
 	"MAXIMUM_DAYS": 90,
 	"TIMEOUT": 60,