Separation of tests by folders and gate-docs fix

For unittests was created new directory and all such tests were moved
there. Also, .testr.conf was edited, where directory
magnetodb/tests/unittests' was set by default tox executing.

'tests.unittests.api.test_boto' and 'storage.model' were edited to back
compatibility with Python 2.6 and README.rst was updated with actual
values (stackforge) as well.

Also, 'sphinx' support was added.

Change-Id: I5d182644f692f4ca874185139cb72990040215eb
Closes-Bug: #1287144
Closes-Bug: #1287187
This commit is contained in:
Maksym Iarmak 2014-03-03 17:37:29 +02:00
parent a44af23b92
commit 6f1ea4e2f9
11 changed files with 324 additions and 35 deletions

4
.gitreview Normal file
View File

@ -0,0 +1,4 @@
[gerrit]
host=review.openstack.org
port=29418
project=stackforge/magnetodb.git

View File

@ -1,4 +1,4 @@
[DEFAULT]
test_command=${PYTHON:-python} -m subunit.run discover -t ./ ./magnetodb/tests $LISTOPT $IDOPTION
test_command=${PYTHON:-python} -m subunit.run discover -t ./ ./magnetodb/tests/unittests $LISTOPT $IDOPTION
test_id_option=--load-list $IDFILE
test_list_option=--list

View File

@ -10,6 +10,6 @@ Wiki - https://wiki.openstack.org/wiki/MagnetoDB
IRC - #magnetodb at FreeNode
Source code - https://github.com/Mirantis/magnetodb
Source code - https://github.com/stackforge/magnetodb
Deployment - https://github.com/Mirantis/magnetodb/blob/master/doc/deploy_magnetodb_howto.rst
Deployment - https://github.com/stackforge/magnetodb/blob/master/doc/deploy_magnetodb_howto.rst

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

@ -0,0 +1,260 @@
# -*- coding: utf-8 -*-
#
# MagnetoDB documentation build configuration file, created by
# sphinx-quickstart on Tue Mar 4 14:41:26 2014.
#
# 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
# 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',
]
# 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'MagnetoDB'
copyright = u'2014, Mirantis Inc.'
# 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 = '2.0'
# The full version, including alpha/beta/rc tags.
release = '2.0.2'
# 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 = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = 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 = '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
# "<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 (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']
# 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
# Output file base name for HTML help builder.
htmlhelp_basename = 'MagnetoDBdoc'
# -- 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, or own class]).
latex_documents = [
('index', 'MagnetoDB.tex', u'MagnetoDB Documentation',
u'Mirantis Inc.', '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', 'magnetodb', u'MagnetoDB Documentation',
[u'Mirantis Inc.'], 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', 'MagnetoDB', u'MagnetoDB Documentation',
u'Mirantis Inc.', 'MagnetoDB', '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

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

@ -0,0 +1,22 @@
.. MagnetoDB documentation master file, created by
sphinx-quickstart on Tue Mar 4 14:41:26 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to MagnetoDB's documentation!
=====================================
Contents:
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -62,10 +62,10 @@ class AttributeType(ModelBase):
COLLECTION_TYPE_SET = "set"
_allowed_types = {ELEMENT_TYPE_STRING, ELEMENT_TYPE_NUMBER,
ELEMENT_TYPE_BLOB}
_allowed_types = set([ELEMENT_TYPE_STRING, ELEMENT_TYPE_NUMBER,
ELEMENT_TYPE_BLOB])
_allowed_collection_types = {None, COLLECTION_TYPE_SET}
_allowed_collection_types = set([None, COLLECTION_TYPE_SET])
_data_fields = ['element_type', 'collection_type']
@ -213,7 +213,7 @@ class AttributeValue(ModelBase):
class Condition(object):
CONDITION_TYPE_EQUAL = "e"
_allowed_types = {CONDITION_TYPE_EQUAL}
_allowed_types = set([CONDITION_TYPE_EQUAL])
def __init__(self, condition_type, condition_arg):
assert condition_type in self._allowed_types, (
@ -242,9 +242,9 @@ class IndexedCondition(Condition):
CONDITION_TYPE_GREATER = "g"
CONDITION_TYPE_GREATER_OR_EQUAL = "ge"
_allowed_types = {Condition.CONDITION_TYPE_EQUAL, CONDITION_TYPE_LESS,
CONDITION_TYPE_LESS_OR_EQUAL, CONDITION_TYPE_GREATER,
CONDITION_TYPE_GREATER_OR_EQUAL}
_allowed_types = set([Condition.CONDITION_TYPE_EQUAL, CONDITION_TYPE_LESS,
CONDITION_TYPE_LESS_OR_EQUAL, CONDITION_TYPE_GREATER,
CONDITION_TYPE_GREATER_OR_EQUAL])
@classmethod
def lt(cls, condition_arg):
@ -282,13 +282,14 @@ class ScanCondition(IndexedCondition):
CONDITION_TYPE_NOT_CONTAINS = "not_contains"
CONDITION_TYPE_NOT_EQUAL = "ne"
_allowed_types = {Condition.CONDITION_TYPE_EQUAL,
IndexedCondition.CONDITION_TYPE_LESS,
IndexedCondition.CONDITION_TYPE_LESS_OR_EQUAL,
IndexedCondition.CONDITION_TYPE_GREATER,
IndexedCondition.CONDITION_TYPE_GREATER_OR_EQUAL,
CONDITION_TYPE_IN, CONDITION_TYPE_CONTAINS,
CONDITION_TYPE_NOT_CONTAINS, CONDITION_TYPE_NOT_EQUAL}
_allowed_types = set([Condition.CONDITION_TYPE_EQUAL,
IndexedCondition.CONDITION_TYPE_LESS,
IndexedCondition.CONDITION_TYPE_LESS_OR_EQUAL,
IndexedCondition.CONDITION_TYPE_GREATER,
IndexedCondition.CONDITION_TYPE_GREATER_OR_EQUAL,
CONDITION_TYPE_IN, CONDITION_TYPE_CONTAINS,
CONDITION_TYPE_NOT_CONTAINS,
CONDITION_TYPE_NOT_EQUAL])
@classmethod
def neq(cls, condition_arg):
@ -310,7 +311,8 @@ class ScanCondition(IndexedCondition):
class ExpectedCondition(Condition):
CONDITION_TYPE_EXISTS = "exists"
_allowed_types = {Condition.CONDITION_TYPE_EQUAL, CONDITION_TYPE_EXISTS}
_allowed_types = set(
[Condition.CONDITION_TYPE_EQUAL, CONDITION_TYPE_EXISTS])
@classmethod
def exists(cls):
@ -327,8 +329,8 @@ class SelectType(object):
SELECT_TYPE_SPECIFIED = "specified"
SELECT_TYPE_COUNT = "count"
_allowed_types = {SELECT_TYPE_ALL, SELECT_TYPE_ALL_PROJECTED,
SELECT_TYPE_SPECIFIED, SELECT_TYPE_COUNT}
_allowed_types = set([SELECT_TYPE_ALL, SELECT_TYPE_ALL_PROJECTED,
SELECT_TYPE_SPECIFIED, SELECT_TYPE_COUNT])
def __init__(self, select_type, attributes=None):
assert select_type in self._allowed_types, (
@ -440,8 +442,8 @@ class UpdateItemAction(object):
UPDATE_ACTION_DELETE = "delete"
UPDATE_ACTION_ADD = "add"
_allowed_actions = {UPDATE_ACTION_PUT, UPDATE_ACTION_DELETE,
UPDATE_ACTION_ADD}
_allowed_actions = set([UPDATE_ACTION_PUT, UPDATE_ACTION_DELETE,
UPDATE_ACTION_ADD])
def __init__(self, action, value):
"""

View File

@ -22,12 +22,12 @@ from boto.dynamodb2 import RegionInfo
from boto.dynamodb2.layer1 import DynamoDBConnection
from boto.dynamodb2 import types as schema_types
from boto.dynamodb2 import fields
from magnetodb.tests.fake import magnetodb_api_fake
from boto.dynamodb2.table import Table
from magnetodb.common.exception import TableNotExistsException
from magnetodb.common.exception import TableAlreadyExistsException
from magnetodb.storage import models
from magnetodb import storage
from magnetodb.tests.fake import magnetodb_api_fake
from mox import Mox, IgnoreArg
from magnetodb.common.config import CONF
@ -281,8 +281,8 @@ class BotoIntegrationTest(unittest.TestCase):
"hash_key": 1,
"range_key": "range",
"value_blob": types.Binary(blob_data1),
"value_blob_set": {types.Binary(blob_data1),
types.Binary(blob_data2)}
"value_blob_set": set([types.Binary(blob_data1),
types.Binary(blob_data2)])
},
False
)
@ -331,7 +331,7 @@ class BotoIntegrationTest(unittest.TestCase):
),
"value_blob_set": models.AttributeValue(
models.ATTRIBUTE_TYPE_BLOB_SET,
{blob_data1, blob_data2}
set([blob_data1, blob_data2])
)
}
]
@ -348,8 +348,8 @@ class BotoIntegrationTest(unittest.TestCase):
"hash_key": decimal.Decimal(hash_key),
"range_key": range_key,
"value_blob": types.Binary(blob_data1),
"value_blob_set": {types.Binary(blob_data1),
types.Binary(blob_data2)}
"value_blob_set": set([types.Binary(blob_data1),
types.Binary(blob_data2)])
}
self.assertDictEqual(expected_item, dict(item.items()))
@ -386,7 +386,7 @@ class BotoIntegrationTest(unittest.TestCase):
),
"value_blob_set": models.AttributeValue(
models.ATTRIBUTE_TYPE_BLOB_SET,
{blob_data1, blob_data2}
set([blob_data1, blob_data2])
)
}
]
@ -403,8 +403,8 @@ class BotoIntegrationTest(unittest.TestCase):
"hash_key": decimal.Decimal(hash_key),
"range_key": range_key,
"value_blob": types.Binary(blob_data1),
"value_blob_set": {types.Binary(blob_data1),
types.Binary(blob_data2)}
"value_blob_set": set([types.Binary(blob_data1),
types.Binary(blob_data2)])
}
self.assertEqual(len(items), 1)

View File

@ -1,11 +1,12 @@
boto>=2.4.0,!=2.13.0
discover
flake8==2.0
funkload
mox>=0.5.3
nose
pep8==1.4.5
sphinx>=1.1.2,<1.2
testresources
testrepository>=0.0.17
testtools>=0.9.32
wsgi_intercept
nose
funkload
testresources
discover