Versioned api (#51)

* add swagger spec generator

* fix tests

* fix tests

* enhance tests for lock apis

* remove specs of version below 3.2.0

Author: Revolution1

.travis.yml

@@ -5,6 +5,7 @@ language: python
 cache: pip
 
 python:
+#  - 3.7
   - 3.6
   - 3.5
   - 2.7
@@ -20,7 +21,7 @@ services:
 env:
   matrix:
     - ETCD_VER=v3.2.20
-    - ETCD_VER=v3.3.0
+#    - ETCD_VER=v3.3.0
 #    - ETCD_VER=v3.3.4
 #    - ETCD_VER=v3.3.7
 #    - ETCD_VER=v3.3.9

Makefile

@@ -84,5 +84,8 @@ dist: clean ## builds source and wheel package
 	python setup.py bdist_wheel
 	ls -l dist
 
+upload: dist
+	twine upload dist/*
+
 install: clean ## install the package to the active Python's site-packages
 	python setup.py install

README.md

@@ -29,6 +29,7 @@ Notice: The authentication header through gRPC-JSON-Gateway only supported in [e
     * [x] Watch
     * [x] Cluster
     * [x] Lease
+    * [x] Lock
     * [x] Maintenance
     * [x] Extra APIs
 * [x] stateful utilities
@@ -159,6 +160,9 @@ docker run -d \
 
 ## TODO
 
+- [ ] human friendly middle level apis
+- [ ] able to expose json or raw response to user
+- [ ] add election api
 - [ ] benchmark
 - [ ] python-etcd(etcd v2) compatible client
 - [ ] etcd browser

docs/etcd3.apis.rst

@@ -38,6 +38,14 @@ etcd3\.apis\.lease
     :undoc-members:
     :show-inheritance:
 
+etcd3\.apis\.lock
+-------------------------
+
+.. automodule:: etcd3.apis.lock
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 etcd3\.apis\.maintenance
 -------------------------------
 

etcd3/aio_client.py

@@ -2,33 +2,36 @@
 asynchronous client
 """
 
-import aiohttp
 import json
-import six
 import ssl
 import warnings
+
+import aiohttp
+import six
 from aiohttp.client import _RequestContextManager
 
 from .baseclient import BaseClient
 from .baseclient import BaseModelizedStreamResponse
+from .baseclient import DEFAULT_VERSION
 from .errors import Etcd3Exception
 from .errors import Etcd3StreamError
 from .errors import get_client_error
 from .utils import iter_json_string, Etcd3Warning
 
 
 class ModelizedResponse(object):
-    def __init__(self, method, resp, decode=True):
+    def __init__(self, client, method, resp, decode=True):
+        self.client = client
         self._coro = resp
         self._method = method
         self._resp = None
         self._decode = decode
 
     async def __modelize(self):
         self._resp = await self._coro
-        await AioClient._raise_for_status(self._resp)
+        await self.client._raise_for_status(self._resp)
         data = await self._resp.json()
-        return AioClient._modelizeResponseData(self._method, data, self._decode)
+        return self.client._modelizeResponseData(self._method, data, self._decode)
 
     def __await__(self):
         return self.__modelize().__await__()
@@ -39,10 +42,11 @@ class ModelizedStreamResponse(BaseModelizedStreamResponse):
     Model of a stream response
     """
 
-    def __init__(self, method, resp, decode=True):
+    def __init__(self, client, method, resp, decode=True):
         """
         :param resp: aiohttp.ClientResponse
         """
+        self.client = client
         self.resp = resp
         self.decode = decode
         self.method = method
@@ -75,17 +79,20 @@ async def __aiter__(self):
     async def __anext__(self):
         if isinstance(self.resp, _RequestContextManager):
             self.resp = await self.resp
-            await AioClient._raise_for_status(self.resp)
+            await self.client._raise_for_status(self.resp)
         data = await self.resp_iter.next()
         data = json.loads(str(data, encoding='utf-8'))
         if data.get('error'):  # pragma: no cover
             # {"error":{"grpc_code":14,"http_code":503,"message":"rpc error: code = Unavailable desc = transport is closing","http_status":"Service Unavailable"}}
             err = data.get('error')
             raise get_client_error(err.get('message'), code=err.get('code'), status=err.get('http_code'))
-        return AioClient._modelizeResponseData(self.method, data, decode=self.decode)
+        r = self.client._modelizeResponseData(self.method, data, decode=self.decode)
+        if r.result:
+            r = r.result
+        return r
 
 
-class ResponseIter():
+class ResponseIter(object):
     """
     yield response content by every json object
     we don't yield by line, because the content of etcd's gRPC-JSON-Gateway stream response
@@ -126,14 +133,16 @@ async def next(self):
 
 
 class AioClient(BaseClient):
-    def __init__(self, host='localhost', port=2379, protocol='http',
+    def __init__(self, host='127.0.0.1', port=2379, protocol='http',
                  cert=(), verify=None,
                  timeout=None, headers=None, user_agent=None, pool_size=30,
-                 username=None, password=None, token=None):
+                 username=None, password=None, token=None,
+                 server_version=DEFAULT_VERSION, cluster_version=DEFAULT_VERSION):
         super(AioClient, self).__init__(host=host, port=port, protocol=protocol,
                                         cert=cert, verify=verify,
                                         timeout=timeout, headers=headers, user_agent=user_agent, pool_size=pool_size,
-                                        username=username, password=password, token=token)
+                                        username=username, password=password, token=token,
+                                        server_version=server_version, cluster_version=cluster_version)
         self.ssl_context = None
         if self.cert:
             if verify is False:
@@ -151,8 +160,7 @@ def __init__(self, host='localhost', port=2379, protocol='http',
             # the ssl problem is a pain in the ass, seems i can never get it right
             # https://github.com/requests/requests/issues/1847
             # https://stackoverflow.com/questions/44316292/ssl-sslerror-tlsv1-alert-protocol-version
-            self.ssl_context = ssl_context = ssl.SSLContext()
-            ssl_context.protocol = ssl.PROTOCOL_TLS
+            self.ssl_context = ssl_context = ssl.SSLContext(protocol=ssl.PROTOCOL_TLS)
             if not hasattr(ssl, 'PROTOCOL_TLSv1_1'):  # should support TLSv1.2 to pass the test
                 warnings.warn(Etcd3Warning("the openssl version of your python is too old to support TLSv1.1+,"
                                            "please upgrade you python"))
@@ -174,13 +182,11 @@ async def __aenter__(self):
     async def __aexit__(self, exc_type, exc_val, exc_tb):
         await self.close()
 
-    @classmethod
-    def _modelizeResponse(cls, method, resp, decode=True):
-        return ModelizedResponse(method, resp, decode)
+    def _modelizeResponse(self, method, resp, decode=True):
+        return ModelizedResponse(self, method, resp, decode)
 
-    @classmethod
-    def _modelizeStreamResponse(cls, method, resp, decode=True):
-        return ModelizedStreamResponse(method, resp, decode)
+    def _modelizeStreamResponse(self, method, resp, decode=True):
+        return ModelizedStreamResponse(self, method, resp, decode)
 
     def _get(self, url, **kwargs):
         r"""
@@ -212,7 +218,7 @@ async def _raise_for_status(resp):
         try:
             data = await resp.json()
         except Exception:
-            error = resp.content
+            error = resp._content or resp.reason
             code = 2
         else:
             error = data.get('error')

etcd3/apis/__init__.py

@@ -17,6 +17,6 @@
     'KVAPI',
     'MaintenanceAPI',
     'LeaseAPI',
-    'BaseAPI'
+    'BaseAPI',
     'LockAPI'
 ]

etcd3/apis/auth.py

@@ -13,7 +13,7 @@ def authenticate(self, name, password):
         :type password: str
         :param password: password of the user
         """
-        method = '/v3alpha/auth/authenticate'
+        method = '/auth/authenticate'
         data = {
             "name": name,
             "password": password
@@ -25,7 +25,7 @@ def auth_disable(self):
         AuthDisable disables authentication.
 
         """
-        method = '/v3alpha/auth/disable'
+        method = '/auth/disable'
         data = {}
         r = self.call_rpc(method, data=data)
         self.token = None  # clear local token
@@ -36,7 +36,7 @@ def auth_enable(self):
         AuthEnable enables authentication.
 
         """
-        method = '/v3alpha/auth/enable'
+        method = '/auth/enable'
         data = {}
         return self.call_rpc(method, data=data)
 
@@ -47,7 +47,7 @@ def role_add(self, name):
         :type name: str
         :param name: name is the name of the role to add to the authentication system.
         """
-        method = '/v3alpha/auth/role/add'
+        method = '/auth/role/add'
         data = {
             "name": name
         }
@@ -60,7 +60,7 @@ def role_delete(self, role):
         :type role: str
         :param role: None
         """
-        method = '/v3alpha/auth/role/delete'
+        method = '/auth/role/delete'
         data = {
             "role": role
         }
@@ -73,7 +73,7 @@ def role_get(self, role):
         :type role: str
         :param role: None
         """
-        method = '/v3alpha/auth/role/get'
+        method = '/auth/role/get'
         data = {
             "role": role
         }
@@ -102,7 +102,7 @@ def role_grant_permission(self, name, key=None, permType=authpbPermissionType.RE
         :type all: bool
         :param all: all the keys [default: False]
         """
-        method = '/v3alpha/auth/role/grant'
+        method = '/auth/role/grant'
         if all:
             key = range_end = '\0'
         if prefix:
@@ -122,7 +122,7 @@ def role_list(self):
         """
         RoleList gets lists of all roles.
         """
-        method = '/v3alpha/auth/role/list'
+        method = '/auth/role/list'
         data = {}
         return self.call_rpc(method, data=data)
 
@@ -146,7 +146,7 @@ def role_revoke_permission(self, role, key=None, range_end=None, prefix=False, a
         :type all: bool
         :param all: all the keys [default: False]
         """
-        method = '/v3alpha/auth/role/revoke'
+        method = '/auth/role/revoke'
         if all:
             key = range_end = '\0'
         if prefix:
@@ -168,7 +168,7 @@ def user_add(self, name, password):
         :type password: str
         :param password: password of the user
         """
-        method = '/v3alpha/auth/user/add'
+        method = '/auth/user/add'
         data = {
             "name": name,
             "password": password
@@ -184,7 +184,7 @@ def user_change_password(self, name, password):
         :type password: str
         :param password: password is the new password for the user.
         """
-        method = '/v3alpha/auth/user/changepw'
+        method = '/auth/user/changepw'
         data = {
             "name": name,
             "password": password
@@ -198,7 +198,7 @@ def user_delete(self, name):
         :type name: str
         :param name: name is the name of the user to delete.
         """
-        method = '/v3alpha/auth/user/delete'
+        method = '/auth/user/delete'
         data = {
             "name": name
         }
@@ -211,7 +211,7 @@ def user_get(self, name):
         :type name: str
         :param name: name is the name of the user to get.
         """
-        method = '/v3alpha/auth/user/get'
+        method = '/auth/user/get'
         data = {
             "name": name
         }
@@ -226,7 +226,7 @@ def user_grant_role(self, user, role):
         :type role: str
         :param role: role is the name of the role to grant to the user.
         """
-        method = '/v3alpha/auth/user/grant'
+        method = '/auth/user/grant'
         data = {
             "user": user,
             "role": role
@@ -237,7 +237,7 @@ def user_list(self):
         """
         UserList gets a list of all users.
         """
-        method = '/v3alpha/auth/user/list'
+        method = '/auth/user/list'
         data = {}
         return self.call_rpc(method, data=data)
 
@@ -250,7 +250,7 @@ def user_revoke_role(self, name, role):
         :type role: str
         :param role: role name
         """
-        method = '/v3alpha/auth/user/revoke'
+        method = '/auth/user/revoke'
         data = {
             "name": name,
             "role": role

etcd3/apis/base.py

@@ -1,9 +1,12 @@
 class BaseAPI(object):  # pragma: no cover
+    def __init__(self):
+        self.headers = {}
+
     @staticmethod
     def _raise_for_status(resp):
         raise NotImplementedError
 
-    def _url(self, method):
+    def _url(self, method, prefix=True):
         raise NotImplementedError
 
     def _get(self, url, **kwargs):

etcd3/apis/cluster.py

@@ -9,7 +9,7 @@ def member_add(self, peerURLs):
         :type peerURLs: list of str
         :param peerURLs: peerURLs is the list of URLs the added member will use to communicate with the cluster.
         """
-        method = '/v3alpha/cluster/member/add'
+        method = '/cluster/member/add'
         data = {
             "peerURLs": peerURLs
         }
@@ -20,7 +20,7 @@ def member_list(self):
         MemberList lists all the members in the cluster.
 
         """
-        method = '/v3alpha/cluster/member/list'
+        method = '/cluster/member/list'
         data = {}
         return self.call_rpc(method, data=data)
 
@@ -31,7 +31,7 @@ def member_remove(self, ID):
         :type ID: int
         :param ID: ID is the member ID of the member to remove.
         """
-        method = '/v3alpha/cluster/member/remove'
+        method = '/cluster/member/remove'
         data = {
             "ID": ID
         }
@@ -46,7 +46,7 @@ def member_update(self, ID, peerURLs):
         :type peerURLs: list of str
         :param peerURLs: peerURLs is the new list of URLs the member will use to communicate with the cluster.
         """
-        method = '/v3alpha/cluster/member/update'
+        method = '/cluster/member/update'
         data = {
             "ID": ID,
             "peerURLs": peerURLs