Python – TuxLabs LLC

Python & The Jira Rest API

October 25, 2016 / Leave a Comment

Recently, while having to work a lot more in Jira than normal I got annoyed with the Jira Web GUI. So I wrote a script to do simple management of our jira issues. Here is the basic usage

(env) ➜  jira git:(master) ✗ ./jira-ctl.py
usage: jira-ctl.py [-h] [-lp] [-li LIST_PROJECT_ISSUES] [-ua UPDATE_ASSIGNEE]
                   [-ud UPDATE_DATE] [-usts UPDATE_STATUS]
                   [-usum UPDATE_SUMMARY]

optional arguments:
  -h, --help            show this help message and exit
  -lp, --list-projects  List all projects
  -li LIST_PROJECT_ISSUES, --list-issues LIST_PROJECT_ISSUES
                        List Issues for a specific project
  -ua UPDATE_ASSIGNEE, --update-assignee UPDATE_ASSIGNEE
                        Update an issues assignee format: <issue
                        number>,<first_last>
  -ud UPDATE_DATE, --update-date UPDATE_DATE
                        Update an issues due date format: <issue number
                        >,<yyyy-mm-dd>
  -usts UPDATE_STATUS, --update-status UPDATE_STATUS
                        Update an issues status format: <issue
                        number>,'<Open|In Progress|Resolved>'
  -usum UPDATE_SUMMARY, --update-summary UPDATE_SUMMARY
                        Update an issues summary format: <issue
                        number>,'<summary>'
(env) ➜  jira git:(master) ✗

(env) ➜ jira git:(master) ✗ ./jira-ctl.py

usage: jira-ctl.py [-h] [-lp] [-li LIST_PROJECT_ISSUES] [-ua UPDATE_ASSIGNEE]

[-ud UPDATE_DATE] [-usts UPDATE_STATUS]

[-usum UPDATE_SUMMARY]

optional arguments:

-h, --help show this help message and exit

-lp, --list-projects List all projects

-li LIST_PROJECT_ISSUES, --list-issues LIST_PROJECT_ISSUES

List Issues for a specific project

-ua UPDATE_ASSIGNEE, --update-assignee UPDATE_ASSIGNEE

Update an issues assignee format: <issue

number>,<first_last>

-ud UPDATE_DATE, --update-date UPDATE_DATE

Update an issues due date format: <issue number

>,<yyyy-mm-dd>

-usts UPDATE_STATUS, --update-status UPDATE_STATUS

Update an issues status format: <issue

number>,'<Open|In Progress|Resolved>'

-usum UPDATE_SUMMARY, --update-summary UPDATE_SUMMARY

Update an issues summary format: <issue

number>,'<summary>'

(env) ➜ jira git:(master) ✗

Here is the code…

from jira.client import JIRA
import os, sys
import prettytable
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('-lp', '--list-projects', action="store_true", dest="list_projects", required=False, help="List all projects")
parser.add_argument('-li', '--list-issues', action="store", dest="list_project_issues", required=False, help="List Issues for a specific project")
parser.add_argument('-ua', '--update-assignee', action="store", dest="update_assignee", required=False, help="Update an issues assignee format: <issue number>,<first_last>")
parser.add_argument('-ud', '--update-date', action="store", dest="update_date", required=False, help="Update an issues due date format: <issue number>,<yyyy-mm-dd>")
parser.add_argument('-usts', '--update-status', action="store", dest="update_status", required=False, help="Update an issues status format: <issue number>,'<Open|In Progress|Resolved>'")
parser.add_argument('-usum', '--update-summary', action="store", dest="update_summary", required=False, help="Update an issues summary format: <issue number>,'<summary>'")
args = parser.parse_args()

def get_pass():
    if os.environ.get('JIRA_PASS') == None:
        print "you must first export your JIRA_PASS in the shell by running: source getpass.sh"
        print 'or "export JIRA_PASS=<jira_password>'
        sys.exit()
    jira_password = str(os.environ['JIRA_PASS'])

    return jira_password

def connect_jira(jira_server, jira_user, jira_password):
    '''
    Connect to JIRA. Return None on error
    '''
    try:
        #print "Connecting to JIRA: %s" % jira_server
        jira_options = {'server': jira_server}
        jira = JIRA(options=jira_options,
                    # Note the tuple
                    basic_auth=(jira_user,
                                jira_password))
        return jira
    except Exception,e:
        print "Failed to connect to JIRA: %s" % e
        return None

def list_projects():
    projects = jira.projects()
    header = ["Projects"]
    table = prettytable.PrettyTable(header)
    for project in projects:
        row = [str(project)]
        table.add_row(row)
    print table

def list_project_issues(project):
    query = 'project = %s and status != Resolved order by due asc' % (project)
    #query = 'project = %s and status != Resolved order by due desc' % (project)
    #query = 'project = %s order by due desc' % (project)
    issues = jira.search_issues(query, maxResults=100)

    if issues:
        header = ["Ticket", "Summary", "Assignee", "Status", "Due Date"]
        table = prettytable.PrettyTable(header)

        for issue in issues:
                summary = issue.fields.summary
                st = str(issue.fields.status)
                dd = issue.fields.duedate
                assignee = issue.fields.assignee
                row = [issue, summary, assignee, st, dd]
                table.add_row(row)
        print table

def update_issue_assignee(issue_number, assignee):
    issue = jira.issue(issue_number)
    issue.update(assignee=assignee)
    print "updated %s with new Assignee: %s" % (issue_number, assignee)

def update_issue_duedate(issue_number, dd):
    issue = jira.issue(issue_number)
    issue.update(duedate=dd)
    print "updated %s with new Due Date: %s" % (issue_number, dd)

def update_issue_summary(issue_number, summary):
    issue = jira.issue(issue_number)
    issue.update(summary=summary)
    print "updated %s with new Summary: %s" % (issue_number, summary)

def update_issue_status(issue_number, status):
    # To figure out transitions view the following URL
    # https://jira.yourcompany.com/rest/api/2/issue/XXXXXX-22/transitions?expand=transitions.fields

    transitions = {
                    'Resolved': 11,
                    'Open': 41,
                    'In Progress': 21,
                    'Testing': 71,
                    'Transition': 81,
                    'Closed': 91,
    }

    issue = jira.issue(issue_number)
    jira.transition_issue(issue, transitions[status])
    print "updated %s with new Status: %s" % (issue_number, status)

if __name__ == "__main__":
    if not args:
        parser.print_help()
    else:
        jira_user = '<your_login>'
        jira_password = get_pass()
        jira_server = 'https://jira.yourcompany.com'

        jira = connect_jira(jira_server, jira_user, jira_password)

        if args.list_projects:
            list_projects()
        elif args.list_project_issues:
            project = args.list_project_issues
            list_project_issues(project)
        elif args.update_assignee:
            (issue_number, assignee) = args.update_assignee.split(',')
            update_issue_assignee(issue_number, assignee)
        elif args.update_date:
            (issue_number, dd) = args.update_date.split(',')
            update_issue_duedate(issue_number, dd)
        elif args.update_status:
            (issue_number, status) = args.update_status.split(',')
            update_issue_status(issue_number, status)
        elif args.update_summary:
            (issue_number, summary) = args.update_summary.split(',')
            update_issue_summary(issue_number, summary)
        else:
            parser.print_help()

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

from jira.client import JIRA

import os, sys

import prettytable

import argparse

parser = argparse.ArgumentParser()

parser.add_argument('-lp', '--list-projects', action="store_true", dest="list_projects", required=False, help="List all projects")

parser.add_argument('-li', '--list-issues', action="store", dest="list_project_issues", required=False, help="List Issues for a specific project")

parser.add_argument('-ua', '--update-assignee', action="store", dest="update_assignee", required=False, help="Update an issues assignee format: <issue number>,<first_last>")

parser.add_argument('-ud', '--update-date', action="store", dest="update_date", required=False, help="Update an issues due date format: <issue number>,<yyyy-mm-dd>")

parser.add_argument('-usts', '--update-status', action="store", dest="update_status", required=False, help="Update an issues status format: <issue number>,'<Open|In Progress|Resolved>'")

parser.add_argument('-usum', '--update-summary', action="store", dest="update_summary", required=False, help="Update an issues summary format: <issue number>,'<summary>'")

args = parser.parse_args()

def get_pass():

if os.environ.get('JIRA_PASS') == None:

print "you must first export your JIRA_PASS in the shell by running: source getpass.sh"

print 'or "export JIRA_PASS=<jira_password>'

sys.exit()

jira_password = str(os.environ['JIRA_PASS'])

return jira_password

def connect_jira(jira_server, jira_user, jira_password):

'''

Connect to JIRA. Return None on error

'''

try:

#print "Connecting to JIRA: %s" % jira_server

jira_options = {'server': jira_server}

jira = JIRA(options=jira_options,

# Note the tuple

basic_auth=(jira_user,

jira_password))

return jira

except Exception,e:

print "Failed to connect to JIRA: %s" % e

return None

def list_projects():

projects = jira.projects()

header = ["Projects"]

table = prettytable.PrettyTable(header)

for project in projects:

row = [str(project)]

table.add_row(row)

print table

def list_project_issues(project):

query = 'project = %s and status != Resolved order by due asc' % (project)

#query = 'project = %s and status != Resolved order by due desc' % (project)

#query = 'project = %s order by due desc' % (project)

issues = jira.search_issues(query, maxResults=100)

if issues:

header = ["Ticket", "Summary", "Assignee", "Status", "Due Date"]

table = prettytable.PrettyTable(header)

for issue in issues:

summary = issue.fields.summary

st = str(issue.fields.status)

dd = issue.fields.duedate

assignee = issue.fields.assignee

row = [issue, summary, assignee, st, dd]

table.add_row(row)

print table

def update_issue_assignee(issue_number, assignee):

issue = jira.issue(issue_number)

issue.update(assignee=assignee)

print "updated %s with new Assignee: %s" % (issue_number, assignee)

def update_issue_duedate(issue_number, dd):

issue = jira.issue(issue_number)

issue.update(duedate=dd)

print "updated %s with new Due Date: %s" % (issue_number, dd)

def update_issue_summary(issue_number, summary):

issue = jira.issue(issue_number)

issue.update(summary=summary)

print "updated %s with new Summary: %s" % (issue_number, summary)

def update_issue_status(issue_number, status):

# To figure out transitions view the following URL

# https://jira.yourcompany.com/rest/api/2/issue/XXXXXX-22/transitions?expand=transitions.fields

transitions = {

'Resolved': 11,

'Open': 41,

'In Progress': 21,

'Testing': 71,

'Transition': 81,

'Closed': 91,

}

issue = jira.issue(issue_number)

jira.transition_issue(issue, transitions[status])

print "updated %s with new Status: %s" % (issue_number, status)

if __name__ == "__main__":

if not args:

parser.print_help()

else:

jira_user = '<your_login>'

jira_password = get_pass()

jira_server = 'https://jira.yourcompany.com'

jira = connect_jira(jira_server, jira_user, jira_password)

if args.list_projects:

list_projects()

elif args.list_project_issues:

project = args.list_project_issues

list_project_issues(project)

elif args.update_assignee:

(issue_number, assignee) = args.update_assignee.split(',')

update_issue_assignee(issue_number, assignee)

elif args.update_date:

(issue_number, dd) = args.update_date.split(',')

update_issue_duedate(issue_number, dd)

elif args.update_status:

(issue_number, status) = args.update_status.split(',')

update_issue_status(issue_number, status)

elif args.update_summary:

(issue_number, summary) = args.update_summary.split(',')

update_issue_summary(issue_number, summary)

else:

parser.print_help()

Later, I found out that there is a Jira command line … [Read more…]

How to use Boto to Audit your AWS EC2 instance security groups

June 6, 2016 / Leave a Comment

Boto is a Software Development Kit for accessing the AWS API’s using Python. https://github.com/boto/boto3 Recently, I needed to determine how many of my EC2 instances were spawned in a public subnet, that also had security groups with wide open access on any port via any protocol to the instances. Because I have an IGW (Internet … [Read more…]

Fun with Python, Tabular & AWS IP ranges

March 9, 2016 / Leave a Comment

I have been spending a lot of time designing a Hybrid Cloud that consists of Openstack and public cloud platforms. In particular I have been spending a lot of time designing the AWS portion of the Hybrid Cloud Platform. Today I found myself continually needing to look up AWS public address space and then parsing out … [Read more…]

How To: curl the Openstack API’s (v3 Keystone Auth)

February 19, 2016 / Leave a Comment

While Openstack provides a python client(s) for interactions….

[root@diamond ~]# source keystonerc_tuxninja
[root@diamond ~(keystone_tuxninja)]# openstack server list
+--------------------------------------+-------+--------+----------------------------------------+
| ID                                   | Name  | Status | Networks                               |
+--------------------------------------+-------+--------+----------------------------------------+
| e5b35d6a-a9ba-4714-a9e1-6361706bd047 | spin1 | ACTIVE | private_tuxlabs=10.0.0.8, 192.168.1.52 |
+--------------------------------------+-------+--------+----------------------------------------+
[root@diamond ~(keystone_tuxninja)]#

[root@diamond ~]# source keystonerc_tuxninja

[root@diamond ~(keystone_tuxninja)]# openstack server list

+--------------------------------------+-------+--------+----------------------------------------+

+--------------------------------------+-------+--------+----------------------------------------+

+--------------------------------------+-------+--------+----------------------------------------+

[root@diamond ~(keystone_tuxninja)]#

I frequently, finding myself needing to get data out of it without the pain of awk/sed’ing out the ASCII art. Thus to quickly access the raw data, we can directly query the API’s using curl & parsing JSON instead, which is much better 🙂 Authentication Before … [Read more…]

Introducing Vault

August 25, 2015 / Leave a Comment

Vault Vault is a command line utility for encrypting & decrypting things. Those things are stored on disk in hidden files, meaning in *nix they simply have a ‘.’ in front and don’t show up unless you type ls -la 😉 But anyway, who cares if someone can locate the files ! They are AES encrypted … [Read more…]