catalyst

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