498
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
1 |
#
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
2 |
# Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
3 |
# All rights reserved.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
4 |
# This component and the accompanying materials are made available
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
5 |
# under the terms of the License "Eclipse Public License v1.0"
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
6 |
# which accompanies this distribution, and is available
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
7 |
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
8 |
#
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
9 |
# Initial Contributors:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
10 |
# Nokia Corporation - initial contribution.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
11 |
#
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
12 |
# Contributors:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
13 |
#
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
14 |
# Description:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
15 |
#
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
16 |
# raptor_api module
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
17 |
#
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
18 |
# Python API for Raptor. External code should interact with Raptor via this
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
19 |
# module only, as it is the only programatic interface considered public. The
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
20 |
# command line --query option is also implemented using this module.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
21 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
22 |
class Reply(object):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
23 |
"""object to return values from API calls.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
24 |
"""
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
25 |
def __init__(self, text=""):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
26 |
self.reply_text = text
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
27 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
28 |
def __str__(self):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
29 |
name = type(self).__name__.lower()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
30 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
31 |
str = "<" + name
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
32 |
end = "/>\n"
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
33 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
34 |
for attribute,value in self.__dict__.items():
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
35 |
if attribute != "reply_text":
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
36 |
str += " %s='%s'" % (attribute, value)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
37 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
38 |
if self.reply_text:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
39 |
str += ">" + self.reply_text
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
40 |
end = "</%s>\n" % name
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
41 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
42 |
str += end
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
43 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
44 |
return str
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
45 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
46 |
class Alias(Reply):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
47 |
pass
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
48 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
49 |
class Config(Reply):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
50 |
pass
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
51 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
52 |
class Product(Reply):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
53 |
pass
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
54 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
55 |
import generic_path
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
56 |
import raptor
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
57 |
import raptor_data
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
58 |
import re
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
59 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
60 |
class Context(object):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
61 |
"""object to contain state information for API calls.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
62 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
63 |
For example,
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
64 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
65 |
api = raptor_api.Context()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
66 |
val = api.get(X)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
67 |
"""
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
68 |
def __init__(self, initialiser=None):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
69 |
# this object has a private Raptor object that can either be
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
70 |
# passed in or created internally.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
71 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
72 |
if initialiser == None:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
73 |
self.__raptor = raptor.Raptor()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
74 |
else:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
75 |
self.__raptor = initialiser
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
76 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
77 |
def StringQuery(self, query):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
78 |
"""turn a string into an API call and execute it.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
79 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
80 |
This is a convenience method for "lazy" callers.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
81 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
82 |
The return value is also converted into a string.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
83 |
"""
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
84 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
85 |
if query == "aliases":
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
86 |
aliases = self.GetAliases()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
87 |
return "".join(map(str, aliases)).strip()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
88 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
89 |
elif query == "products":
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
90 |
variants = self.GetProducts()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
91 |
return "".join(map(str, variants)).strip()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
92 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
93 |
elif query.startswith("config"):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
94 |
match = re.match("config\[(.*)\]", query)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
95 |
if match:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
96 |
config = self.GetConfig(match.group(1))
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
97 |
return str(config).strip()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
98 |
else:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
99 |
raise BadQuery("syntax error")
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
100 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
101 |
raise BadQuery("unknown query")
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
102 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
103 |
def GetAliases(self, type=""):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
104 |
"""extract all aliases of a given type.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
105 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
106 |
the default type is "".
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
107 |
to get all aliases pass type=None
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
108 |
"""
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
109 |
aliases = []
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
110 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
111 |
for a in self.__raptor.cache.aliases.values():
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
112 |
if a.type == type or type == None:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
113 |
r = Alias()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
114 |
# copy the members we want to expose
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
115 |
r.name = a.name
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
116 |
r.meaning = a.meaning
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
117 |
aliases.append(r)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
118 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
119 |
return aliases
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
120 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
121 |
def GetConfig(self, name):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
122 |
"""extract the values for a given configuration.
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
123 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
124 |
'name' should be an alias or variant followed optionally by a
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
125 |
dot-separated list of variants. For example "armv5_urel" or
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
126 |
"armv5_urel.savespace.vasco".
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
127 |
"""
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
128 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
129 |
r = Config()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
130 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
131 |
names = name.split(".")
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
132 |
if names[0] in self.__raptor.cache.aliases:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
133 |
x = self.__raptor.cache.FindNamedAlias(names[0])
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
134 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
135 |
if len(names) > 1:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
136 |
r.fullname = x.meaning + "." + ".".join(names[1:])
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
137 |
else:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
138 |
r.fullname = x.meaning
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
139 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
140 |
elif names[0] in self.__raptor.cache.variants:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
141 |
r.fullname = name
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
142 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
143 |
else:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
144 |
raise BadQuery("'%s' is not an alias or a variant" % names[0])
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
145 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
146 |
tmp = raptor_data.Alias("tmp")
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
147 |
tmp.SetProperty("meaning", r.fullname)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
148 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
149 |
units = tmp.GenerateBuildUnits(self.__raptor.cache)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
150 |
evaluator = self.__raptor.GetEvaluator(None, units[0])
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
151 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
152 |
releasepath = evaluator.Get("RELEASEPATH")
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
153 |
fullvariantpath = evaluator.Get("FULLVARIANTPATH")
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
154 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
155 |
if releasepath and fullvariantpath:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
156 |
r.outputpath = str(generic_path.Join(releasepath, fullvariantpath))
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
157 |
else:
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
158 |
raise BadQuery("could not get outputpath for config '%s'" % name)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
159 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
160 |
return r
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
161 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
162 |
def GetProducts(self):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
163 |
"""extract all product variants."""
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
164 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
165 |
variants = []
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
166 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
167 |
for v in self.__raptor.cache.variants.values():
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
168 |
if v.type == "product":
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
169 |
r = Product()
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
170 |
# copy the members we want to expose
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
171 |
r.name = v.name
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
172 |
variants.append(r)
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
173 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
174 |
return variants
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
175 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
176 |
class BadQuery(Exception):
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
177 |
pass
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
178 |
|
Richard Taylor <richard.i.taylor@nokia.com>
parents:
diff
changeset
|
179 |
# end of the raptor_api module
|