All notable changes to the COT project will be documented in this file. This project adheres to Semantic Versioning.
bin/cothelper script in this repository (not the script installed when installing COT normally) has had some
cot add-disk ... --controllernow accepts
sataas an additional option (#72).
- Error in previous release due to COT using a user-specified relative file
FileReference.createwhich implicitly assumed absolute paths.
- Now correctly fixes up the path before constructing this
- To prevent similar errors in the future, if a
FileReferenceis constructed with a non-absolute path, COT will log a warning and attempt to fix the path at that point.
- Now correctly fixes up the path before constructing this
- COT now ensures that cloned Items have a higher InstanceID than the Item they were cloned from, avoiding unexpected out-of-order behavior (#70).
- COT now produces valid manifests for OVF 2.x files (which use SHA256 instead of SHA1 as in OVF 0.x and 1.x).
- Official support for pypy3. (COT has already been usable under pypy3, but now it's actually part of our tests.)
- COT checks the manifest when loading an OVF/OVA and warns if any checksum mismatches are seen.
FileReferenceclass as superclass of
- Refactored how man page builds are triggered so that Sphinx is no longer a mandatory pre-requisite for building COT. This helps us to avoid breaking Travis-CI tests when a new version of Sphinx comes out that doesn't support older Python versions like 3.3.
- Fixed issue where UnboundLocalError would be raised during COT's attempt to clean up after a qemu-img error occurring while trying to convert a disk to VMDK (#67).
- Fixed incorrect invocation of 'sudo mkdir' on Mac OS X.
- Path normalization of output file resulted in COT failing to detect the case of self-overwriting an OVA, resulting in file corruption (#66). Improved detection of self-overwriting cases including relative vs. absolute paths, symlinks, and hardlinks.
- One unit test case, COT.helpers.tests.test_helper.HelperGenericTest.test_download_and_expand_tgz, was failing after 2.0.0 was released, due to its assumptions about the contents of the master repo on GitHub no longer being valid. Fixed now.
- Fixed a case that could result in a RuntimeError being thrown when using
cot edit-hardwareto simultaneously create NICs and define a new configuration profile (#64).
- Update minimum QEMU version preferred for creation of streamOptimized VMDK
files from 2.1.0 to 2.5.1, due to an incompatibility with VMware in VMDKs
produced by versions prior to 2.5.1 (#65).
vmdktoolis not installed, but QEMU 2.1.0-2.5.0 is, then COT will fall back to usinq
qemu-img, but will warn of this potential incompatibility with ESXi.
cot infois invoked with multiple files as input, an error in loading one file will no longer cause the entire command to abort; COT will now log an error about the offending file and continue to the next.
- COT commands now check the available disk space in the temporary working directory against the temporary storage space the command estimates it will require, and if there is likely to be a problem, warns the user before continuing. (#63)
- Additionally COT commands that write out an updated OVF/OVA now check the available disk space in the requested output location against the VM's predicted output size, and if there is likely to be a problem, warns the user before continuing.
Helperclasses can now opt to cache their output to avoid repeatedly re-running the same command. Currently enabled for
qemu-img info ...and
isoinfo ...commands. (#62)
- New modules and APIs in support of the above:
Command.working_dir_disk_space_required()instance method, to ask a command to estimate how much temporary storage it will require. This method is now automatically called from Command unit tests to validate its accuracy.
VMDescription.predicted_output_size()instance method, to ask a VM to estimate how much disk space it will require when written out.
COT.utilitiesmodule with functions
- Discontinued support for Python 2.6 as it has been retired since 2013.
cot --debugalias for
cot --verbose --verboseas it is no longer correct after increased granularity of logging options, as described below.
cot edit-hardware, the platform hardware validation is no longer a hard limit. Instead, if a value appears to be invalid, the user will be warned about the validation failure and given the option to continue or abort (#61).
cot --force ..., as usual, can be used to auto-continue without prompting.
- More granular logging levels (thanks to verboselogs; COT now requires version 1.6 of this package) and more self-consistency in message logging.
- Revised format of log messages generated by COT.
- Lots of API changes:
- All commands ('submodules') are now grouped as a sub-package
COT.commands. Most classes in this package have been renamed.
COT.ovfpackage to be a sub-package under
- Moved UI and CLI classes into a
- Moved the
COT.deploy_esxi.get_object_from_connectionis now method
COT.cli.formatteris now class
- The functionality of classes
VMFactoryhas been rolled into the core
- COT.disks module:
create_diskis now split into class methods
DiskRepresentation.for_new_file(creates the disk file and returns a corresponding
DiskRepresentation.create_file(creates disk file only).
convert_diskis now class method
disk_representation_from_fileis now class method
DiskRepresentationconstructor now only takes the path to a file as input - if you want to create a new file, use
DiskRepresentation.for_new_fileinstead of calling the constructor directly.
- COT.helpers module:
- Static method
Helper.cphas been renamed to
- Static method
- COT.ovf module:
COT.ovf.ovf.byte_stringhas been moved and renamed to
COT.ovf.ovf.byte_counthas been moved and renamed to
COT.ovf.ovf.factor_byteshas been moved and renamed to
OVF.validate_and_update_networkshave been moved to private functions and are no longer part of the public API of the OVF class.
Hardware.update_existing_item_count_per_profilehas been moved to a private method.
- COT.platforms module:
platform_from_product_classis now class method
Platform.for_product_stringand returns an instance of a
Platformclass rather than the class object itself.
PlatformAPIs are now instance methods instead of class methods.
COT.platforms.is_known_product_classhas been removed.
- All commands ('submodules') are now grouped as a sub-package under
- Support for Python 3.6
- Support for brew package manager (#55).
- Support for Cisco Nexus 9000v (NX-OSv 9000) platform (#60).
- Improved messaging when COT is unable to install a helper program (#57).
- Issue (#58) where various multi-value CLI options for the
inject-configcommands did not append properly.
- Issue in which explicitly specified NIC names were being overwritten by
names auto-derived from network names when attempting to set both NIC name
and network names in a single
cot edit-propertiesagain accepts property values containing the characters
- COT can now detect the presence of an .ovf file in a TAR archive even if
the archive is not named
*.ova*and even if the .ovf file is not the first file in the archive as specified by the OVF specification. This allows (read-only at present) handling of VirtualBox Vagrant .box files, which are approximately equivalent to non-standards-compliant OVAs.
- Under Python versions older than 2.7.9, explicitly require
ndg-httpsclientto avoid issues like
hostname 'people.freebsd.org' doesn't match 'wfe0.ysv.freebsd.org'when installing vmdktool.
- 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 126.96.36.1996.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.