All notable changes to the COT project will be documented in this file. This project adheres to Semantic Versioning.
- TypeError in
cot inject-configcorrectly handles OVAs with multiple empty CD-ROM drives to choose amongst (#54 also).
- Cisco CSR1000v platform now supports 8 CPUs as a valid option.
cot inject-config --extra-filesparameter (#53).
- Helper class for
isoinfo(a companion to
- Added glossary of terms to COT documentation.
- Inline documentation (docstrings) are now validated using the Pylint docparams extension.
- Refactored the monolithic
COT/platforms.pyfile into a proper submodule.
create_iso()now adds Rock Ridge extensions by default.
COT.helpersinto two modules -
COT.helpers(now just for handling helper programs such as
COT.disks(which uses the helpers to handle ISO/VMDK/QCOW2/RAW image files).
- Inline documentation (docstrings) have been converted to “Google style” for better readability in the code. Sphinx rendering of documentation (for readthedocs.org, etc) now makes use of the napoleon extension to handle this style.
get_checksum()is no longer part of the
COT.helpersAPI. (It’s now the method
COT.data_validation, where it really belonged from the start).
download_and_expand()is no longer part of the
COT.helperspublic API. (It’s now the static method
Newer versions of Sphinx have dropped support for Python 2.6 and 3.3, so I have updated COT’s installation requirements to use older Sphinx versions under these Python versions.
- When adding NICs to an OVF, if no
cot edit-hardwarewill now try to infer sequential naming of the Network elements and if successful, offer to create additional Networks as appropriate. (#18)
- Issue #52 - OVFItemDataError raised when adding NICs to CSR1000V OVA, or more generally when cloning an OVFItem whose ElementName references its Connection.
cot deploy ... --serial-connectionwill create additional serial ports beyond those defined in the OVF, if requested. Previously it would ask the user for confirmation but not actually do anything about it. (#51)
- Support for Python 3.5
- Enhancements to
--user-configurableoption to set whether created/updated properties are marked as user-configurable in the OVF.
--descriptionsoptions to set/update the labels and descriptions associated with properties.
- It’s now valid to set no default value for a property by
=value, as in
-p property-with-no-value, as well as the existing
-p property-with-empty-value=syntax to set an empty string as the value.
- Users can now optionally specify the property type to enforce for each
property by using the delimiter
+type, as in
- Switched from statement coverage to branch coverage for better test analysis.
- Moved from Coveralls to Codecov for test coverage tracking, since Coveralls does not support branch coverage reporting.
cot edit-hardwareis used to create new NICs in an OVF that previously had none, and the user does not specify any corresponding Network entries, automatically create a ‘VM Network’ entry, because all NICs must be mapped to Networks for a valid OVF descriptor.
ValueMismatchErrorexceptions are properly caught by the CLI wrapper so as to result in a graceful exit rather than a stack trace.
cot remove-filenow errors if the user specifies both file-id and file-path, one of which matches a file in the OVF, but the other does not match this or any other file.
- Better handling of exceptions and usage of
sudowhen installing helpers.
- Manual pages are now correctly included in the distribution. Oops!
cot edit-product --product-classoption, to set or change the product class identifier (such as
- Enabled additional code quality validation with Pylint, pep8-naming, and mccabe (#49).
- COT now recognizes
- COT no longer ignores the
AllocationUnitsvalue given for RAM.
COT.ovf.byte_string()now properly uses binary units (
- Development requirement changes: The package pep8 has been renamed to pycodestyle, and pep257 has been renamed to pydocstyle. Updated configuration and documentation to reflect these changes. Also, flake8-pep257 does not presently handle these changes, so replaced it as a dependency with the more up-to-date flake8-docstrings package.
cot edit-hardware --network-descriptionsoption, to specify the descriptive string(s) associated with each network definition.
- #48 - NIC type not set when adding NICs to an OVF that had none before.
- When updating NIC network mapping, COT now also updates any Description that references the network mapping.
- #47 - Added
- #43 - add
cot edit-properties --transportoption to set environment transport type(s) - iso, VMWare Tools, etc.
cot infonow has a new “Environment” section that displays the transport type
- #45 - support for multiple values for
- COT now recognizes the Cisco IOS XRv 9000 platform identifier
- #21 - subcommand aliases (Python 3.x only):
- Support for tab-completion of CLI parameters using argcomplete.
--scsi-subtypesare now validated and canonicalized by COT, meaning that:
cot edit-hardware --nic-type virtio-net-pciis now a valid command and will correctly create an OVF with
cot edit-hardware --ide-subtype foobarwill now fail with an error
cot infois now more self-consistent in how it displays property keys. They are now always wrapped in
>, whereas previously this was only sometimes the case.
cot info --verbosenow displays file and disk ID strings under the “Files and Disks” section.
- COT now supports
xorrisoas another alternative to
- #42 -
cot deploy esxierror handling behavior needed to be updated for requests release 2.8.
- #44 - test case failure seen when running pyVmomi 184.108.40.2066.4.
- #24 -
cot deploy esxinow creates serial ports after deployment using pyVmomi library.
- Serial port connectivity must be specified either via entries in the OVF
(which can be defined using
cot edit-hardware ... -S) or at deployment time using the new
- The syntax for serial port connectivity definition is based
on that of QEMU’s
- Currently only “telnet”, “tcp”, and “device” connection types are supported.
- Serial port connectivity must be specified either via entries in the OVF (which can be defined using
- #38 -
cot edit-productcan now set product and vendor information.
- flake8 validation now includes pep257 to validate docstring compliance to PEP 257 as well.
- Added changelog file.
COT.file_referencesubmodule in support of #39.
- Split ESXi-specific logic out of
COT.deploymodule and into new
- UT for
mock(standard library in Python 3.x, install via pip on Python 2.x).
- #39 - avoid unnecessary file copies to save time and disk space.
- #30 -
cot install-helperscan now install
vmdktoolunder Python 3.
- Installation of helper programs is now provided by a
cot install-helperssubcommand rather than a separate script.
- COT now has man pages (
man cot-edit-hardware, etc.) The man pages are also installed by
- Improved documentation of the CLI on readthedocs.org as well.
COT.helperssubpackage. This package has an API (
COT.helpers.api) for the rest of COT to access it; the helper-specific logic (qemu-img, fatdisk, etc.) is split into individual helper modules that are abstracted away by the API.
- Similarly, logic from
COT.tests.helper_toolshas been refactored and enhanced under
- Renamed all test code files from “foo.py” to “test_foo.py” to facilitate test case discovery.
- CLI help strings are dynamically rendered to ReST when docs are built, providing cleaner output for both readthedocs.org and the manpages.
- COT no longer supports Python 3.2.
cot_unittestis no more - use
unit2 discoverto run tests.
- As noted above, the installation script
check_and_install_helpers.pyno longer exists - this functionality is now provided by the
- Documentation built with Sphinx and available at http://cot.readthedocs.org
- CLI adapts more intelligently to terminal width (fixes #28)
- Submodules now use Python properties instead of get_value/set_value methods.
- Now PEP 8 compliant - passes validation by flake8 code analysis.
- Very preliminary support for OVF 2.x format
- Now uses tox for easier test execution and coverage.py for code coverage analysis.
- Code coverage reporting with Coveralls.
- Now uses colorlog instead of
coloredlogsfor CLI log colorization, as this fits better with COT’s logging model.
- Greatly improved unit test structure and code coverage, including tests for logging.
- Greatly improved logging (#26). COT now defaults to logging level INFO,
which provides relatively brief status updates to the user. You can also
--quietto suppress INFO messages and only log WARNING and ERROR messages,
--verboseto see VERBOSE messages as well, or
--debugif you want to really get into the guts of what COT is doing.
- Now integrated with Travis CI for automated builds and UT under all supported Python versions. This should greatly improve the stability of COT under less-common Python versions. (#12)
- The CLI for
cot deployhas been revised somewhat based on user feedback.
- A lot of restructuring of the underlying code to make things more modular and easier to test in isolation.
- Various bugfixes for issues specific to Python 2.6 and 3.x - these environments should now be fully working again.
- Added THANKS file recognizing various non-code contributions to COT.
- Fixed issue #17 (
cot edit-hardwareadding NICs makes an OVA that vCenter regards as invalid)
- Removed several spurious WARNING messages
- COT can at least be installed and run under CentOS/Python2.6 now, although the automated unit tests will complain about the different XML output that 2.6 produces.
- Vastly improved installation workflow under Linuxes supporting
yum- included helper script can automatically install all helper programs except
ovftool. Fixes #9.
--nic-namesoption for assigning names to each NIC
cot infonow displays NIC names.
- Improved installation documentation
- Some improvements to IOS XRv OVA support
- Take advantage of QEMU 2.1 finally supporting the
- Can now create new hardware items without an existing item of the same type (issue #4)
- Clearer documentation and logging messages (issue #8 and others)
- Now uses versioneer for automatic version numbering.
- Fixed several Python 3 compatibility issues (issue #7 and others)
cot deploy esxisubcommand by Kevin Keim (@kakeim), which uses
ovftoolto deploy an OVA to an ESXi vCenter server.
- Removed dependencies on
sha1sumin favor of Python’s
- Nicer formatting of
- Miscellaneous fixes and code cleanup.
1.0.0 - 2014-06-27¶
Initial public release.