source: ProjectBuilder/devel/pb-modules/lib/ProjectBuilder/VE.pm@ 1958

Last change on this file since 1958 was 1958, checked in by Bruno Cornec, 9 years ago
  • Update copyrights dates notices
  • Change pb_parallel_launchv interface to have pbimage earlier in the params to fix newvm not working anymore
File size: 14.3 KB
Line 
1#!/usr/bin/perl -w
2#
3# Common functions for virtual environment
4#
5# Copyright B. Cornec 2007-2015
6# Eric Anderson's changes are (c) Copyright 2012 Hewlett Packard
7# Provided under the GPL v2
8#
9# $Id$
10#
11
12package ProjectBuilder::VE;
13
14use strict;
15use Data::Dumper;
16use Carp 'confess';
17use English;
18use File::Basename;
19use ProjectBuilder::Version;
20use ProjectBuilder::Base;
21use ProjectBuilder::Conf;
22use ProjectBuilder::Distribution;
23
24# Global vars
25# Inherit from the "Exporter" module which handles exporting functions.
26
27use vars qw($VERSION $REVISION @ISA @EXPORT);
28use Exporter;
29
30# Export, by default, all the functions into the namespace of
31# any code which uses this module.
32
33our @ISA = qw(Exporter);
34our @EXPORT = qw(pb_ve_launch pb_ve_snap pb_ve_get_type pb_ve_docker_repo pb_ve_docker_get_image);
35
36($VERSION,$REVISION) = pb_version_init();
37
38=pod
39
40=head1 NAME
41
42ProjectBuilder::VE, part of the project-builder.org - module dealing with Virtual Environment
43
44=head1 DESCRIPTION
45
46This modules provides functions to deal with Virtual Environements (VE), aka chroot/containers.
47
48=head1 SYNOPSIS
49
50 use ProjectBuilder::VE;
51
52 #
53 # Return information on the running distro
54 #
55 my $pbos = pb_ve_launch();
56
57=head1 USAGE
58
59=over 4
60
61=item B<pb_ve_launch>
62
63This function launches a VE, creating it if necessary using multiple external potential tools.
64
65=cut
66
67sub pb_ve_launch {
68
69my $v = shift;
70my $pbforce = shift; # Which step are we in (0: create, 1: setup, 2: build, 3: use)
71my $locsnap = shift;
72my $vetype = shift;
73my $pbimage = shift;
74
75my $dockerregistry = undef;
76my $docrepo = undef; # By default no repository for docker available
77
78pb_log(2,"Entering pb_ve_launch at step $pbforce for type $vetype\n");
79# Get distro context
80my $pbos = pb_distro_get_context($v);
81
82$vetype = pb_ve_get_type($vetype);
83my ($vepath) = pb_conf_get("vepath");
84
85if (($vetype eq "chroot") || ($vetype eq "schroot") || ($vetype eq "docker")) {
86
87 # We need to avoid umask propagation to the VE
88 umask 0022;
89
90 # We can probably only get those params now we have the distro context
91 my ($rbsb4pi,$rbspi,$vesnap,$oscodename,$osmindep,$verebuild,$rbsmirrorsrv) = pb_conf_get_if("rbsb4pi","rbspi","vesnap","oscodename","osmindep","verebuild","rbsmirrorsrv");
92 if ($vetype eq "docker") {
93 # Check acces to registry
94 ($dockerregistry) = pb_conf_get("dockerregistry");
95 if ((defined $dockerregistry) && (defined $dockerregistry->{$ENV{'PBPROJ'}})) {
96 pb_ve_docker_registry($dockerregistry->{$ENV{'PBPROJ'}});
97 } else {
98 die "When using docker you need to declare a dockerregistry parameter. Read the man page"
99 }
100 }
101
102 # Architecture consistency
103 my $arch = pb_get_arch();
104 if ($arch ne $pbos->{'arch'}) {
105 die "Unable to launch a VE of architecture $pbos->{'arch'} on a $arch platform" unless (($pbos->{'arch'} =~ /i?86/o) && ($arch eq "x86_64"));
106 }
107
108 # If we are already root (from pbmkbm e.g.) don't use sudo, just call the command
109 my $sudocmd="";
110 if ($EFFECTIVE_USER_ID != 0) {
111 $sudocmd ="sudo ";
112 foreach my $proxy (qw/http_proxy ftp_proxy/) {
113 if (defined $ENV{$proxy}) {
114 open(CMD,"sudo sh -c 'echo \$$proxy' |") or die "can't run sudo sh?: $!";
115 $_ = <CMD>;
116 chomp();
117 die "sudo not passing through env var $proxy; '$ENV{$proxy}' != '$_'\nAdd line Defaults:`whoami` env_keep += \"$proxy\" to sudoers file?" unless $_ eq $ENV{$proxy};
118 close(CMD);
119 }
120 }
121 }
122
123 # Handle cross arch on Intel based platforms
124 $sudocmd = "setarch i386 $sudocmd" if (($pbos->{'arch'} =~ /i[3456]86/) && ($arch eq 'x86_64'));
125
126 my $root = pb_path_expand($vepath->{$ENV{PBPROJ}});
127
128 if (((((defined $verebuild) && ($verebuild->{$ENV{'PBPROJ'}} =~ /true/i)) || ($pbforce == 0)) && ($vetype ne "docker"))
129 # For docker we may have a reference image that we'll use
130 || (($vetype eq "docker") && ($pbforce == 0))) {
131
132 my ($verpmtype,$vedebtype) = pb_conf_get("verpmtype","vedebtype");
133 my ($rbsopt1) = pb_conf_get_if("rbsopt");
134
135 # We have to rebuild the chroot
136 if ($pbos->{'type'} eq "rpm") {
137
138 # Which tool is used
139 my $verpmstyle = $verpmtype->{$ENV{'PBPROJ'}};
140 die "No verpmtype defined for $ENV{PBPROJ}" unless (defined $verpmstyle);
141
142 # Get potential rbs option
143 my $rbsopt = "";
144 if (defined $rbsopt1) {
145 if (defined $rbsopt1->{$verpmstyle}) {
146 $rbsopt = $rbsopt1->{$verpmstyle};
147 } elsif (defined $rbsopt1->{$ENV{'PBPROJ'}}) {
148 $rbsopt = $rbsopt1->{$ENV{'PBPROJ'}};
149 } else {
150 $rbsopt = "";
151 }
152 }
153
154 my $postinstall = pb_ve_get_postinstall($pbos,$rbspi,$verpmstyle);
155 if ($verpmstyle eq "rinse") {
156 # Need to reshape the mirrors generated with local before-post-install script
157 my $b4post = "--before-post-install ";
158 my $postparam = pb_distro_get_param($pbos,$rbsb4pi);
159 if ($postparam eq "") {
160 $b4post = "";
161 } else {
162 $b4post .= $postparam;
163 }
164
165 # Need to reshape the package list for pb
166 my $addpkgs;
167 $postparam = "";
168 $postparam .= pb_distro_get_param($pbos,$osmindep);
169 if ($postparam eq "") {
170 $addpkgs = "";
171 } else {
172 my $pkgfile = "$ENV{'PBTMP'}/addpkgs.lis";
173 open(PKG,"> $pkgfile") || die "Unable to create $pkgfile";
174 foreach my $p (split(/,/,$postparam)) {
175 print PKG "$p\n";
176 }
177 close(PKG);
178 $addpkgs = "--add-pkg-list $pkgfile";
179 }
180
181 my $rinseverb = "";
182 $rinseverb = "--verbose" if ($pbdebug gt 0);
183 my ($rbsconf) = pb_conf_get("rbsconf");
184
185 my $command = pb_check_req("rinse",0);
186 pb_system("$sudocmd $command --directory \"$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}\" --arch \"$pbos->{'arch'}\" --distribution \"$pbos->{'name'}-$pbos->{'version'}\" --config \"$rbsconf->{$ENV{'PBPROJ'}}\" $b4post $postinstall $rbsopt $addpkgs $rinseverb","Creating the rinse VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})", "verbose");
187 } elsif ($verpmstyle eq "rpmbootstrap") {
188 my $rbsverb = "";
189 foreach my $i (1..$pbdebug) {
190 $rbsverb .= " -v";
191 }
192 my $addpkgs = "";
193 my $postparam = "";
194 $postparam .= pb_distro_get_param($pbos,$osmindep);
195 if ($postparam eq "") {
196 $addpkgs = "";
197 } else {
198 $addpkgs = "-a $postparam";
199 }
200 my $command = pb_check_req("rpmbootstrap",0);
201 pb_system("$sudocmd $command $rbsopt $postinstall $addpkgs $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'} $rbsverb","Creating the rpmbootstrap VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})", "verbose");
202 pb_system("$sudocmd /bin/umount $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/proc","Umounting stale /proc","mayfail") if (-f "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/proc/cpuinfo");
203 } elsif ($verpmstyle eq "mock") {
204 my ($rbsconf) = pb_conf_get("rbsconf");
205 my $command = pb_check_req("mock",0);
206 pb_system("$sudocmd $command --init --resultdir=\"/tmp\" --configdir=\"$rbsconf->{$ENV{'PBPROJ'}}\" -r $v $rbsopt","Creating the mock VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})");
207 # Once setup we need to install some packages, the pb account, ...
208 pb_system("$sudocmd $command --install --configdir=\"$rbsconf->{$ENV{'PBPROJ'}}\" -r $v su","Configuring the mock VE");
209 } else {
210 die "Unknown verpmtype type $verpmstyle. Report to dev team";
211 }
212 } elsif ($pbos->{'type'} eq "deb") {
213 my $vedebstyle = $vedebtype->{$ENV{'PBPROJ'}};
214
215 my $codename = pb_distro_get_param($pbos,$oscodename);
216 my $postparam = "";
217 my $addpkgs;
218 $postparam .= pb_distro_get_param($pbos,$osmindep);
219 if ($postparam eq "") {
220 $addpkgs = "";
221 } else {
222 $addpkgs = "--include $postparam";
223 }
224 my $debmir = "";
225 $debmir .= pb_distro_get_param($pbos,$rbsmirrorsrv);
226
227 # Get potential rbs option
228 my $rbsopt = "";
229 if (defined $rbsopt1) {
230 if (defined $rbsopt1->{$vedebstyle}) {
231 $rbsopt = $rbsopt1->{$vedebstyle};
232 } elsif (defined $rbsopt1->{$ENV{'PBPROJ'}}) {
233 $rbsopt = $rbsopt1->{$ENV{'PBPROJ'}};
234 } else {
235 $rbsopt = "";
236 }
237 }
238
239 # debootstrap works with amd64 not x86_64
240 my $debarch = $pbos->{'arch'};
241 $debarch = "amd64" if ($pbos->{'arch'} eq "x86_64");
242 if ($vedebstyle eq "debootstrap") {
243 my $dbsverb = "";
244 $dbsverb = "--verbose" if ($pbdebug gt 0);
245
246 # Some perl modules are in Universe on Ubuntu
247 $rbsopt .= " --components=main,universe" if ($pbos->{'name'} eq "ubuntu");
248
249 my $cmd1 = pb_check_req("mkdir",0);
250 my $cmd2 = pb_check_req("debootstrap",0);
251 pb_system("$sudocmd $cmd1 -p $root/$pbos->{name}/$pbos->{version}/$pbos->{arch} ; $sudocmd $cmd2 $dbsverb $rbsopt --arch=$debarch $addpkgs $codename \"$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}\" $debmir","Creating the debootstrap VE for $pbos->{'name'}-$pbos->{'version'} ($pbos->{'arch'})", "verbose");
252 # debootstrap doesn't create an /etc/hosts file
253 if (! -f "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/etc/hosts" ) {
254 my $cmd = pb_check_req("cp",0);
255 pb_system("$sudocmd $cmd /etc/hosts $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}/etc/hosts");
256 }
257 } else {
258 die "Unknown vedebtype type $vedebstyle. Report to dev team";
259 }
260 } elsif ($pbos->{'type'} eq "ebuild") {
261 die "Please teach the dev team how to build gentoo chroot";
262 } else {
263 die "Unknown distribution type $pbos->{'type'}. Report to dev team";
264 }
265 }
266
267 # Test if an existing snapshot exists and use it if appropriate
268 # And also use it if no local extracted VE is present
269 if ((-f "$root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz") &&
270 (((defined $vesnap->{$v}) && ($vesnap->{$v} =~ /true/i)) ||
271 ((defined $vesnap->{$ENV{'PBPROJ'}}) && ($vesnap->{$ENV{'PBPROJ'}} =~ /true/i))) &&
272 ($locsnap eq 1) &&
273 ($vetype ne "docker") &&
274 (! -d "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}")) {
275 my $cmd1 = pb_check_req("rm",0);
276 my $cmd2 = pb_check_req("mkdir",0);
277 my $cmd3 = pb_check_req("tar",0);
278 pb_system("$sudocmd $cmd1 -rf $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'} ; $sudocmd $cmd2 -p $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'} ; $sudocmd $cmd3 xz -C $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'} -f $root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz","Extracting snapshot of $pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz under $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}");
279 }
280
281 if ($vetype ne "docker") {
282 # Fix modes to allow access to the VE for pb user
283 my $command = pb_check_req("chmod",0);
284 pb_system("$sudocmd $command 755 $root/$pbos->{'name'} $root/$pbos->{'name'}/$pbos->{'version'} $root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}","Fixing permissions");
285 }
286
287 # If docker, create the image and remove the now temp dir except if we had one already
288 if (($vetype eq "docker") && ($pbforce == 0)) {
289 $docrepo = pb_ve_docker_repo($dockerregistry->{$ENV{'PBPROJ'}});
290 my $cmd1 = pb_check_req("docker",0);
291 # step 0 : nothing at creation -> tag n-v-a (made below)
292
293 # Snaphot the VE to serve as an input for docker
294 pb_ve_snap($pbos,$root);
295 # Create the docker image from the previous bootstrap
296 # Need sudo to be able to create all files correctly
297 # TODO: check before that the image doesn't already exist in the docker registry
298 my $pbimage = "$docrepo:$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}";
299 pb_system("$sudocmd $cmd1 import - $pbimage < $root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz");
300 pb_system("$cmd1 push $pbimage");
301 }
302
303 # Nothing more to do for VE. No real launch
304} else {
305 die "VE of type $vetype not supported. Report to the dev team";
306}
307}
308
309#
310# Return the postinstall line if needed
311#
312
313sub pb_ve_get_postinstall {
314
315my $pbos = shift;
316my $rbspi = shift;
317my $vestyle = shift;
318my $post = "";
319
320# Do we have a local post-install script
321if ($vestyle eq "rinse") {
322 $post = "--post-install ";
323} elsif ($vestyle eq "rpmbootstrap") {
324 $post = "-s ";
325}
326
327my $postparam = pb_distro_get_param($pbos,$rbspi);
328if ($postparam eq "") {
329 $post = "";
330} else {
331 $post .= $postparam;
332}
333return($post);
334}
335
336# Snapshot the VE
337sub pb_ve_snap {
338
339my $pbos = shift;
340my $root = shift;
341my $tpdir = "$root/$pbos->{'name'}/$pbos->{'version'}/$pbos->{'arch'}";
342pb_system("sudo tar cz -C $tpdir -f $root/$pbos->{'name'}-$pbos->{'version'}-$pbos->{'arch'}.tar.gz .","Creating a snapshot of $tpdir");
343}
344
345# Returns the docker registry to interact with
346sub pb_ve_docker_registry {
347
348my $dockerreg = shift;
349my $wget = pb_check_req("wget",0);
350my ($scheme, $account, $host, $port, $path) = pb_get_uri($dockerreg);
351my $docreg = $scheme."://";
352$docreg .= $account."@" if ((defined $account) && ($account ne ""));
353$docreg .= $host;
354$docreg .= ":$port" if ((defined $port) && ($port ne ""));
355open(FD,"$wget $docreg -q -O -|") || die "Unable to talk to the docker registry $docreg";
356my $found = undef;
357while (<FD>) {
358 $found = 1 if (/docker-registry/);
359}
360close(FD);
361die "No correct docker-registry answering at $docreg. Please check your configuration" if (not defined $found);
362#
363return($docreg);
364}
365
366# Returns the docker repository to interact with
367sub pb_ve_docker_repo {
368
369my $dockerreg = shift;
370my $docrepo = "";
371my ($scheme, $account, $host, $port, $path) = pb_get_uri($dockerreg);
372$docrepo .= $host;
373$docrepo .= ":$port" if ((defined $port) && ($port ne ""));
374$docrepo .= "$path";
375return($docrepo);
376}
377
378sub pb_ve_docker_get_image {
379
380my $pbimage = shift;
381my $found = 0;
382
383die "Unable to handle an undef docker image" if (not defined $pbimage);
384
385# Check that this docker image exists
386my $cmd1 = pb_check_req("docker",0);
387open(CMD, "$cmd1 images |") || die "Unable to get docker image list";
388my ($repo, $tag, $id, $dummy);
389while (<CMD>) {
390 ($repo, $tag, $id, $dummy) = split(/\s+/,$_,4);
391 $found = $id if ("$repo:$tag" eq $pbimage);
392}
393close(CMD);
394return($found);
395}
396sub pb_ve_get_type {
397
398my $vetype = shift;
399
400# Get VE context
401if (not defined $vetype) {
402 my ($ptr) = pb_conf_get("vetype");
403 $vetype = $ptr->{$ENV{'PBPROJ'}};
404}
405confess "No vetype defined for $ENV{PBPROJ}" unless (defined $vetype);
406pb_log(1, "Using vetype $vetype for $ENV{PBPROJ}\n");
407return($vetype);
408}
409
410
411=head1 WEB SITES
412
413The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
414
415=head1 USER MAILING LIST
416
417None exists for the moment.
418
419=head1 AUTHORS
420
421The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
422
423=head1 COPYRIGHT
424
425Project-Builder.org is distributed under the GPL v2.0 license
426described in the file C<COPYING> included with the distribution.
427
428=cut
429
430
4311;
Note: See TracBrowser for help on using the repository browser.