ansible/docs/docsite/rst/dev_guide/testing/sanity/update-bundled.rst

:orphan:

update-bundled
==============

Check whether any of our known bundled code needs to be updated for a new upstream release.

This test can error in the following ways:

* The bundled code is out of date with regard to the latest release on pypi.  Update the code
  to the new version and update the version in _BUNDLED_METADATA to solve this.

* The code is lacking a _BUNDLED_METADATA variable.  This typically happens when a bundled version
  is updated and we forget to add a _BUNDLED_METADATA variable to the updated file.  Once that is
  added, this error should go away.

* A file has a _BUNDLED_METADATA variable but the file isn't specified in
  :file:`test/sanity/code-smell/update-bundled.py`.  This typically happens when a new bundled
  library is added.  Add the file to the `get_bundled_libs()` function in the `update-bundled.py`
  test script to solve this error.

_BUNDLED_METADATA has the following fields:

:pypi_name: Name of the bundled package on pypi

:version: Version of the package that we are including here

:version_constraints: Optional PEP440 specifier for the version range that we are bundling.
                      Currently, the only valid use of this is to follow a version that is
                      compatible with the Python stdlib when newer versions of the pypi package
                      implement a new API.
Have update-bundled check for updates to all bundled code Add a test for whether we have bundled code inside of ansible that needs to be updated 6 years ago			`:orphan:`

Remove redundant "Sanity Tests »" from page title. The docs now have multi-level breadcrumbs so including "Sanity Tests »" in the title on a sanity test page is redundant. 5 years ago			`update-bundled`
			`==============`
Have update-bundled check for updates to all bundled code Add a test for whether we have bundled code inside of ansible that needs to be updated 6 years ago
			`Check whether any of our known bundled code needs to be updated for a new upstream release.`

			`This test can error in the following ways:`

			`* The bundled code is out of date with regard to the latest release on pypi. Update the code`
			`to the new version and update the version in _BUNDLED_METADATA to solve this.`

			`* The code is lacking a _BUNDLED_METADATA variable. This typically happens when a bundled version`
			`is updated and we forget to add a _BUNDLED_METADATA variable to the updated file. Once that is`
			`added, this error should go away.`

			`* A file has a _BUNDLED_METADATA variable but the file isn't specified in`
Split up "code smell" sanity tests. (#60174) * Relocate ansible-only sanity tests. * Get "code smell" sanity tests from multiple dirs. - `test/lib/ansible_test/_data/sanity/code-smell/` - General purpose tests used for both Ansible and Ansible Collections. - `test/sanity/code-smell/` - Tests specific to Ansible, will not be used for Ansible Collections. 5 years ago			:file:`test/sanity/code-smell/update-bundled.py`. This typically happens when a new bundled
Have update-bundled check for updates to all bundled code Add a test for whether we have bundled code inside of ansible that needs to be updated 6 years ago			library is added. Add the file to the `get_bundled_libs()` function in the `update-bundled.py`
			`test script to solve this error.`

			`_BUNDLED_METADATA has the following fields:`

			`:pypi_name: Name of the bundled package on pypi`

			`:version: Version of the package that we are including here`

			`:version_constraints: Optional PEP440 specifier for the version range that we are bundling.`
			`Currently, the only valid use of this is to follow a version that is`
			`compatible with the Python stdlib when newer versions of the pypi package`
			`implement a new API.`