other distros move to nodemanager that has a single specfile for all packages
[build.git] / build.common
index 3b73da3..350f662 100644 (file)
@@ -1,39 +1,54 @@
 # -*-Shell-script-*-
 #
 # Common functions for build scripts used by various packages
-# incorporated (e.g., build, myplc, myplc-devel, vserver-reference)
+# incorporated (e.g., build, bootcd, nodeimage, sliceimage)
 #
 # Marc E. Fiuczynski <mef@cs.princeton.edu>
 # Copyright (C) 2007 The Trustees of Princeton University
+# Thierry Parmentelat <thierry.parmentelat@inria.fr> INRIA
 #
-# $Id$
+# supported distros f12 f14 f16 f18 f20 
+# and debians/ubuntus to a lesser extent
 #
+# for locating pkgs.py
+export PATH=.:$PATH
 
-# support for fedora and centos only for now
-
+# returns 'Fedora' or 'CentOS' for now
 function pl_getDistro() {
     if [ -f "/etc/redhat-release" ] ; then
        distro=$(awk ' { print $1 } ' /etc/redhat-release)
-    else
-       echo "build.common.pl_getDistro-unknown"
-       exit 1
+       case $distro in Scientific*) distro="SL" ; esac
+    elif [ -f /etc/lsb-release ] ; then
+       . /etc/lsb-release
+       distro=$DISTRIB_CODENAME 
+    elif [ -f /etc/debian_version ] ; then
+       case $(cat /etc/debian_version) in
+           6.*) distro=squeeze ;;
+           7.*) distro=wheezy  ;;
+           # might be that I'm getting 'jessie'sid' just because it's still testing..
+           8.*|jessie*) distro=jessie  ;;
+           *)   distro=unknown.debian.in.build.common ;;
+       esac
     fi
+    [ -z "$distro" ] && { echo "build.common.pl_getDistro-unknown"; exit 1; }
     echo "$distro"
     return 0
 }
 
+# returns something like 8, 10, or 5.3
 function pl_getRelease() {
     if [ -f "/etc/redhat-release" ] ; then
-       release=$(awk ' { if ($1=="Fedora" && $2=="Core") print $4 ; if (($1=="Fedora" && $2!="Core")||$1=="CentOS") print $3 } ' /etc/redhat-release)
+       release=$(awk ' { if ($1=="Fedora" && $2=="Core") print $4 ; if (($1=="Fedora" && $2!="Core")||$1=="CentOS") print $3 ; if ($1=="Scientific") print $4 } ' /etc/redhat-release)
     else
        echo "build.common.pl_getRelease-unknown"
        exit 1
     fi
-    echo "$release"
+    # keep only the major number
+    echo "$release" | cut -d. -f1
     return 0
 }
 
-# vserver expects something like f8 or centos5
+# returns distro shortname, something like 'f8' or 'centos5'
 function pl_getReleaseName () {
     distro=$1; shift
     release=$1; shift
@@ -48,6 +63,12 @@ function pl_getReleaseName () {
            IFS="$old_IFS"
            releasename=centos$1
            ;;
+       [Ss]L*)
+           releasename=sl$release
+           ;;
+       squeeze|wheezy|jessie|oneiric|precise|quantal|raring|saucy|trusty)
+           releasename=$distro
+           ;;
        *)
            releasename="unknown-name-for-${pl_DISTRO}-please-edit-build.common"
            echo 1>&2 "build.common: WARNING - releasename not set for distro=$distro" 
@@ -58,39 +79,44 @@ function pl_getReleaseName () {
     return 0
 }
 
-# on fedora 8 or 9, we use libnl from the stock repos
-# on centos5 we build it locally
-function pl_getKexcludes () {
-    distroname=$1; shift
-    case $distroname in 
-       f?|f1?)
-           echo 'kernel* util-vserver* iptables iproute'
-           ;;
-       centos5)
-           echo 'kernel* util-vserver* iptables iproute inotify-tools* libnl*'
-           ;;
-       *)
-           echo "pl_DISTRO_NAME=$pl_DISTRO_NAME not supported in getexcludes.sh"
-           exit 1
-           ;;
-    esac
+# yum exclusions are now defined in yumexclude.pkgs
+# so they can now depend both on the linux distro and the pl distro
+function pl_yumexclude () {
+    keyword=$1; shift
+    fcdistro=$1; shift
+    pldistro=$1; shift
+    builddir=$1; shift
+    # search for file "yumexclude.pkgs"
+    yumexclude_file=$(pl_locateDistroFile $builddir $pldistro "yumexclude.pkgs")
+    #
+    # check if pkgs.py is in PATH
+    type -p pkgs.py >& /dev/null || export PATH=$builddir:$PATH
+
+    # parse it
+    pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro $keyword $yumexclude_file || \
+       { echo pl_yumexclude failed with fcdistro=$fcdistro and pldistro=$pldistro; return 1 ; }
 }
 
+# <> fcdistro pldistro builddir
+# node side : use the 'nodeyumexclude' keywork in yumexclude.pkgs
+function pl_nodeyumexclude () { pl_yumexclude 'nodeyumexclude' "$@" ; }
+# server side : use the 'plcyumexclude' keywork in yumexclude.pkgs
+function pl_plcyumexclude () { pl_yumexclude 'plcyumexclude' "$@" ; }
+
+
 # figure out which redhat distro we are using (fedora, centos, redhat)
 pl_DISTRO=$(pl_getDistro)
 
 # select basearch of the host devel environment - protected for macos for local tests
-pl_DISTRO_ARCH=$(uname -i 2>/dev/null|| echo unknownarch)
+# try arch for testing stuff on a mac
+pl_DISTRO_ARCH=$(uname -i 2>/dev/null || arch 2> /dev/null || echo unknownarch)
 
 # the release number (plain number)
 pl_DISTRO_RELEASE=$(pl_getRelease)
 
-# the release name - for vserver build ...
+# the release name - something like 'f8' or 'sl6'
 pl_DISTRO_NAME=$(pl_getReleaseName $pl_DISTRO $pl_DISTRO_RELEASE)
 
-# the packages to exclude
-pl_KEXCLUDES=$(pl_getKexcludes $pl_DISTRO_NAME)
-
 # get path to appropriate yumgroups.xml file
 # Thierry: quick & dirty improvement 
 # this file is updated by the toplevel build, from the .pkgs files
@@ -159,8 +185,6 @@ function pl_root_makedevs() {
     # For pseudo ttys
     mkdir -p $vroot/dev/pts
 
-    # (Might have to remove the following for vserver-reference.)
-
     # for tmpfs mount
     mkdir -p $vroot/dev/shm
 
@@ -169,7 +193,7 @@ function pl_root_makedevs() {
     mknod -m 600 $vroot/dev/net/tun c 10 200
 
     # For mkinitrd (in case a kernel is being installed)
-    # As well for loop back mounting within a vserver
+    # As well as for loop back mounting within a vm
     for i in $(seq 0 255) ; do
        mknod -m 640 $vroot/dev/loop$i b 7 $i
     done
@@ -181,7 +205,7 @@ function mkfedora_usage() {
     echo "                      Defaults are searched in <pldistro>.mirrors"
     echo "     -v              Be verbose"
     echo "     -h              This message"
-    echo " target selection (defaults based on current build vserver)"
+    echo " target selection (defaults based on current build VM context)"
     echo "     -r release      Fedora release number (default: $releasever)"
     echo "     -a arch         Fedora architecture (default: $basearch)"
     exit 1
@@ -199,7 +223,7 @@ function pl_root_mkfedora () {
 # Verbosity
     verbose=0
 
-# Release and architecture to install : defaults to current vserver's settings or previously parsed fedora_options
+# Release and architecture to install : defaults to current vm settings or previously parsed fedora_options
     releasever=$pl_DISTRO_RELEASE
     basearch=$pl_DISTRO_ARCH
 
@@ -222,31 +246,27 @@ function pl_root_mkfedora () {
 
     # parse pkgsfile and add to local vars
     fcdistro=${pl_DISTRO_NAME}
-    pkgs_packages=$(pl_parsePkgs package $fcdistro $pldistro $pkgsfile) 
-    pkgs_groups=$(pl_parsePkgs group $fcdistro $pldistro $pkgsfile)
-    # packages to exclude 
-    pkgs_excludes=$(pl_parsePkgs exclude $fcdistro $pldistro $pkgsfile) 
+    pkgs_packages=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro package $pkgsfile) 
+    pkgs_groups=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro group $pkgsfile)
     # what can get trashed to save space
-    pkgs_junk=$(pl_parsePkgs junk $fcdistro $pldistro $pkgsfile)
+    pkgs_junk=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro junk $pkgsfile)
     # but not this
-    pkgs_precious=$(pl_parsePkgs precious $fcdistro $pldistro $pkgsfile)
+    pkgs_precious=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro precious $pkgsfile)
     # formerly related to mkfedora -k : packages to take from our own build 
     # and thus need be excluded frem the stock repos
-    pkgs_kexcludes=$(pl_parsePkgs kexclude $fcdistro $pldistro $pkgsfile | sed -e s,@KEXCLUDE@,"$pl_KEXCLUDES",)
+    # locate builddir by looking for pkgs.py
+    builddir=$(dirname $(type -p pkgs.py))
+    SUBST_NODEYUMEXCLUDE=$(pl_nodeyumexclude $fcdistro $pldistro $builddir)
+    pkgs_yumexclude=$(pkgs.py -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro yumexclude $pkgsfile | sed -e s,@NODEYUMEXCLUDE@,"$SUBST_NODEYUMEXCLUDE",)
     # get mirrors if not specified with -l
     if [ -z "$mirrors" ] ; then
        mirrorsfile=$(pl_locateDistroFile ../build/ $pldistro "$pldistro.mirrors")
-       mirrors=$(pl_parsePkgs mirror $fcdistro $pldistro $mirrorsfile)
+       # do not sort mirrors, keep order from input
+       mirrors=$(pkgs.py -u -a $pl_DISTRO_ARCH -f $fcdistro -d $pldistro mirror $mirrorsfile)
     fi
 
-    kexclude_line=""
-    # add them manually as the output of pl_parsePkgs is line-separated
-    if [ -n "$pkgs_kexcludes" ] ; then
-       kexclude_line="exclude="
-       for kexclude in $pkgs_kexcludes ; do
-           kexclude_line="$kexclude_line $kexclude"
-       done
-    fi
+    yumexclude_line=""
+    [ -n "$pkgs_yumexclude" ] && yumexclude_line="exclude=$pkgs_yumexclude"
 
     echo "$0: candidate mirrors"
     for mirror in $mirrors ; do
@@ -255,15 +275,15 @@ function pl_root_mkfedora () {
 
     # the repo part of the final yum.conf
     yum_conf_repos=$vroot/xxxmkfedora-repos.confxxx
-    if ! yumconf_mirrors $yum_conf_repos ../build/ $fcdistro "$kexclude_line" $mirrors ; then
+    if ! yumconf_mirrors $yum_conf_repos ../build/ $fcdistro "$yumexclude_line" $mirrors ; then
        echo xxx -- error ; return 1
     fi
     
-    public_gpg_key=$(yumconf_gpgkey $yum_conf_repos)
-
     # Do not tolerate errors
     set -e
 
+    public_gpg_key=$(yumconf_gpgkey $yum_conf_repos)
+
     ## make rpms ignore installing stuff to special fs entries like /proc
     # Because of https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=52725
     # you have to use at least one language beside 'C'
@@ -327,6 +347,7 @@ cachedir=/var/cache/yum
 debuglevel=2
 logfile=/var/log/yum.log
 pkgpolicy=newest
+multilib_policy=best
 distroverpkg=redhat-release
 tolerant=1
 exactarch=1
@@ -363,25 +384,23 @@ fi
     echo "========== EndDump $yum_conf"
 
     yum_options=""
-    yum --help | grep verbose &> /dev/null && yum_options="$yum_options --verbose"
+#    yum --help | grep verbose &> /dev/null && yum_options="$yum_options --verbose"
     yum_options="$yum_options -y"
     yum_options="$yum_options -c $yum_conf"
     yum_options="$yum_options --installroot=$vroot"
 
-    exclude_arg=""
-    for exclude in $pkgs_excludes; do
-       exclude_arg="$exclude_arg --exclude $exclude"
-    done
-
     # glibc must be specified explicitly for the correct arch to be
     # chosen.
     echo "* Installing glibc"
-    yum $yum_options $exclude_arg install glibc
+    # ignore yum's return code that is basically undefined
+    yum $yum_options install glibc || :
 
     # Go, baby, go
     if [ -n "$pkgs_packages" ] ; then
        echo "* Installing optional packages" $pkgs_packages
-       yum $yum_options $exclude_arg install $pkgs_packages
+        # ignore yum's return code that is basically undefined
+        echo "* Install options" $vroot $yum_options 
+       yum $yum_options install $pkgs_packages || :
        if ! rpm --root $vroot -q $pkgs_packages >/dev/null ; then
            echo "* Warning: Missing packages"
            rpm --root $vroot -q $pkgs_packages | grep "not installed"
@@ -390,9 +409,11 @@ fi
 
     if [ -n "$pkgs_groups" ] ; then
        ## call yum sequentially to get finer-grained info on dependencies
-       for grp in $pkgs_groups ; do
-           echo "* Installing optional group $grp" 
-           yum $yum_options $exclude_arg groupinstall "$grp"
+       for group_plus in $pkgs_groups ; do
+           group=$(echo $group_plus | sed -e "s,+++, ,g")
+           echo "* Installing optional group $group" 
+            # ignore yum's return code that is basically undefined
+           yum $yum_options groupinstall "$group" || :
        done
     fi
 
@@ -411,7 +432,25 @@ fi
 
     # Clean yum cache
     echo "* Cleaning up"
-    yum $yum_options clean all
+
+    # NOTE: this hack is for Fedora >= 12.
+    # if kernel-debug is installed, clean it up
+    # we link to our version of kernel/initrd and clean up
+    # kernel-debug manually
+    if rpm --root $vroot --quiet -q kernel-debug ; then
+       echo "* Cleaning up kernel-debug - (workaround for f12)"
+       pushd $vroot/boot/
+        rm -rf kernel-boot kernel-bootsmp initrd-boot initrd-bootsmp
+        ln -s vmlinuz-*${pldistro}* kernel-boot
+        ln -s vmlinuz-*${pldistro}* kernel-bootsmp
+        ln -s initrd-*${pldistro}* initrd-boot
+        ln -s initrd-*${pldistro}* initrd-bootsmp
+        rpm --root $vroot --nodeps -e kernel-debug || :
+       popd
+    fi
+
+    # ignore yum's return code that is basically undefined
+    yum $yum_options clean all || :
 
     # Clean RPM state
     rm -f $vroot/var/lib/rpm/__db*
@@ -517,57 +556,27 @@ function pl_fixdirs() {
 }
 
 ########## .pkgs format
-# comments start with a # - this is needed only if you use a keyword in a comment
-
-function pl_getPkgsAttribute () {
-    keyword=$1; shift
-    file=$1; shift
-    # remove any initial white spaces from the result
-    grep -v '^#' $file | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,," -e "s,^[[:space:]][[:space:]]*,,"
-}
-
-# for a given keyword like 'package' :
-# we support fcdistro-dependant format, for tokens (pkgname) without whitespace
-# you can e.g. use
-# package: pkg1 .. pkgn 
-# package+f8: pkg1 .. pkgn
-# package-f8: pkg1 .. pkgn
-# 
-# values can contain @arch@, @fcdistro@ or @pldistro@ that are replaced with the current values
-#
 # Usage: pl_parsePkgs keyword [-a arch] fcdistro pldistro pkgs-file[..s]
-# the reason for the -a option is for when we build the build vserver itself; in this case
-# pl_DISTRO_ARCH is the one we obtain from the root context, and that's wrong
-# specify -sa arch AFTER keyword, so as to keep pl_getPackages and pl_getGroups simple
-#
+# pkgs.py should be found in PATH, like this file build.common
+# only usage should be for pl_getPackages and pl_getGroups,
+# which in turn are usednow be in {node,slice}image/build.sh
 function pl_parsePkgs () {
-
     target_arch=$pl_DISTRO_ARCH
     keyword=$1;shift
     [ "$1" == "-a" ] && { shift; target_arch="$1"; shift; }
     fcdistro=$1; shift
     pldistro=$1; shift
-    # remaining arguments are paths to the pkgs files
-
-    # grab regular descriptions
-    all=$(grep -v '^#' "$@" | grep --regexp="^${keyword}:" | sed -e "s,${keyword}:,,")
-    # grab additions
-    add=$(grep -v '^#' "$@" | grep --regexp="^${keyword}+${fcdistro}:" | sed -e "s,${keyword}+${fcdistro}:,,")
-    # grab exclusions
-    sub=$(grep -v '^#' "$@" | grep --regexp="^${keyword}-${fcdistro}:" | sed -e "s,${keyword}-${fcdistro}:,,")
-
-    for rpm in $all $add; do
-       for exclude in $sub; do
-           [ "$rpm" = "$exclude" ] && continue 2
-       done
-       echo "${rpm} " | sed -e "s,@arch@,${target_arch},g" -e "s,@fcdistro@,$fcdistro,g" -e "s,@pldistro@,$pldistro,g"
-    done
-    return 0
-}
 
+    echo 1>&2 "pl_parsePkgs: using -a $target_arch -f $fcdistro -d $pldistro $keyword $@"
+    pkgs.py -a $target_arch -f $fcdistro -d $pldistro $keyword "$@" 
+}
 # usage: pl_getPackages [-a arch] fcdistro pldistro pkg-file[..s]
 function pl_getPackages() { pl_parsePkgs package "$@" ; }
 function pl_getGroups() { pl_parsePkgs group "$@" ; }
+function pl_getPips() { pl_parsePkgs pip "$@" ; }
+function pl_getGems() { pl_parsePkgs gem "$@" ; }
+
+##############################
 
 # locates a pldistro-dependant file
 # tries first in build/<pldistro>/, then in build/planetlab/
@@ -577,6 +586,18 @@ function pl_locateDistroFile () {
     pkgsfile=$1; shift
 
     pkgspath=""
+    # if config dir is missing but a .svnpath or a .gitpath exists, use it to extract the config dir
+    configdir="$builddir/config.${pldistro}"
+    if [ ! -d $configdir ] ; then
+       if [ -f "${configdir}.svnpath" -o -f "${configdir}.gitpath" ] ; then
+           echo 1>&2 "Invoking make to extract remote config.${pldistro}"
+           # we set PLDISTROTAGS here to /dev/null because when dealing with remote distros
+           # at a very early stage (like searching for devel.pkgs even before the build VM is created)
+           # then make screams because it cannot find a mandatory include file
+           # OTOH this mechanism here is not intended to depend on tags specifically
+           make 1>&2 --no-print-directory -C $builddir stage1=true config.${pldistro} PLDISTROTAGS=/dev/null
+       fi
+    fi
     # locate it
     paths="$builddir/config.$pldistro/$pkgsfile $builddir/config.planetlab/$pkgsfile"
     for path in $paths; do
@@ -615,8 +636,8 @@ __header
        pkgsfile=$(pl_locateDistroFile $builddir $pldistro $pkgsname)
        packages=$(pl_getPackages $fcdistro $pldistro $pkgsfile)
 
-       groupname=$(pl_getPkgsAttribute groupname $pkgsfile | sed $sedargs)
-       groupdesc=$(pl_getPkgsAttribute groupdesc $pkgsfile | sed $sedargs)
+       groupname=$(pkgs.py groupname $pkgsfile | sed $sedargs)
+       groupdesc=$(pkgs.py groupdesc $pkgsfile | sed $sedargs)
 
        if [ -z "$groupname" -o -z "$groupdesc" ] ; then
            echo "Cannot find groupname: and groupdesc: in $pkgsfile -- skipped" 1>&2
@@ -656,7 +677,7 @@ function yumconf_mirrors () {
     dest_yumconf=$1; shift
     builddir=$1; shift
     fcdistro=$1; shift
-    kexclude_line="$1" ; shift
+    yumexclude_line="$1" ; shift
     mirrors="$@"
 
     template=$builddir/mirroring/$fcdistro/yum.repos.d/building.repo.in
@@ -668,10 +689,11 @@ function yumconf_mirrors () {
     fi
 
     for mirror in $mirrors; do
-       if yumconf_mirror $dest_yumconf $template "$kexclude_line" $mirror; then
+       if yumconf_mirror $dest_yumconf $template "$yumexclude_line" $mirror; then
            return 0
        fi
     done
+    echo 'yumconf_mirrors in build.common : ran out of mirrors -- BAILING OUT'
     rm -f $dest_yumconf
     return 1
 }
@@ -681,12 +703,12 @@ function yumconf_mirrors () {
 function yumconf_mirror () {
     dest_yumconf=$1; shift
     template=$1; shift
-    kexclude_line="$1" ; shift
+    yumexclude_line="$1" ; shift
     mirror=$1; shift
 
     sed -e "s,@MIRRORURL@,$mirror,g" \
        -e "/baseurl=/i\\
-$kexclude_line" $template > $dest_yumconf
+$yumexclude_line" $template > $dest_yumconf
     
     # capture all lines defining baseurl
     baseurl_defs=$(grep '^baseurl=' $dest_yumconf)
@@ -710,23 +732,21 @@ $kexclude_line" $template > $dest_yumconf
     return 0
 }
 
-# from a yum.conf as generated above, computes the (first) gpgkey url
+# from a yum.conf as generated above, computes the gpgkey urls
 function yumconf_gpgkey () {
     dest_yumconf=$1; shift
 
-    first_line=$(grep '^gpgkey=' $dest_yumconf | head -1)
-    values=$(echo $first_line | sed -e s,gpgkey=,,)
-    value=$(echo $values | awk '{print $1;}' | sed -e 's,$basearch,'"$pl_DISTRO_ARCH",g)
-    [ -n "$value" ] || return 1
-    echo $value
+    values=$(grep -h '^gpgkey=' $dest_yumconf | sed -e s,gpgkey=,, | sed -e 's,$basearch,'"$pl_DISTRO_ARCH",g | sed -e 's, ,\n,g' | sort | uniq | xargs)
+    [ -n "$values" ] || return 1
+    echo $values
     return 0
 }
 
 # patches a yum conf to insert an exclude line in each declared repo
 function yumconf_exclude () {
     repo=$1; shift
-    kexclude_line="$1" ; shift
+    yumexclude_line="$1" ; shift
     
-    sed -i -e "/baseurl=.*$/i\\
-$kexclude_line" $repo
+    sed -i -e "/#baseurl=.*$/i\\
+$yumexclude_line" $repo
 }