x/python-picassoclient
Code Issues Proposed changes

Adding docs, testing

Browse Source
This commit is contained in:
Denis Makogon 2016-12-06 18:37:33 +02:00
parent 7178cc0f61
commit ac95817513
15 changed files with 740 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

216
doc/Makefile Normal file
View File

@ -0,0 +1,216 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# 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
help:
@echo "Please use \`make <target>' where <target> 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 " applehelp to make an Apple Help Book"
@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 " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@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 " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
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."
.PHONY: qthelp
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/AIOService.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AIOService.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/AIOService"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AIOService"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: latex
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)."
.PHONY: latexpdf
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."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
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)."
.PHONY: info
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."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
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."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

309
doc/source/conf.py Normal file
View File

@ -0,0 +1,309 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# python-laosclient documentation build configuration file, created by
# sphinx-quickstart on Tue Dec 6 17:37:53 2016.
#
# 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 sys
import os
import openstackdocstheme
import subprocess
# 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('.'))
# -- 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',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
]
# We ask git for the SHA checksum
# The git SHA checksum is used by "log-a-bug"
git_cmd = ["/usr/bin/git", "rev-parse", "HEAD"]
gitsha = str(subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0]).strip('\n')
# tag that reported bugs will be tagged with
bug_tag = "your-chosen-tag"
# source tree
pwd = os.getcwd()
# html_context allows us to pass arbitrary values into the html template
html_context = {"pwd": pwd, "gitsha": gitsha}
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
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 = 'python-laosclient'
copyright = '2016, Denis Makogon'
author = 'Denis Makogon'
# 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.
#
# The short X.Y version.
version = 'latest'
# The full version, including alpha/beta/rc tags.
release = 'latest'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
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 = []
# 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 = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- 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 = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# 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
# "<project> v<release> 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 (relative to this directory) to use as a 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']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# 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 <link> 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
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
#html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'python-laosclientdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
# Latex figure (float) alignment
#'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'python-laosclient.tex', 'python-laosclient Documentation',
'Denis Makogon', '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
# 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 = [
(master_doc, 'python-laosclient', 'python-laosclient Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'python-laosclient', 'python-laosclient Documentation',
author, 'python-laosclient', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}

24
doc/source/index.rst Normal file
View File

@ -0,0 +1,24 @@
.. python-laosclient documentation master file, created by
sphinx-quickstart on Tue Dec 6 17:37:53 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to python-laosclient's documentation!
=============================================
Contents:
.. toctree::
:maxdepth: 2
modules.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

17
doc/source/laosclient.rst Normal file
View File

@ -0,0 +1,17 @@
laosclient package
==================
Subpackages
-----------
.. toctree::
laosclient.v1
Module contents
---------------
.. automodule:: laosclient
:members:
:undoc-members:
:show-inheritance:

30
doc/source/laosclient.v1.rst Normal file
View File

@ -0,0 +1,30 @@
laosclient.v1 package
=====================
Submodules
----------
laosclient.v1.apps module
-------------------------
.. automodule:: laosclient.v1.apps
:members:
:undoc-members:
:show-inheritance:
laosclient.v1.routes module
---------------------------
.. automodule:: laosclient.v1.routes
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: laosclient.v1
:members:
:undoc-members:
:show-inheritance:

7
doc/source/modules.rst Normal file
View File

@ -0,0 +1,7 @@
laosclient
==========
.. toctree::
:maxdepth: 4
laosclient

191
laosclient/exc.py
View File

@ -1,191 +0,0 @@
# 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 sys
from oslo_serialization import jsonutils
from laosclient.i18n import _
verbose = 0
class BaseException(Exception):
"""An error occurred."""
def __init__(self, message=None):
self.message = message
def __str__(self):
return self.message or self.__class__.__doc__
class CommandError(BaseException):
"""Invalid usage of CLI."""
class InvalidEndpoint(BaseException):
"""The provided endpoint is invalid."""
class CommunicationError(BaseException):
"""Unable to communicate with server."""
class HTTPException(BaseException):
"""Base exception for all HTTP-derived exceptions."""
code = 'N/A'
def __init__(self, message=None):
super(HTTPException, self).__init__(message)
try:
self.error = jsonutils.loads(message)
if 'error' not in self.error:
raise KeyError(_('Key "error" not exists'))
except KeyError:
# NOTE(jianingy): If key 'error' happens not exist,
# self.message becomes no sense. In this case, we
# return doc of current exception class instead.
self.error = {'error':
{'message': self.__class__.__doc__}}
except Exception:
self.error = {'error':
{'message': self.message or self.__class__.__doc__}}
def __str__(self):
message = self.error['error'].get('message', 'Internal Error')
if verbose:
traceback = self.error['error'].get('traceback', '')
return (_('ERROR: %(message)s\n%(traceback)s') %
{'message': message, 'traceback': traceback})
else:
return _('ERROR: %s') % message
class HTTPMultipleChoices(HTTPException):
code = 300
def __str__(self):
self.details = _("Requested version of Searchlight API is not"
"available.")
return (_("%(name)s (HTTP %(code)s) %(details)s") %
{
'name': self.__class__.__name__,
'code': self.code,
'details': self.details})
class BadRequest(HTTPException):
"""DEPRECATED."""
code = 400
class HTTPBadRequest(BadRequest):
pass
class Unauthorized(HTTPException):
"""DEPRECATED."""
code = 401
class HTTPUnauthorized(Unauthorized):
pass
class Forbidden(HTTPException):
"""DEPRECATED."""
code = 403
class HTTPForbidden(Forbidden):
pass
class NotFound(HTTPException):
"""DEPRECATED."""
code = 404
class HTTPNotFound(NotFound):
pass
class HTTPMethodNotAllowed(HTTPException):
code = 405
class Conflict(HTTPException):
"""DEPRECATED."""
code = 409
class HTTPConflict(Conflict):
pass
class OverLimit(HTTPException):
"""DEPRECATED."""
code = 413
class HTTPOverLimit(OverLimit):
pass
class HTTPUnsupported(HTTPException):
code = 415
class HTTPInternalServerError(HTTPException):
code = 500
class HTTPNotImplemented(HTTPException):
code = 501
class HTTPBadGateway(HTTPException):
code = 502
class ServiceUnavailable(HTTPException):
"""DEPRECATED."""
code = 503
class HTTPServiceUnavailable(ServiceUnavailable):
pass
# NOTE(bcwaldon): Build a mapping of HTTP codes to corresponding exception
# classes
_code_map = {}
for obj_name in dir(sys.modules[__name__]):
if obj_name.startswith('HTTP'):
obj = getattr(sys.modules[__name__], obj_name)
_code_map[obj.code] = obj
def from_response(response):
"""Return an instance of an HTTPException based on requests response."""
cls = _code_map.get(response.status_code, HTTPException)
return cls(response.content)
class NoTokenLookupException(Exception):
"""DEPRECATED."""
pass
class EndpointNotFound(Exception):
"""DEPRECATED."""
pass

9
laosclient/osc/v1/apps.py
View File

@ -70,7 +70,8 @@ class CreateApp(command.ShowOne):
parser.add_argument("name", metavar="<name>", parser.add_argument("name", metavar="<name>",
help="App name to create") help="App name to create")
parser.add_argument("--config", metavar="<config>", parser.add_argument("--config", metavar="<config>",
help="Config for app to create in JSON format") help="Config for app to create "
"in JSON format")
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
@ -82,7 +83,8 @@ class CreateApp(command.ShowOne):
try: try:
config = json.loads(config) config = json.loads(config)
except Exception as ex: except Exception as ex:
self.log.error("Invalid config JSON: Reason: {}".format(str(ex))) self.log.error("Invalid config JSON. "
"Reason: {}".format(str(ex)))
raise ex raise ex
app = fc.apps.create(app_name, config=config)["app"] app = fc.apps.create(app_name, config=config)["app"]
@ -116,7 +118,8 @@ class UpdateApp(command.ShowOne):
parser.add_argument("name", metavar="<app-name>", parser.add_argument("name", metavar="<app-name>",
help="App name to delete") help="App name to delete")
parser.add_argument("config", metavar="<config>", parser.add_argument("config", metavar="<config>",
help="Config for app to create in JSON format") help="Config for app to "
"create in JSON format")
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):

3
laosclient/osc/v1/routes.py
View File

@ -114,7 +114,8 @@ class CreateAppRoute(command.ShowOne):
try: try:
config = json.loads(config) config = json.loads(config)
except Exception as ex: except Exception as ex:
self.log.error("Invalid config JSON: Reason: {}".format(str(ex))) self.log.error("Invalid config JSON. "
"Reason: {}".format(str(ex)))
raise ex raise ex
new_route = fc.routes.create(app, r_type, route, image, new_route = fc.routes.create(app, r_type, route, image,

0
laosclient/tests/__init__.py Normal file
View File

51
laosclient/v1/apps.py
View File

@ -22,22 +22,24 @@ class Apps(object):
self.client = session_client self.client = session_client
@client.inject_project_id @client.inject_project_id
def list(self, project_id): def list(self, project_id: str):
""" """
Lists project-scoped apps
:param project_id: :return: list of Apps
:return: :rtype: list of dict
""" """
response = self.client.get( response = self.client.get(
self.apps_route.format(project_id=project_id)) self.apps_route.format(project_id=project_id))
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def show(self, project_id, app_name): def show(self, project_id: str, app_name: str):
""" """
Shows project-scoped app info
:param project_id: :param app_name: App name
:param app_name: :type app_name: str
:return: :return:
""" """
response = self.client.get( response = self.client.get(
@ -46,13 +48,17 @@ class Apps(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def create(self, project_id, app_name, config=None): def create(self, project_id: str, app_name: str,
config: dict=None):
""" """
Creates project-scoped app
:param project_id: :param app_name: App name to create
:param app_name: :type app_name: str
:param config: :param config: App config to assign
:return: :type config: dict
:return: app
:rtype: dict
""" """
data = { data = {
"app": { "app": {
@ -66,13 +72,16 @@ class Apps(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def update(self, project_id, app_name, **data): def update(self, project_id: str, app_name: str, **data: dict):
""" """
Updates app
:param project_id: :param app_name: App name to update
:param app_name: :type app_name: str
:param data: :param data: App config to update
:return: :type data: dict
:return: app
:rtype: dict
""" """
response = self.client.put( response = self.client.put(
self.app_route.format(project_id=project_id, self.app_route.format(project_id=project_id,
@ -80,12 +89,14 @@ class Apps(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def delete(self, project_id, app_name): def delete(self, project_id: str, app_name: str):
""" """
Deletes app
:param project_id: :param app_name: App name to delete
:param app_name: :type app_name: str
:return: :return: app
:rtype: dict
""" """
response = self.client.delete( response = self.client.delete(
self.app_route.format(project_id=project_id, self.app_route.format(project_id=project_id,

33
laosclient/v1/client.py
View File

@ -16,24 +16,23 @@ from laosclient.v1 import routes
class Client(object): class Client(object):
"""Client for the Functions v1 API.
:param session: a keystoneauth session object
:type session: keystoneauth1.session.Session
:param str service_type: The default service_type for URL discovery
:param str interface: The default interface for URL discovery
(Default: public)
:param str region_name: The default region_name for URL discovery
:param str endpoint_override: Always use this endpoint URL for requests
for this laosclient
:param auth: An auth plugin to use instead of the session one
:type auth: keystoneauth1.plugin.BaseAuthPlugin
:param str user_agent: The User-Agent string to set
(Default is python-laosclient)
"""
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
"""Initialize a new client for the Functions v1 API.""" """
Client for the Functions v1 API.
:param session: a keystoneauth session object
:type session: keystoneauth1.session.Session
:param str service_type: The default service_type for URL discovery
:param str interface: The default interface for URL discovery
(Default: public)
:param str region_name: The default region_name for URL discovery
:param str endpoint_override: Always use this endpoint URL for requests
for this laosclient
:param auth: An auth plugin to use instead of the session one
:type auth: keystoneauth1.plugin.BaseAuthPlugin
:param str user_agent: The User-Agent string to set
(Default is python-laosclient)
"""
self.http_client = client.construct_http_client(*args, **kwargs) self.http_client = client.construct_http_client(*args, **kwargs)
self.apps = apps.Apps(self.http_client) self.apps = apps.Apps(self.http_client)
self.routes = routes.Routes(self.http_client) self.routes = routes.Routes(self.http_client)

109
laosclient/v1/routes.py
View File

@ -26,22 +26,35 @@ class Routes(object):
self.client = session_client self.client = session_client
@client.inject_project_id @client.inject_project_id
def create(self, project_id, app_name, execution_type, def create(self, project_id: str, app_name: str,
route_path, image, is_public=False, memory=None, execution_type: str, route_path: str, image: str,
timeout=None, max_concurrency=None, config=None): is_public: bool=False, memory: int=None,
timeout: int=None, max_concurrency: int=None,
config: dict=None):
""" """
Creates an app route Creates app route
:param app_name: :param app_name: App name
:param execution_type: :type app_name: str
:param route_path: :param execution_type: App route execution type (async, sync)
:param image: :type execution_type: str
:param is_public: :param route_path: App route path
:param memory: :type route_path: str
:param timeout: :param image: Docker image reference
:param max_concurrency: :type image: str
:param config: :param is_public: Whether app route is public or private
:return: :type is_public: bool
:param memory: App route RAM to allocate
:type memory: int
:param timeout: App route execution time frame
:type timeout: int
:param max_concurrency: Number of app route max concurrent
requests before container dies
:type max_concurrency: int
:param config: App route config
:type config: dict
:return: App route
:rtype: dict
""" """
body = { body = {
"route": { "route": {
@ -62,23 +75,30 @@ class Routes(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def list(self, project_id, app_name): def list(self, project_id: str, app_name: str):
""" """
Lists project-scoped app routes
:param app_name: :param app_name: App route
:return: :type app_name: str
:return: list of routes
:rtype: list of dict
""" """
response = self.client.get(self.routes_path.format( response = self.client.get(self.routes_path.format(
project_id=project_id, app=app_name)) project_id=project_id, app=app_name))
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def show(self, project_id, app_name, route_path): def show(self, project_id: str, app_name: str, route_path: str):
""" """
Retrieves app route information
:param app_name: :param app_name: App name
:param route_path: :type app_name: str
:return: :param route_path: App route path
:type route_path: str
:return: App route
:rtype: dict
""" """
response = self.client.get(self.route_path.format( response = self.client.get(self.route_path.format(
project_id=project_id, app=app_name, project_id=project_id, app=app_name,
@ -86,13 +106,19 @@ class Routes(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def update(self, project_id, app_name, route_path, **data): def update(self, project_id: str, app_name: str,
route_path: str, **data: str):
""" """
Updates route with provided data
:param app_name: :param app_name: App name
:param route_path: :type app_name: str
:param route_path: App route to update
:type route_path: str
:param data: :param data:
:return: :type data: dict
:return: App route
:rtype: dict
""" """
response = self.client.put(self.route_path.format( response = self.client.put(self.route_path.format(
project_id=project_id, app=app_name, project_id=project_id, app=app_name,
@ -100,12 +126,15 @@ class Routes(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def delete(self, project_id, app_name, route_path): def delete(self, project_id: str, app_name: str, route_path: str):
""" """
Deletes app
:param app_name: :param app_name: App name
:param route_path: :type app_name: str
:return: :param route_path: App route path
:return: None
:rtype: None
""" """
response = self.client.delete( response = self.client.delete(
self.route_path.format( self.route_path.format(
@ -114,13 +143,22 @@ class Routes(object):
return response.json() return response.json()
@client.inject_project_id @client.inject_project_id
def execute(self, project_id, app_name, route_path, **data): def execute(self, project_id: str, app_name: str, route_path: str,
supply_auth_properties: bool=False, **data: dict):
""" """
Runs execution against public/private routes
:param app_name: :param app_name: App name
:param route_path: :type app_name: str
:param data: :param route_path: App route path
:return: :type route_path: str
:param supply_auth_properties: Whether to include auth properties
like OS_AUTH_URL and OS_TOKEN into execution parameters data
:type supply_auth_properties: bool
:param data: execution data
:type data: dict
:return: execution result, depends on the type of execution
:rtype: dict
""" """
route = self.show(app_name, route_path) route = self.show(app_name, route_path)
is_public = json.loads(route.get("is_public")) is_public = json.loads(route.get("is_public"))
@ -129,5 +167,8 @@ class Routes(object):
self.private_execution.format( self.private_execution.format(
project_id=project_id, app=app_name, project_id=project_id, app=app_name,
route_path=route_path)) route_path=route_path))
if supply_auth_properties:
data.update(OS_AUTH_URL=self.client.auth.auth_url,
OS_TOKEN=self.client.get_token())
response = self.client.post(url, json=data) response = self.client.post(url, json=data)
return response.json() return response.json()

1
test-requirements.txt
View File

@ -8,6 +8,7 @@ coverage>=4.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD fixtures>=3.0.0 # Apache-2.0/BSD
mock>=2.0 # BSD mock>=2.0 # BSD
oslosphinx>=4.7.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0
openstackdocstheme # Apache-2.0
sphinx!=1.3b1,<1.4,>=1.2.1 # BSD sphinx!=1.3b1,<1.4,>=1.2.1 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT testtools>=1.4.0 # MIT

9
tox.ini
View File

@ -1,5 +1,5 @@
[tox] [tox]
envlist = pypy,py34,py35,pep8 envlist = py35,pep8
minversion = 1.6 minversion = 1.6
skipsdist = True skipsdist = True
@ -13,6 +13,7 @@ commands =
find . -type f -name "*.pyc" -delete find . -type f -name "*.pyc" -delete
python setup.py testr --slowest --testr-args='{posargs}' python setup.py testr --slowest --testr-args='{posargs}'
whitelist_externals = find whitelist_externals = find
rm
[testenv:pypy] [testenv:pypy]
deps = setuptools<3.2 deps = setuptools<3.2
@ -30,13 +31,15 @@ commands = {posargs}
commands = python setup.py testr --coverage --testr-args='{posargs}' commands = python setup.py testr --coverage --testr-args='{posargs}'
[testenv:docs] [testenv:docs]
commands= commands =
rm -rf doc/html doc/build
sphinx-apidoc -f -o doc/source laosclient laosclient/v1/client.py laosclient/client.py laosclient/i18n.py laosclient/osc laosclient/common
python setup.py build_sphinx python setup.py build_sphinx
[flake8] [flake8]
ignore = E123,E126,E128,E241,E265,E713,H202,H405,H238,H404 ignore = E123,E126,E128,E241,E265,E713,H202,H405,H238,H404
show-source = True show-source = True
exclude=.venv,.git,.tox,dist,*lib/python*,*egg,build,*venv* exclude=.venv,.git,.tox,dist,*lib/python*,*egg,build,*venv*,doc*
max-complexity=20 max-complexity=20
[hacking] [hacking]