releases/openstack_releases/versionutils.py
Tony Breeds 828e285701 Add a 'generic' release-type.
We use release-types as a way to verify that versions are compatible and
if needed reflected accurately in the code (puppet, xstatic).  If one
isn't set explicitly then we assume python-service.

In certain circumstances (anything other than the first release in a
series) we also perform python specific requirements checking on all
'python' types.

Add a new 'generic' type that uses the same rules to validate version
numbers but wont run any python specific checks.

We need this a projects (like monasca-thresh) will fail the requirements
check for 2nd or greater releases[1].

An alternate would be to have the requirements code check if setup.py
exists before calling it but that seems like the wrong layer to me.

[1] http://logs.openstack.org/54/652854/1/check/openstack-tox-validate/80df01c/job-output.txt.gz#_2019-04-16_06_08_00_636538
Change-Id: I3fcde5eb266f954fddb6871ce8690b93b8fd7a8d
2019-04-18 15:27:27 +10:00

90 lines
3.7 KiB
Python

# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
from __future__ import unicode_literals
import packaging.version
import pbr.version
# The keys for this dict are the valid release types for OpenStack releases.
# The values are a three-tuple that contains:
# 1. constructor: The function used to convert the version string in to a
# *Verion object.
# 2. exception: The exception raised by the constructor iff version
# string is invalid in some way.
# 3. canonicalise: The function used to canonicalise the *Version object.
# Used to verify that the version string is already in the
# canonical form
_VALIDATORS = {'python-service': (pbr.version.SemanticVersion.from_pip_string,
ValueError,
lambda x: x.release_string()),
'xstatic': (packaging.version.Version,
packaging.version.InvalidVersion,
lambda x: str(x)),
}
_VALIDATORS['fuel'] = _VALIDATORS['python-service']
_VALIDATORS['openstack-manuals'] = _VALIDATORS['python-service']
_VALIDATORS['puppet'] = _VALIDATORS['python-service']
_VALIDATORS['nodejs'] = _VALIDATORS['python-service']
_VALIDATORS['neutron'] = _VALIDATORS['python-service']
_VALIDATORS['horizon'] = _VALIDATORS['python-service']
_VALIDATORS['python-pypi'] = _VALIDATORS['python-service']
# This release-type uses the same version validation as python-service and
# has no language specific validation like nodejs or xstatic.
# It's used to bypass and python specific checks (like requirements validation)
_VALIDATORS['generic'] = _VALIDATORS['python-service']
def validate_version(versionstr, release_type='python-service', pre_ok=True):
"""Given a version string, yield error messages if it is "bad"
Apply our SemVer rules to version strings and report all issues.
"""
if not pre_ok and looks_like_preversion(versionstr):
yield('Version %s looks like a pre-release and the release '
'model does not allow for it' % versionstr)
if release_type not in _VALIDATORS:
yield 'Release Type %r not valid using \'python-service\' instead' % release_type
release_type = 'python-service'
constructor, exception, canonicalise = _VALIDATORS[release_type]
try:
semver = constructor(versionstr)
except exception as err:
yield 'Invalid version: %s' % err
else:
# Make sure we didn't change the version to meet the canonical form.
canonical = canonicalise(semver)
if canonical != versionstr:
yield 'Version %r does not match canonical form %r' % \
(versionstr, canonical)
def canonical_version(versionstr, release_type='python-service'):
"""Given a version string verify it is in the canonical form."""
errors = list(validate_version(versionstr, release_type))
if errors:
raise ValueError(errors[-1])
return versionstr
def looks_like_preversion(versionstr):
"Return boolean indicating if the version appears to be a pre-version."
for pre_indicator in ['a', 'b', 'rc']:
if pre_indicator in versionstr:
return True
return False