ansible/docs/docsite/rst/dev_guide/testing/sanity/update-bundled.rst
Matt Clay d651bda123
Relocate ansible-test code. (#60147)
* Initial move of `test/runner/` content.

`test/runner/lib/` -> `test/lib/ansible_test/_internal/`
`test/runner/`     -> `test/lib/ansible_test/_internal/data/`

* Initial move of `test/sanity/` content.

`test/sanity/` -> `test/lib/ansible_test/_internal/data/sanity/` (except `test/sanity/ignore.txt`)

* Initial move of `test/units/pytest/` content.

`test/units/pytest/` -> `test/lib/ansible_test/_internal/data/pytest/`

* Follow-up move of `test/runner/unit/` content.

`test/lib/ansible_test/_internal/data/unit/` -> `test/lib/ansible_test/tests/unit/`

* Initial move of `ansible.cfg` content.

`test/units/ansible.cfg` -> `test/lib/ansible_test/_internal/data/units/ansible.cfg`
`test/env/ansible.cfg` -> `test/lib/ansible_test/_internal/data/env/ansible.cfg`

* Follow-up move of `data` directory.

`test/lib/ansible_test/_internal/data/` -> `test/lib/ansible_test/_data/`

* Update import statements.

* Add missing __init__.py for unit tests.

* Fix path references and miscellaneous issues.
2019-08-06 14:43:29 -07:00

31 lines
1.4 KiB
ReStructuredText

: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/lib/ansible_test/_data/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.