Merge pull request #84 from annabaas/feature/sqlserver

tillahoffmann · web-flow · commit 1eecf3691846 · 2020-04-28T10:15:51.000+01:00
Feature/sqlserver
diff --git a/.travis.yml b/.travis.yml
@@ -7,6 +7,9 @@ services:
 
 addons:
     chrome: "stable"
+    apt:
+      packages:
+        - unixodbc-dev # required for pyodbc
 
 language: python
 python:
@@ -18,6 +21,12 @@ python:
 install:
   - pip install -r requirements/$TRAVIS_PYTHON_VERSION.txt
 
+before_script: # add the mssql driver for xenial
+  - curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
+  - curl https://packages.microsoft.com/config/ubuntu/16.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list
+  - sudo apt-get -qq update
+  - sudo ACCEPT_EULA=Y apt-get -y install msodbcsql17
+
 script:
   - flake8
   - py.test -sv --cov-config .coveragerc --cov-report html:skip-covered --cov-report term:skip-covered --cov=testcontainers --tb=short tests/
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ Currently available features:
 * MariaDb container
 * OracleDb container
 * PostgreSQL Db container
+* Microsoft SQL Server container
 * Generic docker containers
 
 ### Quick start
diff --git a/docs/database.rst b/docs/database.rst
@@ -63,7 +63,7 @@ Necessary to use it:
 
 - ``cx_Oracle``
 - `Oracle client libraries <https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html>`_
-=======
+
 ::
 
     hostname: localhost
@@ -112,4 +112,18 @@ Example of MongoDb database usage:
                 print(document)
 
 Connection is made using pymongo package and MongoClient class.
-Alternatively, you can use get_connection_url method to use the driver that better fits for your use case.
+Alternatively, you can use get_connection_url method to use the driver that better fits for your use case.
+
+Microsoft SQL Server
+--------------------
+
+::
+
+    mssql = SqlServerContainer()
+
+    with mssql:
+        e = sqlalchemy.create_engine(mssql.get_connection_url())
+        result = e.execute("select @@VERSION")
+
+It uses the Microsoft-provided Docker image and requires `ODBC Driver 17 for SQL Server
+<https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server>`_.
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,7 @@ Currently available features:
 - Google Cloud PubSub emulator container
 - Elasticsearch container
 - MongoDb container
+- MS SQL Server container
 - Generic Docker containers
 
 Installation
@@ -35,6 +36,7 @@ and can be installed using pip, depending on which containers you need:
    pip install testcontainers[selenium]
    pip install testcontainers[google-cloud-pubsub]
    pip install testcontainers[mongodb]
+   pip install testcontainers[mssqlserver]
    # or with multiple
    pip install testcontainers[mysql,postgresql,selenium,google-cloud-pubsub]
 
diff --git a/requirements.in b/requirements.in
@@ -1,4 +1,4 @@
--e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis]
+-e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver]
 codecov
 flake8
 pytest
diff --git a/requirements/3.5.txt b/requirements/3.5.txt
@@ -38,6 +38,7 @@ mccabe==0.6.1             # via flake8
 more-itertools==8.2.0     # via pytest
 packaging==20.1           # via pytest
 paramiko==2.7.1           # via docker
+pathlib2==2.3.5           # via pytest
 pluggy==0.13.1            # via pytest
 protobuf==3.11.3          # via google-api-core, googleapis-common-protos
 psycopg2-binary==2.8.4    # via testcontainers
@@ -50,6 +51,7 @@ pyflakes==2.1.1           # via flake8
 pymongo==3.10.1           # via testcontainers
 pymysql==0.9.3            # via testcontainers
 pynacl==1.3.0             # via paramiko
+pyodbc==4.0.30            # via testcontainers
 pyparsing==2.4.6          # via packaging
 pyrsistent==0.15.7        # via jsonschema
 pytest-cov==2.8.1         # via -r requirements.in
@@ -60,7 +62,7 @@ redis==3.4.1              # via testcontainers
 requests==2.23.0          # via codecov, docker, docker-compose, google-api-core
 rsa==4.0                  # via google-auth
 selenium==3.141.0         # via testcontainers
-six==1.14.0               # via bcrypt, cryptography, docker, docker-compose, dockerpty, google-api-core, google-auth, grpcio, jsonschema, packaging, protobuf, pynacl, pyrsistent, websocket-client
+six==1.14.0               # via bcrypt, cryptography, docker, docker-compose, dockerpty, google-api-core, google-auth, grpcio, jsonschema, packaging, pathlib2, protobuf, pynacl, pyrsistent, websocket-client
 sqlalchemy==1.3.13        # via testcontainers
 texttable==1.6.2          # via docker-compose
 urllib3==1.25.8           # via requests, selenium
diff --git a/requirements/3.6.txt b/requirements/3.6.txt
@@ -50,6 +50,7 @@ pyflakes==2.1.1           # via flake8
 pymongo==3.10.1           # via testcontainers
 pymysql==0.9.3            # via testcontainers
 pynacl==1.3.0             # via paramiko
+pyodbc==4.0.30            # via testcontainers
 pyparsing==2.4.6          # via packaging
 pyrsistent==0.15.7        # via jsonschema
 pytest-cov==2.8.1         # via -r requirements.in
diff --git a/requirements/3.7.txt b/requirements/3.7.txt
@@ -50,6 +50,7 @@ pyflakes==2.1.1           # via flake8
 pymongo==3.10.1           # via testcontainers
 pymysql==0.9.3            # via testcontainers
 pynacl==1.3.0             # via paramiko
+pyodbc==4.0.30            # via testcontainers
 pyparsing==2.4.6          # via packaging
 pyrsistent==0.15.7        # via jsonschema
 pytest-cov==2.8.1         # via -r requirements.in
diff --git a/requirements/3.8.txt b/requirements/3.8.txt
@@ -49,6 +49,7 @@ pyflakes==2.1.1           # via flake8
 pymongo==3.10.1           # via testcontainers
 pymysql==0.9.3            # via testcontainers
 pynacl==1.3.0             # via paramiko
+pyodbc==4.0.30            # via testcontainers
 pyparsing==2.4.6          # via packaging
 pyrsistent==0.15.7        # via jsonschema
 pytest-cov==2.8.1         # via -r requirements.in
diff --git a/setup.py b/setup.py
@@ -55,7 +55,8 @@
         'selenium': ['selenium'],
         'google-cloud-pubsub': ['google-cloud-pubsub'],
         'mongo': ['pymongo'],
-        'redis': ['redis']
+        'redis': ['redis'],
+        'mssqlserver': ['pyodbc']
     },
     long_description_content_type="text/markdown",
     long_description=long_description,
diff --git a/testcontainers/mssql.py b/testcontainers/mssql.py
@@ -0,0 +1,38 @@
+from os import environ
+
+from testcontainers.core.generic import DbContainer
+
+
+class SqlServerContainer(DbContainer):
+    SQLSERVER_PASSWORD = environ.get("SQLSERVER_PASSWORD", "1Secure*Password1")
+
+    def __init__(self, image="mcr.microsoft.com/mssql/server:2019-latest", user="SA", password=None,
+                 port=1433, dbname="tempdb", driver="ODBC Driver 17 for SQL Server"):
+        super(SqlServerContainer, self).__init__(image)
+
+        self.SQLSERVER_PASSWORD = password or self.SQLSERVER_PASSWORD
+        self.port_to_expose = port
+        self.SQLSERVER_USER = user
+        self.SQLSERVER_DBNAME = dbname
+        self.SQLSERVER_DRIVER = driver
+
+        self.with_exposed_ports(self.port_to_expose)
+        self.ACCEPT_EULA = 'Y'
+        self.MSSQL_PID = 'Developer'
+
+    def _configure(self):
+        self.with_env("SA_PASSWORD", self.SQLSERVER_PASSWORD)
+        self.with_env("SQLSERVER_USER", self.SQLSERVER_USER)
+        self.with_env("SQLSERVER_DBNAME", self.SQLSERVER_DBNAME)
+        self.with_env("ACCEPT_EULA", self.ACCEPT_EULA)
+        self.with_env("MSSQL_PID", self.MSSQL_PID)
+        self.with_env("SQLSERVER_DRIVER", self.SQLSERVER_DRIVER)
+
+    def get_connection_url(self):
+        standard_url = super()._create_connection_url(dialect="mssql+pyodbc",
+                                                      username=self.SQLSERVER_USER,
+                                                      password=self.SQLSERVER_PASSWORD,
+                                                      db_name=self.SQLSERVER_DBNAME,
+                                                      port=self.port_to_expose)
+
+        return standard_url + "?driver=" + self.SQLSERVER_DRIVER
diff --git a/tests/test_db_containers.py b/tests/test_db_containers.py
@@ -4,6 +4,7 @@
 
 from testcontainers.core.generic import GenericContainer
 from testcontainers.core.waiting_utils import wait_for
+from testcontainers.mssql import SqlServerContainer
 from testcontainers.mysql import MySqlContainer, MariaDbContainer
 from testcontainers.oracle import OracleDbContainer
 from testcontainers.postgres import PostgresContainer
@@ -100,3 +101,19 @@ def connect():
         cursor = db.restaurants.find({"borough": "Manhattan"})
         for document in cursor:
             print(document)
+
+
+def test_docker_run_mssql():
+    config = SqlServerContainer()
+    with config as mssql:
+        e = sqlalchemy.create_engine(mssql.get_connection_url())
+        result = e.execute('select @@servicename')
+        for row in result:
+            assert row[0] == 'MSSQLSERVER'
+
+    config = SqlServerContainer(password="1Secure*Password2")
+    with config as mssql:
+        e = sqlalchemy.create_engine(mssql.get_connection_url())
+        result = e.execute('select @@servicename')
+        for row in result:
+            assert row[0] == 'MSSQLSERVER'

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,mongo,redis]`
	`1`	`+-e file:.[docker-compose,mysql,oracle,postgresql,selenium,google-cloud-pubsub,mongo,redis,mssqlserver]`
`2`	`2`	`codecov`
`3`	`3`	`flake8`
`4`	`4`	`pytest`