catalyst

   1 #!/usr/bin/python -OO
   2
   3 # Maintained in full by:
   4 # Eric Edgar <rocket@gentoo.org>
   5 # Chris Gianelloni <wolf31o2@gentoo.org>
   6
   7 import os,sys,imp,string,getopt
   8 import pdb
   9
  10 __maintainer__="Chris Gianelloni <wolf31o2@gentoo.org>"
  11 __version__="2.0.5_pre3"
  12
  13 conf_values={}
  14
  15 def usage():
  16         print "Usage catalyst [options] [-C variable=value...] [ -s identifier]"
  17         print " -a --clear-autoresume   clear autoresume flags"
  18         print " -c --config             use specified configuration file"
  19         print " -C --cli                catalyst commandline (MUST BE LAST OPTION)"
  20         print " -d --debug              enable debugging"
  21         print " -f --file               read specfile"
  22         print " -F --fetchonly          fetch files only"
  23         print " -h --help               print this help message"
  24         print " -p --purge              clear tmp dirs,package cache and autoresume flags"
  25         print " -s --snapshot           generate a Portage snapshot"
  26         print " -V --version            display version information"
  27         print " -v --verbose            verbose output"
  28         print
  29         print "Usage examples:"
  30         print
  31         print "Using the commandline option (-C, --cli) to build a Portage snapshot:"
  32         print "catalyst -C target=snapshot version_stamp=my_date"
  33         print
  34         print "Using the snapshot option (-s, --snapshot) to build a Portage snapshot:"
  35         print "catalyst -s 20051208"
  36         print
  37         print "Using the specfile option (-f, --file) to build a stage target:"
  38         print "catalyst -f stage1-specfile.spec"
  39
  40 def version():
  41         print "Gentoo Catalyst, version "+__version__
  42         print "Copyright 2003-2006 The Gentoo Foundation"
  43         print "Distributed under the GNU General Public License version 2\n"
  44
  45 def parse_config(myconfig):
  46         # search a couple of different areas for the main config file
  47         myconf={}
  48         config_file=""
  49
  50         confdefaults={ "storedir":"/var/tmp/catalyst",\
  51                 "sharedir":"/usr/share/catalyst","distdir":"/usr/portage/distfiles",\
  52                 "portdir":"/usr/portage","options":"",\
  53                 "snapshot_cache":"/var/tmp/catalyst/snapshot_cache",\
  54                 "hash_function":"crc32"}
  55
  56         # first, try the one passed (presumably from the cmdline)
  57         if myconfig:
  58                 if os.path.exists(myconfig):
  59                         print "Using command line specified Catalyst configuration file, "+myconfig
  60                         config_file=myconfig
  61
  62                 else:
  63                         print "!!! catalyst: Could not use specified configuration file "+\
  64                                 myconfig
  65                         sys.exit(1)
  66
  67         # next, try the default location
  68         elif os.path.exists("/etc/catalyst/catalyst.conf"):
  69                 print "Using default Catalyst configuration file, /etc/catalyst/catalyst.conf"
  70                 config_file="/etc/catalyst/catalyst.conf"
  71
  72         # can't find a config file (we are screwed), so bail out
  73         else:
  74                 print "!!! catalyst: Could not find a suitable configuration file"
  75                 sys.exit(1)
  76
  77         # now, try and parse the config file "config_file"
  78         try:
  79                 execfile(config_file, myconf, myconf)
  80
  81         except:
  82                 print "!!! catalyst: Unable to parse configuration file, "+myconfig
  83                 sys.exit(1)
  84
  85         # now, load up the values into conf_values so that we can use them
  86         for x in confdefaults.keys():
  87                 if myconf.has_key(x):
  88                         print "Setting",x,"to config file value \""+myconf[x]+"\""
  89                         conf_values[x]=myconf[x]
  90                 else:
  91                         print "Setting",x,"to default value \""+confdefaults[x]+"\""
  92                         conf_values[x]=confdefaults[x]
  93
  94         # parse out the rest of the options from the config file
  95         if "autoresume" in string.split(conf_values["options"]):
  96                 print "Autoresuming support enabled."
  97                 conf_values["AUTORESUME"]="1"
  98
  99         if "ccache" in string.split(conf_values["options"]):
 100                 print "Compiler cache support enabled."
 101                 conf_values["CCACHE"]="1"
 102
 103         if "clear-autoresume" in string.split(conf_values["options"]):
 104                 print "Cleaning autoresume flags support enabled."
 105                 conf_values["CLEAR_AUTORESUME"]="1"
 106
 107 #       if "compress" in string.split(conf_values["options"]):
 108 #               print "Compression enabled."
 109 #               conf_values["COMPRESS"]="1"
 110
 111         if "distcc" in string.split(conf_values["options"]):
 112                 print "Distcc support enabled."
 113                 conf_values["DISTCC"]="1"
 114
 115         if "kerncache" in string.split(conf_values["options"]):
 116                 print "Kernel cache support enabled."
 117                 conf_values["KERNCACHE"]="1"
 118
 119         if "pkgcache" in string.split(conf_values["options"]):
 120                 print "Package cache support enabled."
 121                 conf_values["PKGCACHE"]="1"
 122
 123         if "purge" in string.split(conf_values["options"]):
 124                 print "Purge support enabled."
 125                 conf_values["PURGE"]="1"
 126
 127         if "seedcache" in string.split(conf_values["options"]):
 128                 print "Seed cache support enabled."
 129                 conf_values["SEEDCACHE"]="1"
 130
 131         if "snapcache" in string.split(conf_values["options"]):
 132                 print "Snapshot cache support enabled."
 133                 conf_values["SNAPCACHE"]="1"
 134
 135 #       if "tarball" in string.split(conf_values["options"]):
 136 #               print "Tarball creation enabled."
 137 #               conf_values["TARBALL"]="1"
 138
 139         if myconf.has_key("digests"):
 140                 conf_values["digests"]=myconf["digests"]
 141
 142         if myconf.has_key("envscript"):
 143                 print "Envscript support enabled."
 144                 conf_values["ENVSCRIPT"]=myconf["envscript"]
 145
 146 def import_modules():
 147         # import catalyst's own modules (i.e. catalyst_support and the arch modules)
 148         targetmap={}
 149
 150         try:
 151                 for x in required_build_targets:
 152                         try:
 153                                 fh=open(conf_values["sharedir"]+"/modules/"+x+".py")
 154                                 module=imp.load_module(x,fh,"modules/"+x+".py",(".py","r",imp.PY_SOURCE))
 155                                 fh.close()
 156
 157                         except IOError:
 158                                 raise CatalystError,"Can't find "+x+".py plugin in "+\
 159                                         conf_values.settings["sharedir"]+"/modules/"
 160
 161                 for x in valid_build_targets:
 162                         try:
 163                                 fh=open(conf_values["sharedir"]+"/modules/"+x+".py")
 164                                 module=imp.load_module(x,fh,"modules/"+x+".py",(".py","r",imp.PY_SOURCE))
 165                                 module.register(targetmap)
 166                                 fh.close()
 167
 168                         except IOError:
 169                                 raise CatalystError,"Can't find "+x+".py plugin in "+\
 170                                         conf_values.settings["sharedir"]+"/modules/"
 171
 172         except ImportError:
 173                 print "!!! catalyst: Python modules not found in "+\
 174                         conf_values["sharedir"]+"/modules; exiting."
 175                 sys.exit(1)
 176
 177         return targetmap
 178
 179 def do_spec(myspecfile):
 180         try:
 181                 addlargs=read_spec(myspecfile)
 182         except:
 183                 sys.exit(1)
 184
 185         return addlargs
 186
 187 def do_cli(cmdline):
 188         try:
 189                 return arg_parse(cmdline)
 190
 191         except CatalystError:
 192                 print "!!! catalyst: Could not parse commandline, exiting."
 193                 sys.exit(1)
 194
 195 def build_target(addlargs, targetmap):
 196         try:
 197                 if not targetmap.has_key(addlargs["target"]):
 198                         raise CatalystError,"Target \""+addlargs["target"]+"\" not available."
 199
 200                 mytarget=targetmap[addlargs["target"]](conf_values, addlargs)
 201
 202                 mytarget.run()
 203
 204         except:
 205                 # TODO: Capture traceback, so we can display this error after printing of the traceback
 206                 print "!!! catalyst: Error encountered during run of target " + addlargs["target"]
 207                 raise
 208
 209 if __name__ == "__main__":
 210         targetmap={}
 211
 212         version()
 213         if os.getuid() != 0:
 214                 # catalyst cannot be run as a normal user due to chroots, mounts, etc
 215                 print "!!! catalyst: This script requires root privileges to operate"
 216                 sys.exit(2)
 217
 218         # we need some options in order to work correctly
 219         if len(sys.argv) < 2:
 220                 usage()
 221                 sys.exit(2)
 222
 223         # parse out the command line arguments
 224         try:
 225                 opts,args = getopt.getopt(sys.argv[1:], "aphvdc:C:f:FVs:", ["purge","help", "version", "debug",\
 226                         "clear-autoresume", "config=", "cli=", "file=", "fetch", "verbose","snapshot="])
 227
 228         except getopt.GetoptError:
 229                 usage()
 230                 sys.exit(2)
 231
 232         # defaults for commandline opts
 233         debug=False
 234         verbose=False
 235         fetch=False
 236         myconfig=""
 237         myspecfile=""
 238         mycmdline=[]
 239         myopts=[]
 240
 241         # check preconditions
 242         if len(opts) == 0:
 243                 print "!!! catalyst: please specify one of either -f or -C\n"
 244                 usage()
 245                 sys.exit(2)
 246         run=0
 247         for o, a in opts:
 248                 if o in ("-h", "--help"):
 249                         usage()
 250                         sys.exit(1)
 251
 252                 if o in ("-V", "--version"):
 253                         print "Catalyst version "+__version__
 254                         sys.exit(1)
 255
 256                 if o in ("-d", "--debug"):
 257                         if len(sys.argv) < 3:
 258                                 print "!!! catalyst: please specify one of either -f or -C\n"
 259                                 usage()
 260                                 sys.exit(2)
 261                         else:
 262                                 conf_values["DEBUG"]="1"
 263
 264                 if o in ("-c", "--config"):
 265                         if len(sys.argv) < 3:
 266                                 print "!!! catalyst: please specify one of either -f or -C\n"
 267                                 usage()
 268                                 sys.exit(2)
 269                         else:
 270                                 myconfig=a
 271
 272                 if o in ("-C", "--cli"):
 273                         run=1
 274                         x=sys.argv.index(o)+1
 275                         while x < len(sys.argv):
 276                                 mycmdline.append(sys.argv[x])
 277                                 x=x+1
 278
 279                 if o in ("-f", "--file"):
 280                         run=1
 281                         myspecfile=a
 282
 283                 if o in ("-F", "--fetchonly"):
 284                         if len(sys.argv) < 3:
 285                                 print "!!! catalyst: please specify one of either -f or -C\n"
 286                                 usage()
 287                                 sys.exit(2)
 288                         else:
 289                                 conf_values["FETCH"]="1"
 290
 291                 if o in ("-v", "--verbose"):
 292                         if len(sys.argv) < 3:
 293                                 print "!!! catalyst: please specify one of either -f or -C\n"
 294                                 usage()
 295                                 sys.exit(2)
 296                         else:
 297                                 conf_values["VERBOSE"]="1"
 298
 299                 if o in ("-s", "--snapshot"):
 300                         if len(sys.argv) < 3:
 301                                 print "!!! catalyst: missing snapshot identifier\n"
 302                                 usage()
 303                                 sys.exit(2)
 304                         else:
 305                                 run=1
 306                                 mycmdline.append("target=snapshot")
 307                                 mycmdline.append("version_stamp="+a)
 308
 309                 if o in ("-p", "--purge"):
 310                         if len(sys.argv) < 3:
 311                                 print "!!! catalyst: please specify one of either -f or -C\n"
 312                                 usage()
 313                                 sys.exit(2)
 314                         else:
 315                                 conf_values["PURGE"]="1"
 316                 if o in ("-a", "--clear-autoresume"):
 317                         if len(sys.argv) < 3:
 318                                 print "!!! catalyst: please specify one of either -f or -C\n"
 319                                 usage()
 320                                 sys.exit(2)
 321                         else:
 322                                 conf_values["CLEAR_AUTORESUME"]="1"
 323         if run != 1:
 324                 print "!!! catalyst: please specify one of either -f or -C\n"
 325                 usage()
 326                 sys.exit(2)
 327
 328         # import configuration file and import our main module using those settings
 329         parse_config(myconfig)
 330         sys.path.append(conf_values["sharedir"]+"/modules")
 331         from catalyst_support import *
 332
 333         # Start checking that digests are valid now that the hash_map was imported from catalyst_support
 334         if conf_values.has_key("digests"):
 335                 for i in conf_values["digests"].split():
 336                         if not hash_map.has_key(i):
 337                                 print
 338                                 print i+" is not a valid digest entry"
 339                                 print "Valid digest entries:"
 340                                 print hash_map.keys()
 341                                 print
 342                                 print "Catalyst aborting...."
 343                                 sys.exit(2)
 344                         if find_binary(hash_map[i][1]) == None:
 345                                 print
 346                                 print "digest="+i
 347                                 print "\tThe "+hash_map[i][1]+\
 348                                         " binary was not found. It needs to be in your system path"
 349                                 print
 350                                 print "Catalyst aborting...."
 351                                 sys.exit(2)
 352         if conf_values.has_key("hash_function"):
 353                 if not hash_map.has_key(conf_values["hash_function"]):
 354                         print
 355                         print conf_values["hash_function"]+" is not a valid hash_function entry"
 356                         print "Valid hash_function entries:"
 357                         print hash_map.keys()
 358                         print
 359                         print "Catalyst aborting...."
 360                         sys.exit(2)
 361                 if find_binary(hash_map[conf_values["hash_function"]][1]) == None:
 362                         print
 363                         print "hash_function="+conf_values["hash_function"]
 364                         print "\tThe "+hash_map[conf_values["hash_function"]][1]+\
 365                                 " binary was not found. It needs to be in your system path"
 366                         print
 367                         print "Catalyst aborting...."
 368                         sys.exit(2)
 369
 370         # import the rest of the catalyst modules
 371         targetmap=import_modules()
 372
 373         addlargs={}
 374
 375         if myspecfile:
 376                 addlargs.update(do_spec(myspecfile))
 377
 378         if mycmdline:
 379                 addlargs.update(do_cli(mycmdline))
 380
 381         if not addlargs.has_key("target"):
 382                 raise CatalystError, "Required value \"target\" not specified."
 383
 384         # everything is setup, so the build is a go
 385         try:
 386                 build_target(addlargs, targetmap)
 387
 388         except CatalystError:
 389                 print
 390                 print "Catalyst aborting...."
 391                 sys.exit(2)
 392         except KeyboardInterrupt:
 393                 print "\nCatalyst build aborted due to user interrupt ( Ctrl-C )"
 394                 print
 395                 print "Catalyst aborting...."
 396                 sys.exit(2)
 397         except LockInUse:
 398                 print "Catalyst aborting...."
 399                 sys.exit(2)
 400         except:
 401                 print "Catalyst aborting...."
 402                 raise
 403                 sys.exit(2)
 404
 405         #except CatalystError:
 406         #       print
 407         #       print "Catalyst aborting...."
 408         #       sys.exit(2)
 409         #except KeyError:
 410         #       print "\nproblem with command line or spec file ( Key Error )"
 411         #       print "Key: "+str(sys.exc_value)+" was not found"
 412         #       print "Catalyst aborting...."
 413         #       sys.exit(2)
 414         #except UnboundLocalError:
 415         #       print
 416         #       print "UnboundLocalError: "+str(sys.exc_value)+" was not found"
 417         #       raise
 418         #       print
 419         #       print "Catalyst aborting...."
 420         #       sys.exit(2)