From d54d2fa4a6ae305b452246b6255dd0d1aaf6bb12 Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Sun, 25 Jul 2021 21:14:30 +1200 Subject: [PATCH] xfconf - deprecate get state in favour of the xfconf_info module (#3049) * Deprecate get state in favour of the xfconf_info module * added changelog fragment * added comments in ignore files * Update changelogs/fragments/3049-xfconf-deprecate-get.yaml bummer, forgot that Co-authored-by: Felix Fontein * Update plugins/modules/system/xfconf.py Co-authored-by: Felix Fontein * Update plugins/modules/system/xfconf.py Co-authored-by: Felix Fontein Co-authored-by: Felix Fontein --- changelogs/fragments/3049-xfconf-deprecate-get.yaml | 2 ++ plugins/modules/system/xfconf.py | 5 +++++ tests/sanity/ignore-2.10.txt | 2 +- tests/sanity/ignore-2.11.txt | 2 +- tests/sanity/ignore-2.12.txt | 2 +- 5 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 changelogs/fragments/3049-xfconf-deprecate-get.yaml diff --git a/changelogs/fragments/3049-xfconf-deprecate-get.yaml b/changelogs/fragments/3049-xfconf-deprecate-get.yaml new file mode 100644 index 0000000000..359b39301e --- /dev/null +++ b/changelogs/fragments/3049-xfconf-deprecate-get.yaml @@ -0,0 +1,2 @@ +deprecated_features: + - xfconf - deprecate the ``get`` state. The new module ``xfconf_info`` should be used instead (https://github.com/ansible-collections/community.general/pull/3049). diff --git a/plugins/modules/system/xfconf.py b/plugins/modules/system/xfconf.py index e8aed0a759..001613fc23 100644 --- a/plugins/modules/system/xfconf.py +++ b/plugins/modules/system/xfconf.py @@ -48,6 +48,7 @@ options: type: str description: - The action to take upon the property/value. + - State C(get) is deprecated and will be removed in community.general 5.0.0. Please use the module M(community.general.xfconf_info) instead. choices: [ get, present, absent ] default: "present" force_array: @@ -225,6 +226,10 @@ class XFConfProperty(CmdMixin, StateMixin, ModuleHelper): def state_get(self): self.vars.value = self.vars.previous_value self.vars.previous_value = None + self.module.deprecate( + msg="State 'get' is deprecated. Please use the module community.general.xfconf_info instead", + version="5.0.0", collection_name="community.general" + ) def state_absent(self): if not self.module.check_mode: diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index 6060d0f2d7..9e6c483071 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -47,7 +47,7 @@ plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spe plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc plugins/modules/system/runit.py validate-modules:parameter-type-not-in-doc # param removed in 4.0.0 plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path -plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice +plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0 plugins/modules/system/xfconf.py validate-modules:return-syntax-error plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path tests/integration/targets/django_manage/files/base_test/simple_project/p1/manage.py compile-2.6 # django generated code diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt index 7313abf061..79a90853f2 100644 --- a/tests/sanity/ignore-2.11.txt +++ b/tests/sanity/ignore-2.11.txt @@ -46,7 +46,7 @@ plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spe plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc plugins/modules/system/runit.py validate-modules:parameter-type-not-in-doc # param removed in 4.0.0 plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path -plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice +plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0 plugins/modules/system/xfconf.py validate-modules:return-syntax-error plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path tests/integration/targets/django_manage/files/base_test/simple_project/p1/manage.py compile-2.6 # django generated code diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt index 2ef7ced11e..4d1d5a783c 100644 --- a/tests/sanity/ignore-2.12.txt +++ b/tests/sanity/ignore-2.12.txt @@ -46,6 +46,6 @@ plugins/modules/system/puppet.py validate-modules:doc-default-does-not-match-spe plugins/modules/system/puppet.py validate-modules:parameter-type-not-in-doc plugins/modules/system/runit.py validate-modules:parameter-type-not-in-doc # param removed in 4.0.0 plugins/modules/system/ssh_config.py use-argspec-type-path # Required since module uses other methods to specify path -plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice +plugins/modules/system/xfconf.py validate-modules:parameter-state-invalid-choice # state get removed in 5.0.0 plugins/modules/system/xfconf.py validate-modules:return-syntax-error plugins/modules/web_infrastructure/jenkins_plugin.py use-argspec-type-path