summaryrefslogtreecommitdiff
path: root/tests/cloud_tests/platforms/lxd/instance.py
blob: 0d697c05faf82eabadab8ffec36d8572c1c61bd5 (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
# This file is part of cloud-init. See LICENSE file for license information.

"""Base LXD instance."""

import os
import shutil
from tempfile import mkdtemp

from ..instances import Instance


class LXDInstance(Instance):
    """LXD container backed instance."""

    platform_name = "lxd"

    def __init__(self, platform, name, properties, config, features,
                 pylxd_container):
        """Set up instance.

        @param platform: platform object
        @param name: hostname of instance
        @param properties: image properties
        @param config: image config
        @param features: supported feature flags
        """
        self._pylxd_container = pylxd_container
        super(LXDInstance, self).__init__(
            platform, name, properties, config, features)
        self.tmpd = mkdtemp(prefix="%s-%s" % (type(self).__name__, name))
        self._setup_console_log()

    @property
    def pylxd_container(self):
        """Property function."""
        self._pylxd_container.sync()
        return self._pylxd_container

    def _setup_console_log(self):
        logf = os.path.join(self.tmpd, "console.log")

        # doing this ensures we can read it. Otherwise it ends up root:root.
        with open(logf, "w") as fp:
            fp.write("# %s\n" % self.name)

        cfg = "lxc.console.logfile=%s" % logf
        orig = self._pylxd_container.config.get('raw.lxc', "")
        if orig:
            orig += "\n"
        self._pylxd_container.config['raw.lxc'] = orig + cfg
        self._pylxd_container.save()
        self._console_log_file = logf

    def _execute(self, command, stdin=None, env=None):
        if env is None:
            env = {}

        if stdin is not None:
            # pylxd does not support input to execute.
            # https://github.com/lxc/pylxd/issues/244
            #
            # The solution here is write a tmp file in the container
            # and then execute a shell that sets it standard in to
            # be from that file, removes it, and calls the comand.
            tmpf = self.tmpfile()
            self.write_data(tmpf, stdin)
            ncmd = 'exec <"{tmpf}"; rm -f "{tmpf}"; exec "$@"'
            command = (['sh', '-c', ncmd.format(tmpf=tmpf), 'stdinhack'] +
                       list(command))

        # ensure instance is running and execute the command
        self.start()
        # execute returns a ContainerExecuteResult, named tuple
        # (exit_code, stdout, stderr)
        res = self.pylxd_container.execute(command, environment=env)

        # get out, exit and err from pylxd return
        if not hasattr(res, 'exit_code'):
            # pylxd 2.1.3 and earlier only return out and err, no exit
            raise RuntimeError(
                "No 'exit_code' in pylxd.container.execute return.\n"
                "pylxd > 2.2 is required.")

        return res.stdout, res.stderr, res.exit_code

    def read_data(self, remote_path, decode=False):
        """Read data from instance filesystem.

        @param remote_path: path in instance
        @param decode: decode data before returning.
        @return_value: content of remote_path as bytes if 'decode' is False,
                       and as string if 'decode' is True.
        """
        data = self.pylxd_container.files.get(remote_path)
        return data.decode() if decode else data

    def write_data(self, remote_path, data):
        """Write data to instance filesystem.

        @param remote_path: path in instance
        @param data: data to write in bytes
        """
        self.pylxd_container.files.put(remote_path, data)

    def console_log(self):
        """Console log.

        @return_value: bytes of this instance’s console
        """
        if not os.path.exists(self._console_log_file):
            raise NotImplementedError(
                "Console log '%s' does not exist. If this is a remote "
                "lxc, then this is really NotImplementedError.  If it is "
                "A local lxc, then this is a RuntimeError."
                "https://github.com/lxc/lxd/issues/1129")
        with open(self._console_log_file, "rb") as fp:
            return fp.read()

    def reboot(self, wait=True):
        """Reboot instance."""
        self.shutdown(wait=wait)
        self.start(wait=wait)

    def shutdown(self, wait=True):
        """Shutdown instance."""
        if self.pylxd_container.status != 'Stopped':
            self.pylxd_container.stop(wait=wait)

    def start(self, wait=True, wait_for_cloud_init=False):
        """Start instance."""
        if self.pylxd_container.status != 'Running':
            self.pylxd_container.start(wait=wait)
            if wait:
                self._wait_for_system(wait_for_cloud_init)

    def freeze(self):
        """Freeze instance."""
        if self.pylxd_container.status != 'Frozen':
            self.pylxd_container.freeze(wait=True)

    def unfreeze(self):
        """Unfreeze instance."""
        if self.pylxd_container.status == 'Frozen':
            self.pylxd_container.unfreeze(wait=True)

    def destroy(self):
        """Clean up instance."""
        self.unfreeze()
        self.shutdown()
        self.pylxd_container.delete(wait=True)
        if self.platform.container_exists(self.name):
            raise OSError('container {} was not properly removed'
                          .format(self.name))
        shutil.rmtree(self.tmpd)
        super(LXDInstance, self).destroy()

# vi: ts=4 expandtab