tweak for the new test framework
[build.git] / vbuild-init-vserver.sh
1 #!/bin/bash
2 # -*-shell-*-
3
4 #shopt -s huponexit
5
6 COMMAND=$(basename $0)
7 DIRNAME=$(dirname $0)
8
9 # pkgs parsing utilities
10 PATH=$(dirname $0):$PATH export PATH
11 . build.common
12
13 DEFAULT_FCDISTRO=f8
14 DEFAULT_PLDISTRO=planetlab
15 DEFAULT_PERSONALITY=linux32
16 DEFAULT_IFNAME=eth0
17
18 COMMAND_VBUILD="vbuild-init-vserver.sh"
19 COMMAND_MYPLC="vtest-init-vserver.sh"
20
21 function failure () {
22     echo "$COMMAND : Bailing out"
23     exit 1
24 }
25
26 # overwrite vserver's internal yum config from what is in
27 # .distributions/<distrib>/yum/yum.conf and /yum.repos.d 
28
29 function configure_yum_in_vserver () {
30     set -x 
31     set -e 
32     trap failure ERR INT
33
34     vserver=$1; shift
35     fcdistro=$1; shift
36
37     templates=/etc/vservers/.distributions/${fcdistro}
38     if [ -f ${templates}/yum/yum.conf ] ; then
39         echo "Initializing yum.conf in $vserver from ${templates}/yum"
40         sed -e "s!@YUMETCDIR@!/etc!g;
41                 s!@YUMCACHEDIR@!/var/cache/yum!g;
42                 s!@YUMLOGDIR@!/var/log!g;
43                 s!@YUMLOCKDIR@!/var/lock!g;
44                " ${templates}/yum/yum.conf > /vservers/$vserver/etc/yum.conf
45
46         # post process the various @...@ variables from this yum.conf file.
47     else
48         echo "Using $fcdistro default for yum.conf"
49     fi
50
51     if [ -d ${templates}/yum.repos.d ] ; then
52         echo "Initializing yum.repos.d in $vserver from ${templates}/yum.repos.d"
53         rm -rf /vservers/$vserver/etc/yum.repos.d
54         tar -C ${templates} -cf - yum.repos.d | tar -C /vservers/$vserver/etc -xvf -
55     else
56         echo "Cannot initialize yum.repos.d in $vserver"
57     fi
58
59     # for using vtest-init-vserver.sh as a general-purpose vserver creation wrapper
60     # just mention 'none' as the repo url
61     if [ -n "$MYPLC_MODE" -a "$REPO_URL" != "none" ] ; then
62         if [ ! -d /vservers/$vserver/etc/yum.repos.d ] ; then
63             echo "WARNING : cannot create myplc repo"
64         else
65             # exclude kernel from fedora repos 
66             for repo in /vservers/$vserver/etc/yum.repos.d/* ; do
67                 [ -f $repo ] && yumconf_exclude $repo "exclude=$pl_KEXCLUDES" 
68             done
69             # the build repo is not signed at this stage
70             cat > /vservers/$vserver/etc/yum.repos.d/myplc.repo <<EOF
71 [myplc]
72 name= MyPLC
73 baseurl=$REPO_URL
74 enabled=1
75 gpgcheck=0
76 EOF
77         fi
78     fi
79 }    
80
81 # return yum or debootstrap
82 function package_method () {
83     fcdistro=$1; shift
84     case $fcdistro in
85         f[0-9]*|centos[0-9]*|sl[0-9]*) echo yum ;;
86         lenny|etch) echo debootstrap ;;
87         *) echo Unknown distro $fcdistro ;;
88     esac 
89 }
90
91 # return arch from debian distro and personality
92 function canonical_arch () {
93     personality=$1; shift
94     fcdistro=$1; shift
95     case $(package_method $fcdistro) in
96         yum)
97             case $personality in *32) echo i386 ;; *64) echo x86_64 ;; *) echo Unknown-arch-1 ;; esac ;;
98         debootstrap)
99             case $personality in *32) echo i386 ;; *64) echo amd64 ;; *) echo Unknown-arch-2 ;; esac ;;
100         *)
101             echo Unknown-arch-3 ;;
102     esac
103 }
104
105 # the new test framework creates /timestamp in /vservers/<name> *before* populating it
106 function almost_empty () { 
107     dir="$1"; shift ; 
108     # non existing is fine
109     [ ! -d $dir ] && return 0; 
110     # need to have at most one file
111     count=$(cd $dir; ls | wc -l); [ $count -le 1 ]; 
112 }
113
114 function setup_vserver () {
115
116     set -x
117     set -e
118     trap failure ERR INT
119
120     vserver=$1; shift
121     fcdistro=$1; shift
122     personality=$1; shift
123
124     # check that this is a new one - see above
125     almost_empty /vservers/$vserver || {        
126         echo "$COMMAND : vserver $vserver seems to exist - bailing out"
127         exit 1
128         }
129
130     pkg_method=$(package_method $fcdistro)
131     case $pkg_method in
132         yum)
133             build_options="-m yum -- -d $fcdistro" 
134             ;;
135         debootstrap)
136             arch=$(canonical_arch $personality $fcdistro)
137             build_options="-m debootstrap -- -d $fcdistro -- --arch $arch"
138             ;;
139         *)
140             build_options="something wrong" ;;
141     esac
142
143     # create it
144     # try to work around the vserver issue:
145     # vc_ctx_migrate: No such process
146     # rpm-fake.so: failed to initialize communication with resolver
147     for i in $(seq 20) ; do
148         $personality vserver $VERBOSE $vserver build $VSERVER_OPTIONS $build_options && break || true
149         echo "* ${i}-th attempt to 'vserver build' failed - waiting for 3 seconds"
150         sleep 3
151     done
152     # check success
153     [ -d /vservers/$vserver ] 
154
155     if [ ! -z "$personality" ] ; then
156         if [ -f "/etc/vservers/$vserver/personality" ] ; then
157             registered_personality=$(grep $personality /etc/vservers/$vserver/personality | wc -l)
158         else
159             registered_personality=0
160         fi
161         if [ $registered_personality -eq 0 -a "$personality" != "linux64" ] ; then
162             echo $personality >> /etc/vservers/$vserver/personality
163         fi
164     fi
165
166     BCAPFILE=/etc/vservers/$vserver/bcapabilities
167     touch $BCAPFILE
168     if [ -n "$VBUILD_MODE" ] ; then 
169         ### capabilities required for a build vserver
170         # set up appropriate vserver capabilities to mount, mknod and IPC_LOCK
171         grep -q ^CAP_SYS_ADMIN $BCAPFILE || echo CAP_SYS_ADMIN >> $BCAPFILE
172         grep -q ^CAP_MKNOD $BCAPFILE || echo CAP_MKNOD >> $BCAPFILE
173         grep -q ^CAP_IPC_LOCK $BCAPFILE || echo CAP_IPC_LOCK >> $BCAPFILE
174         # useful for f15 guests that use set_cap_file 
175         grep -q ^CAP_SETFCAP $BCAPFILE || echo CAP_SETFCAP >> $BCAPFILE
176     else
177         ### capabilities required for a myplc vserver
178         # for /etc/plc.d/gpg - need to init /dev/random
179         grep -q ^CAP_MKNOD $BCAPFILE || echo CAP_MKNOD >> $BCAPFILE
180         grep -q ^CAP_NET_BIND_SERVICE $BCAPFILE || echo CAP_NET_BIND_SERVICE >> $BCAPFILE
181         # useful for f15 guests that use set_cap_file 
182         grep -q ^CAP_SETFCAP $BCAPFILE || echo CAP_SETFCAP >> $BCAPFILE
183     fi
184
185     # Set persistent for the network context
186     # Thierry: Daniel's kernels come with single_ip turned off by default, let's make this explicit 
187     echo "persistent,lback_allow,~single_ip" > /etc/vservers/$vserver/nflags
188
189     # Set cflags
190     echo -e "persistent\n~info_init" > /etc/vservers/$vserver/cflags
191
192     # Enable cgroup
193     mkdir /etc/vservers/$vserver/cgroup
194
195     # Start Vserver automatically on boot
196     echo "default" > /etc/vservers/$vserver/apps/init/mark
197
198     # Set the init style of your vserver to plain for f15 and higher
199     # not working with f15 anyways, systemd requires 2.6.36 to work
200     case $fcdistro in 
201         f1[5-9]) echo plain > /etc/vservers/$vserver/apps/init/style ;;
202     esac
203
204     if [ "$pkg_method" = "yum" ] ; then
205         $personality vyum $vserver -- -y install yum
206         # ditto
207         for i in $(seq 20) ; do
208             $personality vserver $VERBOSE $vserver pkgmgmt internalize && break || true
209             echo "* ${i}-th attempt to 'vserver pkgmgmt internalize' failed - waiting for 3 seconds"
210             sleep 3
211         done
212     fi
213
214     # start the vserver so we can do the following operations
215     # redirect out/err to protect against the vserver's init sequence getting stalled 
216     # mostly used for f10 vservers created remotely through ssh
217     $personality vserver $VERBOSE $vserver start >& /dev/null
218
219     if [ "$pkg_method" == "yum" ] ; then
220         $personality vserver $VERBOSE $vserver exec sh -c "rm -f /var/lib/rpm/__db*"
221
222         # run the host rpmdb_dump and restore with the guest rpmdb_load
223         function translate_rpm_hashes () {
224             set -x
225             set -e
226             local personality="$1"; shift
227             local vserver="$1"; shift
228             # need to have utilities installed
229             type -p file
230             type -p awk
231             type -p cut
232             guest_dir=/var/lib/rpm
233             host_dir=/vservers/$vserver/$guest_dir
234             files=$(cd $host_dir ; file * | grep Hash | cut -d: -f 1)
235             for file in $files; do
236                 (cd $host_dir && mv $file ${file}-foreign)
237                 /usr/lib/rpm/rpmdb_dump $host_dir/${file}-foreign | $personality vserver $VERBOSE $vserver exec /usr/lib/rpm/rpmdb_load $guest_dir/$file
238             done
239             $personality vserver $VERBOSE $vserver exec rpm --rebuilddb
240             return 0
241         }
242
243         # try the simple way, if that fails try to cross fix the rpm hashes
244         $personality vserver $VERBOSE $vserver exec rpm --rebuilddb || translate_rpm_hashes $personality $vserver
245     fi
246
247     # check if the vserver kernel is using VSERVER_DEVICE (vdevmap) support
248     need_vdevmap=$(grep "CONFIG_VSERVER_DEVICE=y" /boot/config-$(uname -r) | wc -l)
249
250     if [ $need_vdevmap -eq 1 ] ; then
251         ctx=$(cat /etc/vservers/$vserver/context)
252         vdevmap --set --xid $ctx --open --create --target /dev/null
253         vdevmap --set --xid $ctx --open --create --target /dev/root
254     fi
255             
256     # minimal config in the vserver for yum to work
257     [ "$pkg_method" = "yum" ] && configure_yum_in_vserver $vserver $fcdistro 
258
259     # set up resolv.conf
260     cp /etc/resolv.conf /vservers/$vserver/etc/resolv.conf
261     # and /etc/hosts for at least localhost
262     [ -f /vservers/$vserver/etc/hosts ] || echo "127.0.0.1 localhost localhost.localdomain" > /vservers/$vserver/etc/hosts
263
264 }
265
266 function devel_or_vtest_tools () {
267
268     set -x 
269     set -e 
270     trap failure ERR INT
271
272     vserver=$1; shift
273     fcdistro=$1; shift
274     pldistro=$1; shift
275     personality=$1; shift
276
277     pkg_method=$(package_method $fcdistro)
278
279     # check for .pkgs file based on pldistro
280     if [ -n "$VBUILD_MODE" ] ; then
281         pkgsname=devel.pkgs
282     else
283         pkgsname=vtest.pkgs
284     fi
285     pkgsfile=$(pl_locateDistroFile $DIRNAME $pldistro $pkgsname)
286
287     ### install individual packages, then groups
288     # get target arch - use uname -i here (we want either x86_64 or i386)
289     vserver_arch=$($personality vserver $vserver exec uname -i)
290     # on debian systems we get arch through the 'arch' command
291     [ "$vserver_arch" = "unknown" ] && vserver_arch=$($personality vserver $vserver exec arch)
292     
293     packages=$(pl_getPackages -a $vserver_arch $fcdistro $pldistro $pkgsfile)
294     groups=$(pl_getGroups -a $vserver_arch $fcdistro $pldistro $pkgsfile)
295
296     case "$pkg_method" in
297         yum)
298             [ -n "$packages" ] && $personality vserver $vserver exec yum -y install $packages
299             for group_plus in $groups; do
300                 group=$(echo $group_plus | sed -e "s,+++, ,g")
301                 $personality vserver $vserver exec yum -y groupinstall "$group"
302             done
303             # store current rpm list in /init-vserver.rpms in case we need to check the contents
304             $personality vserver $vserver exec rpm -aq > /vservers/$vserver/init-vserver.rpms
305             ;;
306         debootstrap)
307             $personality vserver $vserver exec apt-get update
308             for package in $packages ; do 
309                 $personality vserver $vserver exec apt-get install -y $package 
310             done
311             ### xxx todo install groups with apt..
312             ;;
313         *)
314             echo "unknown pkg_method $pkg_method"
315             ;;
316     esac
317
318     return 0
319 }
320
321 function post_install () {
322     if [ -n "$VBUILD_MODE" ] ; then
323         post_install_vbuild "$@" 
324     else
325         post_install_myplc "$@"
326     fi
327     # setup localtime from the host
328     vserver=$1; shift 
329     cp /etc/localtime /vservers/$vserver/etc/localtime
330 }
331
332 function post_install_vbuild () {
333
334     set -x 
335     set -e 
336     trap failure ERR INT
337
338     vserver=$1; shift
339     personality=$1; shift
340
341 ### From myplc-devel-native.spec
342 # be careful to backslash $ in this, otherwise it's the root context that's going to do the evaluation
343     cat << EOF | $personality vserver $VERBOSE $vserver exec bash -x
344     # set up /dev/loop* in vserver
345     for i in \$(seq 0 255) ; do
346         mknod -m 640 /dev/loop\$i b 7 \$i
347     done
348     
349     # create symlink for /dev/fd
350     [ ! -e "/dev/fd" ] && ln -s /proc/self/fd /dev/fd
351
352     # modify /etc/rpm/macros to not use /sbin/new-kernel-pkg
353     sed -i 's,/sbin/new-kernel-pkg:,,' /etc/rpm/macros
354     if [ -h "/sbin/new-kernel-pkg" ] ; then
355         filename=\$(readlink -f /sbin/new-kernel-pkg)
356         if [ "\$filename" == "/sbin/true" ] ; then
357                 echo "WARNING: /sbin/new-kernel-pkg symlinked to /sbin/true"
358                 echo "\tmost likely /etc/rpm/macros has /sbin/new-kernel-pkg declared in _netsharedpath."
359                 echo "\tPlease remove /sbin/new-kernel-pkg from _netsharedpath and reintall mkinitrd."
360                 exit 1
361         fi
362     fi
363     
364     # customize root's prompt
365     cat << PROFILE > /root/.profile
366 export PS1="[$vserver] \\w # "
367 PROFILE
368
369     uid=2000
370     gid=2000
371     
372     # add a "build" user to the system
373     builduser=\$(grep "^build:" /etc/passwd | wc -l)
374     if [ \$builduser -eq 0 ] ; then
375         groupadd -o -g \$gid build;
376         useradd -o -c 'Automated Build' -u \$uid -g \$gid -n -M -s /bin/bash build;
377     fi
378
379 # Allow build user to build certain RPMs as root
380     if [ -f /etc/sudoers ] ; then
381         buildsudo=\$(grep "^build.*ALL=(ALL).*NOPASSWD:.*ALL"  /etc/sudoers | wc -l)
382         if [ \$buildsudo -eq 0 ] ; then
383             echo "build   ALL=(ALL)       NOPASSWD: ALL" >> /etc/sudoers
384         fi
385         sed -i 's,^Defaults.*requiretty,#Defaults requiretty,' /etc/sudoers
386     fi
387 #
388 EOF
389
390 }
391
392 function post_install_myplc  () {
393     set -x 
394     set -e 
395     trap failure ERR INT
396
397     vserver=$1; shift
398     personality=$1; shift
399
400 # be careful to backslash $ in this, otherwise it's the root context that's going to do the evaluation
401     cat << EOF | $personality vserver $VERBOSE $vserver exec bash -x
402
403     # create /etc/sysconfig/network if missing
404     [ -f /etc/sysconfig/network ] || echo NETWORKING=yes > /etc/sysconfig/network
405
406     # create symlink for /dev/fd
407     [ ! -e "/dev/fd" ] && ln -s /proc/self/fd /dev/fd
408
409     # turn off regular crond, as plc invokes plc_crond
410     chkconfig crond off
411
412     # take care of loginuid in /etc/pam.d 
413     sed -i "s,#*\(.*loginuid.*\),#\1," /etc/pam.d/*
414
415     # customize root's prompt
416     cat << PROFILE > /root/.profile
417 export PS1="[$vserver] \\w # "
418 PROFILE
419
420 EOF
421 }
422
423 # parses ifconfig's output to find out ip address and mask
424 # will then be passed to vserver as e.g. --interface 138.96.250.126/255.255.0.0
425 # default is to use lo, that's enough for local mirrors
426 # use -i eth0 in case your fedora mirror is on a separate box on the network
427 function vserverIfconfig () {
428     ifname=$1; shift
429     local result="" 
430     line=$(ifconfig $ifname 2> /dev/null | grep 'inet addr')
431     if [ -n "$line" ] ; then
432         set $line
433         for word in "$@" ; do
434             addr=$(echo $word | sed -e s,[aA][dD][dD][rR]:,,)
435             mask=$(echo $word | sed -e s,[mM][aA][sS][kK]:,,)
436             if [ "$word" != "$addr" ] ; then
437                 result="${addr}"
438             elif [ "$word" != "$mask" ] ; then
439                 result="${result}/${mask}"
440             fi
441         done
442     fi
443     if [ -z "$result" ] ; then 
444         echo "vserverIfconfig failed to locate $ifname"
445         exit 1
446     else
447         echo $result
448     fi
449 }
450
451 function usage () {
452     set +x 
453     echo "Usage: $COMMAND_VBUILD [options] vserver-name [ -- vserver-options ]"
454     echo "Usage: $COMMAND_MYPLC [options] vserver-name repo-url [ -- vserver-options ]"
455     echo "Requirements: you need to have a vserver-compliant kernel,"
456     echo "   as well as the util-vserver RPM installed"
457     echo "Description:"
458     echo "   This command creates a fresh vserver instance, for building, or running, myplc"
459     echo "Supported options"
460     echo " -f fcdistro - for creating the root filesystem - defaults to $DEFAULT_FCDISTRO"
461     echo " -d pldistro - defaults to $DEFAULT_PLDISTRO"
462     echo " -p personality - defaults to $DEFAULT_PERSONALITY"
463     echo " -i ifname: determines ip and netmask attached to ifname, and passes it to the vserver"
464     echo " -v : verbose - passes -v to calls to vserver"
465     echo "vserver-options"
466     echo "  all args after the optional -- are passed to vserver <name> build <options>"
467     echo "  typical usage is e.g. --interface eth0:200.150.100.10/24"
468     echo "With $COMMAND_MYPLC you can give 'none' as the URL, in which case"
469     echo "   myplc.repo does not get created"
470     exit 1
471 }
472
473 ### parse args and 
474 function main () {
475
476     set -e
477     trap failure ERR INT
478
479     case "$COMMAND" in
480         $COMMAND_VBUILD)
481             VBUILD_MODE=true ;;
482         $COMMAND_MYPLC)
483             MYPLC_MODE=true;;
484         *)
485             usage ;;
486     esac
487
488     VERBOSE=
489     IFNAME=""
490     VSERVER_OPTIONS=""
491     while getopts "f:d:p:i:v" opt ; do
492         case $opt in
493             f) fcdistro=$OPTARG;;
494             d) pldistro=$OPTARG;;
495             p) personality=$OPTARG;;
496             i) IFNAME=$OPTARG;;
497             v) VERBOSE="-v" ;;
498             *) usage ;;
499         esac
500     done
501         
502     shift $(($OPTIND - 1))
503
504     # parse fixed arguments
505     [[ -z "$@" ]] && usage
506     vserver=$1 ; shift
507     if [ -n "$MYPLC_MODE" ] ; then
508         [[ -z "$@" ]] && usage
509         REPO_URL=$1 ; shift
510     fi
511
512     # parse vserver options
513     if [[ -n "$@" ]] ; then
514         if [ "$1" == "--" ] ; then
515             shift
516             VSERVER_OPTIONS="$@"
517         else
518             usage
519         fi
520     fi
521
522     # with new util-vserver, it is mandatory to provide an IP even for building
523     if [ -n "$VBUILD_MODE" ] ; then
524         [ -z "$IFNAME" ] && IFNAME=$DEFAULT_IFNAME
525     fi
526     if [ -n "$IFNAME" ] ; then
527         localip=$(vserverIfconfig $IFNAME)
528         VSERVER_OPTIONS="$VSERVER_OPTIONS --interface $localip"
529     fi
530
531     [ -z "$fcdistro" ] && fcdistro=$DEFAULT_FCDISTRO
532     [ -z "$pldistro" ] && pldistro=$DEFAULT_PLDISTRO
533     [ -z "$personality" ] && personality=$DEFAULT_PERSONALITY
534
535     setup_vserver $vserver $fcdistro $personality 
536     devel_or_vtest_tools $vserver $fcdistro $pldistro $personality
537     post_install $vserver $personality
538
539 }
540
541 main "$@"