Merge branch 'release/1.2.2'

.gitignore

@@ -56,3 +56,6 @@ docs/_build/
 
 # PyBuilder
 target/
+
+# OS X crud
+.DS_Store

CONTRIBUTING.rst

@@ -0,0 +1,145 @@
+Please do contribute! We only have a few simple requirements for diffs and
+pull requests.
+
+* `Follow coding guidelines`_
+* `Add automated unit tests`_
+* `Update documentation`_
+* `Add yourself as a contributor`_
+
+Follow coding guidelines
+------------------------
+
+Logging level usage
+'''''''''''''''''''
+
+  ERROR
+    Something is wrong (such as a violation of the OVF specification)
+    but COT was able to attempt to recover. If recovery is not possible,
+    you should raise an ``Error`` of appropriate type instead of logging
+    an ERROR message.
+  WARNING
+    Something unexpected or risky happened that the user needs a
+    heads-up about. This includes cases where the software had to make
+    an uncertain choice on its own due to lack of information from the
+    user.
+  INFO
+    Important status updates about normal operation of the software.
+    As this is the lowest logging level enabled by default, you should
+    keep the logs generated at this level relatively brief but
+    meaningful.
+  VERBOSE
+    Detailed information of interest to an advanced or inquisitive user.
+  DEBUG
+    Highly detailed information only useful to a developer familiar with
+    the code.
+
+Coding style
+''''''''''''
+
+To verify that your code meets applicable Python coding standards, use
+flake8_ (``pip install flake8``):
+
+::
+
+  cot/$ flake8
+  ./COT/tests/ovf.py:180:80: E501 line too long (80 > 79 characters)
+  ./COT/tests/ovf.py:184:77: F841 local variable 'ovf' is assigned to but never used
+  ./COT/tests/ovf.py:184:80: E501 line too long (80 > 79 characters)
+  ./COT/tests/ovf.py:196:40: F841 local variable 'ova' is assigned to but never used
+  ./COT/tests/ovf.py:210:75: F841 local variable 'ovf' is assigned to but never used
+  ./COT/ovf.py:776:5: E303 too many blank lines (2)
+
+Fix any errors it reports, and run again until no errors are reported.
+
+Add automated unit tests
+------------------------
+
+Whether adding new functionality or fixing a bug, **please** add appropriate
+unit test case(s) under ``COT/tests/`` to cover your changes. Your changes
+**must** pass all existing and new automated test cases before your code
+will be accepted.
+
+You can run the COT automated tests under a single Python version by
+running ``python ./setup.py test``.
+
+For full testing under all supported versions as well as verifying code
+coverage for your tests, you should install tox_ (``pip install tox``) and
+coverage_ (``pip install coverage``) then run ``tox`` from the COT directory:
+
+::
+
+  cot/$ tox
+  ...
+  py26 runtests: commands[0] | coverage run --append setup.py test --quiet
+  ...
+  py27 runtests: commands[0] | coverage run --append setup.py test --quiet
+  ...
+  py32 runtests: commands[0] | coverage run --append setup.py test --quiet
+  ...
+  py33 runtests: commands[0] | coverage run --append setup.py test --quiet
+  ...
+  py34 runtests: commands[0] | coverage run --append setup.py test --quiet
+  ...
+  pypy runtests: commands[0] | coverage run --append setup.py test --quiet
+  ...
+  stats runtests: commands[0] | coverage combine
+  stats runtests: commands[1] | coverage report -i
+  Name                        Stmts   Miss  Cover
+  -----------------------------------------------
+  COT/__init__.py                 4      0   100%
+  COT/add_disk.py               147      1    99%
+  COT/add_file.py                50      0   100%
+  COT/cli.py                    143      6    96%
+  COT/data_validation.py         69      0   100%
+  COT/deploy.py                 142      5    96%
+  COT/edit_hardware.py          159      0   100%
+  COT/edit_product.py            36      0   100%
+  COT/edit_properties.py        104     40    62%
+  COT/helper_tools.py           171      3    98%
+  COT/info.py                    41      0   100%
+  COT/inject_config.py           87      2    98%
+  COT/ovf.py                   1586     52    96%
+  COT/platforms.py              173      0   100%
+  COT/submodule.py               80      2    98%
+  COT/ui_shared.py               24      0   100%
+  COT/vm_context_manager.py      12      0   100%
+  COT/vm_description.py         119      1    99%
+  COT/vm_factory.py              25      0   100%
+  COT/xml_file.py               112      0   100%
+  -----------------------------------------------
+  TOTAL                        3284    112    96%
+  stats runtests: commands[2] | coverage html -i
+  ...
+  flake8 runtests: commands[0] | flake8
+  _______________ summary _______________
+    clean: commands succeeded
+    py26: commands succeeded
+    py27: commands succeeded
+    py32: commands succeeded
+    py33: commands succeeded
+    py34: commands succeeded
+    pypy: commands succeeded
+    stats: commands succeeded
+    flake8: commands succeeded
+    congratulations :)
+
+After running ``tox`` you can check the code coverage details by opening
+``htmlcov/index.html`` in a web browser.
+
+Update documentation
+--------------------
+
+If you add or change any COT CLI or APIs, or add or remove any external
+dependencies, please update the relevant documentation.
+
+Add yourself as a contributor
+-----------------------------
+
+If you haven't contributed to COT previously, be sure to add yourself as a
+contributor in the ``COPYRIGHT.txt`` file.
+
+
+.. _flake8: http://flake8.readthedocs.org/en/latest/
+.. _tox: http://tox.readthedocs.org/en/latest/
+.. _coverage: http://nedbatchelder.com/code/coverage/
+

COT/__init__.py

@@ -10,6 +10,55 @@
 # of COT, including this file, may be copied, modified, propagated, or
 # distributed except according to the terms contained in the LICENSE.txt file.
 
+"""
+Package implementing the Common OVF Tool.
+
+Virtual machine definition modules
+----------------------------------
+.. autosummary::
+  :toctree:
+
+  COT.vm_description
+  COT.vm_factory
+  COT.vm_context_manager
+  COT.xml_file
+  COT.ovf
+
+Command modules
+---------------
+.. autosummary::
+  :toctree:
+
+  COT.submodule
+  COT.add_disk
+  COT.add_file
+  COT.deploy
+  COT.edit_hardware
+  COT.edit_product
+  COT.edit_properties
+  COT.help
+  COT.info
+  COT.inject_config
+
+Helper library modules
+----------------------
+.. autosummary::
+  :toctree:
+
+  COT.data_validation
+  COT.helper_tools
+  COT.platforms
+
+User interface modules
+----------------------
+.. autosummary::
+  :toctree:
+
+  COT.ui_shared
+  COT.cli
+
+"""
+
 from ._version import get_versions
 __version__ = get_versions()['version']
 del get_versions