test_docker.py 9.34 KB
Newer Older
André Anjos's avatar
André Anjos committed
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
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

###############################################################################
#                                                                             #
# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/           #
# Contact: beat.support@idiap.ch                                              #
#                                                                             #
# This file is part of the beat.core module of the BEAT platform.             #
#                                                                             #
# Commercial License Usage                                                    #
# Licensees holding valid commercial BEAT licenses may use this file in       #
# accordance with the terms contained in a written agreement between you      #
# and Idiap. For further information contact tto@idiap.ch                     #
#                                                                             #
# Alternatively, this file may be used under the terms of the GNU Affero      #
# Public License version 3 as published by the Free Software and appearing    #
# in the file LICENSE.AGPL included in the packaging of this file.            #
# The BEAT platform 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.                                        #
#                                                                             #
# You should have received a copy of the GNU Affero Public License along      #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
#                                                                             #
###############################################################################


"""Asynchronous process I/O with the Subprocess module
"""

import os
import sys
import time
35
import unittest
André Anjos's avatar
André Anjos committed
36
import pkg_resources
37
import time
André Anjos's avatar
André Anjos committed
38

39 40
import docker
import requests
André Anjos's avatar
André Anjos committed
41

42
from ..dock import Host
43
from . import tmp_prefix
44
from .utils import slow
André Anjos's avatar
André Anjos committed
45

46

47 48
class AsyncTest(unittest.TestCase):

Philip ABBET's avatar
Philip ABBET committed
49 50 51 52
    @classmethod
    def setUpClass(cls):
        cls.host = Host(raise_on_errors=False)
        cls.test_environment = cls.host.full_environment_name('Python 2.7')
53 54


Philip ABBET's avatar
Philip ABBET committed
55 56 57
    @classmethod
    def tearDownClass(cls):
        cls.host.teardown()
58 59


Philip ABBET's avatar
Philip ABBET committed
60 61 62
    def tearDown(self):
        self.host.teardown()
        assert not self.host.containers # All containers are gone
63 64


Philip ABBET's avatar
Philip ABBET committed
65 66
    @slow
    def test_echo(self):
67

Philip ABBET's avatar
Philip ABBET committed
68
        string = "hello, world"
69

Philip ABBET's avatar
Philip ABBET committed
70 71 72
        container = self.host.create_container('debian:8.4', ["echo", string])
        self.host.start(container)
        status = self.host.wait(container)
73

Philip ABBET's avatar
Philip ABBET committed
74 75 76
        self.assertEqual(status, 0)
        self.assertEqual(self.host.stdout(container), string + '\n')
        self.assertEqual(self.host.stderr(container), '')
77 78


Philip ABBET's avatar
Philip ABBET committed
79 80
    @slow
    def test_non_existing(self):
81

Philip ABBET's avatar
Philip ABBET committed
82
        container = self.host.create_container('debian:8.4', ["sdfsdfdsf329909092"])
83

84 85 86 87 88 89 90 91 92 93
        try:
            self.host.start(container)
        except Exception, e:
            # The type of the exception depends on the docker version...
            exc_type = type(e)
            exc_type_name = exc_type.__module__ + '.' + exc_type.__name__
            self.assertTrue((exc_type_name == 'docker.errors.APIError') or \
                            (exc_type_name == 'docker.errors.NotFound'))

        self.assertFalse(self.host.containers) # All containers are gone
94 95


Philip ABBET's avatar
Philip ABBET committed
96 97
    @slow
    def test_timeout(self):
98

Philip ABBET's avatar
Philip ABBET committed
99
        sleep_for = 100 # seconds
100

Philip ABBET's avatar
Philip ABBET committed
101 102
        container = self.host.create_container('debian:8.4', ["sleep", str(sleep_for)])
        self.host.start(container)
103

Philip ABBET's avatar
Philip ABBET committed
104 105 106 107 108
        try:
            retval = self.host.wait(container, timeout=0.5)
            assert False, "timeout never occurred after %d seconds" % sleep_for
        except requests.exceptions.ReadTimeout as e:
            self.assertEqual(self.host.status(container), 'running')
109

Philip ABBET's avatar
Philip ABBET committed
110
        self.host.kill(container)
111

Philip ABBET's avatar
Philip ABBET committed
112
        status = self.host.wait(container)
113

Philip ABBET's avatar
Philip ABBET committed
114 115 116 117
        self.assertEqual(self.host.status(container), 'exited')
        self.assertEqual(status, 137)
        self.assertEqual(self.host.stdout(container), '')
        self.assertEqual(self.host.stderr(container), '')
118 119


Philip ABBET's avatar
Philip ABBET committed
120 121
    @slow
    def test_does_not_timeout(self):
122

Philip ABBET's avatar
Philip ABBET committed
123
        sleep_for = 0.5 # seconds
124

Philip ABBET's avatar
Philip ABBET committed
125 126
        container = self.host.create_container('debian:8.4', ["sleep", str(sleep_for)])
        self.host.start(container)
127

Philip ABBET's avatar
Philip ABBET committed
128
        status = self.host.wait(container, timeout=5) # Should not timeout
129

Philip ABBET's avatar
Philip ABBET committed
130 131 132 133
        self.assertEqual(self.host.status(container), 'exited')
        self.assertEqual(status, 0)
        self.assertEqual(self.host.stdout(container), '')
        self.assertEqual(self.host.stderr(container), '')
134 135


Philip ABBET's avatar
Philip ABBET committed
136 137
    @slow
    def test_memory_limit(self):
138

Philip ABBET's avatar
Philip ABBET committed
139 140 141 142 143 144 145 146
        cmd = ['python', '-c', '; '.join([
            "print('Before')",
            "import sys; sys.stdout.flush()",
            "d = '0' * (10 * 1024 * 1024)",
            "import time; time.sleep(5)",
            "print('After')",
          ])
        ]
147

Philip ABBET's avatar
Philip ABBET committed
148 149
        container = self.host.create_container(self.test_environment, cmd)
        self.host.start(container, virtual_memory_in_megabytes=4)
150

Philip ABBET's avatar
Philip ABBET committed
151
        time.sleep(2)
152

Philip ABBET's avatar
Philip ABBET committed
153
        stats = self.host.statistics(container)
154

Philip ABBET's avatar
Philip ABBET committed
155
        status = self.host.wait(container)
156

Philip ABBET's avatar
Philip ABBET committed
157 158 159 160
        self.assertEqual(self.host.status(container), 'exited')
        self.assertEqual(status, 137)
        self.assertEqual(self.host.stdout(container).strip(), 'Before')
        self.assertEqual(self.host.stderr(container), '')
161 162


Philip ABBET's avatar
Philip ABBET committed
163 164
    @slow
    def test_memory_limit2(self):
165

Philip ABBET's avatar
Philip ABBET committed
166 167 168 169 170 171 172 173
        cmd = ['python', '-c', '; '.join([
            "print('Before')",
            "import sys; sys.stdout.flush()",
            "d = '0' * (10 * 1024 * 1024)",
            "import time; time.sleep(5)",
            "print('After')",
          ])
        ]
174

Philip ABBET's avatar
Philip ABBET committed
175 176
        container = self.host.create_container(self.test_environment, cmd)
        self.host.start(container, virtual_memory_in_megabytes=100)
177

Philip ABBET's avatar
Philip ABBET committed
178
        time.sleep(2)
179

Philip ABBET's avatar
Philip ABBET committed
180
        stats = self.host.statistics(container)
181

Philip ABBET's avatar
Philip ABBET committed
182
        status = self.host.wait(container)
183

Philip ABBET's avatar
Philip ABBET committed
184 185
        assert stats['memory']['percent'] > 10, 'Memory check failed, ' \
            '%d%% <= 10%%' % stats['memory']['percent']
186

Philip ABBET's avatar
Philip ABBET committed
187 188
        assert stats['memory']['percent'] < 15, 'Memory check failed, ' \
            '%d%% >= 15%%' % stats['memory']['percent']
189

Philip ABBET's avatar
Philip ABBET committed
190 191 192 193
        self.assertEqual(self.host.status(container), 'exited')
        self.assertEqual(status, 0)
        self.assertEqual(self.host.stdout(container).strip(), 'Before\nAfter')
        self.assertEqual(self.host.stderr(container), '')
194 195


Philip ABBET's avatar
Philip ABBET committed
196
    def _run_cpulimit(self, processes, max_cpu_percent, sleep_time):
197

Philip ABBET's avatar
Philip ABBET committed
198 199
        program = pkg_resources.resource_filename(__name__, 'cpu_stress.py')
        dst_name = os.path.join('/tmp', os.path.basename(program))
200

Philip ABBET's avatar
Philip ABBET committed
201 202
        container = self.host.create_container(self.test_environment,
                                               ['python', dst_name, str(processes)])
203

Philip ABBET's avatar
Philip ABBET committed
204
        container.copy_path(program, '/tmp')
205

Philip ABBET's avatar
Philip ABBET committed
206
        self.host.start(container, max_cpu_percent=max_cpu_percent)
207

Philip ABBET's avatar
Philip ABBET committed
208
        time.sleep(sleep_time)
209

Philip ABBET's avatar
Philip ABBET committed
210
        stats = self.host.statistics(container)
211

Philip ABBET's avatar
Philip ABBET committed
212
        self.assertEqual(self.host.status(container), 'running')
213

Philip ABBET's avatar
Philip ABBET committed
214 215 216
        percent = stats['cpu']['percent']
        assert percent < (1.1 * max_cpu_percent), \
               "%.2f%% is more than 20%% off the expected ceiling at %d%%!" % (percent, max_cpu_percent)
217

Philip ABBET's avatar
Philip ABBET committed
218 219 220
        # make sure nothing is there anymore
        self.host.kill(container)
        self.assertEqual(self.host.wait(container), 137)
221 222


Philip ABBET's avatar
Philip ABBET committed
223 224 225 226
    @slow
    def test_cpulimit_at_20percent(self):
        # runs 1 process that should consume at most 20% of the host CPU
        self._run_cpulimit(1, 20, 3)
227 228


Philip ABBET's avatar
Philip ABBET committed
229 230 231 232
    @slow
    def test_cpulimit_at_100percent(self):
        # runs 4 processes that should consume 50% of the host CPU
        self._run_cpulimit(4, 100, 3)
233 234 235 236 237



class HostTest(unittest.TestCase):

Philip ABBET's avatar
Philip ABBET committed
238 239
    def setUp(self):
        Host.images_cache = {}
240 241


Philip ABBET's avatar
Philip ABBET committed
242 243 244
    @slow
    def test_images_cache(self):
        self.assertEqual(len(Host.images_cache), 0)
245

Philip ABBET's avatar
Philip ABBET committed
246 247
        # Might take some time
        start = time.time()
248

Philip ABBET's avatar
Philip ABBET committed
249 250
        host = Host(raise_on_errors=False)
        host.teardown()
251

Philip ABBET's avatar
Philip ABBET committed
252
        stop = time.time()
253

Philip ABBET's avatar
Philip ABBET committed
254 255
        nb_images = len(Host.images_cache)
        self.assertTrue(nb_images > 0)
256

Philip ABBET's avatar
Philip ABBET committed
257
        self.assertTrue(stop - start > 2.0)
258

Philip ABBET's avatar
Philip ABBET committed
259 260
        # Should be instantaneous
        start = time.time()
261

Philip ABBET's avatar
Philip ABBET committed
262 263
        host = Host(raise_on_errors=False)
        host.teardown()
264

Philip ABBET's avatar
Philip ABBET committed
265
        stop = time.time()
266

Philip ABBET's avatar
Philip ABBET committed
267
        self.assertEqual(len(Host.images_cache), nb_images)
268

Philip ABBET's avatar
Philip ABBET committed
269
        self.assertTrue(stop - start < 1.0)
270 271


Philip ABBET's avatar
Philip ABBET committed
272 273 274
    @slow
    def test_images_cache_file(self):
        self.assertEqual(len(Host.images_cache), 0)
275

Philip ABBET's avatar
Philip ABBET committed
276 277
        # Might take some time
        start = time.time()
278

Philip ABBET's avatar
Philip ABBET committed
279 280 281
        host = Host(images_cache=os.path.join(tmp_prefix, 'images_cache.json'),
                    raise_on_errors=False)
        host.teardown()
282

Philip ABBET's avatar
Philip ABBET committed
283
        stop = time.time()
284

Philip ABBET's avatar
Philip ABBET committed
285 286
        nb_images = len(Host.images_cache)
        self.assertTrue(nb_images > 0)
287

Philip ABBET's avatar
Philip ABBET committed
288
        self.assertTrue(stop - start > 2.0)
289

Philip ABBET's avatar
Philip ABBET committed
290
        Host.images_cache = {}
291

Philip ABBET's avatar
Philip ABBET committed
292 293
        # Should be instantaneous
        start = time.time()
294

Philip ABBET's avatar
Philip ABBET committed
295 296 297
        host = Host(images_cache=os.path.join(tmp_prefix, 'images_cache.json'),
                    raise_on_errors=False)
        host.teardown()
298

Philip ABBET's avatar
Philip ABBET committed
299
        stop = time.time()
300

Philip ABBET's avatar
Philip ABBET committed
301
        self.assertEqual(len(Host.images_cache), nb_images)
302

Philip ABBET's avatar
Philip ABBET committed
303
        self.assertTrue(stop - start < 1.0)