def test_cookie_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.session.cookies['key'] = 'value'
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertFalse('Authorization' in self.server.last_request.headers)
def test_cookie_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.session.cookies['key'] = 'value'
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertFalse('Authorization' in self.server.last_request.headers)
def test_basic_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertEqual(self.server.last_request.headers.get('Authorization'),
'Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
def test_basic_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertEqual(self.server.last_request.headers.get('Authorization'),
'Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
def login(base_url):
"""Authenticate with JIRA server"""
email, password = get_credentials(base_url)
if email is not None:
if not click.confirm('This server is already configured. Override?'):
return
click.echo('Enter your JIRA credentials')
email = click.prompt('Email', type=str)
password = click.prompt('Password', type=str, hide_input=True)
client = JIRAClient(base_url, auth=(email, password))
check_login(client)
set_credentials(base_url, email, password)
def cli(ctx, base_url):
if not ctx.obj:
if ctx.invoked_subcommand == 'login':
ctx.obj = base_url
else:
email, password = get_credentials(base_url)
if not email or not password:
click.echo(
'== Authentication not configured. Run `goji login`')
exit()
ctx.obj = JIRAClient(base_url, auth=(email, password))
if len(ctx.obj.session.cookies) > 0:
check_login(ctx.obj)
def setUp(self):
super(ClientTests, self).setUp()
self.client = JIRAClient(self.server.url)
class ClientTests(ServerTestCase):
def setUp(self):
super(ClientTests, self).setUp()
self.client = JIRAClient(self.server.url)
def test_post_400_error(self):
self.server.response.status_code = 400
self.server.response.body = {'errorMessages': ['Big Problem']}
with self.assertRaises(JIRAException):
self.client.post('path', {
'body': 'example',
})
def test_post_404_error(self):
self.server.response.status_code = 404
self.server.response.body = {
'errors': {
'rapidViewId':
'The requested board cannot be viewed because it either does not exist or you do not have permission to view it.'
}
}
with self.assertRaises(JIRAException):
self.client.post('path', {
'body': 'example',
})
def test_basic_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertEqual(self.server.last_request.headers.get('Authorization'),
'Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
def test_cookie_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.session.cookies['key'] = 'value'
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertFalse('Authorization' in self.server.last_request.headers)
def test_get_user(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
user = self.client.get_user()
self.assertEqual(user.username, 'kyle')
self.assertEqual(user.name, 'Kyle Fuller')
self.assertEqual(user.email, '*****@*****.**')
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
def test_get_issue(self):
self.server.response.body = {
'key': 'GOJI-13',
'fields': {
'summary': 'Implement Client Unit Tests',
'status': {
'id': 1,
'name': 'open',
}
},
}
issue = self.client.get_issue('GOJI-13')
self.assertEqual(issue.summary, 'Implement Client Unit Tests')
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-13')
def test_get_issue_transitions(self):
self.server.response.body = {
'transitions': [{
'id': 1,
'name': 'Close Issue'
}]
}
transitions = self.client.get_issue_transitions('GOJI-13')
self.assertEqual(len(transitions), 1)
self.assertEqual(transitions[0].id, 1)
self.assertEqual(transitions[0].name, 'Close Issue')
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-13/transitions')
def test_transition_issue(self):
self.server.response.status_code = 204
self.client.change_status('GOJI-14', 1)
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-14/transitions')
self.assertEqual(self.server.last_request.body,
{'transition': {
'id': 1
}})
def test_create_issue(self):
self.server.response.status_code = 201
self.server.response.body = {
'id': '10000',
'key': 'GOJI-14',
}
issue = self.client.create_issue({
'summary':
'Test Creating Issues in JIRA Client',
})
self.assertEqual(issue.key, 'GOJI-14')
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path, '/rest/api/2/issue')
self.assertEqual(
self.server.last_request.body,
{'fields': {
'summary': 'Test Creating Issues in JIRA Client',
}})
def test_edit_issue(self):
self.client.edit_issue(
'GOJI-15', {
'summary': 'Test Updating Issues in JIRA Client',
})
self.assertEqual(self.server.last_request.method, 'PUT')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-15')
self.assertEqual(
self.server.last_request.body,
{'fields': {
'summary': 'Test Updating Issues in JIRA Client',
}})
def test_assign(self):
self.server.response.status_code = 204
self.client.assign('GOJI-14', 'kyle')
self.assertEqual(self.server.last_request.method, 'PUT')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-14/assignee')
self.assertEqual(self.server.last_request.body, {'name': 'kyle'})
def test_comment(self):
self.server.response.body = {
'id': '10000',
'author': {
'name': 'fred',
'displayName': 'Fred F. User',
},
'body': 'Hello World',
'created': '2018-05-08T05:54:42.688+0000',
}
comment = self.client.comment('GOJI-14', 'Hello World')
self.assertEqual(comment.message, 'Hello World')
self.assertEqual(comment.author.name, 'Fred F. User')
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-14/comment')
self.assertEqual(self.server.last_request.body,
{'body': 'Hello World'})
def test_search(self):
self.server.response.body = {
'issues': [{
'key': 'GOJI-1',
'fields': {
'summary': 'Hello World',
'description': 'One\nTwo\nThree\n',
'status': {
'id': 1,
'name': 'open'
},
}
}],
}
issues = self.client.search('PROJECT = GOJI')
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path, '/rest/api/2/search')
self.assertEqual(self.server.last_request.body,
{'jql': 'PROJECT = GOJI'})
self.assertEqual(len(issues), 1)
self.assertEqual(issues[0].key, 'GOJI-1')
def test_create_sprint(self):
self.server.response.status_code = 201
self.server.response.body = {
'id': 12,
'name': 'Testing Sprint #1',
'state': 'future',
}
sprint = self.client.create_sprint(5, 'Testing Sprint #1')
self.assertEqual(self.server.last_request.path,
'/rest/agile/1.0/sprint')
self.assertEqual(self.server.last_request.body, {
'name': 'Testing Sprint #1',
'originBoardId': 5,
})
def test_create_sprint_start_end(self):
self.server.response.status_code = 201
self.server.response.body = {
'id': 12,
'name': 'Testing Sprint #1',
'state': 'future',
}
sprint = self.client.create_sprint(5, 'Testing Sprint #1',
datetime.datetime(2018, 1, 1),
datetime.datetime(2018, 6, 1))
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path,
'/rest/agile/1.0/sprint')
self.assertEqual(
self.server.last_request.body, {
'name': 'Testing Sprint #1',
'originBoardId': 5,
'startDate': '2018-01-01T00:00:00',
'endDate': '2018-06-01T00:00:00',
})
def setUp(self):
super(ClientTests, self).setUp()
self.client = JIRAClient(self.server.url)
class ClientTests(ServerTestCase):
def setUp(self):
super(ClientTests, self).setUp()
self.client = JIRAClient(self.server.url)
def test_post_400_error(self):
self.server.response.status_code = 400
self.server.response.body = {
'errorMessages': ['Big Problem']
}
with self.assertRaises(JIRAException):
self.client.post('path', {
'body': 'example',
})
def test_post_404_error(self):
self.server.response.status_code = 404
self.server.response.body = {
'errors': {
'rapidViewId': 'The requested board cannot be viewed because it either does not exist or you do not have permission to view it.'
}
}
with self.assertRaises(JIRAException):
self.client.post('path', {
'body': 'example',
})
def test_basic_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertEqual(self.server.last_request.headers.get('Authorization'),
'Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
def test_cookie_authentication(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
client = JIRAClient(self.server.url, ('username', 'password'))
client.session.cookies['key'] = 'value'
client.get_user()
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
self.assertFalse('Authorization' in self.server.last_request.headers)
def test_get_user(self):
self.server.response.body = {
'name': 'kyle',
'displayName': 'Kyle Fuller',
'emailAddress': '*****@*****.**',
}
user = self.client.get_user()
self.assertEqual(user.username, 'kyle')
self.assertEqual(user.name, 'Kyle Fuller')
self.assertEqual(user.email, '*****@*****.**')
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/myself')
def test_get_issue(self):
self.server.response.body = {
'key': 'GOJI-13',
'fields': {
'summary': 'Implement Client Unit Tests',
'status': {
'id': 1,
'name': 'open',
}
},
}
issue = self.client.get_issue('GOJI-13')
self.assertEqual(issue.summary, 'Implement Client Unit Tests')
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/issue/GOJI-13')
def test_get_issue_transitions(self):
self.server.response.body = {
'transitions': [
{
'id': 1,
'name': 'Close Issue'
}
]
}
transitions = self.client.get_issue_transitions('GOJI-13')
self.assertEqual(len(transitions), 1)
self.assertEqual(transitions[0].id, 1)
self.assertEqual(transitions[0].name, 'Close Issue')
self.assertEqual(self.server.last_request.method, 'GET')
self.assertEqual(self.server.last_request.path, '/rest/api/2/issue/GOJI-13/transitions')
def test_transition_issue(self):
self.server.response.status_code = 204
self.client.change_status('GOJI-14', 1)
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path, '/rest/api/2/issue/GOJI-14/transitions')
self.assertEqual(self.server.last_request.body, {'transition': {'id': 1}})
def test_create_issue(self):
self.server.response.status_code = 201
self.server.response.body = {
'id': '10000',
'key': 'GOJI-14',
}
issue = self.client.create_issue({
'summary': 'Test Creating Issues in JIRA Client',
})
self.assertEqual(issue.key, 'GOJI-14')
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path, '/rest/api/2/issue')
self.assertEqual(self.server.last_request.body, {
'fields': {
'summary': 'Test Creating Issues in JIRA Client',
}
})
def test_edit_issue(self):
self.client.edit_issue('GOJI-15', {
'summary': 'Test Updating Issues in JIRA Client',
})
self.assertEqual(self.server.last_request.method, 'PUT')
self.assertEqual(self.server.last_request.path, '/rest/api/2/issue/GOJI-15')
self.assertEqual(self.server.last_request.body, {
'fields': {
'summary': 'Test Updating Issues in JIRA Client',
}
})
def test_assign(self):
self.server.response.status_code = 204
self.client.assign('GOJI-14', 'kyle')
self.assertEqual(self.server.last_request.method, 'PUT')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-14/assignee')
self.assertEqual(self.server.last_request.body, {'name': 'kyle'})
def test_comment(self):
self.server.response.body = {
'id': '10000',
'author': {
'name': 'fred',
'displayName': 'Fred F. User',
},
'body': 'Hello World',
'created': '2018-05-08T05:54:42.688+0000',
}
comment = self.client.comment('GOJI-14', 'Hello World')
self.assertEqual(comment.message, 'Hello World')
self.assertEqual(comment.author.name, 'Fred F. User')
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/issue/GOJI-14/comment')
self.assertEqual(self.server.last_request.body, {
'body': 'Hello World'
})
def test_search(self):
self.server.response.body = {
'issues': [
{
'key': 'GOJI-1',
'fields': {
'summary': 'Hello World',
'description': 'One\nTwo\nThree\n',
'status': {
'id': 1,
'name': 'open'
},
}
}
],
}
issues = self.client.search('PROJECT = GOJI')
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path,
'/rest/api/2/search')
self.assertEqual(self.server.last_request.body, {
'jql': 'PROJECT = GOJI'
})
self.assertEqual(len(issues), 1)
self.assertEqual(issues[0].key, 'GOJI-1')
def test_create_sprint(self):
self.server.response.status_code = 201
self.server.response.body = {
'id': 12,
'name': 'Testing Sprint #1',
'state': 'future',
}
sprint = self.client.create_sprint(5, 'Testing Sprint #1')
self.assertEqual(self.server.last_request.path, '/rest/agile/1.0/sprint')
self.assertEqual(self.server.last_request.body, {
'name': 'Testing Sprint #1',
'originBoardId': 5,
})
def test_create_sprint_start_end(self):
self.server.response.status_code = 201
self.server.response.body = {
'id': 12,
'name': 'Testing Sprint #1',
'state': 'future',
}
sprint = self.client.create_sprint(5, 'Testing Sprint #1',
datetime.datetime(2018, 1, 1),
datetime.datetime(2018, 6, 1))
self.assertEqual(self.server.last_request.method, 'POST')
self.assertEqual(self.server.last_request.path, '/rest/agile/1.0/sprint')
self.assertEqual(self.server.last_request.body, {
'name': 'Testing Sprint #1',
'originBoardId': 5,
'startDate': '2018-01-01T00:00:00',
'endDate': '2018-06-01T00:00:00',
})
def invoke(self, *args):
runner = CliRunner()
args = ['--base-url', self.server.url] + list(args)
client = JIRAClient(self.server.url, ('kyle', None))
result = runner.invoke(cli, args, obj=client)
return result
def cli(ctx, base_url):
if not ctx.obj:
if ctx.invoked_subcommand == 'login':
ctx.obj = base_url
else:
ctx.obj = JIRAClient(base_url)