Merge branch 'master' into mssql-exposed-ports

spicy-sauce · web-flow · commit c12cd9b0056b · 2023-01-01T10:41:20.000+02:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -67,6 +67,7 @@ jobs:
           - keycloak.py
           - arangodb.py
           - azurite.py
+          - opensearch.py
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
diff --git a/.gitignore b/.gitignore
@@ -70,3 +70,4 @@ venv
 .vscode/
 
 .DS_Store
+.python-version
diff --git a/README.rst b/README.rst
@@ -12,22 +12,28 @@ Python port for testcontainers-java that allows using docker containers for func
 
 Currently available features:
 
-* Selenium Grid containers
-* Selenium Standalone containers
-* MySql Db container
+* Generic docker container
+* ArangoDB container
+* Azurite container
+* ClickHouse container
+* ElasticSearch container
+* Kafka container
+* Keycloak container
+* LocalStack container
 * MariaDb container
+* Microsoft SQL Server container
+* Minio container
+* MongoDB container
+* MySql Db container
 * Neo4j container
+* NGINX container
+* OpenSearch container
 * OracleDb container
 * PostgreSQL Db container
-* ClickHouse container
-* Microsoft SQL Server container
-* Generic docker containers
-* ArangoDB container
-* LocalStack
-* RabbitMQ
-* Keycloak
-* Azurite container
-* Minio container
+* RabbitMQ container
+* Redis container
+* Selenium Grid container
+* Selenium Standalone container
 
 Installation
 ------------
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,4 +23,5 @@ Usage modes
    RabbitMQ container <rabbitmq>
    Redis container <redis>
    Minio container <minio>
+   OpenSearch container <opensearch>
 
diff --git a/docs/opensearch.rst b/docs/opensearch.rst
@@ -0,0 +1,6 @@
+OpenSearch
+===================
+
+Allows to spin up OpenSearch Container.
+
+.. autoclass:: testcontainers.opensearch.OpenSearchContainer
diff --git a/requirements.in b/requirements.in
@@ -1,4 +1,4 @@
--e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,minio,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse,keycloak,arangodb,azurite]
+-e file:.[docker-compose,mysql,oracle,opensearch,postgresql,selenium,google-cloud-pubsub,minio,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse,keycloak,arangodb,azurite]
 codecov>=2.1.0
 cryptography<37
 flake8<3.8.0  # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.
diff --git a/requirements/3.10.txt b/requirements/3.10.txt
@@ -40,6 +40,7 @@ certifi==2022.12.7
     # via
     #   minio
     #   msrest
+    #   opensearch-py
     #   requests
     #   selenium
 cffi==1.15.1
@@ -163,6 +164,8 @@ neo4j==5.3.0
     # via testcontainers
 oauthlib==3.2.2
     # via requests-oauthlib
+opensearch-py==2.0.1
+    # via testcontainers
 outcome==1.2.0
     # via trio
 packaging==22.0
@@ -258,6 +261,7 @@ requests==2.28.1
     #   docker-compose
     #   google-api-core
     #   msrest
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests-oauthlib
@@ -343,6 +347,7 @@ urllib3[socks]==1.26.13
     # via
     #   docker
     #   minio
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests
diff --git a/requirements/3.7.txt b/requirements/3.7.txt
@@ -46,6 +46,7 @@ certifi==2022.12.7
     # via
     #   minio
     #   msrest
+    #   opensearch-py
     #   requests
     #   selenium
 cffi==1.15.1
@@ -177,6 +178,8 @@ neo4j==5.3.0
     # via testcontainers
 oauthlib==3.2.2
     # via requests-oauthlib
+opensearch-py==2.0.1
+    # via testcontainers
 outcome==1.2.0
     # via trio
 packaging==22.0
@@ -272,6 +275,7 @@ requests==2.28.1
     #   docker-compose
     #   google-api-core
     #   msrest
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests-oauthlib
@@ -363,6 +367,7 @@ urllib3[socks]==1.26.13
     # via
     #   docker
     #   minio
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests
diff --git a/requirements/3.8.txt b/requirements/3.8.txt
@@ -44,6 +44,7 @@ certifi==2022.12.7
     # via
     #   minio
     #   msrest
+    #   opensearch-py
     #   requests
     #   selenium
 cffi==1.15.1
@@ -168,6 +169,8 @@ neo4j==5.3.0
     # via testcontainers
 oauthlib==3.2.2
     # via requests-oauthlib
+opensearch-py==2.0.1
+    # via testcontainers
 outcome==1.2.0
     # via trio
 packaging==22.0
@@ -263,6 +266,7 @@ requests==2.28.1
     #   docker-compose
     #   google-api-core
     #   msrest
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests-oauthlib
@@ -350,6 +354,7 @@ urllib3[socks]==1.26.13
     # via
     #   docker
     #   minio
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests
diff --git a/requirements/3.9.txt b/requirements/3.9.txt
@@ -40,6 +40,7 @@ certifi==2022.12.7
     # via
     #   minio
     #   msrest
+    #   opensearch-py
     #   requests
     #   selenium
 cffi==1.15.1
@@ -164,6 +165,8 @@ neo4j==5.3.0
     # via testcontainers
 oauthlib==3.2.2
     # via requests-oauthlib
+opensearch-py==2.0.1
+    # via testcontainers
 outcome==1.2.0
     # via trio
 packaging==22.0
@@ -259,6 +262,7 @@ requests==2.28.1
     #   docker-compose
     #   google-api-core
     #   msrest
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests-oauthlib
@@ -344,6 +348,7 @@ urllib3[socks]==1.26.13
     # via
     #   docker
     #   minio
+    #   opensearch-py
     #   python-arango
     #   python-keycloak
     #   requests
diff --git a/setup.py b/setup.py
@@ -72,6 +72,7 @@
         'keycloak': ['python-keycloak'],
         'arangodb': ['python-arango'],
         'azurite': ['azure-storage-blob'],
+        'opensearch': ['opensearch-py'],
     },
     long_description_content_type="text/x-rst",
     long_description=long_description,
diff --git a/testcontainers/opensearch.py b/testcontainers/opensearch.py
@@ -0,0 +1,105 @@
+from opensearchpy import OpenSearch
+from opensearchpy.exceptions import ConnectionError, TransportError
+
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.waiting_utils import wait_container_is_ready
+
+
+class OpenSearchContainer(DockerContainer):
+    """
+    The following example demonstrates how to create a new index in an OpenSearch container
+    and add a document to it. It also shows how to search within the created index. The refresh
+    step in between makes sure that the newly created document is available for search.
+
+    The method :code:`get_client` can be used to create a OpenSearch Python Client.
+    The method :code:`get_config` can be used to retrieve the host, port, user
+    and password of the container.
+
+    Example
+    -------
+    .. doctest::
+
+        >>> from testcontainers.opensearch import OpenSearchContainer
+
+        >>> with OpenSearchContainer() as opensearch:
+        ...   client = opensearch.get_client()
+        ...   creation_result = client.index(index="test", body={"test": "test"})
+        ...   refresh_result = client.indices.refresh(index="test")
+        ...   search_result = client.search(index="test", body={"query": {"match_all": {}}})
+    """
+
+    def __init__(
+        self,
+        image="opensearchproject/opensearch:2.4.0",
+        port_to_expose=9200,
+        security_enabled=False,
+        **kwargs,
+    ):
+        """
+        Args:
+            image (str, optional): The Docker image to use for the container.
+                                   Defaults to "opensearchproject/opensearch:2.4.0".
+            port_to_expose (int, optional): The port to expose on the container.
+                                            Defaults to 9200.
+            security_enabled (bool, optional): `False` disables the security plugin in OpenSearch.
+                                                Defaults to False.
+        """
+        super(OpenSearchContainer, self).__init__(image, **kwargs)
+        self.port_to_expose = port_to_expose
+        self.security_enabled = security_enabled
+
+        self.with_exposed_ports(self.port_to_expose)
+        self.with_env("discovery.type", "single-node")
+        self.with_env("plugins.security.disabled", "false" if security_enabled else "true")
+        if security_enabled:
+            self.with_env("plugins.security.allow_default_init_securityindex", "true")
+
+    def get_config(self):
+        """This method returns the configuration of the OpenSearch container,
+        including the host, port, user, and password.
+
+        Returns:
+            dict: {`host`: str, `port`: str, `user`: str, `password`: str}
+        """
+
+        return {
+            "host": self.get_container_host_ip(),
+            "port": self.get_exposed_port(self.port_to_expose),
+            "user": "admin",
+            "password": "admin",
+        }
+
+    def get_client(self, verify_certs: bool = False, **kwargs) -> OpenSearch:
+        """Returns a OpenSearch client to connect to the container.
+
+        Returns:
+            OpenSearch: Python OpenSearch Client according to
+                   https://opensearch.org/docs/latest/clients/python/
+        """
+        config = self.get_config()
+        return OpenSearch(
+            hosts=[
+                {
+                    "host": config["host"],
+                    "port": config["port"],
+                }
+            ],
+            http_auth=(config["user"], config["password"]),
+            use_ssl=self.security_enabled,
+            verify_certs=verify_certs,
+            **kwargs,
+        )
+
+    @wait_container_is_ready(ConnectionError, TransportError)
+    def _healthcheck(self):
+        """This is an internal method used to check if the OpenSearch container
+        is healthy and ready to receive requests."""
+        client: OpenSearchContainer = self.get_client()
+        client.cluster.health(wait_for_status="green")
+
+    def start(self):
+        """This method starts the OpenSearch container and runs the healthcheck
+        to verify that the container is ready to use."""
+        super().start()
+        self._healthcheck()
+        return self
diff --git a/tests/test_opensearch.py b/tests/test_opensearch.py
@@ -0,0 +1,36 @@
+from testcontainers.opensearch import OpenSearchContainer
+
+
+def test_docker_run_opensearch():
+    with OpenSearchContainer() as opensearch:
+        client = opensearch.get_client()
+        assert client.cluster.health()["status"] == "green"
+
+
+def test_docker_run_opensearch_with_security():
+    with OpenSearchContainer(security_enabled=True) as opensearch:
+        client = opensearch.get_client()
+        assert client.cluster.health()["status"] == "green"
+
+
+def test_docker_run_opensearch_v1():
+    with OpenSearchContainer(image="opensearchproject/opensearch:1.3.6") as opensearch:
+        client = opensearch.get_client()
+        assert client.cluster.health()["status"] == "green"
+
+
+def test_docker_run_opensearch_v1_with_security():
+    with OpenSearchContainer(
+        image="opensearchproject/opensearch:1.3.6", security_enabled=True
+    ) as opensearch:
+        client = opensearch.get_client()
+        assert client.cluster.health()["status"] == "green"
+
+
+def test_search():
+    with OpenSearchContainer() as opensearch:
+        client = opensearch.get_client()
+        client.index(index="test", body={"test": "test"})
+        client.indices.refresh(index="test")
+        result = client.search(index="test", body={"query": {"match_all": {}}})
+        assert result["hits"]["total"]["value"] == 1

Original file line number	Diff line number	Diff line change
`@@ -70,3 +70,4 @@ venv`
`70`	`70`	`.vscode/`
`71`	`71`
`72`	`72`	`.DS_Store`
	`73`	`+.python-version`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`--e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,minio,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse,keycloak,arangodb,azurite]`
	`1`	`+-e file:.[docker-compose,mysql,oracle,opensearch,postgresql,selenium,google-cloud-pubsub,minio,mongo,redis,mssqlserver,neo4j,kafka,rabbitmq,clickhouse,keycloak,arangodb,azurite]`
`2`	`2`	`codecov>=2.1.0`
`3`	`3`	`cryptography<37`
`4`	`4`	`flake8<3.8.0 # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.`