Changed how containers are supplied by fixture as discussed in pytest-docker-compose#8

Author: RmStorm

README.rst

@@ -1,5 +1,8 @@
 pytest-docker-compose
 =====================
+.. image:: https://circleci.com/gh/pytest-docker-compose/pytest-docker-compose/tree/master.svg?style=svg
+    :target: https://circleci.com/gh/pytest-docker-compose/pytest-docker-compose/tree/master
+
 This package contains a `pytest`_ plugin for integrating Docker Compose into your automated integration tests.
 
 Given a path to a ``docker-compose.yml`` file, it will automatically build the project at the start of the test run, bring the containers up before each test starts, and tear them down after each test ends.
@@ -38,10 +41,7 @@ See `Installing and Using Plugins`_ for more information.
 To interact with Docker containers in your tests, use the following fixtures:
 
 ``function_scoped_containers``
-    A dictionary of the Docker ``compose.container.Container`` objects
-    running during the test. These containers each have an extra attribute
-    called ``network_info`` added to them. This attribute has a list of
-    ``pytest_docker_compose.NetworkInfo`` objects.
+    An object that fetches containers of the Docker ``compose.container.Container`` objects running during the test. The containers are fetched using ``function_scoped_containers.get('service_name')`` These containers each have an extra attribute called ``network_info`` added to them. This attribute has a list of ``pytest_docker_compose.NetworkInfo`` objects.
 
     This information can be used to configure API clients and other objects that
     will connect to services exposed by the Docker containers in your tests.
@@ -103,7 +103,7 @@ Here's an example of a fixture called ``wait_for_api`` that waits for an HTTP se
                         status_forcelist=[500, 502, 503, 504])
         request_session.mount('http://', HTTPAdapter(max_retries=retries))
 
-        service = function_scoped_containers["my_network_my_api_service_1"].network_info[0]
+        service = function_scoped_containers.get("my_api_service").network_info[0]
         api_url = "http://%s:%s/" % (service.hostname, service.host_port)
         assert request_session.get(api_url)
         return request_session, api_url

src/pytest_docker_compose/__init__.py

@@ -160,11 +160,13 @@ def scoped_containers_fixture(docker_project: Project, request):
                 containers = docker_project.up()  # type: List[Container]
                 if not containers:
                     raise ValueError("`docker-compose` didn't launch any containers!")
+            else:
+                containers = docker_project.containers()
 
-            container_dict = ContainerDict(docker_project)
-            yield container_dict
+            container_fetcher = ContainerFetcher(docker_project)
+            yield container_fetcher
 
-            for container in sorted(container_dict.values(), key=lambda c: c.name):
+            for container in sorted(containers, key=lambda c: c.name):
                 header = "Logs from {name}:".format(name=container.name)
                 print(header, '\n', "=" * len(header))
                 print(container.logs(since=now).decode("utf-8", errors="replace")
@@ -182,28 +184,18 @@ def scoped_containers_fixture(docker_project: Project, request):
         return scoped_containers_fixture
 
 
-class ContainerDict(dict):
+class ContainerFetcher:
     """
-    A read-only dictionary that re-fetches containers from a docker-compose
-    project dynamically every time they are accessed.
+    A class that retrieves containers from the docker project and adds a
+    convenience wrapper for the available ports
     """
     def __init__(self, docker_project: Project) -> None:
-        super().__init__()
         self.docker_project = docker_project
-        for container in docker_project.containers():
-            super().__setitem__(container.name, container)
 
-    def __getitem__(self, key: str) -> Container:
-        container = [container for container in self.docker_project.containers()
-                     if container.name == key][0]
+    def get(self, key: str) -> Container:
+        container = self.docker_project.containers(service_names=[key])[0]
         container.network_info = create_network_info_for_container(container)
         return container
 
-    def __setitem__(self, k, v) -> None:
-        raise TypeError('ContainerDict does not allow item assignment')
-
-    def __delitem__(self, v) -> None:
-        raise TypeError('ContainerDict does not allow item deletion')
-
 
 plugin = DockerComposePlugin()

tests/pytest_docker_compose_tests/test_function_scoping_fixtures.py

@@ -16,7 +16,7 @@ def wait_for_api(function_scoped_containers):
                     status_forcelist=[500, 502, 503, 504])
     request_session.mount('http://', HTTPAdapter(max_retries=retries))
 
-    service = function_scoped_containers["my_network_my_api_service_1"].network_info[0]
+    service = function_scoped_containers.get("my_api_service").network_info[0]
     api_url = "http://%s:%s/" % (service.hostname, service.host_port)
     assert request_session.get(api_url)
     return request_session, api_url

tests/pytest_docker_compose_tests/test_module_scoping_fixtures.py

@@ -16,7 +16,7 @@ def wait_for_api(module_scoped_containers):
                     status_forcelist=[500, 502, 503, 504])
     request_session.mount('http://', HTTPAdapter(max_retries=retries))
 
-    service = module_scoped_containers["my_network_my_api_service_1"].network_info[0]
+    service = module_scoped_containers.get("my_api_service").network_info[0]
     api_url = "http://%s:%s/" % (service.hostname, service.host_port)
     assert request_session.get(api_url)
     return request_session, api_url

tests/pytest_docker_compose_tests/test_wrong_scoping.py

@@ -4,9 +4,9 @@
 
 @pytest.mark.should_fail
 def test_read_all_module(module_scoped_containers):
-    assert module_scoped_containers["my_network_my_api_service_1"].network_info[0]
+    assert module_scoped_containers.get("my_api_service").network_info[0]
 
 
 @pytest.mark.should_fail
 def test_read_all_function(function_scoped_containers):
-    assert function_scoped_containers["my_network_my_api_service_1"].network_info[0]
+    assert function_scoped_containers.get("my_api_service").network_info[0]