Skip to content
This repository was archived by the owner on Sep 6, 2025. It is now read-only.

Add support for the CSRF protection #1

Open
nigelbabu wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for the CSRF protection #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 55 additions & 14 deletions jenkins-trigger-console.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"""jenkins-trigger-console.py

Usage:
jenkins-trigger-console.py --job <jobname> [--url <url>] [--sleep <sleep_time>] [--encoding <type>] [--parameters <data>] [--wait-timer <time>] [--debug]
jenkins-trigger-console.py --job <jobname> [--url <url>] [--sleep <sleep_time>] [--encoding <type>] [--parameters <data>] [--wait-timer <time>] [--debug] [--user <username>] [--pass <password>]
jenkins-trigger-console.py -h

Examples:
Expand All @@ -14,6 +14,8 @@
-s, --sleep <sleep_time> Sleep time between polling requests [default: 2]
-w, --wait-timer <time> Wait time in queue [default: 100]
-e, --encoding <type> Encoding type supports text or html [default: html]
--user <username> Username for the remote Jenkins user
--pass <password> Password or API key for the remote Jenkins user
-p, --parameters <data> Comma separated job parameters i.e. a=1,b=2
-d, --debug Print debug info
-h, --help Show this screen and exit.
Expand All @@ -22,12 +24,13 @@
import requests
from docopt import docopt
from time import sleep
import os


class Trigger():
def __init__(self, arguments):
self.arguments = arguments
self.debug = arguments['--debug']
self.debug = arguments['--debug']
if self.debug:
print "argument = ", arguments
self.url = arguments['--url']
Expand All @@ -36,10 +39,17 @@ def __init__(self, arguments):
self.sleep = int(arguments['--sleep'])
self.encoding = arguments['--encoding']
self.debug = arguments['--debug']
username = os.environ.get('REMOTE_JENKINS_USER') or os.arguments['--user']
password = os.environ.get('REMOTE_JENKINS_PASS') or arguments['--pass']
self.crumb = None
self.auth = None
if username and password:
self.auth = (username, password)
self.crumb = self.get_crumb()
if self.encoding.lower() in ["html", "text"]:
self.encoding = self.encoding.title()
else:
print " '%s' is not a valid encoding only support 'text', 'html'" % self.encoding
print " '%s' is not a valid encoding only support 'text', 'html'" % self.encoding
exit(1)
if arguments['--parameters']:
try:
Expand All @@ -50,18 +60,45 @@ def __init__(self, arguments):
else:
self.parameters = False


def get_crumb(self):
# Get Jenkins crumb
r = requests.get(self.url + '/crumbIssuer/api/json',
auth=self.auth
)
r.raise_for_status()
crumb_data = r.json()
return {
crumb_data['crumbRequestField']: crumb_data['crumb']
}


def trigger_build(self):

# Do a build request
if self.parameters:
build_url = self.url + "/job/" + self.job + "/buildWithParameters"
print "Triggering a build via post @ ", build_url
build_request = requests.post(build_url,data=self.parameters)
if self.auth:
build_request = requests.post(build_url,
data=self.parameters,
auth=self.auth,
headers=self.crumb
)
else:
build_request = requests.post(build_url, data=self.parameters)

else:
build_url = self.url + "/job/" + self.job + "/build"
print "Triggering a build via get @ ", build_url
build_request = requests.get(build_url)

if self.auth:
build_request = requests.get(build_url,
auth=(self.username,self.password),
headers={crumb_data['key']: crumb_data['value']}
)
else:
build_request = requests.get(build_url),


if build_request.status_code == 201:
queue_url = build_request.headers['location'] + "/api/json"
print "Build is queued @ ", queue_url
Expand All @@ -71,14 +108,14 @@ def trigger_build(self):
print build_request.text
exit(1)
return queue_url

def waiting_for_job_to_start(self, queue_url):
# Poll till we get job number
print ""
print "Starting polling for our job to start"
timer = self.timer

waiting_for_job = True
waiting_for_job = True
while waiting_for_job:
queue_request = requests.get(queue_url)
if queue_request.json().get("why") != None:
Expand All @@ -87,15 +124,16 @@ def waiting_for_job_to_start(self, queue_url):
sleep(self.sleep)
else:
waiting_for_job = False
job_number = queue_request.json().get("executable").get("number")
print " Job is being build number: ", job_number
job_number = queue_request.json().get("executable").get("number")
print " Job is being build number: ", job_number

if timer == 0:
print " time out waiting for job to start"
exit(1)
# Return the job numner of the working
return job_number



def console_output(self, job_number):
# Get job console till job stops
job_url = self.url + "/job/" + self.job + "/" + str(job_number) + "/logText/progressive" + self.encoding
Expand All @@ -106,7 +144,10 @@ def console_output(self, job_number):

console_requests = requests.session()
while stream_open:
console_response = console_requests.post(job_url, data={'start': start_at })
if self.auth:
console_response = console_requests.post(job_url, data={'start': start_at }, auth=self.auth, headers=self.crumb)
else:
console_response = console_requests.post(job_url, data={'start': start_at })
content_length = int(console_response.headers.get("Content-Length",-1))

if console_response.status_code != 200:
Expand Down Expand Up @@ -137,7 +178,7 @@ def console_output(self, job_number):
else:
# Job is still running
check_job_status = 0

def main(self):
queue_url = self.trigger_build()
job_number = self.waiting_for_job_to_start(queue_url)
Expand Down