From e694075c7fdcc9c4579d55b792da7a1391401b35 Mon Sep 17 00:00:00 2001 From: Sander Vrijders Date: Tue, 27 Mar 2018 16:40:59 +0200 Subject: testbeds, prototypes, model: Add docstrings This adds docstrings for methods of in the testbeds, prototypes and certain things in the model. --- rumba/testbeds/dockertb.py | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'rumba/testbeds/dockertb.py') diff --git a/rumba/testbeds/dockertb.py b/rumba/testbeds/dockertb.py index d018f8c..6d7c7b5 100644 --- a/rumba/testbeds/dockertb.py +++ b/rumba/testbeds/dockertb.py @@ -36,8 +36,19 @@ from rumba.executors.docker import DockerExecutor logger = log.get_logger(__name__) class Testbed(mod.Testbed): + """ + Represents a docker testbed. + """ def __init__(self, exp_name, base_image, pull_image=True, use_ovs=False): + """ + Initializes the testbed class. + + :param exp_name: The experiment name. + :param base_image: The docker base image. + :param pull_image: Retrieve the docker image from the Docker hub? + :param use_ovs: Use the OVS switch instead of the Linux bridge? + """ mod.Testbed.__init__(self, exp_name, "", "", "") img = base_image.rsplit(":", 1) @@ -159,7 +170,7 @@ class Testbed(mod.Testbed): logger.info("Experiment swapped in") - def swap_out(self, experiment): + def _swap_out(self, experiment): for name, container in self.running_containers.items(): container.remove(force=True) @@ -184,4 +195,4 @@ class Testbed(mod.Testbed): self.running_containers = {} - logger.info("Experiment swapped out") \ No newline at end of file + logger.info("Experiment swapped out") -- cgit v1.2.3