pvl/backup/mount.py
author Tero Marttila <terom@paivola.fi>
Fri, 02 Mar 2012 16:15:47 +0200
changeset 33 2de09042414f
parent 10 724a90bd77b5
child 69 468704db09c4
permissions -rw-r--r--
mount/rsync: use a tmpdir for mounting, not /mnt
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
"""
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
    Mount filesystems.
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     3
"""
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     4
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
from pvl.backup.invoke import command
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
import contextlib
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
     8
import os, os.path
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
import logging
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
    10
import tempfile
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
log = logging.getLogger('pvl.backup.mount')
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
class MountError (Exception) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
    pass
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    17
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    18
class Mount (object) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    19
    """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
        Trivial filesystem mounting
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
    """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    22
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    23
    MOUNT   = '/bin/mount'
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    24
    UMOUNT  = '/bin/umount'
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    25
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    26
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    27
    def __init__ (self, dev, mnt, readonly=False) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    28
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    29
            dev         - device path
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    30
            mnt         - mount path
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    31
            readonly    - mount readonly
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    32
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    33
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
        self.dev = dev
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
        self.mnt = mnt
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
        self.readonly = readonly
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
    @property
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
    def path (self) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
        return self.mnt
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
    def options (self) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    43
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    44
            Mount options as a comma-separated string.
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    45
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
        options = [
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    48
                ('ro' if self.readonly else None),
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
        ]
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
        return ','.join(option for option in options if option)
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
    def open (self) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
            Mount
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
        # check
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
        if not os.path.isdir(self.mnt) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
            raise MountError("Mountpoint is not a directory: {mnt}".format(mnt=self.mnt))
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
        if os.path.ismount(self.mnt) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
            raise MountError("Mountpoint is already mounted: {mnt}".format(mnt=self.mnt))
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
        if not os.path.exists(self.dev) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
            raise MountError("Device does not exist: {dev}".format(dev=self.dev))
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    67
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
        # mount
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
        command(self.MOUNT, self.dev, self.mnt, options=self.options())
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    70
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
    def close (self) :
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    73
            Un-mount
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
        """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    75
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
        # check
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
        if not os.path.ismount(self.mnt):
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
            raise MountError("Mountpoint is not mounted: {mnt}".format(mnt=self.mnt))
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    80
        # umount
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81
        command(self.UMOUNT, self.mnt)
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    82
10
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    83
    def __repr__ (self) :
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    84
        return "Mount(dev={dev}, mnt={mnt})".format(
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    85
                dev     = repr(self.dev),
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    86
                mnt     = repr(self.mnt),
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    87
        )
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    88
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    89
    def __str__ (self) :
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    90
        return self.mnt
724a90bd77b5 fixup __str__s
Tero Marttila <terom@paivola.fi>
parents: 5
diff changeset
    91
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    92
@contextlib.contextmanager
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
    93
def mount (dev, mnt=None, name_hint='tmp', **kwargs) :
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    94
    """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    95
        Use a temporary mount:
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    96
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
    97
        with mount('/dev/...', readonly=True) as mount:
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    98
            ...
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
    99
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   100
        Mounts at the given mountpoint path, or a tempdir
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   101
    """
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   102
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   103
    if mnt is None :
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   104
        mnt = tmpdir = tempfile.mkdtemp(suffix='.mnt', prefix=name_hint)
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   105
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   106
        log.debug("using tmp mnt: %s", tmpdir)
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   107
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   108
    else :
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   109
        tmpdir = None
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   110
        
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   111
    log.debug("mount: %s -> %s", dev, mnt)
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   112
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   113
    # with tempdir
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   114
    try :
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   115
        mount = Mount(dev, mnt, **kwargs)
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   116
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   117
        # open
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   118
        log.debug("open: %s", mount)
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   119
        mount.open()
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   120
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   121
        try :
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   122
            log.debug("got: %s", mount)
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   123
            yield mount
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   124
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   125
        finally:
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   126
            # cleanup
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   127
            log.debug("cleanup: %s", mount)
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   128
            mount.close()
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   129
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   130
    finally:
33
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   131
        if tmpdir :
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   132
            # cleanup
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   133
            log.debug("cleanup tmp mnt: %s", tmpdir)
2de09042414f mount/rsync: use a tmpdir for mounting, not /mnt
Tero Marttila <terom@paivola.fi>
parents: 10
diff changeset
   134
            os.rmdir(tmpdir)
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   135