Adding tests (#2)

adding tests

Author: valentin-gauthier-geosiris

.gitignore

@@ -41,3 +41,7 @@ dask-worker-space
 # Example for local test
 example/
 utils/
+
+# Other files
+requirements.txt
+doc/

README.md

@@ -58,8 +58,19 @@ simply run
 ```
 to have pre-commit install the new version.
 
-To bump a new version of the project simply run: 
+To bump a new version of the project simply publish a release name 'vX.X.X' with X replaced by your numbers
+
+Test
+----------
+
+Run tests with poetry
 ```console
-    poetry version [patch, minor, major]
+poetry run pytest -v --cache-clear -rf --cov=etpproto/ --cov-report=term --cov-report=html --maxfail=10
 ```
-You must choose between the semver rules [patch, minor, major]
+
+Test the code validity : 
+```console
+poetry run black .
+poetry run flake8 .
+poetry run mypy etpproto
+```

etpproto/client_info.py

@@ -1,5 +1,7 @@
 from typing import Any, ClassVar, Dict, Union
 
+from dataclasses import dataclass, field
+
 from etptypes.energistics.etp.v12.protocol.core.open_session import OpenSession
 from etptypes.energistics.etp.v12.protocol.core.request_session import (
     RequestSession,
@@ -8,25 +10,22 @@
 from etpproto.endpoint_capability_kind import kind_from_name
 
 
+@dataclass
 class ClientInfo:
     count_instance: ClassVar[int] = 0
 
-    endpoint_capabilities: Dict[str, Any] = {}
-
-    def __init__(
-        self,
-        ip: str = "0.0.0.0",
-        login: str = "anonymousUser",
-        endpoint_capabilities: Dict[str, Any] = {
+    endpoint_capabilities: Dict[str, Any] = field(
+        default_factory=lambda: {
             "MaxWebSocketFramePayloadSize": 10000,
             "MaxWebSocketMessagePayloadSize": 10000,
-        },
-    ):
+        }
+    )
+    login: str = field(default="anonymousUser")
+    ip: str = field(default="0.0.0.0")
+
+    def __post_init__(self):
         self._id = self.count_instance
         ClientInfo.count_instance = ClientInfo.count_instance + 1
-        self.ip = ip
-        self.login = login
-        self.endpoint_capabilities = endpoint_capabilities
 
     def getCapability(self, name: str) -> Any:
         if name in self.endpoint_capabilities:
@@ -52,6 +51,7 @@ def negotiate(self, msg: Union[OpenSession, RequestSession]):
                     val = max(val, cap_class._min)
                 if cap_class._max is not None:
                     val = min(val, cap_class._max)
+
             self.endpoint_capabilities[k] = val
 
         print("Negotiated capa : ", self.endpoint_capabilities)

etpproto/connection.py

@@ -141,13 +141,13 @@ class ETPConnection:
     # \____/\__,_/\___/_/ /_/\___/  / .___/\____/\__,_/_/     /_/\___/____/   \____/_/ /_/\__,_/_/ /_/_/|_/____/  /_/ /_/ /_/\___/____/____/\__,_/\__, /\___/
     #                              /_/                                                                                                           /____/
 
-    chunk_msg_cache: ClassVar[dict] = field(
-        default={}
-    )  #: Dict[int, Message] = field(default_factory={})
+    chunk_msg_cache: Dict[int, List[Message]] = field(
+        default_factory=lambda: {}
+    )
 
-    error_msg_cache: ClassVar[dict] = field(
-        default={}
-    )  #: Dict[int, List[Optional[Message]]] = field(default_factory={})
+    error_msg_cache: Dict[int, List[Optional[Message]]] = field(
+        default_factory=lambda: {}
+    )
 
     client_info: ClientInfo = field(default=ClientInfo())
 

etpproto/endpoint_capability_kind.py

@@ -234,7 +234,7 @@ class SupportsAlternateRequestUris(EndpointCapabilityKind):
 
     _default = False
     _unit = None
-    value: Optional[int] = field(default=False)
+    value: Optional[bool] = field(default=False)
 
 
 @dataclass
@@ -245,7 +245,7 @@ class SupportsMessageHeaderExtensions(EndpointCapabilityKind):
 
     _default = False
     _unit = None
-    value: Optional[int] = field(default=False)
+    value: Optional[bool] = field(default=False)
 
 
 def kind_from_name(classname):

etpproto/messages.py

@@ -388,15 +388,19 @@ def decode_binary_message(
                     return_record_name_override=True,
                 )
 
+                print("HEADER", recMH, flush=True)
+
                 print(
                     "classmethod decode_binary_message", object_res, flush=True
                 )
+                print(" ==> object_class ", object_class)
 
                 return Message(
                     mh.MessageHeader.parse_obj(recMH),
                     object_class.parse_obj(object_res),
                 )
-            except Exception:
+            except Exception as e:
+                print(e)
                 # error, now we try to read it as an error, because error has now the protocol of the message send by the clien
                 # try:
                 object_class = dict_map_pro_to_class["0"][
@@ -486,34 +490,6 @@ def decode_binary_message(
     )
 
 
-# Ecrit un message complet a partir d'un objet ETP dans un BytesIO
-# Retourne le nouveau msg_id
-def write_etp_message(
-    bio: BytesIO,
-    msg_id: int,
-    etp_object: ETPModel,
-    message_flags: int = 0,
-) -> int:
-    header_schema = json.loads(avro_schema(mh.MessageHeader))
-    objSchema = json.loads(avro_schema(type(etp_object)))
-
-    header = mh.MessageHeader(
-        protocol=int(objSchema["protocol"]),
-        messageType=int(objSchema["messageType"]),
-        correlationId=0,
-        messageId=msg_id,
-        messageFlags=message_flags,
-    )
-
-    objectDict = etp_object.dict(by_alias=True)
-
-    print("write_etp_message", objectDict, flush=True)
-
-    schemaless_writer(bio, header_schema, header.dict(by_alias=True))
-    schemaless_writer(bio, objSchema, objectDict)
-    return msg_id + 1
-
-
 # When calling thins function we are supposed to have only one entry in the data_objects map/list
 async def _encode_message_generator_chunk(
     chunkable_msg: Message,

etpproto/uri.py

@@ -76,7 +76,7 @@ def validate(uri: str) -> bool:
         return re.match(CANONICAL_DATA_OBJECT_URIS, uri) is not None
 
 
-def findUuid(input: str) -> Optional[str]:
+def find_uuid(input: str) -> Optional[str]:
     p = re.compile(UUID_REGEX)
     result = p.search(input)
     if result is not None:

poetry.lock

@@ -15,19 +15,36 @@ maintainers = [
 ]
 license = "Apache-2.0"
 readme = "README.md"
-repository = "https://github.com/bp/resqpy"
+repository = "https://github.com/geosiris-technologies/etpproto-python"
 homepage = "http://www.geosiris.com"
 classifiers = [
-    "Programming Language :: Python :: 3.9",
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: Apache Software License",
     "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "Typing :: Typed",
 ]
 keywords = ["ETP"]
 
 [tool.poetry.dependencies]
 python = "^3.9,<3.11"
-fastavro = "1.5.3"
+fastavro = "^1.6.1"
 coverage = {extras = ["toml"], version = "^6.2"}
-etptypes = "^1.0.0"
+etptypes = "^1.0.1"
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.0.0"