pax_global_header00006660000000000000000000000064131612435450014516gustar00rootroot0000000000000052 comment=01a634014e28d04dfb2ed8bf2401369933ecc465 gerritlib-0.8.0/000077500000000000000000000000001316124354500135065ustar00rootroot00000000000000gerritlib-0.8.0/.gitignore000066400000000000000000000002131316124354500154720ustar00rootroot00000000000000# Packages *.egg-info .tox build/* *.pyc gerritlib/versioninfo doc/build/* # pbr generates these AUTHORS ChangeLog # Editors *~ .*.swp gerritlib-0.8.0/.gitreview000066400000000000000000000001241316124354500155110ustar00rootroot00000000000000[gerrit] host=review.openstack.org port=29418 project=openstack-infra/gerritlib.git gerritlib-0.8.0/.testr.conf000066400000000000000000000004771316124354500156040ustar00rootroot00000000000000[DEFAULT] test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION test_id_option=--load-list $IDFILE test_list_option=--list gerritlib-0.8.0/CONTRIBUTING.rst000066400000000000000000000021661316124354500161540ustar00rootroot00000000000000Contributing ============ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: http://docs.openstack.org/infra/manual/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: http://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on StoryBoard, not GitHub: https://storyboard.openstack.org/#!/project/718 To browse the latest code: https://git.openstack.org/cgit/openstack-infra/gerritlib/tree/ To clone the latest code: git clone git://git.openstack.org/openstack-infra/gerritlib Code reviews are handled by gerrit: http://review.openstack.org Use `git review` to submit patches (after creating a gerrit account that links to your launchpad account). Example:: # Do your commits $ git review # Enter your username if prompted gerritlib-0.8.0/LICENSE000066400000000000000000000236361316124354500145250ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. gerritlib-0.8.0/MANIFEST.in000066400000000000000000000001751316124354500152470ustar00rootroot00000000000000include gerritlib/versioninfo include AUTHORS include ChangeLog exclude .gitignore exclude .gitreview global-exclude *.pyc gerritlib-0.8.0/README.rst000066400000000000000000000026751316124354500152070ustar00rootroot00000000000000README ====== Gerritlib is a Python library for interacting with Gerrit_. It aims to provide a more conventionally pythonic way of managing a Gerrit instance. To install:: $ sudo python setup.py install Online documentation: * http://gerritlib.readthedocs.org/en/latest/ Developers ---------- Bug report: * https://storyboard.openstack.org/#!/project/718 Repository: * https://git.openstack.org/cgit/openstack-infra/gerritlib Cloning:: git clone https://git.openstack.org/openstack-infra/gerritlib Patches are submitted via Gerrit at: * https://review.openstack.org/ Please do not submit GitHub pull requests, they will be automatically closed. More details on how you can contribute is available on our wiki at: * http://docs.openstack.org/infra/manual/developers.html Writing a patch --------------- We ask that all code submissions be pep8_ and pyflakes_ clean. The easiest way to do that is to run tox_ before submitting code for review in Gerrit. It will run ``pep8`` and ``pyflakes`` in the same manner as the automated test suite that will run on proposed patchsets. Installing without setup.py --------------------------- Then install the required python packages using pip_:: $ sudo pip install gerritlib .. _Gerrit: https://code.google.com/p/gerrit/ .. _pyflakes: https://pypi.python.org/pypi/pyflakes .. _tox: https://testrun.org/tox .. _pip: https://pypi.python.org/pypi/pip .. _pep8: https://pypi.python.org/pypi/pep8 gerritlib-0.8.0/doc/000077500000000000000000000000001316124354500142535ustar00rootroot00000000000000gerritlib-0.8.0/doc/Makefile000066400000000000000000000127341316124354500157220ustar00rootroot00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonJenkins.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonJenkins.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonJenkins" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonJenkins" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." gerritlib-0.8.0/doc/source/000077500000000000000000000000001316124354500155535ustar00rootroot00000000000000gerritlib-0.8.0/doc/source/api.rst000066400000000000000000000002061316124354500170540ustar00rootroot00000000000000:title: API reference API reference ============= .. automodule:: gerritlib.gerrit :members: :noindex: :undoc-members: gerritlib-0.8.0/doc/source/conf.py000066400000000000000000000163131316124354500170560ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # Gerritlib documentation build configuration file, created by # sphinx-quickstart on Sat Sep 3 16:24:58 2011. # # This file is execfile()d with the current directory set to its containing # dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import os import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../..')) sys.path.insert(0, os.path.abspath('../../gerritlib')) # -- General configuration ---------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc'] # Also document __init__ autoclass_content = 'both' # Change that to 'alphabetical' if you want autodoc_member_order = 'bysource' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'Gerritlib' copyright = u'2012-2015, Openstack Foundation' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # Version info from gerritlib.version import version_info as gerritlib_version release = gerritlib_version.version_string_with_vcs() # The short X.Y version. version = gerritlib_version.canonical_version_string() # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". #html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. #html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'Gerritlibdoc' # -- Options for LaTeX output ------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]) latex_documents = [ ('index', 'Gerritlib.tex', u'Gerritlib Documentation', u'Openstack Infra', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Additional stuff for the LaTeX preamble. #latex_preamble = '' # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output ------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'Gerritlib', u'Gerritlib Documentation', [u'Openstack infra'], 1) ] gerritlib-0.8.0/doc/source/contributing.rst000066400000000000000000000000451316124354500210130ustar00rootroot00000000000000.. include:: ../../CONTRIBUTING.rst gerritlib-0.8.0/doc/source/index.rst000066400000000000000000000003171316124354500174150ustar00rootroot00000000000000Gerritlib ========= .. include:: ../../README.rst Contents ======== .. toctree:: :maxdepth: 3 :glob: * Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` gerritlib-0.8.0/doc/source/installation.rst000066400000000000000000000014711316124354500210110ustar00rootroot00000000000000:title: Installing Installing ========== The module is known to pip and Debian-based distributions as ``gerritlib``. ``pip``:: pip install gerritlib ``easy_install``:: easy_install gerritlib The module has been packaged since Ubuntu Oneiric (11.10):: apt-get install gerritlib And on Fedora 19 and later:: yum install gerritlib For development:: python setup.py develop Documentation ------------- Documentation is included in the ``doc`` folder. To generate docs locally execute the command:: tox -e docs The generated documentation is then available under ``doc/build/html/index.html``. Unit Tests ---------- Unit tests are in the ``tests`` folder. To run the unit tests, execute the command:: tox -e py27 * Note: View ``tox.ini`` to run tests on other versions of Python. gerritlib-0.8.0/doc/source/usage.rst000066400000000000000000000006641316124354500174170ustar00rootroot00000000000000===== Usage ===== Example usage:: import gerritlib.gerrit as gerrit g = gerrit.Gerrit('gerrit_host', 'username', keyfile='/home/username/.ssh/id_rsa.pub') # manage projects g.createProject('test', description='a test project') projects = g.listProjects() print(projects) # manage groups g.createGroup('testers') groups = g.listGroups() print(groups) Look at the :doc:`api` for more details.gerritlib-0.8.0/gerritlib/000077500000000000000000000000001316124354500154715ustar00rootroot00000000000000gerritlib-0.8.0/gerritlib/__init__.py000066400000000000000000000000001316124354500175700ustar00rootroot00000000000000gerritlib-0.8.0/gerritlib/gerrit.py000066400000000000000000000346331316124354500173500ustar00rootroot00000000000000# Copyright 2011 OpenStack, LLC. # Copyright 2012 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import json import logging import pprint import select import six.moves import threading import time import paramiko CONNECTED = 'connected' CONNECTING = 'connecting' CONSUMING = 'consuming' DEAD = 'dead' DISCONNECTED = 'disconnected' IDLE = 'idle' UPDATE_ALLOWED_KEYS = ['description', 'submit-type', 'contributor-agreements', 'signed-off-by', 'content-merge', 'change-id', 'project-state', 'max-object-size-limit'] class GerritWatcher(threading.Thread): log = logging.getLogger("gerrit.GerritWatcher") def __init__( self, gerrit, username=None, hostname=None, port=None, keyfile=None, connection_attempts=-1, retry_delay=5): """Create a GerritWatcher. :param gerrit: A Gerrit instance to pass events to. All other parameters are optional and if not supplied are sourced from the gerrit instance. """ super(GerritWatcher, self).__init__() assert retry_delay >= 0, "Retry delay must be >= 0" self.username = username or gerrit.username self.keyfile = keyfile or gerrit.keyfile self.hostname = hostname or gerrit.hostname self.port = port or gerrit.port self.gerrit = gerrit self.connection_attempts = int(connection_attempts) self.retry_delay = float(retry_delay) self.state = IDLE def _read(self, fd): l = fd.readline() data = json.loads(l) self.log.debug("Received data from Gerrit event stream: \n%s" % pprint.pformat(data)) self.gerrit.addEvent(data) def _listen(self, stdout, stderr): poll = select.poll() poll.register(stdout.channel) while True: ret = poll.poll() for (fd, event) in ret: if fd == stdout.channel.fileno(): if event == select.POLLIN: self._read(stdout) else: raise Exception("event on ssh connection") def _connect(self): """Attempts to connect and returns the connected client.""" def _make_client(): client = paramiko.SSHClient() client.load_system_host_keys() client.set_missing_host_key_policy(paramiko.WarningPolicy()) return client def _attempt_gen(connection_attempts, retry_delay): if connection_attempts <= 0: attempt = 1 while True: yield (attempt, retry_delay) attempt += 1 else: for attempt in range(1, connection_attempts + 1): if attempt < connection_attempts: yield (attempt, retry_delay) else: # No more attempts left after this one, (signal this by # not returning a valid retry_delay). yield (attempt, None) for (attempt, retry_delay) in _attempt_gen(self.connection_attempts, self.retry_delay): self.log.debug("Connection attempt %s to %s:%s (retry_delay=%s)", attempt, self.hostname, self.port, retry_delay) client = None try: client = _make_client() client.connect(self.hostname, username=self.username, port=self.port, key_filename=self.keyfile) return client except (IOError, paramiko.SSHException) as e: self.log.exception("Exception connecting to %s:%s", self.hostname, self.port) if client: try: client.close() except (IOError, paramiko.SSHException): self.log.exception("Failure closing broken client") if retry_delay is not None: if retry_delay > 0: self.log.info("Trying again in %s seconds", retry_delay) time.sleep(retry_delay) else: raise e def _consume(self, client): """Consumes events using the given client.""" stdin, stdout, stderr = client.exec_command("gerrit stream-events") self.state = CONSUMING self._listen(stdout, stderr) ret = stdout.channel.recv_exit_status() self.log.debug("SSH exit status: %s" % ret) if ret: raise Exception("Gerrit error executing stream-events:" " return code %s" % ret) def _run(self): self.state = CONNECTING client = self._connect() self.state = CONNECTED try: self._consume(client) except Exception: # NOTE(harlowja): allow consuming failures to *always* be retryable self.log.exception("Exception consuming ssh event stream:") if client: try: client.close() except (IOError, paramiko.SSHException): self.log.exception("Failure closing broken client") self.state = DISCONNECTED if self.retry_delay > 0: self.log.info("Delaying consumption retry for %s seconds", self.retry_delay) time.sleep(self.retry_delay) def run(self): try: while True: self.state = DISCONNECTED self._run() finally: self.state = DEAD class Gerrit(object): log = logging.getLogger("gerrit.Gerrit") def __init__(self, hostname, username, port=29418, keyfile=None): self.username = username self.hostname = hostname self.port = port self.keyfile = keyfile self.watcher_thread = None self.event_queue = None self.installed_plugins = None def startWatching(self, connection_attempts=-1, retry_delay=5): self.event_queue = six.moves.queue.Queue() watcher = GerritWatcher(self, connection_attempts=connection_attempts, retry_delay=retry_delay) self.watcher_thread = watcher self.watcher_thread.daemon = True self.watcher_thread.start() def addEvent(self, data): return self.event_queue.put(data) def getEvent(self): return self.event_queue.get() def createGroup(self, group, visible_to_all=True, owner=None): cmd = 'gerrit create-group' if visible_to_all: cmd = '%s --visible-to-all' % cmd if owner: cmd = '%s --owner %s' % (cmd, owner) cmd = '%s "%s"' % (cmd, group) out, err = self._ssh(cmd) return err def listMembers(self, group, recursive=False): cmd = 'gerrit ls-members' if recursive: cmd = '%s --recursive' % cmd cmd = '%s "%s"' % (cmd, group) out, err = self._ssh(cmd) ret = [] rows = out.split('\n') if len(rows) > 1: keys = rows[0].split('\t') for row in rows[1:]: ret.append(dict(zip(keys, row.split('\t')))) return ret def _setMember(self, verb, group, member): cmd = 'gerrit set-members' if verb == 'add': cmd = '%s --add "%s"' % (cmd, member) elif verb == 'remove': cmd = '%s --remove "%s"' % (cmd, member) cmd = '%s "%s"' % (cmd, group) out, err = self._ssh(cmd) return err def addMember(self, group, member): self._setMember('add', group, member) def removeMember(self, group, member): self._setMember('remove', group, member) def createProject(self, project, require_change_id=True, empty_repo=False, description=None): cmd = 'gerrit create-project' if require_change_id: cmd = '%s --require-change-id' % cmd if empty_repo: cmd = '%s --empty-commit' % cmd if description: cmd = "%s --description \"%s\"" % \ (cmd, description.replace('"', r'\"')) version = None try: version = self.parseGerritVersion(self.getVersion()) except Exception: # If no version then we know version is old and should use --name pass if not version or version < (2, 12): cmd = '%s --name "%s"' % (cmd, project) else: cmd = '%s "%s"' % (cmd, project) out, err = self._ssh(cmd) return err def updateProject(self, project, update_key, update_value): # check for valid keys if update_key not in UPDATE_ALLOWED_KEYS: raise Exception("Trying to update a non-valid key %s" % update_key) cmd = 'gerrit set-project %s ' % project if update_key == 'description': cmd += "--%s \"%s\"" % (update_key, update_value.replace('"', r'\"')) else: cmd += '--%s %s' % (update_key, update_value) out, err = self._ssh(cmd) return err def listProjects(self, show_description=False): cmd = 'gerrit ls-projects' if show_description: # display projects alongs with descriptions # separated by ' - ' sequence cmd += ' --description' out, err = self._ssh(cmd) return filter(None, out.split('\n')) def listGroups(self, verbose=False): if verbose: cmd = 'gerrit ls-groups -v' else: cmd = 'gerrit ls-groups' out, err = self._ssh(cmd) return filter(None, out.split('\n')) def listPlugins(self): plugins = self.getPlugins() plugin_names = plugins.keys() return plugin_names # get installed plugins info returned is (name, version, status, file) def getPlugins(self): # command only available on gerrit verion >= 2.5 cmd = 'gerrit plugin ls --format json' out, err = self._ssh(cmd) return json.loads(out) def getVersion(self): # command only available on gerrit verion >= 2.6 cmd = 'gerrit version' out, err = self._ssh(cmd) out = out.split(' ')[2] return out.strip('\n') def parseGerritVersion(self, version): # Adapted from gertty setRemoteVersion() base = version.split('-')[0] parts = base.split('.') major = minor = micro = 0 if len(parts) > 0: major = int(parts[0]) if len(parts) > 1: minor = int(parts[1]) if len(parts) > 2: micro = int(parts[2]) return (major, minor, micro) def replicate(self, project='--all'): cmd = 'replication start %s' % project if self.installed_plugins is None: try: self.installed_plugins = self.listPlugins() except Exception: cmd = 'gerrit replicate %s' % project out, err = self._ssh(cmd) return out.split('\n') def review(self, project, change, message, action={}): cmd = 'gerrit review %s --project %s' % (change, project) if message: cmd += ' --message "%s"' % message for k, v in action.items(): if v is True: cmd += ' --%s' % k else: cmd += ' --%s %s' % (k, v) out, err = self._ssh(cmd) return err def query(self, change, commit_msg=False, comments=False): if commit_msg: if comments: cmd = ('gerrit query --format json --commit-message --comments' ' %s"' % change) else: cmd = 'gerrit query --format json --commit-message %s"' % ( change) else: if comments: cmd = 'gerrit query --format json --comments %s"' % (change) else: cmd = 'gerrit query --format json %s"' % (change) out, err = self._ssh(cmd) if not out: return False lines = out.split('\n') if not lines: return False data = json.loads(lines[0]) if not data: return False self.log.debug("Received data from Gerrit query: \n%s" % ( pprint.pformat(data))) return data def bulk_query(self, query): cmd = 'gerrit query --format json %s"' % ( query) out, err = self._ssh(cmd) if not out: return False lines = out.split('\n') if not lines: return False data = [] for line in lines: if line: data.append(json.loads(line)) if not data: return False self.log.debug("Received data from Gerrit query: \n%s" % ( pprint.pformat(data))) return data def _ssh(self, command): client = paramiko.SSHClient() client.load_system_host_keys() client.set_missing_host_key_policy(paramiko.WarningPolicy()) client.connect(self.hostname, username=self.username, port=self.port, key_filename=self.keyfile) self.log.debug("SSH command:\n%s" % command) stdin, stdout, stderr = client.exec_command(command) out = stdout.read() self.log.debug("SSH received stdout:\n%s" % out) ret = stdout.channel.recv_exit_status() self.log.debug("SSH exit status: %s" % ret) err = stderr.read() self.log.debug("SSH received stderr:\n%s" % err) if ret: raise Exception("Gerrit error executing %s" % command) return (out, err) gerritlib-0.8.0/gerritlib/tests/000077500000000000000000000000001316124354500166335ustar00rootroot00000000000000gerritlib-0.8.0/gerritlib/tests/__init__.py000066400000000000000000000000001316124354500207320ustar00rootroot00000000000000gerritlib-0.8.0/gerritlib/tests/base.py000066400000000000000000000001631316124354500201170ustar00rootroot00000000000000import testtools class TestCase(testtools.TestCase): "Placeholder wrapper for the testtools.TestCase class." gerritlib-0.8.0/gerritlib/tests/test_gerritlib.py000066400000000000000000000014101316124354500222230ustar00rootroot00000000000000# -*- coding: utf-8 -*- # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. """ test_gerritlib ---------------------------------- Tests for `gerritlib` module. """ from gerritlib.tests import base class TestGerritlib(base.TestCase): def test_something(self): pass gerritlib-0.8.0/gerritlib/version.py000066400000000000000000000014241316124354500175310ustar00rootroot00000000000000# vim: tabstop=4 shiftwidth=4 softtabstop=4 # Copyright 2011 OpenStack LLC # Copyright 2015 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import pbr.version version_info = pbr.version.VersionInfo('gerritlib') gerritlib-0.8.0/requirements.txt000066400000000000000000000000541316124354500167710ustar00rootroot00000000000000pbr>=0.11 paramiko>=1.8.0,<2.0.0 six>=1.7.0 gerritlib-0.8.0/setup.cfg000066400000000000000000000017451316124354500153360ustar00rootroot00000000000000[metadata] name = gerritlib summary = Client library for accessing Gerrit. description-file = README.rst author = OpenStack Infrastructure Team author-email = openstack-infra@lists.openstack.org maintainer = OpenStack Infrastructure Team maintainer-email = openstack-infra@lists.openstack.org home-page = http://git.openstack.org/cgit/openstack-infra/gerritlib/ license = apache classifier = Topic :: Utilities Intended Audience :: Developers Intended Audience :: Information Technology Intended Audience :: System Administrators Environment :: Console License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux Programming Language :: Python Programming Language :: Python :: 2 Programming Language :: Python :: 2.7 Programming Language :: Python :: 3 Programming Language :: Python :: 3.4 [files] packages = gerritlib [pbr] warnerrors = True [build_sphinx] source-dir = doc/source build-dir = doc/build all_files = 1 gerritlib-0.8.0/setup.py000066400000000000000000000013101316124354500152130ustar00rootroot00000000000000#!/usr/bin/env python # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # implied. # See the License for the specific language governing permissions and # limitations under the License. import setuptools setuptools.setup( setup_requires=['pbr'], pbr=True) gerritlib-0.8.0/test-requirements.txt000066400000000000000000000001201316124354500177400ustar00rootroot00000000000000hacking>=0.5.6,<0.11 sphinx>=1.1.2,<1.2 python-subunit testrepository testtools gerritlib-0.8.0/tox.ini000066400000000000000000000007551316124354500150300ustar00rootroot00000000000000[tox] minversion = 1.6 skipdist = True envlist = pep8, py27, pypy, py33, py34 [testenv] commands = python setup.py test --slowest --testr-args='{posargs}' setenv = VIRTUAL_ENV={envdir} usedevelop = True install_command = pip install {opts} {packages} deps = -r{toxinidir}/test-requirements.txt [testenv:pep8] commands = flake8 [testenv:docs] commands = python setup.py build_sphinx [testenv:venv] commands = {posargs} [flake8] show-source = True exclude = .venv,.tox,dist,doc,build,*.egg