Skip to content

Latest commit

 

History

History
291 lines (190 loc) · 12.6 KB

CHANGELOG.rst

File metadata and controls

291 lines (190 loc) · 12.6 KB

Community Internal Test Tools Collection Release Notes

Topics

v0.13.0

Release Summary

Feature release.

Minor Changes

  • extra sanity tests runner - add --break-system-packages to pip invocations (#137).
  • extra sanity tests runner - bump default Python version used for tests to 3.13 (#137).
  • extra sanity tests runner - update fallback image name and use Python 3.13 inside the container (#137).

v0.12.0

Release Summary

Feature release.

Minor Changes

  • fetch_url and open_url unit test frameworks - use the tests.unit.compat.mock module everywhere so that unittest.mock is used instead of mock on Python 3 (#130).
  • open_url and fetch_url unit test frameworks - allow to check for form value arrays (#125).

Removed Features (previously deprecated)

  • Removed the ansible_builtin_runtime tool (#111, #131).

v0.11.0

Release Summary

Feature, bugfix, and maintenance release.

Minor Changes

  • extra sanity test runner - make sure that a ansible_collections ancestor directory is also copied into the Docker container (#103).

Breaking Changes / Porting Guide

  • The internal test module fetch_url_test_module has been renamed to _fetch_url_test_module, and the internal test lookup plugin open_url_test_lookup has been renamed to _open_url_test_lookup. This emphasizes that these plugins are private and not supposed to be used by end-users (#112).

Deprecated Features

  • The tools/ansible_builtin_runtime.py tool is deprecated and will be removed in a future version. If anyone is interested in keeping this tool, please comment on the tool removal issue (#111).

Bugfixes

  • extra sanity test runner - run pip via Python instead of running it directly; also set PIP_BREAK_SYSTEM_PACKAGES=1 in the environment (#104).

v0.10.1

Release Summary

Maintenance release to test whether publishing community collections works.

v0.10.0

Release Summary

Maintenance release with updated documentation and removal of a deprecated tool.

From this version on, community.internal_test_tools is using the new Ansible semantic markup in its documentation. If you look at documentation with the ansible-doc CLI tool from ansible-core before 2.15, please note that it does not render the markup correctly. You should be still able to read it in most cases, but you need ansible-core 2.15 or later to see it as it is intended. Alternatively you can look at the docsite for the rendered HTML version of the documentation of the latest release.

Removed Features (previously deprecated)

  • Removed the deprecated meta/runtime.yml tool (#79, #91).

Known Issues

v0.9.0

Release Summary

Feature release with improved extra sanity test runner.

Minor Changes

  • Let the extra sanity test runner report bad test descriptors as errors (#89).
  • Use Python 3.10 instead of Python 3.8 for the extra sanity test runner (#88).

Deprecated Features

  • The meta/runtime.yml helper tool tools/meta_runtime.py is deprecated and will be removed soon. If you need it, please comment on the issue and/or stick to a version of community.internal_test_tools that is known to still includes it (#79, #90).

v0.8.0

Release Summary

Maintenance release with updated documentation and licensing information.

Minor Changes

v0.7.0

Release Summary

Regular feature release.

Minor Changes

  • All software licenses are now in the LICENSES/ directory of the collection root. Moreover, SPDX-License-Identifier: is used to declare the applicable license for every file that is not automatically generated (#69).
  • open_url and fetch_url unit test frameworks - allow to check for timeout, url_username, url_password, and force_basic_auth settings (#65).

v0.6.1

Release Summary

Regular bugfix release.

Bugfixes

  • extra sanity test runner - bump default Docker image fallback to container currently used by ansible-test in devel branch (#55).
  • extra sanity test runner - fix default Docker image detection to work with ansible-test from ansible-core 2.12.2 on (#55).

v0.6.0

Release Summary

Feature and bugfix release.

Minor Changes

  • fetch_url test framework - make behavior more similar to latest ansible-core devel branch, and include closed property for response objects (#52).
  • open_url test framework - include closed property for response objects (#52).

Bugfixes

  • fetch_url_test_module - fix usage of fetch_url with changes in latest ansible-core devel branch (#52).
  • files_collect, files_diff - ignore atime since that does not indicate that a file was modified (#54).

v0.5.0

Release Summary

Feature release with various tool improvements.

Minor Changes

  • fetch_url and open_url test frameworks - output number of expected and actual calls when number of actual calls is too low.
  • ansible_builtin_runtime tool - allow to specify collection root directory for check-ansible-core-redirects subcommand (#51).
  • ansible_builtin_runtime tool - make tool executable (#51).
  • extra sanity test runner - add options --bot and --junit to create results that ansibullbot and AZP can parse (#41).
  • extra sanity test runner - bump default Python version from 3.7 to 3.8 (#49).
  • meta_runtime tool - allow to specify collection root directory for all subcommands (#51).

Breaking Changes / Porting Guide

  • ansible_builtin_runtime tool - renamed check-ansible-base-redirects subcommand to check-ansible-core-redirects (#51).

Bugfixes

  • ansible_builtin_runtime tool - fix subcommand check-ansible-core-redirects (#51).
  • extra sanity test runner - bump default Docker image fallback to container currently used by ansible-test in devel branch (#50).
  • extra sanity test runner - fix default Docker image detection to work with ansible-test from ansible-core 2.12 (#47).

v0.4.0

Release Summary

Add bugfixes for and new features to the open_url/fetch_url test framework.

Minor Changes

  • fetch_url and open_url testing frameworks - allow to check query parameters of URLs (#33).
  • fetch_url and open_url testing frameworks - allow to compare URLs without query and/or fragment (#33).
  • fetch_url and open_url testing frameworks - allow to parse and check JSON data (#34).

Bugfixes

  • fetch_url testing framework - return url as part of info (#33).

v0.3.0

Minor Changes

  • Added a framework for testing plugins using open_url from ansible.module_utils.urls (#24).
  • The fetch_url testing framework now allows to match the provided content (#31).
  • There are now a meta/runtime.yml and ansible_builtin_runtime.yml helper tools which allows to convert between symlinks and redirects in meta/runtime.yml, allows to compare ansible-base's lib/ansible/config/ansible_builtin_runtime.yml with this collection, and verify that plugins mentioned actually exist.

Bugfixes

  • Fix form value present test for fetch_url testing framework (#24).
  • Fix header test for fetch_url testing framework (#24).

New Plugins

Lookup

  • community.internal_test_tools.open_url_test_lookup - Test plugin for the open_url test framework (DO NOT USE THIS!)

New Modules

  • community.internal_test_tools.files_collect - Collect state of files and directories on disk
  • community.internal_test_tools.files_diff - Check whether there were changes since files_collect was called

v0.2.1

Release Summary

Re-release because Galaxy did not accept a tag with spaces in galaxy.yml. No other changes besides that the changelog moved to the root directory.

v0.2.0

Major Changes

  • There is now a extra sanity test runner which allows to easily run extra sanity tests. This is a stop-gap solution until ansible-test supports sanity test plugins.

v0.1.1

Release Summary

Initial release.

New Modules

  • community.internal_test_tools.community.internal_test_tools.fetch_url_test_module - Test module for fetch_url test framework