summaryrefslogtreecommitdiff
path: root/tests/cloud_tests/images/base.py
blob: 394b11ff7c43ce462f6abdf4edcd68d74bb5bbb0 (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
# This file is part of cloud-init. See LICENSE file for license information.


class Image(object):
    """
    Base class for images
    """
    platform_name = None

    def __init__(self, name, config, platform):
        """
        setup
        """
        self.name = name
        self.config = config
        self.platform = platform

    def __str__(self):
        """
        a brief description of the image
        """
        return '-'.join((self.properties['os'], self.properties['release']))

    @property
    def properties(self):
        """
        {} containing: 'arch', 'os', 'version', 'release'
        """
        raise NotImplementedError

    # FIXME: instead of having execute and push_file and other instance methods
    #        here which pass through to a hidden instance, it might be better
    #        to expose an instance that the image can be modified through
    def execute(self, command, stdin=None, stdout=None, stderr=None, env={}):
        """
        execute command in image, modifying image
        """
        raise NotImplementedError

    def push_file(self, local_path, remote_path):
        """
        copy file at 'local_path' to instance at 'remote_path', modifying image
        """
        raise NotImplementedError

    def run_script(self, script):
        """
        run script in image, modifying image
        return_value: script output
        """
        raise NotImplementedError

    def snapshot(self):
        """
        create snapshot of image, block until done
        """
        raise NotImplementedError

    def destroy(self):
        """
        clean up data associated with image
        """
        pass

# vi: ts=4 expandtab