0
|
1 |
#
|
|
2 |
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
3 |
# All rights reserved.
|
|
4 |
# This component and the accompanying materials are made available
|
|
5 |
# under the terms of "Eclipse Public License v1.0"
|
|
6 |
# which accompanies this distribution, and is available
|
|
7 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
8 |
#
|
|
9 |
# Initial Contributors:
|
|
10 |
# Nokia Corporation - initial contribution.
|
|
11 |
#
|
|
12 |
# Contributors:
|
|
13 |
#
|
|
14 |
# Description:
|
|
15 |
#
|
|
16 |
#!/usr/bin/env python
|
|
17 |
##
|
|
18 |
# @author Teemu Rytkonen
|
|
19 |
|
|
20 |
import os
|
|
21 |
import sys
|
|
22 |
import logging
|
|
23 |
import logging.config
|
|
24 |
import re, fnmatch
|
|
25 |
from optparse import Option
|
|
26 |
import cone_tool
|
|
27 |
|
|
28 |
|
|
29 |
"""
|
|
30 |
try to import cone and modify the sys.paths if it does not succeed.
|
|
31 |
This is done mainly for local installation and testing purposes.
|
|
32 |
"""
|
|
33 |
ROOT_PATH = os.path.dirname(os.path.abspath(__file__))
|
|
34 |
|
|
35 |
try:
|
3
|
36 |
from cone.public import api, settings, utils
|
0
|
37 |
except ImportError:
|
|
38 |
sys.path.append(os.path.join(ROOT_PATH))
|
|
39 |
sys.path.append(os.path.join(ROOT_PATH,'..'))
|
3
|
40 |
from cone.public import api, settings, utils
|
0
|
41 |
|
|
42 |
# Common command line options used by all sub-actions
|
|
43 |
COMMON_OPTIONS = [
|
|
44 |
Option("--print-settings",
|
|
45 |
dest="print_settings",
|
|
46 |
action="store_true",
|
|
47 |
help="Print all the default settings from the current setting container.",
|
|
48 |
default=False),
|
|
49 |
|
|
50 |
Option("--print-supported-impls",
|
|
51 |
action="store_true",
|
|
52 |
help="Print all supported ImplML XML namespaces and file extensions.",
|
|
53 |
default=False),
|
|
54 |
|
|
55 |
Option("--print-runtime-info",
|
|
56 |
action="store_true",
|
|
57 |
help="Print runtime information about ConE.",
|
|
58 |
default=False),
|
|
59 |
|
|
60 |
Option("-v", "--verbose",\
|
|
61 |
dest="verbose",\
|
|
62 |
help="""Print error, warning and information on system out.
|
|
63 |
Possible choices: Default is 3.
|
|
64 |
NONE (all) 0
|
|
65 |
CRITICAL 1
|
|
66 |
ERROR 2
|
|
67 |
WARNING 3
|
|
68 |
INFO 4
|
|
69 |
DEBUG 5""",
|
|
70 |
metavar="LEVEL",
|
|
71 |
default="3"),
|
3
|
72 |
|
0
|
73 |
Option("--log-file",
|
|
74 |
dest="log_file",
|
|
75 |
action="store",
|
|
76 |
type="string",
|
|
77 |
help="Location of the used log file. Default is 'cone.log'",
|
|
78 |
metavar="FILE",
|
|
79 |
default="cone.log"),
|
|
80 |
|
|
81 |
Option("--log-config",
|
|
82 |
dest="log_conf",
|
|
83 |
action="store",
|
|
84 |
type="string",
|
|
85 |
help="Location of the used logging configuration file. Default is 'logging.ini'",
|
|
86 |
metavar="FILE"),
|
|
87 |
|
|
88 |
Option("--username",
|
|
89 |
dest="username",
|
|
90 |
action="store",
|
|
91 |
type="string",
|
|
92 |
help="Username for webstorage operations. Not needed for filestorage or cpf storage. If the username \
|
3
|
93 |
is not given, the tool will use the logged in username. "\
|
|
94 |
"Example: cone export -p webstorage_url -r . -c sample.confml --username=admin --password=abc123.",
|
0
|
95 |
metavar="USERNAME"),
|
|
96 |
|
|
97 |
Option("--password",
|
|
98 |
dest="password",
|
|
99 |
action="store",
|
|
100 |
type="string",
|
|
101 |
help="Password for webstorage operations. Not needed for filestorage or cpf storage. If the password \
|
3
|
102 |
is not given, the tool will prompt for password if needed. ",
|
0
|
103 |
metavar="PASSWORD"),
|
|
104 |
]
|
|
105 |
|
|
106 |
def handle_common_options(options, settings=None):
|
|
107 |
"""
|
|
108 |
Handle common command line options.
|
|
109 |
@param options: The parsed command line options.
|
|
110 |
@param settings: The settings to print if --print-settings is used.
|
|
111 |
Can be None, in which case the default settings are printed.
|
|
112 |
"""
|
|
113 |
if options.log_conf:
|
|
114 |
open_log(options.verbose, options.log_file, options.log_conf)
|
|
115 |
else:
|
|
116 |
open_log(options.verbose, options.log_file)
|
|
117 |
|
|
118 |
exit = False
|
|
119 |
|
|
120 |
if options.print_settings:
|
|
121 |
if settings == None:
|
|
122 |
settings = get_settings([])
|
|
123 |
print_settings(settings)
|
|
124 |
exit = True
|
|
125 |
|
|
126 |
if options.print_supported_impls:
|
|
127 |
from cone.public import plugin
|
|
128 |
print "Supported ImplML namespaces:"
|
|
129 |
for ns in sorted(plugin.get_supported_namespaces()):
|
|
130 |
print ns
|
|
131 |
|
|
132 |
print ""
|
|
133 |
print "Supported ImplML file extensions:"
|
|
134 |
for ns in plugin.get_supported_file_extensions():
|
|
135 |
print ns
|
|
136 |
exit = True
|
|
137 |
|
|
138 |
if options.print_runtime_info:
|
|
139 |
print _get_runtime_info()
|
|
140 |
print "\nsys.path contents:"
|
|
141 |
print '\n'.join(sys.path)
|
|
142 |
exit = True
|
|
143 |
|
|
144 |
if exit: sys.exit()
|
|
145 |
|
|
146 |
def _get_runtime_info():
|
|
147 |
if hasattr(sys, 'executable'): executable = sys.executable
|
|
148 |
else: executable = 'N/A'
|
|
149 |
info = ["ConE version: %s" % cone_tool.VERSION,
|
|
150 |
"Python version: %s" % sys.version,
|
|
151 |
"Platform: %s" % sys.platform,
|
|
152 |
"Executable: %s" % executable,
|
|
153 |
"Command line: %s" % ' '.join(sys.argv),
|
|
154 |
"Working dir: %s" % os.getcwd(),
|
|
155 |
"Script location: %s" % ROOT_PATH]
|
|
156 |
return '\n'.join(info)
|
|
157 |
|
|
158 |
def open_log(verbose, log_file, log_conf_file=os.path.join(ROOT_PATH, 'logging.ini')):
|
|
159 |
try:
|
3
|
160 |
# Convert the reference to the log file as a absolute path so that it would work in all scenarios
|
|
161 |
log_file = repr(os.path.abspath(log_file))
|
|
162 |
|
|
163 |
if log_file.startswith("'"):
|
|
164 |
log_file = log_file.replace("'", '', 1)
|
|
165 |
if log_file.endswith("'"):
|
|
166 |
log_file = log_file.replace("'",'', 1)
|
|
167 |
|
0
|
168 |
log_dir = os.path.dirname(log_file)
|
|
169 |
if log_dir != '' and not os.path.exists(log_dir):
|
|
170 |
os.makedirs(log_dir)
|
|
171 |
|
|
172 |
if (os.path.exists(log_conf_file)):
|
|
173 |
defaults = {'logfile': log_file, 'level': get_log_level_for_config(verbose)}
|
|
174 |
logging.config.fileConfig(log_conf_file, defaults)
|
|
175 |
else:
|
|
176 |
print "Failed to load logging configuration file: %s" % log_conf_file
|
|
177 |
|
|
178 |
logger = logging.getLogger('cone')
|
|
179 |
logger.info("Runtime info:\n%s" % _get_runtime_info())
|
|
180 |
logger.debug("sys.path contents:\n%s" % '\n'.join(sys.path))
|
|
181 |
|
|
182 |
def get_var(varname):
|
|
183 |
try: return os.environ[varname]
|
|
184 |
except KeyError: return 'N/A'
|
|
185 |
logger.debug("PATH: %s" % get_var('PATH'))
|
|
186 |
logger.debug("PYTHONPATH: %s" % get_var('PYTHONPATH'))
|
|
187 |
except IOError, e:
|
|
188 |
print "Cannot create log file. ", e
|
|
189 |
|
|
190 |
def get_settings(files):
|
|
191 |
parser = settings.SettingsFactory.cone_parser()
|
|
192 |
parser.read(files)
|
|
193 |
return parser
|
|
194 |
|
|
195 |
def print_settings(parser):
|
|
196 |
print_section(parser,"DEFAULT")
|
|
197 |
for section in parser.sections():
|
|
198 |
print_section(parser,section)
|
|
199 |
|
|
200 |
def print_section(parser, section):
|
|
201 |
print "[%s]" % section
|
|
202 |
for (name,value) in parser.items(section):
|
|
203 |
print " %s = %s" % (name,value)
|
|
204 |
|
|
205 |
|
|
206 |
def get_log_level(level):
|
|
207 |
"""
|
|
208 |
Change the given user input log level to logging categorisation
|
|
209 |
"""
|
|
210 |
# If the level is empty, revert to the default
|
|
211 |
if level in ('', None):
|
|
212 |
level = '3'
|
|
213 |
|
|
214 |
if level == '0' : return logging.NOTSET
|
|
215 |
elif level == '1' : return logging.CRITICAL
|
|
216 |
elif level == '2' : return logging.ERROR
|
|
217 |
elif level == '3' : return logging.WARNING
|
|
218 |
elif level == '4' : return logging.INFO
|
|
219 |
elif level == '5' : return logging.DEBUG
|
|
220 |
else : return logging.NOTSET
|
|
221 |
|
|
222 |
def get_log_level_for_config(level):
|
|
223 |
"""
|
|
224 |
Change the given user input to log level to logging configuration file
|
|
225 |
"""
|
|
226 |
|
|
227 |
# If the level is empty, revert to the default
|
|
228 |
if level in ('', None):
|
|
229 |
level = 'WARNING'
|
|
230 |
|
|
231 |
if level == '0' : return 'NOTSET'
|
|
232 |
elif level == '1' : return 'CRITICAL'
|
|
233 |
elif level == '2' : return 'ERROR'
|
|
234 |
elif level == '3' : return 'WARNING'
|
|
235 |
elif level == '4' : return 'INFO'
|
|
236 |
elif level == '5' : return 'DEBUG'
|
|
237 |
else : return 'NOTSET'
|
|
238 |
|
|
239 |
|
|
240 |
class ConfigurationNotFoundError(Exception):
|
|
241 |
"""
|
|
242 |
Exception raised by get_config_list_from_project() if an invalid
|
|
243 |
configuration is given.
|
|
244 |
"""
|
|
245 |
pass
|
|
246 |
|
|
247 |
def get_config_list_from_project(project, configs, config_wildcards, config_regexes):
|
|
248 |
"""
|
|
249 |
Return a list of configuration root names based on the given parameters.
|
|
250 |
@param project: The project from which to get the configuration list.
|
|
251 |
@param configs: List of configuration names to add. All of these should exist
|
|
252 |
in the project, or a ConfigurationNotFoundError is raised.
|
|
253 |
@param config_wildcards: List of wildcard patterns for including configurations.
|
|
254 |
@param config_regexs: List of regular expression patters for including configurations.
|
|
255 |
@return: A distinct list of configuration names matched by the given parameters. The
|
|
256 |
list contains matched configurations in the following order:
|
|
257 |
1. Configurations specified in configs
|
|
258 |
2. Configurations matched by wildcard patterns
|
|
259 |
3. Configurations matched by regular expressions
|
|
260 |
If a configuration is matched by more than one of these, the first match determines
|
|
261 |
its placement in the list.
|
|
262 |
@raise ConfigurationNotFoundError: A configuration specified in configs is not
|
|
263 |
actually found in the project.
|
|
264 |
"""
|
|
265 |
config_list = []
|
|
266 |
|
|
267 |
configs_in_project = sorted(project.list_configurations())
|
|
268 |
|
|
269 |
# Handle configurations specified with --configuration first
|
|
270 |
for config in configs:
|
3
|
271 |
if not project.get_storage().is_resource(utils.resourceref.norm(config)):
|
0
|
272 |
raise ConfigurationNotFoundError("No such configuration: %s" % config)
|
|
273 |
if config not in config_list:
|
|
274 |
config_list.append(config)
|
|
275 |
|
|
276 |
# Then handle wildcards
|
|
277 |
if config_wildcards:
|
|
278 |
for config in configs_in_project:
|
|
279 |
for wildcard in config_wildcards:
|
|
280 |
if fnmatch.fnmatch(config, wildcard):
|
|
281 |
if config not in config_list:
|
|
282 |
config_list.append(config)
|
|
283 |
|
|
284 |
# Lastly handle regexes
|
|
285 |
if config_regexes:
|
|
286 |
for config in configs_in_project:
|
|
287 |
for pattern in config_regexes:
|
|
288 |
if re.match(pattern, config) is not None:
|
|
289 |
if config not in config_list:
|
|
290 |
config_list.append(config)
|
|
291 |
|
3
|
292 |
return config_list |