2 # Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
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".
9 # Initial Contributors:
10 # Nokia Corporation - initial contribution.
15 # mmbuild2 - python script intended to replace mmbuild.pl
18 from optparse import (make_option,OptionParser)
24 # some literals. TODO - use explicit type?
30 _KMainTempConfig = ".config.xml"
31 _KTestTempConfig = ".testconfig.xml"
32 _KTestBuildTempConfig = ".testbuildconfig.xml"
34 class Unimplemented(Exception):
35 """Raised for invalid commands"""
37 def __init__(self, msg):
46 # TODO this option_list should be replaced by add_option calls to parameter
47 # option_list parameter to OptionParser is down as deprecated
49 make_option ("-t", "--test",
50 action="store_true", dest="buildTest", default=False,
51 help="""build test code rather than main code (without -b, that built by "abld build" or equiv)"""),
52 make_option ("-b", "--testBuild",
53 action="store_true", dest="buildTestBuild", default=False,
54 help="""when given with -t, build that code that requires "abld test build" """),
55 make_option ("-x", "--additional", "--opt", "--extra",
56 action="store_true", dest="extra", default=False,
57 help="build additional modules (from Xopt.mbc files)"),
58 make_option ("-i", "--icl",
59 action="store_const", const=_KIcl, dest="toBuild", default=_KAll,
60 help="build icl modules only"),
61 make_option ("-m", "--mmf",
62 action="store_const", const=_KMmf, dest="toBuild", default=_KAll,
63 help="build mmf modules only"),
64 make_option ("-c", "--misc",
65 action="store_const", const=_KMisc, dest="toBuild", default=_KAll,
66 help="build misc modules only"),
67 make_option ("-f", "--full", "--all",
68 action="store_const", const=_KAll, dest="toBuild", default=_KAll,
69 help="build all modules (which depends on if -x is given too)"),
70 make_option ("-k", "--keepgoing",
71 action="store_true", dest="keepgoing", default=False,
72 help="keep going if errors are found"),
73 make_option ("-g", "--gccxml",
74 action="store_true", dest="gccxml", default=False,
75 help="build for gccxml"),
76 make_option ("-s", "--skipmake",
77 action="store_true", dest="skipmake", default=False,
78 help="skip building makefile (ignored)"),
79 make_option ("--iclTestdata",
80 action="store_true", dest="icl_tests", default=False,
81 help="build ICL Tests"),
85 """Script for selection appropriate set of multimedia
86 components and build them together, so build order does not matter.
87 One, and only one of "setup", "build" or "clean" must be given.
91 # need to implement commands as property and not class constant or
92 # we get a forward declaration problem
93 self.iCommands = {"setup": self.doSetup, "build": self.doBuild, "clean": self.doClean}
95 self.iProdCodeList = []
96 self.iTestCodeList = []
97 self.iTestBuildCodeList = []
98 self.iOptionParser = None
102 "main function of script"
103 self.iOptionParser = OptionParser(
104 option_list = Script.option_table,
105 usage="%prog [-t [-b]] [-i|-m|-c|-f] (setup|build [winscw]|clean)",
106 description = Script.description
108 (self.iOptions, args) = self.iOptionParser.parse_args()
110 self.DebugPrint (str(self.iOptions))
111 self.DebugPrint (str(args))
113 if (len(args)==0 or not args[0] in self.iCommands or
114 not self.CheckOptions()):
115 self.iOptionParser.print_usage()
118 remainingArgs = args[1:len(args)]
120 return self.iCommands[args[0]](remainingArgs) # effective switch to doBuild, doSetup or doClean
122 def CheckOptions(self):
123 "Check for any invalid option combinations. Warn about ignored ones etc"
124 if self.iOptions.skipmake:
125 print ("Warning ignoring -s - option is no longer valid in raptor version")
126 if not self.iOptions.buildTest and self.iOptions.buildTestBuild:
127 return False # can't do -b without -t
128 return True # all other combinations OK
130 def doBuild(self, remainingArgs):
131 # if we have a remainingArg, only "winscw" is allowed
132 if not (len(remainingArgs)==0 or len(remainingArgs)==1 and remainingArgs[0]=="winscw"):
133 self.iOptionParser.print_usage()
136 # for normal build need to run "sbs -s .config.xml build"
137 # for test build need to run "sbs -s .testconfig.xml build"
138 # use --logfile=- to send output to stdout instead of log file
139 configFile = _KMainTempConfig
141 if self.iOptions.buildTest:
142 if not self.iOptions.buildTestBuild:
143 # build test config instead when -t etc given
144 configFile = _KTestTempConfig
146 # build test config instead when -t -b etc given
147 configFile = _KTestBuildTempConfig
149 sbs_command = self.sbsCommand()
150 commands = [sbs_command, "-s", configFile]
151 commands += ["--logfile=-"] # send output to stdout
152 if self.iOptions.keepgoing:
153 commands += ["--keepgoing"]
155 commands += ["--config=winscw.test"]
157 commands += ["--config=winscw"]
158 if not(len(remainingArgs)>0 and remainingArgs[0]=="winscw"):
159 # not the winscw scenario - we want both winscw and armv5
161 commands += ["--config=armv5.test"]
163 commands += ["--config=armv5"]
164 commands += ["--filters=FilterSquashLog"] # reduce log size
165 commands += ["--tries=2"] # retry on failure - e.g. for license fails
166 commands += ["build"]
167 self.DebugPrint("""command="%s" """ % str(commands))
168 print "------------------ sbs start : %s" % str(commands)
169 sys.stdout.flush() # flush any output here so appears correct in log
170 subprocess.check_call(commands) # raises exception on error
171 print "------------------ sbs end"
174 def sbsCommand(self):
175 "sbs command - that can be used by subprocess"
176 # For some reason, have to work out batch file to run by longhand
177 # rather than just saying "sbs" and letting command work it out.
178 # Could use sys.command() instead, but that is deprecated
179 sbs_home = os.getenv("SBS_HOME")
180 assert sbs_home, "SBS_HOME must be defined to use this script"
181 sbs_command = os.path.join(sbs_home, "bin", "sbs.bat")
184 def doSetup(self, remainingArgs):
185 if len(remainingArgs)!=0:
186 self.iOptionParser.print_usage()
191 self.DebugPrint ("prodCodeList=%s" % str(self.iProdCodeList))
192 self.DebugPrint ("testCodeList=%s" % str(self.iTestCodeList))
193 self.DebugPrint ("testBuildCodeList=%s" % str(self.iTestBuildCodeList))
195 mbcParser = MbcUtils.MbcParser(self.iProdCodeList)
196 folders = mbcParser()
197 self.DebugPrint ("folders=%s" % str (folders))
198 getFolderList = MbcUtils.GetFolderList(folders)
199 groupFolders = getFolderList()
200 self.DebugPrint ("prodCodeFolderList=%s" % str(groupFolders))
202 generator = MbcUtils.ConfigFileGenerator(groupFolders, _KMainTempConfig)
205 mbcParser = MbcUtils.MbcParser(self.iTestCodeList)
206 folders = mbcParser()
207 self.DebugPrint ("testfolders=%s" % str (folders))
208 getFolderList = MbcUtils.GetFolderList(folders)
209 groupFolders = getFolderList()
210 self.DebugPrint ("testCodeFolderList=%s" % str(groupFolders))
212 generator = MbcUtils.ConfigFileGenerator(groupFolders, _KTestTempConfig)
215 mbcParser = MbcUtils.MbcParser(self.iTestBuildCodeList)
216 folders = mbcParser()
217 self.DebugPrint ("testBuildfolders=%s" % str (folders))
218 getFolderList = MbcUtils.GetFolderList(folders)
219 groupFolders = getFolderList()
220 self.DebugPrint ("testBuildCodeFolderList=%s" % str(groupFolders))
222 generator = MbcUtils.ConfigFileGenerator(groupFolders, _KTestBuildTempConfig)
226 def buildMbcLists(self):
227 # some boolean values
228 want_mmf = self.iOptions.toBuild in [_KAll, _KMmf];
229 want_icl = self.iOptions.toBuild in [_KAll, _KIcl];
230 want_misc = self.iOptions.toBuild in [_KAll, _KMisc];
231 want_extra = self.iOptions.extra
232 want_icl_tests = self.iOptions.icl_tests
234 # now build up the lists depending on which "component" we want
235 # perhaps this should be reworked as a table, but not obvious as to how
236 self.iTestCodeList += ["AllTests.mbc", "TestFrameworkTest.mbc",
239 self.iProdCodeList += ["mmf.mbc"]
240 self.iTestCodeList += ["mmfTest.mbc"]
241 self.iTestBuildCodeList += ["mmfTestBuild.mbc"]
242 # assume mmfPhys and mmfOptPhys can currently be ignored
243 # they should generate another list and be built as special cases
244 # self.iProdCodeList += ["mmfPhys.mbc"]
246 self.iProdCodeList += ["mmfOpt.mbc"]
247 self.iTestCodeList += ["mmfOptTest.mbc"]
248 self.iTestBuildCodeList += ["mmfOptTestBuild.mbc"]
249 # self.iProdCodeList += ["mmfOptPhys.mbc"]
251 self.iTestCodeList += ["mmfNotOptTest.mbc"]
253 self.iProdCodeList += ["icl.mbc"]
255 self.iTestCodeList += ["iclTest.mbc"]
256 self.iTestBuildCodeList += ["iclTestBuild.mbc"]
258 self.iTestCodeList += ["iclOptTest.mbc"]
259 self.iTestBuildCodeList += ["iclOptTestBuild.mbc"]
261 self.iProdCodeList += ["iclOpt.mbc"]
263 self.iProdCodeList += ["misc.mbc"]
264 self.iTestCodeList += ["miscTest.mbc"]
265 self.iTestBuildCodeList += ["miscTestBuild.mbc"]
267 self.iProdCodeList += ["miscOpt.mbc"]
268 self.iTestCodeList += ["miscOptTest.mbc"]
269 self.iTestBuildCodeList += ["miscOptTestBuild.mbc"]
271 def doClean(self, remainingArgs):
272 "clean is called. Note -t clean means clean test code too, not instead"
273 # for normal clean need to run "sbs -s .config.xml clean"
274 # for test clean need to run "sbs -s .testconfig.xml clean"
275 # use --logfile=- to send output to stdout instead of log file
276 whatToClean = [_KMainTempConfig]
277 if self.iOptions.buildTest:
278 whatToClean += [_KTestTempConfig]
279 for configFile in whatToClean:
280 sbs_command = self.sbsCommand()
281 commands = [sbs_command, "-s", configFile]
282 commands += ["--logfile=-"] # send output to stdout
283 commands += ["reallyclean"]
284 self.DebugPrint ("""command="%s" """ % str(commands))
285 subprocess.check_call(commands) # raises exception on error
288 def DebugPrint(self, str):
289 "print a string if self.iDebug is set - would be turned on manually"
293 if __name__ == "__main__":
295 sys.exit(script.main())