From 8926f635df1eece47c239e09d6c1cf08a0a0729c Mon Sep 17 00:00:00 2001 From: beeankha Date: Tue, 14 Apr 2020 17:34:36 -0400 Subject: [PATCH] Mark send, receive, and workflow_job_template modules as deprecated Add routing.yml file to mark modules for deprecation and pass sanity tests Ignore sanity tests for deprecated modules --- awx_collection/meta/routing.yml | 15 +++++++++++++++ awx_collection/plugins/modules/tower_receive.py | 6 +++++- awx_collection/plugins/modules/tower_send.py | 6 +++++- .../plugins/modules/tower_workflow_template.py | 6 +++++- awx_collection/tests/sanity/ignore-2.10.txt | 6 ++++++ 5 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 awx_collection/meta/routing.yml create mode 100644 awx_collection/tests/sanity/ignore-2.10.txt diff --git a/awx_collection/meta/routing.yml b/awx_collection/meta/routing.yml new file mode 100644 index 0000000000..3980ccc14c --- /dev/null +++ b/awx_collection/meta/routing.yml @@ -0,0 +1,15 @@ +--- +plugin_routing: + modules: + tower_receive: + deprecation: + removal_date: TBD + warning_text: see plugin documentation for details + tower_send: + deprecation: + removal_date: TBD + warning_text: see plugin documentation for details + tower_workflow_template: + deprecation: + removal_date: TBD + warning_text: see plugin documentation for details diff --git a/awx_collection/plugins/modules/tower_receive.py b/awx_collection/plugins/modules/tower_receive.py index 05ccb10b31..0411ff19f2 100644 --- a/awx_collection/plugins/modules/tower_receive.py +++ b/awx_collection/plugins/modules/tower_receive.py @@ -9,13 +9,17 @@ __metaclass__ = type ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} DOCUMENTATION = ''' --- module: tower_receive +deprecated: + removed_in: "3.7" + why: Deprecated in favor of upcoming C(_export) module. + alternative: Once published, use M(tower_export) instead. author: "John Westcott IV (@john-westcott-iv)" version_added: "2.8" short_description: Receive assets from Ansible Tower. diff --git a/awx_collection/plugins/modules/tower_send.py b/awx_collection/plugins/modules/tower_send.py index 39a4e57427..f8f8243f30 100644 --- a/awx_collection/plugins/modules/tower_send.py +++ b/awx_collection/plugins/modules/tower_send.py @@ -9,13 +9,17 @@ __metaclass__ = type ANSIBLE_METADATA = {'metadata_version': '1.1', - 'status': ['preview'], + 'status': ['deprecated'], 'supported_by': 'community'} DOCUMENTATION = ''' --- module: tower_send +deprecated: + removed_in: "3.7" + why: Deprecated in favor of upcoming C(_import) module. + alternative: Once published, use M(tower_import) instead. author: "John Westcott IV (@john-westcott-iv)" version_added: "2.8" short_description: Send assets to Ansible Tower. diff --git a/awx_collection/plugins/modules/tower_workflow_template.py b/awx_collection/plugins/modules/tower_workflow_template.py index 0fbe1eef61..0fa5308c6a 100644 --- a/awx_collection/plugins/modules/tower_workflow_template.py +++ b/awx_collection/plugins/modules/tower_workflow_template.py @@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -ANSIBLE_METADATA = {'status': ['preview'], +ANSIBLE_METADATA = {'status': ['deprecated'], 'supported_by': 'community', 'metadata_version': '1.1'} @@ -16,6 +16,10 @@ ANSIBLE_METADATA = {'status': ['preview'], DOCUMENTATION = ''' --- module: tower_workflow_template +deprecated: + removed_in: "3.7" + why: Deprecated in favor of C(_workflow_job_template) and C(_workflow_job_template_node) modules. + alternative: Use M(tower_workflow_job_template) and M(_workflow_job_template_node) instead. author: "Adrien Fleury (@fleu42)" version_added: "2.7" short_description: create, update, or destroy Ansible Tower workflow template. diff --git a/awx_collection/tests/sanity/ignore-2.10.txt b/awx_collection/tests/sanity/ignore-2.10.txt new file mode 100644 index 0000000000..9242eefca9 --- /dev/null +++ b/awx_collection/tests/sanity/ignore-2.10.txt @@ -0,0 +1,6 @@ +plugins/modules/tower_receive.py validate-modules:deprecation-mismatch +plugins/modules/tower_receive.py validate-modules:invalid-documentation +plugins/modules/tower_send.py validate-modules:deprecation-mismatch +plugins/modules/tower_send.py validate-modules:invalid-documentation +plugins/modules/tower_workflow_template.py validate-modules:deprecation-mismatch +plugins/modules/tower_workflow_template.py validate-modules:invalid-documentation