summaryrefslogtreecommitdiff
path: root/extensions/writeexts.py
blob: 0768057da05f978bd220530d18354cc9f393ade3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
# Copyright (C) 2012-2015  Codethink Limited
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program.  If not, see <http://www.gnu.org/licenses/>.


import contextlib
import errno
import fcntl
import logging
import os
import partitioning
import pyfdisk
import re
import select
import shutil
import stat
import subprocess
import sys
import time
import tempfile


if sys.version_info >= (3, 3, 0):
    import shlex
    shell_quote = shlex.quote
else:
    import pipes
    shell_quote = pipes.quote


def get_data_path(relative_path):
    extensions_dir = os.path.dirname(__file__)
    return os.path.join(extensions_dir, relative_path)


def get_data(relative_path):
    with open(get_data_path(relative_path)) as f:
        return f.read()


def ssh_runcmd(host, args, **kwargs):
    '''Run command over ssh'''
    command = ['ssh', host, '--'] + [shell_quote(arg) for arg in args]

    feed_stdin = kwargs.get('feed_stdin')
    stdin = kwargs.get('stdin', subprocess.PIPE)
    stdout = kwargs.get('stdout', subprocess.PIPE)
    stderr = kwargs.get('stderr', subprocess.PIPE)

    p = subprocess.Popen(command, stdin=stdin, stdout=stdout, stderr=stderr)
    out, err = p.communicate(input=feed_stdin)
    if p.returncode != 0:
        raise ExtensionError('ssh command `%s` failed' % ' '.join(command))
    return out


def write_from_dict(filepath, d, validate=lambda x, y: True):
    """Takes a dictionary and appends the contents to a file

    An optional validation callback can be passed to perform validation on
    each value in the dictionary.

    e.g.

        def validation_callback(dictionary_key, dictionary_value):
            if not dictionary_value.isdigit():
                raise Exception('value contains non-digit character(s)')

    Any callback supplied to this function should raise an exception
    if validation fails.

    """
    # Sort items asciibetically
    # the output of the deployment should not depend
    # on the locale of the machine running the deployment
    items = sorted(d.iteritems(), key=lambda (k, v): [ord(c) for c in v])

    for (k, v) in items:
        validate(k, v)

    with open(filepath, 'a') as f:
        for (_, v) in items:
            f.write('%s\n' % v)

        os.fchown(f.fileno(), 0, 0)
        os.fchmod(f.fileno(), 0644)


def parse_environment_pairs(env, pairs):
    '''Add key=value pairs to the environment dict.

    Given a dict and a list of strings of the form key=value,
    set dict[key] = value, unless key is already set in the
    environment, at which point raise an exception.

    This does not modify the passed in dict.

    Returns the extended dict.

    '''
    extra_env = dict(p.split('=', 1) for p in pairs)
    conflicting = [k for k in extra_env if k in env]
    if conflicting:
        raise ExtensionError('Environment already set: %s'
                             % ', '.join(conflicting))

    # Return a dict that is the union of the two
    # This is not the most performant, since it creates
    # 3 unnecessary lists, but I felt this was the most
    # easy to read. Using itertools.chain may be more efficicent
    return dict(env.items() + extra_env.items())


class ExtensionError(Exception):

    def __init__(self, msg):
        self.msg = msg

    def __str__(self):
        return self.msg


class Fstab(object):
    '''Small helper class for parsing and adding lines to /etc/fstab.'''

    # There is an existing Python helper library for editing of /etc/fstab.
    # However it is unmaintained and has an incompatible license (GPL3).
    #
    # https://code.launchpad.net/~computer-janitor-hackers/python-fstab/trunk

    def __init__(self, filepath='/etc/fstab'):
        if os.path.exists(filepath):
            with open(filepath, 'r') as f:
                self.text= f.read()
        else:
            self.text = ''
        self.filepath = filepath
        self.lines_added = 0

    def get_mounts(self):
        '''Return list of mount devices and targets in /etc/fstab.

        Return value is a dict of target -> device.
        '''
        mounts = dict()
        for line in self.text.splitlines():
            words = line.split()
            if len(words) >= 2 and not words[0].startswith('#'):
                device, target = words[0:2]
                mounts[target] = device
        return mounts

    def add_line(self, line):
        '''Add a new entry to /etc/fstab.

        Lines are appended, and separated from any entries made by configure
        extensions with a comment.

        '''
        if self.lines_added == 0:
            if len(self.text) == 0 or self.text[-1] is not '\n':
                self.text += '\n'
            self.text += '# Morph default system layout\n'
        self.lines_added += 1

        self.text += line + '\n'

    def write(self):
        '''Rewrite the fstab file to include all new entries.'''
        with tempfile.NamedTemporaryFile(delete=False) as f:
            f.write(self.text)
            tmp = f.name
        shutil.move(os.path.abspath(tmp), os.path.abspath(self.filepath))


class Extension(object):

    '''A base class for deployment extensions.

    A subclass should subclass this class, and add a
    ``process_args`` method.

    Note that it is not necessary to subclass this class for write
    extensions. This class is here just to collect common code for
    write extensions.

    '''

    def setup_logging(self):
        '''Direct all logging output to MORPH_LOG_FD, if set.

        This file descriptor is read by Morph and written into its own log
        file.

        '''
        log_write_fd = int(os.environ.get('MORPH_LOG_FD', 0))

        if log_write_fd == 0:
            return

        formatter = logging.Formatter('%(message)s')

        handler = logging.StreamHandler(os.fdopen(log_write_fd, 'w'))
        handler.setFormatter(formatter)

        logger = logging.getLogger()
        logger.addHandler(handler)
        logger.setLevel(logging.DEBUG)

    def process_args(self, args):
        raise NotImplementedError()

    def run(self, args=None):
        if args is None:
            args = sys.argv[1:]
        try:
            self.setup_logging()
            self.process_args(args)
        except ExtensionError as e:
            sys.stdout.write('ERROR: %s\n' % e)
            sys.exit(1)

    @staticmethod
    def status(**kwargs):
        '''Provide status output.

        The ``msg`` keyword argument is the actual message,
        the rest are values for fields in the message as interpolated
        by %.

        '''
        sys.stdout.write('%s\n' % (kwargs['msg'] % kwargs))
        sys.stdout.flush()


class WriteExtension(Extension):

    '''A base class for deployment write extensions.

    A subclass should subclass this class, and add a
    ``process_args`` method.

    Note that it is not necessary to subclass this class for write
    extensions. This class is here just to collect common code for
    write extensions.

    '''

    def check_for_btrfs_in_deployment_host_kernel(self):
        with open('/proc/filesystems') as f:
            text = f.read()
        return '\tbtrfs\n' in text

    def require_btrfs_in_deployment_host_kernel(self):
        if not self.check_for_btrfs_in_deployment_host_kernel():
            raise ExtensionError(
                'Error: Btrfs is required for this deployment, but was not '
                'detected in the kernel of the machine that is running Morph.')

    def create_local_system(self, temp_root, location):
        '''Create a raw system image locally.'''

        with self.created_disk_image(location):
            self.create_partitioned_system(temp_root, location)

    @contextlib.contextmanager
    def created_disk_image(self, location):
        size = self.get_disk_size()
        if not size:
            raise ExtensionError('DISK_SIZE is not defined')
        self.create_raw_disk_image(location, size)
        try:
            yield
        except BaseException:
            os.unlink(location)
            raise

    def format_btrfs(self, raw_disk):
        try:
            self.mkfs_btrfs(raw_disk)
        except BaseException:
            sys.stderr.write('Error creating disk image')
            raise

    def _parse_size(self, size):
        '''Parse a size from a string.

        Return size in bytes.

        '''

        m = re.match('^(\d+)([kmgKMG]?)$', size)
        if not m:
            return None

        factors = {
            '': 1,
            'k': 1024,
            'm': 1024**2,
            'g': 1024**3,
        }
        factor = factors[m.group(2).lower()]

        return int(m.group(1)) * factor

    def _parse_size_from_environment(self, env_var, default):
        '''Parse a size from an environment variable.'''

        size = os.environ.get(env_var, default)
        if size is None:
            return None
        bytes = self._parse_size(size)
        if bytes is None:
            raise ExtensionError('Cannot parse %s value %s'
                                 % (env_var, size))
        return bytes

    def get_disk_size(self):
        '''Parse disk size from environment.'''
        return self._parse_size_from_environment('DISK_SIZE', None)

    def get_ram_size(self):
        '''Parse RAM size from environment.'''
        return self._parse_size_from_environment('RAM_SIZE', '1G')

    def get_vcpu_count(self):
        '''Parse the virtual cpu count from environment.'''
        return self._parse_size_from_environment('VCPUS', '1')

    def create_raw_disk_image(self, filename, size):
        '''Create a raw disk image.'''

        self.status(msg='Creating empty disk image')
        with open(filename, 'wb') as f:
            if size > 0:
                f.seek(size-1)
                f.write('\0')

    def mkfs_btrfs(self, location):
        '''Create a btrfs filesystem on the disk.'''

        self.status(msg='Creating btrfs filesystem')
        try:
            # The following command disables some new filesystem features. We
            # need to do this because at the time of writing, SYSLINUX has not
            # been updated to understand these new features and will fail to
            # boot if the kernel is on a filesystem where they are enabled.
            subprocess.check_output(
                ['mkfs.btrfs','-f', '-L', 'baserock',
                '--features', '^extref',
                '--features', '^skinny-metadata',
                '--features', '^mixed-bg',
                '--nodesize', '4096',
                location], stderr=subprocess.STDOUT)
        except subprocess.CalledProcessError as e:
            if 'unrecognized option \'--features\'' in e.output:
                # Old versions of mkfs.btrfs (including v0.20, present in many
                # Baserock releases) don't support the --features option, but
                # also don't enable the new features by default. So we can
                # still create a bootable system in this situation.
                logging.debug(
                    'Assuming mkfs.btrfs failure was because the tool is too '
                    'old to have --features flag.')
                subprocess.check_call(['mkfs.btrfs','-f',
                                       '-L', 'baserock', location])
            else:
                raise

    def get_uuid(self, location, offset=0, disk=False):
        '''Get the UUID of a block device's file system.

        Requires util-linux blkid; the busybox version ignores options and
        lies by exiting successfully.

        Args:
            location: Path of device or image to inspect
            offset: A byte offset - which should point to the start of a
                    partition containing a filesystem
            disk: Boolean, if true, find the disk (partition table) UUID,
                  rather than a filesystem UUID. Offset has no effect.
        '''
        if disk:
            field = 'PTUUID'
        else:
            field = 'UUID'

        return subprocess.check_output(['blkid', '-s', field, '-o',
                                        'value', '-p', '-O', str(offset),
                                        location]).strip()

    @contextlib.contextmanager
    def mount(self, location):
        self.status(msg='Mounting filesystem')
        try:
            mount_point = tempfile.mkdtemp()
            if self.is_device(location):
                subprocess.check_call(['mount', location, mount_point])
            else:
                subprocess.check_call(['mount', '-o', 'loop',
                                       location, mount_point])
        except BaseException as e:
            sys.stderr.write('Error mounting filesystem')
            os.rmdir(mount_point)
            raise
        try:
            yield mount_point
        finally:
            self.status(msg='Unmounting filesystem')
            subprocess.check_call(['umount', mount_point])
            os.rmdir(mount_point)

    def create_btrfs_system_layout(self, temp_root, mountpoint, version_label,
                                   rootfs_uuid, device):
        '''Separate base OS versions from state using subvolumes.

        '''
        initramfs = self.find_initramfs(temp_root)
        version_root = os.path.join(mountpoint, 'systems', version_label)
        state_root = os.path.join(mountpoint, 'state')

        os.makedirs(version_root)
        os.makedirs(state_root)

        system_dir = self.create_orig(version_root, temp_root)
        state_dirs = self.complete_fstab_for_btrfs_layout(system_dir,
                                                          rootfs_uuid, device)

        for state_dir in state_dirs:
            self.create_state_subvolume(system_dir, mountpoint, state_dir)

        self.create_run(version_root)

        os.symlink(
                version_label, os.path.join(mountpoint, 'systems', 'default'))

        if self.bootloader_config_is_wanted():
            self.install_kernel(version_root, temp_root)
            if self.get_dtb_path() != '':
                self.install_dtb(version_root, temp_root)
            self.install_syslinux_menu(mountpoint, version_root)
            if initramfs is not None:
                self.install_initramfs(initramfs, version_root)
                self.generate_bootloader_config(mountpoint,
                                                rootfs_uuid=rootfs_uuid)
            else:
                disk_uuid = self.get_uuid(device.location, disk=True)
                root_num = next(r.number for r in device.partitionlist
                                         if hasattr(r, 'mountpoint')
                                         and r.mountpoint == '/')
                self.generate_bootloader_config(mountpoint,
                                                disk_uuid=disk_uuid,
                                                root_partition=root_num)
            self.install_bootloader(mountpoint, system_dir, device.location)

        # Move this?
        # Delete contents of partition mountpoints in the rootfs to leave an
        # empty mount drectory (files are copied to the actual partition
        # separately), or create an empty mount directory in the rootfs.
        for part in device.partitionlist:
            if hasattr(part, 'mountpoint') and part.mountpoint != '/':
                part_mount_dir = os.path.join(system_dir,
                                     re.sub('^/', '', part.mountpoint))
                if os.path.exists(part_mount_dir):
                    self.empty_dir(part_mount_dir)
                else:
                    self.status(msg='Creating empty mount directory '
                                    'for %s partition' % part.mountpoint)
                    os.mkdir(part_mount_dir)

    def create_orig(self, version_root, temp_root):
        '''Create the default "factory" system.'''

        orig = os.path.join(version_root, 'orig')

        self.status(msg='Creating orig subvolume')
        subprocess.check_call(['btrfs', 'subvolume', 'create', orig])
        self.status(msg='Copying files to orig subvolume')
        subprocess.check_call(['cp', '-a', temp_root + '/.', orig + '/.'])

        return orig

    def create_run(self, version_root):
        '''Create the 'run' snapshot.'''

        self.status(msg='Creating run subvolume')
        orig = os.path.join(version_root, 'orig')
        run = os.path.join(version_root, 'run')
        subprocess.check_call(
            ['btrfs', 'subvolume', 'snapshot', orig, run])

    def create_state_subvolume(self, system_dir, mountpoint, state_subdir):
        '''Create a shared state subvolume.

        We need to move any files added to the temporary rootfs by the
        configure extensions to their correct home. For example, they might
        have added keys in `/root/.ssh` which we now need to transfer to
        `/state/root/.ssh`.

        '''
        self.status(msg='Creating %s subvolume' % state_subdir)
        subvolume = os.path.join(mountpoint, 'state', state_subdir)
        subprocess.check_call(['btrfs', 'subvolume', 'create', subvolume])
        os.chmod(subvolume, 0o755)

        existing_state_dir = os.path.join(system_dir, state_subdir)
        self.move_or_copy_dir(existing_state_dir, subvolume)

    def move_or_copy_dir(self, source_dir, target_dir, copy=False):
        '''Move or copy all files source_dir, to target_dir'''

        cmd = 'mv'
        act = 'Mov'
        if copy:
            cmd = 'cp'
            act = 'Copy'

        files = []
        if os.path.exists(source_dir):
            files = os.listdir(source_dir)
        if len(files) > 0:
            self.status(msg='%sing data to %s' % (act, target_dir))
        for filename in files:
            filepath = os.path.join(source_dir, filename)
            subprocess.check_call([cmd, filepath, target_dir])

    def empty_dir(self, directory):
        '''Empty the contents of a directory, but not the directory itself'''
        files = []
        if os.path.exists(directory):
            files = os.listdir(directory)
        for filename in files:
            filepath = os.path.join(directory, filename)
            subprocess.check_call(['rm', '-rf', filepath])

    def complete_fstab_for_btrfs_layout(self, system_dir,
                                        rootfs_uuid=None, device=None):
        '''Fill in /etc/fstab entries for the default Btrfs disk layout.

        In the future we should move this code out of the write extension and
        in to a configure extension. To do that, though, we need some way of
        informing the configure extension what layout should be used. Right now
        a configure extension doesn't know if the system is going to end up as
        a Btrfs disk image, a tarfile or something else and so it can't come
        up with a sensible default fstab.

        Configuration extensions can already create any /etc/fstab that they
        like. This function only fills in entries that are missing, so if for
        example the user configured /home to be on a separate partition, that
        decision will be honoured and /state/home will not be created.

        '''
        shared_state_dirs = {'home', 'root', 'opt', 'srv', 'var'}

        fstab = Fstab(os.path.join(system_dir, 'etc', 'fstab'))
        existing_mounts = fstab.get_mounts()

        if '/' in existing_mounts:
            root_device = existing_mounts['/']
        else:
            root_device = (self.get_root_device() if rootfs_uuid is None else
                           'UUID=%s' % rootfs_uuid)
            fstab.add_line('%s  / btrfs defaults,rw,noatime 0 1' % root_device)

        # Add fstab entries for partitions
        partition_mounts = set()
        if device:
            mount_parts = set(p for p in device.partitionlist
                          if hasattr(p, 'mountpoint') and p.mountpoint != '/')
            part_mountpoints = set(p.mountpoint for p in mount_parts)
            for part in mount_parts:
                if part.mountpoint not in existing_mounts:
                    part_uuid = self.get_uuid(device.location,
                                              part.extent.start *
                                              device.sector_size)
                    self.status(msg='Adding fstab entry for %s '
                                    'partition' % part.mountpoint)
                    fstab.add_line('UUID=%s  %s %s defaults,rw,noatime '
                                   '0 2' % (part_uuid, part.mountpoint,
                                            part.filesystem))
                else:
                    self.status(msg='WARNING: an entry already exists in '
                                    'fstab for %s partition, skipping' %
                                    part.mountpoint)

        # Add entries for state dirs
        state_dirs_to_create = set()
        for state_dir in shared_state_dirs:
            mp = '/' + state_dir
            if (mp not in existing_mounts and
                    (device and mp not in part_mountpoints)):
                state_dirs_to_create.add(state_dir)
                state_subvol = os.path.join('/state', state_dir)
                fstab.add_line(
                        '%s  /%s  btrfs subvol=%s,defaults,rw,noatime 0 2' %
                        (root_device, state_dir, state_subvol))

        fstab.write()
        return state_dirs_to_create

    def find_initramfs(self, temp_root):
        '''Check whether the rootfs has an initramfs.

        Uses the INITRAMFS_PATH option to locate it.
        '''
        if 'INITRAMFS_PATH' in os.environ:
            initramfs = os.path.join(temp_root, os.environ['INITRAMFS_PATH'])
            if not os.path.exists(initramfs):
                raise ExtensionError('INITRAMFS_PATH specified, '
                                     'but file does not exist')
            return initramfs
        return None

    def install_initramfs(self, initramfs_path, version_root):
        '''Install the initramfs outside of 'orig' or 'run' subvolumes.

        This is required because syslinux doesn't traverse subvolumes when
        loading the kernel or initramfs.
        '''
        self.status(msg='Installing initramfs')
        initramfs_dest = os.path.join(version_root, 'initramfs')
        subprocess.check_call(['cp', '-a', initramfs_path, initramfs_dest])

    def install_kernel(self, version_root, temp_root):
        '''Install the kernel outside of 'orig' or 'run' subvolumes'''

        self.status(msg='Installing kernel')
        image_names = ['vmlinuz', 'zImage', 'uImage']
        kernel_dest = os.path.join(version_root, 'kernel')
        for name in image_names:
            try_path = os.path.join(temp_root, 'boot', name)
            if os.path.exists(try_path):
                subprocess.check_call(['cp', '-a', try_path, kernel_dest])
                break

    def install_dtb(self, version_root, temp_root):
        '''Install the device tree outside of 'orig' or 'run' subvolumes'''

        self.status(msg='Installing devicetree')
        device_tree_path = self.get_dtb_path()
        dtb_dest = os.path.join(version_root, 'dtb')
        try_path = os.path.join(temp_root, device_tree_path)
        if os.path.exists(try_path):
            subprocess.check_call(['cp', '-a', try_path, dtb_dest])
        else:
            logging.error("Failed to find device tree %s", device_tree_path)
            raise ExtensionError(
                'Failed to find device tree %s' % device_tree_path)

    def get_dtb_path(self):
        return os.environ.get('DTB_PATH', '')

    def get_bootloader_install(self):
        # Do we actually want to install the bootloader?
        # Set this to "none" to prevent the install
        return os.environ.get('BOOTLOADER_INSTALL', 'extlinux')

    def get_bootloader_config_format(self):
        # The config format for the bootloader,
        # if not set we default to extlinux for x86
        return os.environ.get('BOOTLOADER_CONFIG_FORMAT', 'extlinux')

    def get_extra_kernel_args(self):
        return os.environ.get('KERNEL_ARGS', '')

    def get_root_device(self):
        return os.environ.get('ROOT_DEVICE', '/dev/sda')

    def generate_bootloader_config(self, *args, **kwargs):
        '''Install extlinux on the newly created disk image.'''
        config_function_dict = {
            'extlinux': self.generate_extlinux_config,
        }

        config_type = self.get_bootloader_config_format()
        if config_type in config_function_dict:
            config_function_dict[config_type](*args, **kwargs)
        else:
            raise ExtensionError(
                'Invalid BOOTLOADER_CONFIG_FORMAT %s' % config_type)

    def generate_extlinux_config(self, real_root,
                                 rootfs_uuid=None,
                                 disk_uuid=None, root_partition=False):
        '''Generate the extlinux configuration file

        Args:
            real_root: Path to the mounted top level of the root filesystem
            rootfs_uuid: Specify a filesystem UUID which can be loaded using
                         an initramfs
            disk_uuid: Disk UUID, can be used without an initramfs
            root_partition: Partition number of the boot partition if using
                            disk_uuid
        '''

        self.status(msg='Creating extlinux.conf')
        config = os.path.join(real_root, 'extlinux.conf')

        ''' Please also update the documentation in the following files
            if you change these default kernel args:
            - kvm.write.help
            - rawdisk.write.help
            - virtualbox-ssh.write.help '''
        kernel_args = (
            'rw ' # ro ought to work, but we don't test that regularly
            'init=/sbin/init ' # default, but it doesn't hurt to be explicit
            'rootfstype=btrfs ' # required when using initramfs, also boots
                                # faster when specified without initramfs
            'rootflags=subvol=systems/default/run ') # boot runtime subvol

        if rootfs_uuid:
            root_device = 'UUID=%s' % rootfs_uuid
        elif disk_uuid:
            root_device = 'PARTUUID=%s-%02d' % (disk_uuid, root_partition)
        else:
            # Fall back to the root partition named in the cluster
            root_device = '%s%d' % (self.get_root_device(), root_partition)
        kernel_args += 'root=%s ' % root_device

        kernel_args += self.get_extra_kernel_args()
        with open(config, 'w') as f:
            f.write('default linux\n')
            f.write('timeout 1\n')
            f.write('label linux\n')
            f.write('kernel /systems/default/kernel\n')
            if rootfs_uuid is not None:
                f.write('initrd /systems/default/initramfs\n')
            if self.get_dtb_path() != '':
                f.write('devicetree /systems/default/dtb\n')
            f.write('append %s\n' % kernel_args)

    def install_bootloader(self, *args):
        install_function_dict = {
            'extlinux': self.install_bootloader_extlinux,
        }

        install_type = self.get_bootloader_install()
        if install_type in install_function_dict:
            install_function_dict[install_type](*args)
        elif install_type != 'none':
            raise ExtensionError(
                'Invalid BOOTLOADER_INSTALL %s' % install_type)

    def install_bootloader_extlinux(self, real_root, orig_root, location):
        self.status(msg='Installing extlinux')
        subprocess.check_call(['extlinux', '--install', real_root])

        # FIXME this hack seems to be necessary to let extlinux finish
        subprocess.check_call(['sync'])
        time.sleep(2)

        # Install Syslinux MBR blob
        self.status(msg='Installing syslinux MBR blob')
        mbr_blob_location = os.path.join(orig_root,
                            'usr/share/syslinux/mbr.bin')
        subprocess.check_call(['dd', 'if=%s' % mbr_blob_location,
                                     'of=%s' % location,
                                     'bs=440', 'count=1', 'conv=notrunc'])

    def install_syslinux_menu(self, real_root, version_root):
        '''Make syslinux/extlinux menu binary available.

        The syslinux boot menu is compiled to a file named menu.c32. Extlinux
        searches a few places for this file but it does not know to look inside
        our subvolume, so we copy it to the filesystem root.

        If the file is not available, the bootloader will still work but will
        not be able to show a menu.

        '''
        menu_file = os.path.join(version_root, 'orig',
            'usr', 'share', 'syslinux', 'menu.c32')
        if os.path.isfile(menu_file):
            self.status(msg='Copying menu.c32')
            shutil.copy(menu_file, real_root)

    def parse_attach_disks(self):
        '''Parse $ATTACH_DISKS into list of disks to attach.'''

        if 'ATTACH_DISKS' in os.environ:
            s = os.environ['ATTACH_DISKS']
            return s.split(':')
        else:
            return []

    def bootloader_config_is_wanted(self):
        '''Does the user want to generate a bootloader config?

        The user may set $BOOTLOADER_CONFIG_FORMAT to the desired
        format. 'extlinux' is the only allowed value, and is the default
        value for x86-32 and x86-64.

        '''

        def is_x86(arch):
            return (arch == 'x86_64' or
                    (arch.startswith('i') and arch.endswith('86')))

        value = os.environ.get('BOOTLOADER_CONFIG_FORMAT', '')
        if value == '':
            if not is_x86(os.uname()[-1]):
                return False

        return True

    def get_environment_boolean(self, variable):
        '''Parse a yes/no boolean passed through the environment.'''

        value = os.environ.get(variable, 'no').lower()
        if value in ['no', '0', 'false']:
            return False
        elif value in ['yes', '1', 'true']:
            return True
        else:
            raise ExtensionError('Unexpected value for %s: %s' %
                                 (variable, value))

    def check_ssh_connectivity(self, ssh_host):
        try:
            output = ssh_runcmd(ssh_host, ['echo', 'test'])
        except ExtensionError as e:
            logging.error("Error checking SSH connectivity: %s", str(e))
            raise ExtensionError(
                'Unable to SSH to %s: %s' % (ssh_host, e))

        if output.strip() != 'test':
            raise ExtensionError(
                'Unexpected output from remote machine: %s' % output.strip())

    def is_device(self, location):
        try:
            st = os.stat(location)
            return stat.S_ISBLK(st.st_mode)
        except OSError as e:
            if e.errno == errno.ENOENT:
                return False
            raise

    def create_partitioned_system(self, temp_root, location):
        '''Create a Baserock system in a partitioned disk image or device'''

        part_spec = os.environ.get('PARTITION_FILE', 'partitioning/default')

        disk_size = self.get_disk_size()
        if not disk_size:
            raise writeexts.ExtensionError('DISK_SIZE is not defined')

        dev = partitioning.do_partitioning(location, disk_size,
                                           temp_root, part_spec)

        for part in dev.partitionlist:
            if not hasattr(part, 'mountpoint'):
                continue
            if part.mountpoint == '/':
                # Re-format the rootfs, to include needed extra features
                with pyfdisk.create_loopback(location,
                                             part.extent.start *
                                             dev.sector_size, part.size) as l:
                    self.mkfs_btrfs(l)

            self.status(msg='Mounting partition %d' % part.number)
            offset = part.extent.start * dev.sector_size
            with self.mount_partition(location, offset) as part_mount_dir:
                if part.mountpoint == '/':
                    # Install system
                    root_uuid = self.get_uuid(location, part.extent.start *
                                              dev.sector_size)
                    self.create_btrfs_system_layout(temp_root, part_mount_dir,
                                                    'factory', root_uuid, dev)
                else:
                    # Copy files to partition from unpacked rootfs
                    src_dir = os.path.join(temp_root,
                                           re.sub('^/', '', part.mountpoint))
                    self.status(msg='Copying files for %s partition' %
                                     part.mountpoint)
                    self.move_or_copy_dir(src_dir, part_mount_dir, copy=True)

            # Write raw files
            if hasattr(dev, 'raw_files'):
                partitioning.write_raw_files(location, temp_root, dev)
            for part in dev.partitionlist:
                if hasattr(part, 'raw_files'):
                    # dd seek is used, which skips n blocks before writing,
                    # so we must skip n-1 sectors before writing in order to
                    # start writing files to the first block of the partition
                    partitioning.write_raw_files(location, temp_root, part,
                                                 (part.extent.start - 1) *
                                                 dev.sector_size)

    @contextlib.contextmanager
    def mount_partition(self, location, offset_bytes):
        """Mount a partition in a partitioned device or image"""
        with pyfdisk.create_loopback(location, offset=offset_bytes) as loop:
            with self.mount(loop) as mountpoint:
                yield mountpoint

    @contextlib.contextmanager
    def find_and_mount_rootfs(self, location):
        """Find a Baserock rootfs in a partitioned device or image"""
        sector_size = pyfdisk.get_sector_size(location)
        for offset in pyfdisk.get_disk_offsets(location):
            with self.mount_partition(location, offset * sector_size) as mp:
                path = os.path.join(mp, 'systems/default/orig/baserock')
                if os.path.exists(path):
                    self.status(msg='Found a Baserock rootfs at '
                                    'offset %d sectors/%d bytes' %
                                     (offset, offset * sector_size))
                    yield mp