-#!/usr/bin/env
+#!/usr/bin/env python
# -*- coding: UTF-8 -*-
# vim: sw=4 ts=4 expandtab ai
#
def _do_http_call(self, relative_url, data=None, method='GET', headers={}):
"""Makes HTTP request with digest authentication"""
- request = urllib2.Request(urlparse.urljoin(self.baseurl, relative_url), data=data, headers = headers)
+ request = urllib2.Request(urlparse.urljoin(self.baseurl, relative_url), data=data, headers=headers)
if method == "PUT":
request.get_method = lambda: 'PUT'
elif method == "DELETE":
@staticmethod
def quote_id(oid):
"Returns encoded project or group name if it contains /"
- return urllib2.quote(oid,"") if '/' in oid else oid
+ return urllib2.quote(oid, "") if '/' in oid else oid
@staticmethod
def change_id(changeid, project=None, branch=None):
if parents:
opts.append("t")
if prefix:
- opts.append("p=%s" % (urllib2.quote(prefix,"")
- if '/' in prefix else prefix))
+ opts.append("p=%s" % (urllib2.quote(prefix, "") \
+ if '/' in prefix else prefix))
if branches:
if not isinstance(branches, (types.ListType, types.TupleType)):
- branches = [ branches ]
+ branches = [branches]
for branch in branches:
- opts.append("b=%s" % urllib2.quote(branch,""))
+ opts.append("b=%s" % urllib2.quote(branch, ""))
if opts:
return self._do_json_call("a/projects/?%s" % "&".join(opts))
else:
return None
return self._do_json_call("a/projects/%s" % self.quote_id(project))
- def create_project(self, project, parent=None, description=None,
- permissions_only=None, create_empty_commit=None, submit_type=None,
- branches=None, owners=None, use_contributor_agreements=None,
+ def create_project(self, project, parent=None, description=None, \
+ permissions_only=None, create_empty_commit=None, submit_type=None, \
+ branches=None, owners=None, use_contributor_agreements=None, \
use_signed_off_by=None, use_content_merge=None, require_change_id=None):
"""
PUT /projects/{project-name}
description: The description of the project.
permissions_only: false if not set
create_empty_commit: false if not set
- submit_type: optional (*MERGE_IF_NECESSARY, REBASE_IF_NECESSARY,
+ submit_type: optional (*MERGE_IF_NECESSARY, REBASE_IF_NECESSARY,
FAST_FORWARD_ONLY, MERGE_ALWAYS, CHERRY_PICK).
branches: A list of branches that should be initially created.
For the branch names the refs/heads/ prefix can be omitted.
owners: A list of groups that should be assigned as project owner.
- use_contributor_agreements: Whether contributor agreements should be
+ use_contributor_agreements: Whether contributor agreements should be
used for the project (TRUE, FALSE, *INHERIT).
- use_signed_off_by: Whether the usage of Signed-Off-By footers is
+ use_signed_off_by: Whether the usage of Signed-Off-By footers is
required for the project (TRUE, FALSE, *INHERIT).
- use_content_merge: Whether content merge should be enabled for the
- project (TRUE, FALSE, *INHERIT).
+ use_content_merge: Whether content merge should be enabled for the
+ project (TRUE, FALSE, *INHERIT).
FALSE, if the submit_type is FAST_FORWARD_ONLY.
- require_change_id: Whether the usage of Change-Ids is required for
+ require_change_id: Whether the usage of Change-Ids is required for
the project (TRUE, FALSE, *INHERIT).
"""
if not project:
info['use_content_merge'] = use_content_merge
if require_change_id:
info['require_change_id'] = require_change_id
- return self._do_json_call(
- "a/projects/%s" % self.quote_id(project),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/projects/%s" % self.quote_id(project), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_project_description(self, project):
"""
PUT /projects/{project-name}/description
Content-Type: application/json;charset=UTF-8
{
- "description": optional, The project description.
+ "description": optional, The project description.
The project description will be deleted if not set.
"commit_message": optional, Message that should be used to commit
the change of the project description in the project.config file to
info['description'] = description
if commit_message:
info['commit_message'] = commit_message
- return self._do_json_call(
- "a/projects/%s/description" % self.quote_id(project),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/projects/%s/description" % self.quote_id(project), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def delete_project_description(self, project):
"""
"""
if not project:
return None
- return self._do_json_call("a/projects/%s/description" % self.quote_id(project), method='DELETE')
+ return self._do_json_call("a/projects/%s/description" % \
+ self.quote_id(project), method='DELETE')
def get_project_parent(self, project):
"""
{
"parent": The name of the parent project.
- "commit_message": optional, Message that should be used to commit
- the change of the project parent in the project.config file to
+ "commit_message": optional, Message that should be used to commit
+ the change of the project parent in the project.config file to
the refs/meta/config branch.
}
"""
info['parent'] = parent
if commit_message:
info['commit_message'] = commit_message
- return self._do_json_call(
- "a/projects/%s/parent" % self.quote_id(project),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/projects/%s/parent" % self.quote_id(project), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_project_head(self, project):
"""
def set_project_head(self, project, head):
"""
PUT /projects/{project-name}/HEAD
- ref: The ref to which HEAD should be set,
+ ref: The ref to which HEAD should be set,
the refs/heads prefix can be omitted.
"""
info = {}
if head:
info['ref'] = head
- return self._do_json_call(
- "a/projects/%s/HEAD" % self.quote_id(project),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/projects/%s/HEAD" % self.quote_id(project), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_project_statistics(self, project):
"""
"""
if not project:
return None
- return self._do_json_call("a/projects/%s/statistics.git" % self.quote_id(project))
+ return self._do_json_call("a/projects/%s/statistics.git" % \
+ self.quote_id(project))
def run_project_gc(self, project):
"""
"""
if not project:
return None
- return self._do_http_call("a/projects/%s/gc" % self.quote_id(project), method='POST')[0]
+ return self._do_http_call("a/projects/%s/gc" % \
+ self.quote_id(project), method='POST')[0]
def get_groups(self, members=False, includes=False, project=None, user=None):
"""
"description": "contains all committers for MyProject",
"visible_to_all": true,
"owner_id": "7ca042f4d5847936fcb90ca91057673157fd06fc"
- }
+ }
"""
if not group:
return None
info['visible_to_all'] = visible_to_all
if owner:
info['owner_id'] = owner
- return self._do_json_call(
- "a/groups/%s" % self.quote_id(group),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s" % self.quote_id(group), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_group_detail(self, group):
"""
if not group or not new_name:
return None
info = {'name': new_name}
- return self._do_json_call(
- "a/groups/%s" % self.quote_id(group),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s" % self.quote_id(group), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_group_description(self, group):
"""
"""
if not group:
return None
- return self._do_json_call("a/groups/%s/description" % self.quote_id(group))
+ return self._do_json_call("a/groups/%s/description" % \
+ self.quote_id(group))
def set_group_description(self, group, new_description):
"""
if not group:
return None
info = {'description': new_description}
- return self._do_json_call(
- "a/groups/%s/description" % self.quote_id(group),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s/description" % self.quote_id(group), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def delete_group_description(self, group):
"""
"""
if not group:
return None
- return self._do_json_call("a/groups/%s/description" % self.quote_id(group), method='DELETE')
+ return self._do_json_call("a/groups/%s/description" % \
+ self.quote_id(group), method='DELETE')
def get_group_options(self, group):
"""
if not group or visible_to_all is None:
return None
info = {'visible_to_all': visible_to_all}
- return self._do_json_call(
- "a/groups/%s/options" % self.quote_id(group),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s/options" % self.quote_id(group), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_group_owner(self, group):
"""
if not group:
return None
info = {'owner': new_owner}
- return self._do_json_call(
- "a/groups/%s/owner" % self.quote_id(group),
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s/owner" % self.quote_id(group), \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_group_member(self, group, member):
"""
"""
if not group or not member:
return None
- return self._do_json_call("a/groups/%s/member/%s" % (self.quote_id(group), member))
+ return self._do_json_call("a/groups/%s/member/%s" % \
+ (self.quote_id(group), member))
def add_group_member(self, group, member):
"""
"""
if not group or not member:
return None
- return self._do_json_call("a/groups/%s/members/%s" % (self.quote_id(group), member), method='PUT', data="")
+ return self._do_json_call("a/groups/%s/members/%s" % \
+ (self.quote_id(group), member), method='PUT', data="")
def delete_group_member(self, group, member):
"""
"""
if not group or not member:
return None
- return self._do_json_call("a/groups/%s/members/%s" % (self.quote_id(group), member), method='DELETE')
+ return self._do_json_call("a/groups/%s/members/%s" % \
+ (self.quote_id(group), member), method='DELETE')
def get_group_members(self, group, recursive=None):
"""
if not group:
return None
options = "?recursive" if recursive else ""
- return self._do_json_call("a/groups/%s/members/%s" % (self.quote_id(group), options))
+ return self._do_json_call("a/groups/%s/members/%s" % \
+ (self.quote_id(group), options))
def add_group_members(self, group, members):
"""
POST /groups/{group-id}/members.add
or
POST /groups/{group-id}/members
- members: A list of account ids that identify the accounts that should
+ members: A list of account ids that identify the accounts that should
be added or deleted.
TODO:
_one_member: The id of one account that should be added or deleted.
if not group or not members:
return None
info = {'members': members}
- return self._do_json_call(
- "a/groups/%s/members.add" % self.quote_id(group),
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s/members.add" % self.quote_id(group), \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def delete_group_members(self, group, members):
"""
POST /groups/{group-id}/members.delete
- members: A list of account ids that identify the accounts that
+ members: A list of account ids that identify the accounts that
should be added or deleted.
TODO:
_one_member: The id of one account that should be added or deleted.
if not group or not members:
return None
info = {'members': members}
- return self._do_json_call(
- "a/groups/%s/members.delete" % self.quote_id(group),
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s/members.delete" % self.quote_id(group), \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_group_group(self, group, included_group):
"""
"""
if not group or not included_group:
return None
- return self._do_json_call("a/groups/%s/groups/%s" % (self.quote_id(group), included_group))
+ return self._do_json_call("a/groups/%s/groups/%s" % \
+ (self.quote_id(group), included_group))
def add_group_group(self, group, included_group):
"""
"""
if not group or not included_group:
return None
- return self._do_json_call("a/groups/%s/groups/%s" % (self.quote_id(group), included_group), method='PUT', data="")
+ return self._do_json_call("a/groups/%s/groups/%s" % \
+ (self.quote_id(group), included_group), method='PUT', data="")
def delete_group_group(self, group, included_group):
"""
"""
if not group or not included_group:
return None
- return self._do_json_call("a/groups/%s/groups/%s" % (self.quote_id(group), included_group), method='DELETE')
+ return self._do_json_call("a/groups/%s/groups/%s" % \
+ (self.quote_id(group), included_group), method='DELETE')
def get_group_groups(self, group):
"""
POST /groups/{group-id}/groups
OR
POST /groups/{group-id}/groups.add
- groups: A list of group ids that identify the groups that should be
+ groups: A list of group ids that identify the groups that should be
included or deleted.
TODO:
_one_group: The id of one group that should be included or deleted.
if not group or not included_groups:
return None
info = {'groups': included_groups}
- return self._do_json_call(
- "a/groups/%s/groups.add" % self.quote_id(group),
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/groups/%s/groups.add" % self.quote_id(group), \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def delete_group_groups(self, group, included_groups):
"""
POST /groups/{group-id}/groups.delete
- groups: A list of group ids that identify the groups that should be
+ groups: A list of group ids that identify the groups that should be
included or deleted.
TODO:
_one_group The id of one group that should be included or deleted.
if not group or not included_groups:
return None
info = {'groups': included_groups}
- return self._do_json_call(
- "a/groups/%s/groups.delete" % self.quote_id(group),
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
-
- def get_changes(self, query=None, n=None, labels=False,
- detailed_labels=False, current_revision=False,
+ return self._do_json_call( \
+ "a/groups/%s/groups.delete" % self.quote_id(group), \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
+
+ def get_changes(self, query=None, n=None, labels=False,
+ detailed_labels=False, current_revision=False,
all_revisions=False, current_commit=False,
all_commits=False, current_files=False, all_files=False,
detailed_accounts=False):
"""
if not change:
return None
- return self._do_json_call("a/changes/%s" % self.change_id(change, project, branch))
+ return self._do_json_call("a/changes/%s" % \
+ self.change_id(change, project, branch))
def get_change_detail(self, change):
"""
"""
PUT /changes/{change-id}/topic
topic: The topic. The topic will be deleted if not set.
- message: Message to be added as review comment to the change when
+ message: Message to be added as review comment to the change when
setting the topic.
"""
if not change:
info['topic'] = topic
if message:
info['message'] = message
- return self._do_json_call(
- "a/changes/%s/topic" % change,
- method='PUT',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/topic" % change, \
+ method='PUT', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def delete_change_topic(self, change):
"""
"""
if not change:
return None
- return self._do_json_call("a/changes/%s/topic" % change, method='DELETE')
+ return self._do_json_call("a/changes/%s/topic" % \
+ change, method='DELETE')
def abandon_change(self, change, message=None):
"""
POST /changes/{change-id}/abandon
- message: Message to be added as review comment to the change when
+ message: Message to be added as review comment to the change when
abandoning the change.
TODO: error handling (409 + message in body)
"""
info = {}
if message:
info['message'] = message
- return self._do_json_call(
- "a/changes/%s/abandon" % change,
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/abandon" % change, \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def restore_change(self, change, message=None):
"""
POST /changes/{change-id}/restore
- message: Message to be added as review comment to the change when
+ message: Message to be added as review comment to the change when
restoring the change.
TODO: error handling (409 + message in body)
"""
info = {}
if message:
info['message'] = message
- return self._do_json_call(
- "a/changes/%s/restore" % change,
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/restore" % change, \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def revert_change(self, change, message=None):
"""
POST /changes/{change-id}/revert
- message: Message to be added as review comment to the change when
+ message: Message to be added as review comment to the change when
reverting the change.
TODO: error handling (409 + message in body)
"""
info = {}
if message:
info['message'] = message
- return self._do_json_call(
- "a/changes/%s/revert" % change,
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/revert" % change, \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def submit_change(self, change, wait_for_merge=None):
"""
POST /changes/{change-id}/submit
- wait_for_merge: false if not set. Whether the request should wait for
- the merge to complete.
+ wait_for_merge: false if not set. Whether the request should wait for
+ the merge to complete.
If false the request returns immediately after the change has been added
- to the merge queue and the caller can’t know whether the change could
+ to the merge queue and the caller can’t know whether the change could
be merged successfully.
TODO: error handling (409 + message in body)
"""
info = {}
if wait_for_merge is not None:
info['wait_for_merge'] = wait_for_merge
- return self._do_json_call(
- "a/changes/%s/submit" % change,
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/submit" % change, \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_change_reviewers(self, change):
"""
"""
if not change:
return None
- return self._do_json_call("a/changes/%s/reviewers/%s" % (change, reviewer))
+ return self._do_json_call("a/changes/%s/reviewers/%s" % \
+ (change, reviewer))
def add_change_reviewer(self, change, reviewer, confirmed=None):
"""
POST /changes/{change-id}/reviewers
- reviewer: The ID of one account that should be added as reviewer or
+ reviewer: The ID of one account that should be added as reviewer or
the ID of one group for which all members should be added as reviewers.
- If an ID identifies both an account and a group, only the account is
+ If an ID identifies both an account and a group, only the account is
added as reviewer to the change.
- confirmed: Whether adding the reviewer is confirmed. The Gerrit server
- may be configured to require a confirmation when adding a group as
+ confirmed: Whether adding the reviewer is confirmed. The Gerrit server
+ may be configured to require a confirmation when adding a group as
reviewer that has many members.
"""
if not change or not reviewer:
info['reviewer'] = reviewer
if confirmed is not None:
info['confirmed'] = confirmed
- return self._do_json_call(
- "a/changes/%s/reviewers" % change,
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/reviewers" % change, \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def delete_change_reviewer(self, change, reviewer):
"""
"""
if not change or not reviewer:
return None
- return self._do_json_call("a/changes/%s/reviewers/%s" % (change, reviewer), method='DELETE')
+ return self._do_json_call("a/changes/%s/reviewers/%s" % \
+ (change, reviewer), method='DELETE')
def get_change_review(self, change, revision):
"""
"""
if not change or not revision:
return None
- return self._do_json_call("a/changes/%s/revisions/%s/review" % (change, revision))
+ return self._do_json_call("a/changes/%s/revisions/%s/review" % \
+ (change, revision))
def set_change_review(self, change, revision):
"""
def submit_change_revision(self, change, revision, wait_for_merge=None):
"""
POST /changes/{change-id}/revisions/{revision-id}/submit
- wait_for_merge: false if not set. Whether the request should wait for
- the merge to complete.
- If false the request returns immediately after the change
- has been added to the merge queue and the caller can’t know
+ wait_for_merge: false if not set. Whether the request should wait for
+ the merge to complete.
+ If false the request returns immediately after the change
+ has been added to the merge queue and the caller can’t know
whether the change could be merged successfully.
TODO: error handling (409 + message in body)
"""
info = {}
if wait_for_merge is not None:
info['wait_for_merge'] = wait_for_merge
- return self._do_json_call(
- "a/changes/%s/revisions/%s/submit" % (change, revision),
- method='POST',
- headers={'Content-Type': 'application/json;charset=UTF-8'},
- data=json.dumps(info))
+ return self._do_json_call( \
+ "a/changes/%s/revisions/%s/submit" % (change, revision), \
+ method='POST', \
+ headers={'Content-Type': 'application/json;charset=UTF-8'}, \
+ data=json.dumps(info))
def get_change_revision_submit_type(self, change, revision):
"""
"""
if not change or not revision:
return None
- return self._do_json_call("a/changes/%s/revisions/%s/submit_type" % (change, revision))
+ return self._do_json_call("a/changes/%s/revisions/%s/submit_type" % \
+ (change, revision))
def get_account(self, account="self"):
"""
GET /accounts/{account-id}/capabilities
"""
- return self._do_json_call("a/accounts/%s/capabilities" % urllib2.quote(account))
+ return self._do_json_call("a/accounts/%s/capabilities" % \
+ urllib2.quote(account, ""))
def get_account_capability(self, account="self", capability=None):
"""
"""
if not capability:
return None
- ret = self._do_http_call("a/accounts/%s/capabilities/%s" %
- (urllib2.quote(account), capability))
+ ret = self._do_http_call("a/accounts/%s/capabilities/%s" % \
+ (urllib2.quote(account, ""), capability))
if ret[0] and ret[0] == "ok\n":
return True
if ret[1] == 404:
"""
GET /accounts/{account-id}/groups/
"""
- return self._do_json_call("a/accounts/%s/groups" % urllib2.quote(account))
+ return self._do_json_call("a/accounts/%s/groups" % \
+ urllib2.quote(account, ""))
def get_account_avatar(self, account="self", size=None):
"""
projects / services / gerritrest.git / commitdiff