cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

ansible-test: do not accept empty string as valid version number (#69816)

Browse source 
* Work around strange behavior of StrictVersion and SemanticVersion constructors that they accept an falsy value.

* Do not accept empty strings as versions.
This commit is contained in:
Felix Fontein 2020-06-04 22:25:05 +02:00 committed by GitHub
parent 3b00c161dc
commit 2dbd5dc2ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 36 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
test/lib/ansible_test/_data/sanity/pylint/plugins/deprecated.py
View file

@ -205,6 +205,8 @@ class AnsibleDeprecatedChecker(BaseChecker):
if collection == 'ansible.builtin': if collection == 'ansible.builtin':
# Ansible-base # Ansible-base
try: try:
if not version_no:
raise ValueError('Version string should not be empty')
loose_version = LooseVersion(str(version_no)) loose_version = LooseVersion(str(version_no))
if ANSIBLE_VERSION >= loose_version: if ANSIBLE_VERSION >= loose_version:
self.add_message('ansible-deprecated-version', node=node, args=(version,)) self.add_message('ansible-deprecated-version', node=node, args=(version,))
@ -213,6 +215,8 @@ class AnsibleDeprecatedChecker(BaseChecker):
else: else:
# Collections # Collections
try: try:
if not version_no:
raise ValueError('Version string should not be empty')
semantic_version = SemanticVersion(version_no) semantic_version = SemanticVersion(version_no)
if collection == self.collection_name and self.collection_version is not None: if collection == self.collection_name and self.collection_version is not None:
if self.collection_version >= semantic_version: if self.collection_version >= semantic_version:

49
test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/main.py
View file

@ -254,21 +254,21 @@ class ModuleValidator(Validator):
self.analyze_arg_spec = analyze_arg_spec self.analyze_arg_spec = analyze_arg_spec
self.Version = LooseVersion self._Version = LooseVersion
self.StrictVersion = StrictVersion self._StrictVersion = StrictVersion
self.collection = collection self.collection = collection
self.collection_name = 'ansible.builtin' self.collection_name = 'ansible.builtin'
if self.collection: if self.collection:
self.Version = SemanticVersion self._Version = SemanticVersion
self.StrictVersion = SemanticVersion self._StrictVersion = SemanticVersion
collection_namespace_path, collection_name = os.path.split(self.collection) collection_namespace_path, collection_name = os.path.split(self.collection)
self.collection_name = '%s.%s' % (os.path.basename(collection_namespace_path), collection_name) self.collection_name = '%s.%s' % (os.path.basename(collection_namespace_path), collection_name)
self.routing = routing self.routing = routing
self.collection_version = None self.collection_version = None
if collection_version is not None: if collection_version is not None:
self.collection_version_str = collection_version self.collection_version_str = collection_version
self.collection_version = self.Version(collection_version) self.collection_version = SemanticVersion(collection_version)
self.base_branch = base_branch self.base_branch = base_branch
self.git_cache = git_cache or GitCache() self.git_cache = git_cache or GitCache()
@ -288,6 +288,16 @@ class ModuleValidator(Validator):
else: else:
self.base_module = None self.base_module = None
def _create_version(self, v):
if not v:
raise ValueError('Empty string is not a valid version')
return self._Version(v)
def _create_strict_version(self, v):
if not v:
raise ValueError('Empty string is not a valid version')
return self._StrictVersion(v)
def __enter__(self): def __enter__(self):
return self return self
@ -1193,7 +1203,8 @@ class ModuleValidator(Validator):
def _check_version_added(self, doc, existing_doc): def _check_version_added(self, doc, existing_doc):
version_added_raw = doc.get('version_added') version_added_raw = doc.get('version_added')
try: try:
version_added = self.StrictVersion(self._extract_version_from_tag_for_msg(str(doc.get('version_added', '0.0') or '0.0'))) version_added = self._create_strict_version(
self._extract_version_from_tag_for_msg(str(doc.get('version_added', '0.0') or '0.0')))
except ValueError: except ValueError:
version_added = doc.get('version_added', '0.0') version_added = doc.get('version_added', '0.0')
if self._is_new_module() or version_added != 'ansible.builtin:historical': if self._is_new_module() or version_added != 'ansible.builtin:historical':
@ -1219,7 +1230,7 @@ class ModuleValidator(Validator):
return return
should_be = '.'.join(ansible_version.split('.')[:2]) should_be = '.'.join(ansible_version.split('.')[:2])
strict_ansible_version = self.StrictVersion(should_be) strict_ansible_version = self._create_strict_version(should_be)
if (version_added < strict_ansible_version or if (version_added < strict_ansible_version or
strict_ansible_version < version_added): strict_ansible_version < version_added):
@ -1585,7 +1596,7 @@ class ModuleValidator(Validator):
if removed_in_version is not None: if removed_in_version is not None:
try: try:
collection_name, removed_in_version = self._split_tagged_version(removed_in_version) collection_name, removed_in_version = self._split_tagged_version(removed_in_version)
if collection_name == self.collection_name and compare_version >= self.Version(str(removed_in_version)): if collection_name == self.collection_name and compare_version >= self._create_version(str(removed_in_version)):
msg = "Argument '%s' in argument_spec" % arg msg = "Argument '%s' in argument_spec" % arg
if context: if context:
msg += " found in %s" % " -> ".join(context) msg += " found in %s" % " -> ".join(context)
@ -1605,7 +1616,7 @@ class ModuleValidator(Validator):
if 'name' in deprecated_alias and 'version' in deprecated_alias: if 'name' in deprecated_alias and 'version' in deprecated_alias:
try: try:
collection_name, version = self._split_tagged_version(deprecated_alias['version']) collection_name, version = self._split_tagged_version(deprecated_alias['version'])
if collection_name == self.collection_name and compare_version >= self.Version(str(version)): if collection_name == self.collection_name and compare_version >= self._create_version(str(version)):
msg = "Argument '%s' in argument_spec" % arg msg = "Argument '%s' in argument_spec" % arg
if context: if context:
msg += " found in %s" % " -> ".join(context) msg += " found in %s" % " -> ".join(context)
@ -2022,12 +2033,10 @@ class ModuleValidator(Validator):
return return
try: try:
mod_version_added = self.StrictVersion() mod_version_added = self._create_strict_version(
mod_version_added.parse( self._extract_version_from_tag_for_msg(str(existing_doc.get('version_added', '0.0'))))
self._extract_version_from_tag_for_msg(str(existing_doc.get('version_added', '0.0')))
)
except ValueError: except ValueError:
mod_version_added = self.StrictVersion('0.0') mod_version_added = self._create_strict_version('0.0')
if self.base_branch and 'stable-' in self.base_branch: if self.base_branch and 'stable-' in self.base_branch:
metadata.pop('metadata_version', None) metadata.pop('metadata_version', None)
@ -2042,7 +2051,7 @@ class ModuleValidator(Validator):
options = doc.get('options', {}) or {} options = doc.get('options', {}) or {}
should_be = '.'.join(ansible_version.split('.')[:2]) should_be = '.'.join(ansible_version.split('.')[:2])
strict_ansible_version = self.StrictVersion(should_be) strict_ansible_version = self._create_strict_version(should_be)
for option, details in options.items(): for option, details in options.items():
try: try:
@ -2069,10 +2078,8 @@ class ModuleValidator(Validator):
continue continue
try: try:
version_added = self.StrictVersion() version_added = self._create_strict_version(
version_added.parse( self._extract_version_from_tag_for_msg(str(details.get('version_added', '0.0'))))
self._extract_version_from_tag_for_msg(str(details.get('version_added', '0.0')))
)
except ValueError: except ValueError:
# already reported during schema validation # already reported during schema validation
continue continue
@ -2167,12 +2174,12 @@ class ModuleValidator(Validator):
) )
# Treat the module as not to be removed: # Treat the module as not to be removed:
raise ValueError('') raise ValueError('')
removed_in = self.StrictVersion(str(version)) removed_in = self._create_strict_version(str(version))
except ValueError: except ValueError:
end_of_deprecation_should_be_removed_only = False end_of_deprecation_should_be_removed_only = False
else: else:
if not self.collection: if not self.collection:
strict_ansible_version = self.StrictVersion('.'.join(ansible_version.split('.')[:2])) strict_ansible_version = self._create_strict_version('.'.join(ansible_version.split('.')[:2]))
end_of_deprecation_should_be_removed_only = strict_ansible_version >= removed_in end_of_deprecation_should_be_removed_only = strict_ansible_version >= removed_in
elif self.collection_version: elif self.collection_version:
strict_ansible_version = self.collection_version strict_ansible_version = self.collection_version

4
test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/schema.py
View file

@ -40,6 +40,10 @@ def _add_ansible_error_code(exception, error_code):
def semantic_version(v, error_code=None): def semantic_version(v, error_code=None):
if not isinstance(v, string_types): if not isinstance(v, string_types):
raise _add_ansible_error_code(Invalid('Semantic version must be a string'), error_code or 'collection-invalid-version') raise _add_ansible_error_code(Invalid('Semantic version must be a string'), error_code or 'collection-invalid-version')
if not v:
raise _add_ansible_error_code(
Invalid('Empty string is not a valid semantic version'),
error_code or 'collection-invalid-version')
try: try:
SemanticVersion(v) SemanticVersion(v)
except ValueError as e: except ValueError as e: