summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlan Rominger <arominge@redhat.com>2024-02-16 22:02:09 +0100
committerGitHub <noreply@github.com>2024-02-16 22:02:09 +0100
commit1f7be9258c7082b86407f0ccb68b450a6429838b (patch)
treee811590bbbc55cdf5123487ae9e847477e00c9ab
parentUpdate release doc to check for awxkit tar files. (#14892) (diff)
downloadawx-1f7be9258c7082b86407f0ccb68b450a6429838b.tar.xz
awx-1f7be9258c7082b86407f0ccb68b450a6429838b.zip
Remove `tower_legacy` module_utils that appears unused (#14421)
* Remove tower_legacy module that appears unused * Update license details
-rw-r--r--awx_collection/galaxy.yml2
-rw-r--r--awx_collection/plugins/module_utils/tower_legacy.py119
-rw-r--r--awx_collection/test/awx/conftest.py4
-rw-r--r--awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j22
4 files changed, 2 insertions, 125 deletions
diff --git a/awx_collection/galaxy.yml b/awx_collection/galaxy.yml
index b995bfe3e8..624752e568 100644
--- a/awx_collection/galaxy.yml
+++ b/awx_collection/galaxy.yml
@@ -18,7 +18,7 @@ documentation: https://github.com/ansible/awx/blob/devel/awx_collection/README.m
homepage: https://www.ansible.com/
issues: https://github.com/ansible/awx/issues?q=is%3Aissue+label%3Acomponent%3Aawx_collection
license:
- - GPL-3.0-only
+ - GPL-3.0-or-later
name: awx
namespace: awx
readme: README.md
diff --git a/awx_collection/plugins/module_utils/tower_legacy.py b/awx_collection/plugins/module_utils/tower_legacy.py
deleted file mode 100644
index 84205c0f80..0000000000
--- a/awx_collection/plugins/module_utils/tower_legacy.py
+++ /dev/null
@@ -1,119 +0,0 @@
-# This code is part of Ansible, but is an independent component.
-# This particular file snippet, and this file snippet only, is BSD licensed.
-# Modules you write using this snippet, which is embedded dynamically by Ansible
-# still belong to the author of the module, and may assign their own license
-# to the complete work.
-#
-# Copyright (c), Wayne Witzel III <wayne@riotousliving.com>
-# All rights reserved.
-#
-# Redistribution and use in source and binary forms, with or without modification,
-# are permitted provided that the following conditions are met:
-#
-# * Redistributions of source code must retain the above copyright
-# notice, this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
-# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-from __future__ import absolute_import, division, print_function
-
-__metaclass__ = type
-
-import os
-import traceback
-
-TOWER_CLI_IMP_ERR = None
-try:
- import tower_cli.utils.exceptions as exc
- from tower_cli.utils import parser
- from tower_cli.api import client
-
- HAS_TOWER_CLI = True
-except ImportError:
- TOWER_CLI_IMP_ERR = traceback.format_exc()
- HAS_TOWER_CLI = False
-
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib
-
-
-def tower_auth_config(module):
- """
- `tower_auth_config` attempts to load the tower-cli.cfg file
- specified from the `tower_config_file` parameter. If found,
- if returns the contents of the file as a dictionary, else
- it will attempt to fetch values from the module params and
- only pass those values that have been set.
- """
- config_file = module.params.pop('tower_config_file', None)
- if config_file:
- if not os.path.exists(config_file):
- module.fail_json(msg='file not found: %s' % config_file)
- if os.path.isdir(config_file):
- module.fail_json(msg='directory can not be used as config file: %s' % config_file)
-
- with open(config_file, 'r') as f:
- return parser.string_to_dict(f.read())
- else:
- auth_config = {}
- host = module.params.pop('tower_host', None)
- if host:
- auth_config['host'] = host
- username = module.params.pop('tower_username', None)
- if username:
- auth_config['username'] = username
- password = module.params.pop('tower_password', None)
- if password:
- auth_config['password'] = password
- module.params.pop('tower_verify_ssl', None) # pop alias if used
- verify_ssl = module.params.pop('validate_certs', None)
- if verify_ssl is not None:
- auth_config['verify_ssl'] = verify_ssl
- return auth_config
-
-
-def tower_check_mode(module):
- '''Execute check mode logic for Ansible Tower modules'''
- if module.check_mode:
- try:
- result = client.get('/ping').json()
- module.exit_json(changed=True, tower_version='{0}'.format(result['version']))
- except (exc.ServerError, exc.ConnectionError, exc.BadRequest) as excinfo:
- module.fail_json(changed=False, msg='Failed check mode: {0}'.format(excinfo))
-
-
-class TowerLegacyModule(AnsibleModule):
- def __init__(self, argument_spec, **kwargs):
- args = dict(
- tower_host=dict(),
- tower_username=dict(),
- tower_password=dict(no_log=True),
- validate_certs=dict(type='bool', aliases=['tower_verify_ssl']),
- tower_config_file=dict(type='path'),
- )
- args.update(argument_spec)
-
- kwargs.setdefault('mutually_exclusive', [])
- kwargs['mutually_exclusive'].extend(
- (
- ('tower_config_file', 'tower_host'),
- ('tower_config_file', 'tower_username'),
- ('tower_config_file', 'tower_password'),
- ('tower_config_file', 'validate_certs'),
- )
- )
-
- super().__init__(argument_spec=args, **kwargs)
-
- if not HAS_TOWER_CLI:
- self.fail_json(msg=missing_required_lib('ansible-tower-cli'), exception=TOWER_CLI_IMP_ERR)
diff --git a/awx_collection/test/awx/conftest.py b/awx_collection/test/awx/conftest.py
index 3e6f571f46..5bf288ba69 100644
--- a/awx_collection/test/awx/conftest.py
+++ b/awx_collection/test/awx/conftest.py
@@ -181,10 +181,8 @@ def run_module(request, collection_import):
resource_class = resource_module.ControllerAWXKitModule
elif getattr(resource_module, 'ControllerAPIModule', None):
resource_class = resource_module.ControllerAPIModule
- elif getattr(resource_module, 'TowerLegacyModule', None):
- resource_class = resource_module.TowerLegacyModule
else:
- raise RuntimeError("The module has neither a TowerLegacyModule, ControllerAWXKitModule or a ControllerAPIModule")
+ raise RuntimeError("The module has neither a ControllerAWXKitModule or a ControllerAPIModule")
with mock.patch.object(resource_class, '_load_params', new=mock_load_params):
# Call the test utility (like a mock server) instead of issuing HTTP requests
diff --git a/awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j2 b/awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j2
index bf306aecca..5290dc7217 100644
--- a/awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j2
+++ b/awx_collection/tools/roles/template_galaxy/templates/galaxy.yml.j2
@@ -19,8 +19,6 @@ homepage: https://www.ansible.com/
issues: https://github.com/ansible/awx/issues?q=is%3Aissue+label%3Acomponent%3Aawx_collection
license:
- GPL-3.0-or-later
- # plugins/module_utils/tower_legacy.py
- - BSD-2-Clause
name: {{ collection_package }}
namespace: {{ collection_namespace }}
readme: README.md