Modify to work python-jobs correctly

- Refactoring for pep8
- add small tests for py27
- fix a issue that build_sphinx fails

Change-Id: If70024b6a18e6fc234205843dbde3a306296b5ab

.gitignore

@@ -0,0 +1 @@
+*.pyc

.testr.conf

@@ -0,0 +1,7 @@
+[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 $DISCOVER_DIRECTORY $LISTOPT $IDOPTION
+test_id_option=--load-list $IDFILE
+test_list_option=--list

doc/source/conf.py

@@ -0,0 +1,275 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2013 Mirantis Inc.
+#
+# 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 subprocess
+import sys
+
+import os
+import warnings
+
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+# 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('../../meteosclient'))
+sys.path.append(os.path.abspath('..'))
+sys.path.append(os.path.abspath('../bin'))
+
+# -- 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.doctest', 'sphinx.ext.todo',
+              'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+
+if not on_rtd:
+    extensions.append('oslosphinx')
+
+# 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'Meteos Client'
+copyright = u'2013, 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 meteosclient.version import version_info as meteosclient_version
+release = meteosclient_version.release_string()
+# The short X.Y version.
+version = meteosclient_version.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 = []
+
+# 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.
+
+if on_rtd:
+    html_theme_path = ['.']
+    html_theme = '_theme_rtd'
+
+# 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 = 'Meteos Client'
+
+# 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'
+git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
+           "-n1"]
+try:
+    html_last_updated_fmt = subprocess.Popen(
+        git_cmd, stdout=subprocess.PIPE).communicate()[0]
+except Exception:
+    warnings.warn('Cannot get last updated time from git repository. '
+                  'Not setting "html_last_updated_fmt".')
+
+# 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 = {
+    'index':    ['sidebarlinks.html', 'localtoc.html', 'searchbox.html', 'sourcelink.html'],
+    '**':       ['localtoc.html', 'relations.html',
+                 'searchbox.html', 'sourcelink.html']
+}
+
+# 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
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MeteosClientDoc'
+
+
+# -- 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': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+    ('index', 'meteosclientdoc.tex', u'Meteos Client',
+     u'OpenStack Foundation', '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 = [
+    ('index', 'meteosclient', u'Meteos Client',
+     [u'OpenStack Foundation'], 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 = [
+    ('index', 'Meteos Client', u'Meteos Client',
+     u'OpenStack Foundation', 'Meteos Client', 'Meteos Client',
+     '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'

doc/source/index.rst

@@ -0,0 +1,42 @@
+Python bindings to the OpenStack Meteos API
+===========================================
+
+This is a client for OpenStack Meteos API. There's :doc:`a Python API
+<api>` (the :mod:`meteosclient` module), and a :doc:`command-line utility
+<shell>` (installed as an OpenStackClient plugin). Each implements the entire
+OpenStack Meteos API.
+
+You'll need credentials for an OpenStack cloud that implements the
+Data Processing API, in order to use the meteos client.
+
+You may want to read the `OpenStack Meteos Docs`__  -- the overview, at
+least -- to get an idea of the concepts. By understanding the concepts
+this library should make more sense.
+
+ __ http://docs.openstack.org/developer/meteos/
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   shell
+   cli
+   how_to_participate
+
+Contributing
+============
+
+Code is hosted in `review.o.o`_ and mirrored to `github`_ and `git.o.o`_ .
+Submit bugs to the Meteos project on `launchpad`_ and to the Meteos client on
+`launchpad_client`_. Submit code to the openstack/python-meteosclient project
+using `gerrit`_.
+
+.. _review.o.o: https://review.openstack.org
+.. _github: https://github.com/openstack/python-meteosclient
+.. _git.o.o: http://git.openstack.org/cgit/openstack/python-meteosclient
+.. _launchpad: https://launchpad.net/meteos
+.. _launchpad_client: https://launchpad.net/python-meteosclient
+.. _gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
+

meteosclient/api/client.py

@@ -22,12 +22,12 @@ from keystoneauth1.identity import v3
 from keystoneauth1 import session as keystone_session
 from keystoneauth1 import token_endpoint
 
-from meteosclient.api import templates
-from meteosclient.api import experiments
 from meteosclient.api import datasets
-from meteosclient.api import models
-from meteosclient.api import model_evaluations
+from meteosclient.api import experiments
 from meteosclient.api import learnings
+from meteosclient.api import model_evaluations as model_eva
+from meteosclient.api import models
+from meteosclient.api import templates
 
 
 USER_AGENT = 'python-meteosclient'
@@ -120,7 +120,7 @@ class Client(object):
         self.experiments = experiments.ExperimentManager(client)
         self.datasets = datasets.DatasetManager(client)
         self.models = models.ModelManager(client)
-        self.model_evaluations = model_evaluations.ModelEvaluationManager(client)
+        self.model_evaluations = model_eva.ModelEvaluationManager(client)
         self.learnings = learnings.LearningManager(client)
 
     def _get_keystone_auth(self, username=None, api_key=None, auth_url=None,

meteosclient/api/datasets.py

@@ -14,8 +14,8 @@
 # limitations under the License.
 
 import base64
-from six.moves.urllib import parse
 from meteosclient.api import base
+from six.moves.urllib import parse
 
 
 class Dataset(base.Resource):

meteosclient/api/model_evaluations.py

@@ -13,10 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import base64
-from six.moves.urllib import parse
-
 from meteosclient.api import base
+from six.moves.urllib import parse
 
 
 class ModelEvaluation(base.Resource):

meteosclient/api/shell.py

@@ -14,13 +14,10 @@
 #    under the License.
 
 import argparse
-import datetime
 import inspect
 import json
-import os.path
 import sys
 
-from meteosclient.openstack.common.apiclient import exceptions
 from meteosclient.openstack.common import cliutils as utils
 
 

meteosclient/shell.py

@@ -27,7 +27,6 @@ import argparse
 import getpass
 import logging
 import sys
-import warnings
 
 import six
 

meteosclient/tests/unit/base.py

@@ -0,0 +1,47 @@
+# Copyright (c) 2014 Mirantis Inc.
+#
+#    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 six
+import testtools
+
+from meteosclient.api import base
+from meteosclient.api import client
+
+from requests_mock.contrib import fixture
+
+
+class BaseTestCase(testtools.TestCase):
+
+    URL = 'http://localhost:8989'
+    TOKEN = 'token'
+
+    def setUp(self):
+        super(BaseTestCase, self).setUp()
+        self.responses = self.useFixture(fixture.Fixture())
+        self.client = client.Client(meteos_url=self.URL,
+                                    input_auth_token=self.TOKEN)
+
+    def assertFields(self, body, obj):
+        for key, value in six.iteritems(body):
+            self.assertEqual(value, getattr(obj, key))
+
+
+class TestResource(base.Resource):
+    resource_name = 'Test Resource'
+    defaults = {'description': 'Test Description',
+                'extra': "extra"}
+
+
+class TestManager(base.ResourceManager):
+    resource_class = TestResource

meteosclient/tests/unit/test_base.py

@@ -0,0 +1,28 @@
+# Copyright (c) 2016 Mirantis Inc.
+#
+#    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.
+
+from meteosclient.api import base as api_base
+from meteosclient.tests.unit import base
+
+
+class BaseTest(base.BaseTestCase):
+    def test_get_query_string(self):
+        res = api_base.get_query_string(None, limit=None, marker=None)
+        self.assertEqual("", res)
+
+        res = api_base.get_query_string(None, limit=4, marker=None)
+        self.assertEqual("?limit=4", res)
+
+        res = api_base.get_query_string({'opt1': 2}, limit=None, marker=3)
+        self.assertEqual("?marker=3&opt1=2", res)

meteosclient/tests/unit/test_templates.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2014 Mirantis Inc.
+#
+#    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.
+
+from meteosclient.api import templates
+from meteosclient.tests.unit import base
+
+
+class TemplateTest(base.BaseTestCase):
+    body = {
+        'username': 'name',
+        'description': 'descr'
+    }
+
+    def test_templates_list(self):
+        url = self.URL + '/templates'
+        self.responses.get(url, json={'templates': [self.body]})
+
+        resp = self.client.templates.list()
+
+        self.assertEqual(url, self.responses.last_request.url)
+        self.assertIsInstance(resp[0], templates.Template)
+        self.assertFields(self.body, resp[0])
+
+    def test_templates_get(self):
+        url = self.URL + '/templates/id?show_progress=False'
+        self.responses.get(url, json={'template': self.body})
+
+        resp = self.client.templates.get('id')
+
+        self.assertEqual(url, self.responses.last_request.url)
+        self.assertIsInstance(resp, templates.Template)
+        self.assertFields(self.body, resp)

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py34,pypy,pep8,releasenotes
+envlist = py27,pep8
 minversion = 1.6
 skipsdist = True