blob: 2fb7785a1211a5ca8aa4be3055e85ee64fc104ef (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
# Copyright (C) 2015 Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#
# =*= License: GPL-2 =*=
'''Functions for dealing with the definitions VERSION marker file.'''
import cliapp
import yaml
import morphlib
SUPPORTED_VERSIONS = [6, 7]
class DefinitionsVersionError(cliapp.AppException):
pass
class UnknownVersionError(DefinitionsVersionError): # pragma: no cover
def __init__(self, version):
DefinitionsVersionError.__init__(
self, "Definitions format version %s is not supported" % version)
class InvalidVersionFileError(DefinitionsVersionError): # pragma: no cover
def __init__(self, text):
DefinitionsVersionError.__init__(
self, "invalid VERSION file: '%s'" % text)
def parse_version_file(version_text):
'''Parse VERSION file and return the version of the format if:
VERSION is a YAML file
and it's a dict
and has the key 'version'
and the type stored in the 'version' key is an int
otherwise returns None
'''
yaml_obj = yaml.safe_load(version_text)
return (yaml_obj['version'] if yaml_obj is not None
and isinstance(yaml_obj, dict)
and 'version' in yaml_obj
and isinstance(yaml_obj['version'], int)
else None)
def check_version_file(version_text): # pragma: no cover
'''Check the VERSION information is valid and is a supported version.'''
if version_text == None:
raise InvalidVersionFileError()
version = morphlib.definitions_version.parse_version_file(version_text)
if version == None:
raise InvalidVersionFileError(version_text)
if version not in SUPPORTED_VERSIONS:
raise UnknownVersionError(version)
return version
|