Rework tests to run against an etcd cluster

A new utility class `EtcdCluster` is added to manage the lifecycle of
a etcd cluster run in containers.
This class replaces the methods in `docker_cli` and `etcd_go_cli`.

A set of fixtures(`etcd_cluster`, `etcd_cluster_ssl`, `client` and
`io_client` manages the lifecycle of the test resources.

All the tests are set to run using the `BaseClient`'s `endpoint` parameter,
additional tests have been added to test `host` and `port`.

Author: dariko

requirements_dev.txt

@@ -19,3 +19,4 @@ m2r==0.2.1
 codecov>=1.4.0
 codacy-coverage==1.3.11
 twine==1.13.0
+docker==3.7.0

tests/conftest.py

@@ -0,0 +1,90 @@
+from etcd3.client import Client
+from etcd3 import AioClient
+import pytest
+from .etcd_cluster import EtcdTestCluster
+
+
+@pytest.fixture(scope='session')
+def etcd_cluster(request):
+    # function_name = request.function.__name__
+    # function_name = re.sub(r"[^a-zA-Z0-9]+", "", function_name)
+    cluster = EtcdTestCluster(ident='cleartext', size=3)
+
+    def fin():
+        cluster.down()
+    request.addfinalizer(fin)
+    cluster.up()
+
+    return cluster
+
+
+@pytest.fixture(scope='session')
+def etcd_cluster_ssl(request):
+    # function_name = request.function.__name__
+    # function_name = re.sub(r"[^a-zA-Z0-9]+", "", function_name)
+    cluster = EtcdTestCluster(ident='ssl', size=3, ssl=True)
+
+    def fin():
+        cluster.down()
+    request.addfinalizer(fin)
+    cluster.up()
+
+    return cluster
+
+
+@pytest.fixture(scope='module')
+def client(etcd_cluster):
+    """
+    init Etcd3Client, close its connection-pool when teardown
+    """
+    # _, p, _ = docker_run_etcd_main()
+    c = Client(endpoints=etcd_cluster.get_endpoints(),
+               protocol='https' if etcd_cluster.ssl else 'http')
+    yield c
+    c.close()
+
+
+@pytest.fixture
+def clear(etcd_cluster):
+    def _clear():
+        etcd_cluster.etcdctl('del --from-key ""')
+    return _clear
+
+
+@pytest.fixture
+async def aio_client(event_loop, request, etcd_cluster):
+    """
+    init Etcd3Client, close its connection-pool when teardown
+    """
+
+    c = AioClient(endpoints=etcd_cluster.get_endpoints(),
+                  protocol='https' if etcd_cluster.ssl else 'http')
+
+    def teardown():
+        async def _t():
+            await c.close()
+
+        event_loop.run_until_complete(_t())
+        event_loop._close()
+
+    request.addfinalizer(teardown)
+    return c
+
+
+def teardown_auth(etcd_cluster):  # pragma: no cover
+    """
+    disable auth, delete all users and roles
+    """
+    etcd_cluster.etcdctl('--user root:root auth disable')
+    etcd_cluster.etcdctl('--user root:changed auth disable')
+    for i in (etcd_cluster.etcdctl('role list') or '').splitlines():
+        etcd_cluster.etcdctl('role delete %s' % i)
+    for i in (etcd_cluster.etcdctl('user list') or '').splitlines():
+        etcd_cluster.etcdctl('user delete %s' % i)
+
+
+def enable_auth(etcd_cluster):  # pragma: no cover
+    etcd_cluster.etcdctl('user add root:root')
+    etcd_cluster.etcdctl('role add root')
+    etcd_cluster.etcdctl('user grant root root')
+    etcd_cluster.etcdctl('auth enable')

tests/docker_cli.py

@@ -1,20 +1,31 @@
 import logging
 import os
-from six.moves.urllib_parse import urlparse
 
 logging.basicConfig(format='%(name)s %(levelname)s - %(message)s')
 log = logging.getLogger()
 log.setLevel(logging.DEBUG)
 handler = logging.StreamHandler()
 log.addHandler(handler)
 
-ETCD_ENDPOINT = os.getenv('ETCD_ENDPOINT') or 'http://localhost:2379'
-_url = urlparse(ETCD_ENDPOINT)
+ETCD_VER = os.getenv('ETCD_VER') or 'v3.3.0'
 
-protocol = _url.scheme
+ETCD_IMG = 'quay.io/coreos/etcd:' + ETCD_VER
 
-host, port = _url.netloc.split(':')
+DOCKER_PUBLISH_HOST = '127.0.0.1'
 
-ETCD_VER = os.getenv('ETCD_VER') or 'v3.3.0'
 
-ETCD_IMG = 'quay.io/coreos/etcd:' + ETCD_VER
+CERTS_DIR = os.path.join(os.path.dirname(__file__), 'certs')
+CA_PATH = os.path.join(CERTS_DIR, 'ca.pem')
+CERT_PATH = os.path.join(CERTS_DIR, 'client.pem')
+KEY_PATH = os.path.join(CERTS_DIR, 'client-key.pem')
+SERVER_CA_PATH = '/certs/ca.pem'
+SERVER_CERT_PATH = '/certs/server.pem'
+SERVER_KEY_PATH = '/certs/server-key.pem'
+
+NO_DOCKER_SERVICE = True
+try:  # pragma: no cover
+    import docker  # noqa
+    NO_DOCKER_SERVICE = False
+except ImportError as e:  # pragma: no cover
+    print("docker library not found")
+    print(e)