aherman
/
ansible
mirror of https://github.com/ansible/ansible
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deprecate apt_* using runtime.yml (#86690)

Browse Source 
Signed-off-by: Abhijeet Kasurde <Akasurde@redhat.com>
Co-authored-by: Matt Clay <matt@mystile.com>
pull/57129/merge
Abhijeet Kasurde 2 months ago committed by GitHub
parent e4004d720d
commit 8d24f0d32f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 49 additions and 57 deletions
Show Stats Download Patch File Download Diff File

8
lib/ansible/config/ansible_builtin_runtime.yml
Unescape View File

@ -2717,6 +2717,14 @@ plugin_routing:
redirect: community.general.apk
apt_rpm:
redirect: community.general.apt_rpm
apt_repository:
deprecation:
removal_version: "2.25"
warning_text: Use deb822_repository instead.
apt_key:
deprecation:
removal_version: "2.25"
warning_text: Use deb822_repository instead.
flatpak:
redirect: community.general.flatpak
flatpak_remote:

0
lib/ansible/modules/_apt_key.py → lib/ansible/modules/apt_key.py
Unescape View File

0
lib/ansible/modules/_apt_repository.py → lib/ansible/modules/apt_repository.py
Unescape View File

88
test/lib/ansible_test/_util/controller/sanity/validate-modules/validate_modules/main.py
Unescape View File

@ -879,25 +879,19 @@ class ModuleValidator(Validator):
def _validate_docs(self):
doc = None
# We have three ways of marking deprecated/removed files. Have to check each one
# We have two ways of marking deprecated/removed files. Have to check each one
# individually and then make sure they all agree
filename_deprecated_or_removed = False
deprecated = False
doc_deprecated = None # doc legally might not exist
routing_says_deprecated = False
if self.object_name.startswith('_') and not os.path.islink(self.object_path):
filename_deprecated_or_removed = True
# We are testing a collection
if self.routing:
routing_deprecation = self.routing.get('plugin_routing', {})
routing_deprecation = routing_deprecation.get('modules' if self.plugin_type == 'module' else self.plugin_type, {})
routing_deprecation = routing_deprecation.get(self.name, {}).get('deprecation', {})
if routing_deprecation:
# meta/runtime.yml says this is deprecated
# consult meta/runtime.yml for collection to see if this is deprecated
# consult ansible_builtin_runtime.yml for ansible.builtin to see if this is deprecated
routing_says_deprecated = True
deprecated = True
if self._python_module():
doc_info = self._get_py_docs()
@ -1030,30 +1024,22 @@ class ModuleValidator(Validator):
if os.path.islink(self.object_path):
# This module has an alias, which we can tell as it's a symlink
# Rather than checking for `module: $filename` we need to check against the true filename
self._validate_docs_schema(
doc,
doc_schema(
os.readlink(self.object_path).split('.')[0],
for_collection=bool(self.collection),
deprecated_module=deprecated,
plugin_type=self.plugin_type,
),
'DOCUMENTATION',
'invalid-documentation',
)
module_name = os.readlink(self.object_path).split('.')[0]
else:
# This is the normal case
self._validate_docs_schema(
doc,
doc_schema(
self.object_name.split('.')[0],
for_collection=bool(self.collection),
deprecated_module=deprecated,
plugin_type=self.plugin_type,
),
'DOCUMENTATION',
'invalid-documentation',
)
module_name = self.object_name.split('.')[0]
self._validate_docs_schema(
doc,
doc_schema(
module_name,
for_collection=bool(self.collection),
deprecated_module=routing_says_deprecated or doc_deprecated,
plugin_type=self.plugin_type,
),
'DOCUMENTATION',
'invalid-documentation',
)
if doc:
self._validate_option_docs(doc.get('options'))
@ -1135,21 +1121,12 @@ class ModuleValidator(Validator):
# Check for mismatched deprecation
if not self.collection:
mismatched_deprecation = True
if not (filename_deprecated_or_removed or deprecated or doc_deprecated):
mismatched_deprecation = False
else:
if (filename_deprecated_or_removed and doc_deprecated):
mismatched_deprecation = False
if (filename_deprecated_or_removed and not doc):
mismatched_deprecation = False
if mismatched_deprecation:
if doc_deprecated != routing_says_deprecated:
self.reporter.error(
path=self.object_path,
code='deprecation-mismatch',
msg='Module deprecation/removed must agree in documentation, by prepending filename with'
' "_", and setting DOCUMENTATION.deprecated for deprecation or by removing all'
msg='Module deprecation/removed must agree in documentation, by adding an entry in ansible_builtin_runtime.yml'
' and setting DOCUMENTATION.deprecated for deprecation or by removing all'
' documentation for removed'
)
else:
@ -1298,7 +1275,12 @@ class ModuleValidator(Validator):
self._validate_semantic_markup_return_values(return_docs)
def _check_version_added(self, doc, existing_doc):
deprecated = doc.get('deprecated', False)
if deprecated:
return
version_added_raw = doc.get('version_added')
try:
collection_name = doc.get('version_added_collection')
version_added = self._create_strict_version(
@ -2597,15 +2579,17 @@ def run():
routing = None
if args.collection:
routing_file = 'meta/runtime.yml'
# Load meta/runtime.yml if it exists, as it may contain deprecation information
if os.path.isfile(routing_file):
try:
with open(routing_file) as f:
routing = yaml.safe_load(f)
except yaml.error.MarkedYAMLError as ex:
print('%s:%d:%d: YAML load failed: %s' % (routing_file, ex.context_mark.line + 1, ex.context_mark.column + 1, re.sub(r'\s+', ' ', str(ex))))
except Exception as ex: # pylint: disable=broad-except
print('%s:%d:%d: YAML load failed: %s' % (routing_file, 0, 0, re.sub(r'\s+', ' ', str(ex))))
else:
routing_file = 'lib/ansible/config/ansible_builtin_runtime.yml'
if os.path.isfile(routing_file):
try:
with open(routing_file) as f:
routing = yaml.safe_load(f)
except yaml.error.MarkedYAMLError as ex:
print('%s:%d:%d: YAML load failed: %s' % (routing_file, ex.context_mark.line + 1, ex.context_mark.column + 1, re.sub(r'\s+', ' ', str(ex))))
except Exception as ex: # pylint: disable=broad-except
print('%s:%d:%d: YAML load failed: %s' % (routing_file, 0, 0, re.sub(r'\s+', ' ', str(ex))))
for plugin in args.plugins:
if os.path.isfile(plugin):

2
test/sanity/ignore.txt
Unescape View File

@ -4,7 +4,7 @@ lib/ansible/_internal/_wrapt.py black!skip # vendored code
lib/ansible/config/base.yml no-unwanted-files
lib/ansible/keyword_desc.yml no-unwanted-files
lib/ansible/modules/apt.py validate-modules:parameter-invalid
lib/ansible/modules/_apt_repository.py validate-modules:parameter-invalid
lib/ansible/modules/apt_repository.py validate-modules:parameter-invalid
lib/ansible/modules/async_status.py validate-modules!skip
lib/ansible/modules/async_wrapper.py ansible-doc!skip # not an actual module
lib/ansible/modules/async_wrapper.py pylint:ansible-bad-function # ignore, required

8
test/units/modules/test_apt_key.py
Unescape View File

@ -5,7 +5,7 @@ import os
from unittest.mock import patch, Mock
import unittest
from ansible.modules import _apt_key
from ansible.modules import apt_key
def returnc(x):
@ -14,13 +14,13 @@ def returnc(x):
class AptKeyTestCase(unittest.TestCase):
@patch.object(_apt_key, 'apt_key_bin', '/usr/bin/apt-key')
@patch.object(_apt_key, 'lang_env', returnc)
@patch.object(apt_key, 'apt_key_bin', '/usr/bin/apt-key')
@patch.object(apt_key, 'lang_env', returnc)
@patch.dict(os.environ, {'HTTP_PROXY': 'proxy.example.com'})
def test_import_key_with_http_proxy(self):
m_mock = Mock()
m_mock.run_command.return_value = (0, '', '')
_apt_key.import_key(
apt_key.import_key(
m_mock, keyring=None, keyserver='keyserver.example.com',
key_id='0xDEADBEEF')
self.assertEqual(

Write Preview
Loading…
Cancel
Save