[PR #5721/28969c61 backport][stable-6] manageiq_policies: deprecate list state (#5723)

manageiq_policies: deprecate list state (#5721)

* manageiq_policies: deprecate list state

* add changelog fragment

(cherry picked from commit 28969c61ad)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

changelogs/fragments/5721-manageiq-policies-deprecate-list-state.yaml

@@ -0,0 +1,2 @@
+deprecated_features:
+  - manageiq_policies - deprecate ``state=list`` in favour of using ``community.general.manageiq_policies_info`` (https://github.com/ansible-collections/community.general/pull/5721).

plugins/modules/manageiq_policies.py

@@ -27,7 +27,10 @@ options:
     description:
       - C(absent) - policy_profiles should not exist,
       - C(present) - policy_profiles should exist,
-      - C(list) - list current policy_profiles and policies.
+      - >
+        C(list) - list current policy_profiles and policies.
+        This state is deprecated and will be removed 8.0.0.
+        Please use the module M(community.general.manageiq_policies_info) instead.
     choices: ['absent', 'present', 'list']
     default: 'present'
   policy_profiles:
@@ -163,6 +166,13 @@ def main():
     resource_name = module.params['resource_name']
     state = module.params['state']
 
+    if state == "list":
+        module.deprecate(
+            'The value "list" for "state" is deprecated. Please use community.general.manageiq_policies_info instead.',
+            version='8.0.0',
+            collection_name='community.general'
+        )
+
     # get the action and resource type
     action = actions[state]
     resource_type = manageiq_entities()[resource_type_key]

tests/sanity/ignore-2.11.txt

@@ -10,7 +10,7 @@ plugins/modules/consul_session.py validate-modules:parameter-state-invalid-choic
 plugins/modules/gconftool2.py validate-modules:parameter-state-invalid-choice         # state=get - removed in 8.0.0
 plugins/modules/iptables_state.py validate-modules:undocumented-parameter
 plugins/modules/lxc_container.py validate-modules:use-run-command-not-popen
-plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice
+plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice  # state=list - removed in 8.0.0
 plugins/modules/manageiq_provider.py validate-modules:doc-choices-do-not-match-spec   # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:doc-missing-type                # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:parameter-type-not-in-doc       # missing docs on suboptions

tests/sanity/ignore-2.12.txt

@@ -5,7 +5,7 @@ plugins/modules/consul_session.py validate-modules:parameter-state-invalid-choic
 plugins/modules/gconftool2.py validate-modules:parameter-state-invalid-choice         # state=get - removed in 8.0.0
 plugins/modules/iptables_state.py validate-modules:undocumented-parameter
 plugins/modules/lxc_container.py validate-modules:use-run-command-not-popen
-plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice
+plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice  # state=list - removed in 8.0.0
 plugins/modules/manageiq_provider.py validate-modules:doc-choices-do-not-match-spec   # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:doc-missing-type                # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:parameter-type-not-in-doc       # missing docs on suboptions

tests/sanity/ignore-2.13.txt

@@ -5,7 +5,7 @@ plugins/modules/consul_session.py validate-modules:parameter-state-invalid-choic
 plugins/modules/gconftool2.py validate-modules:parameter-state-invalid-choice         # state=get - removed in 8.0.0
 plugins/modules/iptables_state.py validate-modules:undocumented-parameter
 plugins/modules/lxc_container.py validate-modules:use-run-command-not-popen
-plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice
+plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice  # state=list - removed in 8.0.0
 plugins/modules/manageiq_provider.py validate-modules:doc-choices-do-not-match-spec   # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:doc-missing-type                # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:parameter-type-not-in-doc       # missing docs on suboptions

tests/sanity/ignore-2.14.txt

@@ -6,7 +6,7 @@ plugins/modules/gconftool2.py validate-modules:parameter-state-invalid-choice
 plugins/modules/homectl.py import-3.11  # Uses deprecated stdlib library 'crypt'
 plugins/modules/iptables_state.py validate-modules:undocumented-parameter
 plugins/modules/lxc_container.py validate-modules:use-run-command-not-popen
-plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice
+plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice  # state=list - removed in 8.0.0
 plugins/modules/manageiq_provider.py validate-modules:doc-choices-do-not-match-spec   # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:doc-missing-type                # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:parameter-type-not-in-doc       # missing docs on suboptions

tests/sanity/ignore-2.15.txt

@@ -6,7 +6,7 @@ plugins/modules/gconftool2.py validate-modules:parameter-state-invalid-choice
 plugins/modules/homectl.py import-3.11  # Uses deprecated stdlib library 'crypt'
 plugins/modules/iptables_state.py validate-modules:undocumented-parameter
 plugins/modules/lxc_container.py validate-modules:use-run-command-not-popen
-plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice
+plugins/modules/manageiq_policies.py validate-modules:parameter-state-invalid-choice  # state=list - removed in 8.0.0
 plugins/modules/manageiq_provider.py validate-modules:doc-choices-do-not-match-spec   # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:doc-missing-type                # missing docs on suboptions
 plugins/modules/manageiq_provider.py validate-modules:parameter-type-not-in-doc       # missing docs on suboptions