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
|
# python3
# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Container definitions."""
import contextlib
import logging
import pydoc
import types
from typing import Tuple
import docker
import docker.errors
from benchmarks import workloads
class Container:
"""Abstract container.
Must be a context manager.
Usage:
with Container(client, image, ...):
...
"""
def run(self, **env) -> str:
"""Run the container synchronously."""
raise NotImplementedError
def detach(self, **env):
"""Run the container asynchronously."""
raise NotImplementedError
def address(self) -> Tuple[str, int]:
"""Return the bound address for the container."""
raise NotImplementedError
def get_names(self) -> types.GeneratorType:
"""Return names of all containers."""
raise NotImplementedError
# pylint: disable=too-many-instance-attributes
class DockerContainer(Container):
"""Class that handles creating a docker container."""
# pylint: disable=too-many-arguments
def __init__(self,
client: docker.DockerClient,
host: str,
image: str,
count: int = 1,
runtime: str = "runc",
port: int = 0,
**kwargs):
"""Trys to setup "count" containers.
Args:
client: A docker client from dockerpy.
host: The host address the image is running on.
image: The name of the image to run.
count: The number of containers to setup.
runtime: The container runtime to use.
port: The port to reserve.
**kwargs: Additional container options.
"""
assert count >= 1
assert port == 0 or count == 1
self._client = client
self._host = host
self._containers = []
self._count = count
self._image = image
self._runtime = runtime
self._port = port
self._kwargs = kwargs
if port != 0:
self._ports = {"%d/tcp" % port: None}
else:
self._ports = {}
@contextlib.contextmanager
def detach(self, **env):
env = ["%s=%s" % (key, value) for (key, value) in env.items()]
# Start all containers.
for _ in range(self._count):
try:
# Start the container in a detached mode.
container = self._client.containers.run(
self._image,
detach=True,
remove=True,
runtime=self._runtime,
ports=self._ports,
environment=env,
**self._kwargs)
logging.info("Started detached container %s -> %s", self._image,
container.attrs["Id"])
self._containers.append(container)
except Exception as exc:
self._clean_containers()
raise exc
try:
# Wait for all containers to be up.
for container in self._containers:
while not container.attrs["State"]["Running"]:
container = self._client.containers.get(container.attrs["Id"])
yield self
finally:
self._clean_containers()
def address(self) -> Tuple[str, int]:
assert self._count == 1
assert self._port != 0
container = self._client.containers.get(self._containers[0].attrs["Id"])
port = container.attrs["NetworkSettings"]["Ports"][
"%d/tcp" % self._port][0]["HostPort"]
return (self._host, port)
def get_names(self) -> types.GeneratorType:
for container in self._containers:
yield container.name
def run(self, **env) -> str:
env = ["%s=%s" % (key, value) for (key, value) in env.items()]
return self._client.containers.run(
self._image,
runtime=self._runtime,
ports=self._ports,
remove=True,
environment=env,
**self._kwargs).decode("utf-8")
def _clean_containers(self):
"""Kills all containers."""
for container in self._containers:
try:
container.kill()
except docker.errors.NotFound:
pass
class MockContainer(Container):
"""Mock of Container."""
def __init__(self, workload: str):
self._workload = workload
def __enter__(self):
return self
def run(self, **env):
# Lookup sample data if any exists for the workload module. We use a
# well-defined test locate and a well-defined sample function.
mod = pydoc.locate(workloads.__name__ + "." + self._workload)
if hasattr(mod, "sample"):
return mod.sample(**env)
return "" # No output.
def address(self) -> Tuple[str, int]:
return ("example.com", 80)
def get_names(self) -> types.GeneratorType:
yield "mock"
@contextlib.contextmanager
def detach(self, **env):
yield self
|
