From 9882374a4cd9b5e04a8c0f4c38a4016145c84481 Mon Sep 17 00:00:00 2001 From: Huang Rui Date: Fri, 28 Aug 2015 13:44:45 +0800 Subject: [PATCH] Init commit of ceilometer-zvm Build project infrastructure, including: - project source tree - init sphinx doc - testr config file - .gitignore - requirement and test-requirement file - setup.py and setup.cfg - tox config file - empty README.rst Change-Id: Ia4c1b03aa1dc871b9e41d56bf7c4a160eff4e1e1 --- .gitignore | 17 ++ .testr.conf | 10 + README.rst | 1 + ceilometer_zvm/__init__.py | 0 ceilometer_zvm/compute/__init__.py | 0 ceilometer_zvm/compute/virt/__init__.py | 0 ceilometer_zvm/compute/virt/zvm/__init__.py | 0 ceilometer_zvm/tests/__init__.py | 0 ceilometer_zvm/tests/unit/__init__.py | 0 ceilometer_zvm/tests/unit/compute/__init__.py | 0 .../tests/unit/compute/virt/__init__.py | 0 .../tests/unit/compute/virt/zvm/__init__.py | 0 doc/source/conf.py | 258 ++++++++++++++++++ doc/source/index.rst | 22 ++ requirements.txt | 7 + setup.cfg | 46 ++++ setup.py | 23 ++ test-requirements.txt | 12 + tox.ini | 36 +++ 19 files changed, 432 insertions(+) create mode 100644 .gitignore create mode 100644 .testr.conf create mode 100644 README.rst create mode 100644 ceilometer_zvm/__init__.py create mode 100644 ceilometer_zvm/compute/__init__.py create mode 100644 ceilometer_zvm/compute/virt/__init__.py create mode 100644 ceilometer_zvm/compute/virt/zvm/__init__.py create mode 100644 ceilometer_zvm/tests/__init__.py create mode 100644 ceilometer_zvm/tests/unit/__init__.py create mode 100644 ceilometer_zvm/tests/unit/compute/__init__.py create mode 100644 ceilometer_zvm/tests/unit/compute/virt/__init__.py create mode 100644 ceilometer_zvm/tests/unit/compute/virt/zvm/__init__.py create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cf8ef3e --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +.autogenerated +.coverage +.project +.pydevproject +.python-version +.settings/ +.testrepository/ +.tox/ +.venv +*.log +*.pyc +build/ +ceilometer_zvm.egg-info/ +dist/ +doc/build/ +AUTHORS +ChangeLog \ No newline at end of file diff --git a/.testr.conf b/.testr.conf new file mode 100644 index 0000000..32794fc --- /dev/null +++ b/.testr.conf @@ -0,0 +1,10 @@ +[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 ./ceilometer_zvm/tests/unit/compute/virt/zvm/ \ + ./ceilometer_zvm/tests/unit/compute/virt/zvm \ + $LISTOPT $IDOPTION +test_id_option=--load-list $IDFILE +test_list_option=--list diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..bac3035 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +TODO(rui): To add readme content diff --git a/ceilometer_zvm/__init__.py b/ceilometer_zvm/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/compute/__init__.py b/ceilometer_zvm/compute/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/compute/virt/__init__.py b/ceilometer_zvm/compute/virt/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/compute/virt/zvm/__init__.py b/ceilometer_zvm/compute/virt/zvm/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/tests/__init__.py b/ceilometer_zvm/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/tests/unit/__init__.py b/ceilometer_zvm/tests/unit/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/tests/unit/compute/__init__.py b/ceilometer_zvm/tests/unit/compute/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/tests/unit/compute/virt/__init__.py b/ceilometer_zvm/tests/unit/compute/virt/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ceilometer_zvm/tests/unit/compute/virt/zvm/__init__.py b/ceilometer_zvm/tests/unit/compute/virt/zvm/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..93b77e3 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,258 @@ +# -*- coding: utf-8 -*- +# +# Ceilometer-zvm-virt-inspector documentation build configuration file, created by +# sphinx-quickstart on Wed Jul 1 17:25:05 2015. +# +# 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 = ['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'Ceilometer-zvm' +copyright = u'2015, IBM' + +# 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 = '2015.2' +# The full version, including alpha/beta/rc tags. +release = '2015.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 +# " 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'] + +# 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 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 = 'Ceilometer-zvm-doc' + + +# -- 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', 'Ceilometer-zvm.tex', u'Ceilometer-zvm Documentation', + u'IBM', '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', 'ceilometer-zvm', u'Ceilometer-zvm Documentation', + [u'IBM'], 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', 'Ceilometer-zvm', u'Ceilometer-zvm Documentation', + u'IBM', 'Ceilometer-zvm', '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 diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..f0367fd --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,22 @@ +.. Ceilometer-zvm-virt-inspector documentation master file, created by + sphinx-quickstart on Wed Jul 1 17:25:05 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Ceilometer-zvm's documentation! +========================================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1912f67 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +eventlet>=0.17.4 +oslo.concurrency>=2.3.0 # Apache-2.0 +oslo.config>=2.1.0 # Apache-2.0 +oslo.i18n>=1.5.0 # Apache-2.0 +oslo.log>=1.8.0 # Apache-2.0 +oslo.service>=0.6.0 # Apache-2.0 +pbr<2.0,>=1.4 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..8ecde89 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,46 @@ +[metadata] +name = ceilometer-zvm +version = 2015.2 +summary = Ceilometer zvm specific implementation of virt inspector +description-file = README.rst +author = IBM +home-page = +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + +[files] +packages = + ceilometer_zvm + +[entry_points] +ceilometer.compute.virt = + zvm = ceilometer_zvm.compute.virt.zvm.inspector:ZVMInspector + +[build_sphinx] +source-dir = doc/source +build-dir = doc/build +all_files = 1 + +[upload_sphinx] +upload-dir = doc/build/html + +[compile_catalog] +directory = ceilometer_zvm/locale +domain = ceilometer-zvm + +[update_catalog] +domain = ceilometer-zvm +output_dir = ceilometer_zvm/locale +input_file = ceilometer_zvm/locale/ceilometer-zvm.pot + +[extract_messages] +keywords = _ gettext ngettext l_ lazy_gettext +mapping_file = babel.cfg +output_file = ceilometer_zvm/locale/ceilometer-zvm.pot diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..46da3a8 --- /dev/null +++ b/setup.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python + +# Copyright 2015 IBM Corp. +# +# 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) diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..99a42e1 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,12 @@ +hacking<0.11,>=0.10.0 +coverage>=3.6 +discover +fixtures>=1.3.1 +python-subunit>=0.0.18 +sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 +oslosphinx>=2.5.0 # Apache-2.0 +oslotest>=1.10.0 # Apache-2.0 +testrepository>=0.0.18 +testscenarios>=0.4 +testtools>=1.4.0 +mock>=1.2 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..652869e --- /dev/null +++ b/tox.ini @@ -0,0 +1,36 @@ +[tox] +minversion = 1.6 +envlist = pep8,py27 +skipsdist = True + +[testenv] +usedevelop = True +install_command = pip install -U {opts} {packages} +setenv = + VIRTUAL_ENV={envdir} +deps = -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + -egit+https://github.com/openstack/ceilometer#egg=ceilometer +commands = python setup.py testr --slowest --testr-args='{posargs}' + +[testenv:pep8] +commands = flake8 + +[testenv:py27] +commands = /bin/cp -r {toxinidir}/ceilometer_zvm/compute/virt/zvm \ + {toxinidir}/.tox/py27/src/ceilometer/ceilometer/compute/virt/ + python setup.py testr --slowest --testr-args='{posargs}' + +[testenv:venv] +commands = {posargs} + +[testenv:cover] +commands = python setup.py testr --coverage --testr-args='{posargs}' + +[flake8] +#ignore = E121,E122,E123,E124,E125,E126,E127,E128,E129,E131,E251,H405 +exclude = .venv,.git,.tox,dist,doc,*egg,build + +[hacking] +import_exceptions = nova.i18n +