diff options
| author | Felix Fontein <felix@fontein.de> | 2021-02-08 00:52:29 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-07 17:52:29 -0600 |
| commit | 63ead90ab9d81f9b5ac3cdc08a6a3a932c1a81d7 (patch) | |
| tree | cbb9b6f0ac24d38394690c0c1b1b85abae239359 | |
| parent | 70fb5ae36a10dd6b9079b61aab9d9eb076486d2c (diff) | |
| download | ansible-63ead90ab9d81f9b5ac3cdc08a6a3a932c1a81d7.tar.gz | |
Always mention the name of the deprecated plugin in routing deprecation messages (#73059) (#73237)
(cherry picked from commit df9cf368c0bb5ff2f7152402b30a0f27a5571389)
| -rw-r--r-- | changelogs/fragments/73059-improve-deprecation-texts.yml | 2 | ||||
| -rw-r--r-- | lib/ansible/plugins/loader.py | 10 |
2 files changed, 8 insertions, 4 deletions
diff --git a/changelogs/fragments/73059-improve-deprecation-texts.yml b/changelogs/fragments/73059-improve-deprecation-texts.yml new file mode 100644 index 0000000000..b1ca876858 --- /dev/null +++ b/changelogs/fragments/73059-improve-deprecation-texts.yml @@ -0,0 +1,2 @@ +bugfixes: +- "Always mention the name of the deprecated or tombstoned plugin in routing deprecation/tombstone messages (https://github.com/ansible/ansible/pull/73059)." diff --git a/lib/ansible/plugins/loader.py b/lib/ansible/plugins/loader.py index 957fa725b3..3c241274e0 100644 --- a/lib/ansible/plugins/loader.py +++ b/lib/ansible/plugins/loader.py @@ -140,14 +140,15 @@ class PluginLoadContext(object): if not deprecation: return self - warning_text = deprecation.get('warning_text', None) + # The `or ''` instead of using `.get(..., '')` makes sure that even if the user explicitly + # sets `warning_text` to `~` (None) or `false`, we still get an empty string. + warning_text = deprecation.get('warning_text', None) or '' removal_date = deprecation.get('removal_date', None) removal_version = deprecation.get('removal_version', None) # If both removal_date and removal_version are specified, use removal_date if removal_date is not None: removal_version = None - if not warning_text: - warning_text = '{0} has been deprecated'.format(name) + warning_text = '{0} has been deprecated.{1}{2}'.format(name, ' ' if warning_text else '', warning_text) display.deprecated(warning_text, date=removal_date, version=removal_version, collection_name=collection_name) @@ -462,7 +463,8 @@ class PluginLoader: if tombstone: removal_date = tombstone.get('removal_date') removal_version = tombstone.get('removal_version') - warning_text = tombstone.get('warning_text') or '{0} has been removed.'.format(fq_name) + warning_text = tombstone.get('warning_text') or '' + warning_text = '{0} has been removed.{1}{2}'.format(fq_name, ' ' if warning_text else '', warning_text) removed_msg = display.get_deprecation_message(msg=warning_text, version=removal_version, date=removal_date, removed=True, collection_name=acr.collection) |