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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
#
# RTEMS Tools Project (http://www.rtems.org/)
# Copyright 2010-2018 Chris Johns (chrisj@rtems.org)
# All rights reserved.
#
# This file is part of the RTEMS Tools package in 'rtems-tools'.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. 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.
#
#
# Releasing RTEMS Tools
# ---------------------
#
# Format:
#
# The format is INI. The file requires a `[version`] section and a `revision`
# option:
#
# [version]
# revision = <version-string>
#
# The `<version-string>` has the `version` and `revision` delimited by a
# single `.`. An example file is:
#
# [version]
# revision = 5.0.not_released
#
# where the `version` is `5` and the revision is `0` and the package is not
# released. The label `not_released` is reversed to mean the package is not
# released. A revision string can contain extra characters after the
# `revision` number for example `5.0-rc1` or is deploying a package
# `5.0-nasa-cfs`
#
# Packages can optionally add specialised sections to a version configuration
# files. These can be accessed via the:
#
# load_release_settings: Return the items in a section
# load_release_setting: Return an item from a section
#
# User deployment:
#
# Create a git archive and then add a suitable VERSION file to the top
# directory of the package. The package assumes your python executable is
# location in `bin` directory which is one below the top of the package's
# install prefix.
#
# Notes:
#
# This module uses os.apth for paths and assumes all paths are in the host
# format.
#
from __future__ import print_function
import os
import sys
from . import error
from . import git
from . import path
#
# Default to an internal string.
#
_version = '6'
_revision = 'not_released'
_version_str = '%s.%s' % (_version, _revision)
_released = False
_git = False
_is_loaded = False
_top_dir = None
def _top():
if _top_dir is None:
top = path.dirname(sys.argv[0])
else:
top = _top_dir
if len(top) == 0:
top = '.'
return top
def _load_released_version_config():
'''Local worker to load a configuration file.'''
top = _top()
for ver in [path.join(top, 'VERSION'),
path.join('..', 'VERSION')]:
if path.exists(path.join(ver)):
try:
import configparser
except ImportError:
import ConfigParser as configparser
v = configparser.SafeConfigParser()
try:
v.read(path.host(ver))
except Exception as e:
raise error.general('Invalid version config format: %s: %s' % (ver,
e))
return ver, v
return None, None
def _load_released_version():
'''Load the release data if present. If not found the package is not released.
A release can be made by adding a file called `VERSION` to the top level
directory of a package. This is useful for user deploying a package and
making custom releases.
The RTEMS project reserves the `rtems-version.ini` file for it's
releases. This is the base release and should not be touched by users
deploying a package.
'''
global _version
global _revision
global _released
global _version_str
global _is_loaded
if not _is_loaded:
vc, v = _load_released_version_config()
if v is not None:
try:
ver_str = v.get('version', 'revision')
except Exception as e:
raise error.general('Invalid version file: %s: %s' % (vc, e))
ver_split = ver_str.split('.', 1)
if len(ver_split) < 2:
raise error.general('Invalid version release value: %s: %s' % (vc,
ver_str))
ver = ver_split[0]
rev = ver_split[1]
try:
_version = int(ver)
except:
raise error.general('Invalid version config value: %s: %s' % (vc,
ver))
_revision = rev
if 'not_released' not in ver:
_released = True
_version_str = ver_str
_is_loaded = True
return _released
def _load_git_version():
global _version
global _revision
global _git
global _version_str
global _is_loaded
if not _is_loaded:
repo = git.repo(_top())
if repo.valid():
head = repo.head()
if repo.dirty():
modified = 'modified'
revision_sep = '-'
sep = ' '
else:
modified = ''
revision_sep = ''
sep = ''
_revision = '%s%s%s' % (head[0:12], revision_sep, modified)
_version_str = '%s (%s%s%s)' % (_version, head[0:12], sep, modified)
_git = True
_is_loaded = True
return _git
def set_top(top):
global _top_dir
_top_dir = top
def load_release_settings(section, error = False):
vc, v = _load_released_version_config()
items = []
if v is not None:
try:
items = v.items(section)
except Exception as e:
if not isinstance(error, bool):
error(e)
elif error:
raise error.general('Invalid config section: %s: %s: %s' % (vc,
section,
e))
return items
def load_release_setting(section, option, raw = False, error = False):
vc, v = _load_released_version_config()
value = None
if v is not None:
try:
value = v.get(section, option, raw = raw)
except Exception as e:
if not isinstance(error, bool):
error(e)
elif error:
raise error.general('Invalid config section: %s: %s: %s.%s' % (vc,
section,
option,
e))
return value
def released():
return _load_released_version()
def version_control():
return _load_git_version()
def string():
_load_released_version()
_load_git_version()
return _version_str
def version():
_load_released_version()
_load_git_version()
return _version
def revision():
_load_released_version()
_load_git_version()
return _revision
if __name__ == '__main__':
print('Version: %s' % (str(version())))
print('Revision: %s' % (str(revision())))
print('String: %s' % (string()))
if version() == 'undefined':
raise Exception('version is undefined')
|
