diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 57af3f4f2a9fe004d9825fab9028106e13ccac4d..463b1d56507cb970e5ec15e6fa90ce6adf3e123b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -57,9 +57,8 @@ mypy:
tags: [ docker ]
stage: linting
script:
- - pip install mypy types-PyYAML types-jsonschema types-requests types-setuptools types-lxml types-python-dateutil pytest
+ - pip install .[mypy,test]
- make mypy
- allow_failure: true
# run unit tests
unittest_py3.8:
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 270188c2231aa6222c7a1494ae738baa14323465..0544d70bfabff5a53bdd693d5acf21f738e26341 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,8 +18,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Removed ###
### Fixed ###
+
* [#89](https://gitlab.com/linkahead/linkahead-pylib/-/issues/89)
`to_xml` does not add `noscript` or `TransactionBenchmark` tags anymore
+* [#103](https://gitlab.com/linkahead/linkahead-pylib/-/issues/103)
+ `authentication/interface/on_response()` does not overwrite
+ `auth_token` if new value is `None`
### Security ###
@@ -51,7 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed ###
-* [gitlab.indiscale.com#200](https://gitlab.indiscale.com/caosdb/src/caosdb-pylib/-/merge_requests/153)
+* [gitlab.indiscale.com#200](https://gitlab.indiscale.com/caosdb/src/caosdb-pylib/-/issues/200)
``linkahead_admin.py`` prints reasonable error messages when users
or roles don't exist.
diff --git a/setup.py b/setup.py
index 7e3dfb93359978b18cdddb5783c6e2ef1fcd443a..daf36764ef043916bea44694bf0620505e6fcd9c 100755
--- a/setup.py
+++ b/setup.py
@@ -188,14 +188,24 @@ def setup_package():
'future',
],
extras_require={
- 'jsonschema': ['jsonschema>=4.4.0'],
- 'keyring': ['keyring>=13.0.0'],
+ "jsonschema": ["jsonschema>=4.4.0"],
+ "keyring": ["keyring>=13.0.0"],
+ "mypy": [
+ "mypy",
+ "types-PyYAML",
+ "types-jsonschema",
+ "types-requests",
+ "types-setuptools",
+ "types-lxml",
+ "types-python-dateutil",
+ ],
"test": [
"pytest",
"pytest-cov",
"coverage>=4.4.2",
"jsonschema>=4.4.0",
]
+
},
setup_requires=["pytest-runner>=2.0,<3dev"],
package_data={
diff --git a/src/linkahead/apiutils.py b/src/linkahead/apiutils.py
index 49336aa8db24fba663337185c5c37a346330c4cd..31e49aa9a25ea8a58a0cdf2b5e81f6c489a36b5f 100644
--- a/src/linkahead/apiutils.py
+++ b/src/linkahead/apiutils.py
@@ -275,9 +275,11 @@ def compare_entities(entity0: Optional[Entity] = None,
if entity1 is not None:
raise ValueError("You cannot use both entity1 and new_entity")
entity1 = new_entity
+ assert entity0 is not None
+ assert entity1 is not None
- diff: tuple = ({"properties": {}, "parents": []},
- {"properties": {}, "parents": []})
+ diff: tuple[dict[str, Any], dict[str, Any]] = ({"properties": {}, "parents": []},
+ {"properties": {}, "parents": []})
if entity0 is entity1:
return diff
@@ -550,9 +552,10 @@ def merge_entities(entity_a: Entity,
"""
# Compare both entities:
- diff_r1, diff_r2 = compare_entities(entity_a, entity_b,
- entity_name_id_equivalency=merge_id_with_resolved_entity,
- compare_referenced_records=merge_references_with_empty_diffs)
+ diff_r1, diff_r2 = compare_entities(
+ entity_a, entity_b,
+ entity_name_id_equivalency=merge_id_with_resolved_entity,
+ compare_referenced_records=merge_references_with_empty_diffs)
# Go through the comparison and try to apply changes to entity_a:
for key in diff_r2["parents"]:
diff --git a/src/linkahead/common/administration.py b/src/linkahead/common/administration.py
index 28ef107579fccb689b7337aed65e054cfbf36c05..9d9d4f013f1ad10cd0957cfb9a9e4f2f44bd6102 100644
--- a/src/linkahead/common/administration.py
+++ b/src/linkahead/common/administration.py
@@ -91,7 +91,7 @@ def get_server_properties() -> dict[str, Optional[str]]:
props: dict[str, Optional[str]] = dict()
for elem in xml.getroot():
- props[elem.tag] = elem.text
+ props[str(elem.tag)] = str(elem.text)
return props
@@ -156,7 +156,10 @@ def generate_password(length: int):
def _retrieve_user(name: str, realm: Optional[str] = None, **kwargs):
con = get_connection()
try:
- return con._http_request(method="GET", path="User/" + (realm + "/" + name if realm is not None else name), **kwargs).read()
+ return con._http_request(
+ method="GET",
+ path="User/" + (realm + "/" + name if realm is not None else name),
+ **kwargs).read()
except HTTPForbiddenError as e:
e.msg = "You are not permitted to retrieve this user."
raise
@@ -198,7 +201,9 @@ def _update_user(name: str,
if entity is not None:
params["entity"] = str(entity)
try:
- return con.put_form_data(entity_uri_segment="User/" + (realm + "/" + name if realm is not None else name), params=params, **kwargs).read()
+ return con.put_form_data(entity_uri_segment="User/" + (realm + "/" +
+ name if realm is not None else name),
+ params=params, **kwargs).read()
except HTTPResourceNotFoundError as e:
e.msg = "User does not exist."
raise e
@@ -246,7 +251,9 @@ def _insert_user(name: str,
def _insert_role(name, description, **kwargs):
con = get_connection()
try:
- return con.post_form_data(entity_uri_segment="Role", params={"role_name": name, "role_description": description}, **kwargs).read()
+ return con.post_form_data(entity_uri_segment="Role",
+ params={"role_name": name, "role_description": description},
+ **kwargs).read()
except HTTPForbiddenError as e:
e.msg = "You are not permitted to insert a new role."
raise
@@ -259,7 +266,9 @@ def _insert_role(name, description, **kwargs):
def _update_role(name, description, **kwargs):
con = get_connection()
try:
- return con.put_form_data(entity_uri_segment="Role/" + name, params={"role_description": description}, **kwargs).read()
+ return con.put_form_data(entity_uri_segment="Role/" + name,
+ params={"role_description": description},
+ **kwargs).read()
except HTTPForbiddenError as e:
e.msg = "You are not permitted to update this role."
raise
@@ -301,8 +310,10 @@ def _set_roles(username, roles, realm=None, **kwargs):
body = xml2str(xml)
con = get_connection()
try:
- body = con._http_request(method="PUT", path="UserRoles/" + (realm + "/" +
- username if realm is not None else username), body=body, **kwargs).read()
+ body = con._http_request(method="PUT",
+ path="UserRoles/" + (realm + "/" +
+ username if realm is not None else username),
+ body=body, **kwargs).read()
except HTTPForbiddenError as e:
e.msg = "You are not permitted to set this user's roles."
raise
@@ -369,7 +380,8 @@ def _set_permissions(role, permission_rules, **kwargs):
body = xml2str(xml)
con = get_connection()
try:
- return con._http_request(method="PUT", path="PermissionRules/" + role, body=body, **kwargs).read()
+ return con._http_request(method="PUT", path="PermissionRules/" + role, body=body,
+ **kwargs).read()
except HTTPForbiddenError as e:
e.msg = "You are not permitted to set this role's permissions."
raise
@@ -381,7 +393,9 @@ def _set_permissions(role, permission_rules, **kwargs):
def _get_permissions(role, **kwargs):
con = get_connection()
try:
- return PermissionRule._parse_body(con._http_request(method="GET", path="PermissionRules/" + role, **kwargs).read())
+ return PermissionRule._parse_body(con._http_request(method="GET",
+ path="PermissionRules/" + role,
+ **kwargs).read())
except HTTPForbiddenError as e:
e.msg = "You are not permitted to retrieve this role's permissions."
raise
@@ -429,7 +443,8 @@ class PermissionRule():
if permission is None:
raise ValueError(f"Permission is missing in PermissionRule xml: {elem}")
priority = PermissionRule._parse_boolean(elem.get("priority"))
- return PermissionRule(elem.tag, permission, priority if priority is not None else False)
+ return PermissionRule(str(elem.tag), permission,
+ priority if priority is not None else False)
@staticmethod
def _parse_body(body: str):
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 6204e1197840c4f7347697c91ecae90967e5e894..aff85556ce3bf13396b43444e68f81cd26606b9c 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -41,7 +41,6 @@ import warnings
from builtins import str
from copy import deepcopy
from datetime import date, datetime
-from enum import Enum
from functools import cmp_to_key
from hashlib import sha512
from os import listdir
@@ -1120,7 +1119,7 @@ class Entity:
else:
return getattr(ref, special_selector.lower())
- def get_property_values(self, *selectors):
+ def get_property_values(self, *selectors) -> tuple:
""" Return a tuple with the values described by the given selectors.
This represents an entity's properties as if it was a row of a table
@@ -1861,12 +1860,12 @@ class QueryTemplate():
@staticmethod
def _from_xml(xml: etree._Element):
- if xml.tag.lower() == "querytemplate":
+ if str(xml.tag).lower() == "querytemplate":
q = QueryTemplate(name=xml.get("name"),
description=xml.get("description"), query=None)
for e in xml:
- if e.tag.lower() == "query":
+ if str(e.tag).lower() == "query":
q.query = e.text
else:
child = _parse_single_xml_element(e)
@@ -1903,7 +1902,7 @@ class QueryTemplate():
ret = Messages()
for m in self.messages:
- if m.type.lower() == "error":
+ if str(m.type).lower() == "error":
ret.append(m)
return ret
@@ -2409,7 +2408,7 @@ class PropertyList(list):
This class provides addional functionality like get/set_importance or get_by_name.
"""
- def __init__(self):
+ def __init__(self) -> None:
super().__init__()
self._importance: dict[Entity, IMPORTANCE] = dict()
self._inheritance: dict[Entity, INHERITANCE] = dict()
@@ -2733,7 +2732,7 @@ class ParentList(list):
# by name
for e in self:
- if e.name is not None and e.name.lower() == parent.name.lower():
+ if e.name is not None and str(e.name).lower() == str(parent.name).lower():
list.remove(self, e)
return
@@ -4544,7 +4543,7 @@ class ACL():
return len(self._grants) + len(self._priority_grants) + \
len(self._priority_denials) + len(self._denials) == 0
- def clear(self):
+ def clear(self) -> None:
self._grants: set[ACI] = set()
self._denials: set[ACI] = set()
self._priority_grants: set[ACI] = set()
@@ -4886,7 +4885,7 @@ class Query():
self.etag = q.get("etag")
for m in q:
- if m.tag.lower() == 'warning' or m.tag.lower() == 'error':
+ if str(m.tag).lower() == 'warning' or str(m.tag).lower() == 'error':
self.messages.append(_parse_single_xml_element(m))
else:
self.q = q
@@ -5093,13 +5092,13 @@ class DropOffBox(list):
xml = etree.fromstring(body)
for child in xml:
- if child.tag.lower() == "stats":
+ if str(child.tag).lower() == "stats":
infoelem = child
break
for child in infoelem:
- if child.tag.lower() == "dropoffbox":
+ if str(child.tag).lower() == "dropoffbox":
dropoffboxelem = child
break
@@ -5148,7 +5147,7 @@ class Info():
"""
- def __init__(self):
+ def __init__(self) -> None:
self.messages = Messages()
self.user_info: Optional[UserInfo] = None
self.time_zone: Optional[TimeZone] = None
@@ -5274,36 +5273,36 @@ def _parse_single_xml_element(elem: etree._Element):
"entity": Entity,
}
- if elem.tag.lower() in classmap:
- klass = classmap.get(elem.tag.lower())
+ if str(elem.tag).lower() in classmap:
+ klass = classmap.get(str(elem.tag).lower())
if klass is None:
- raise LinkAheadException("No class for tag '{}' found.".format(elem.tag))
+ raise LinkAheadException("No class for tag '{}' found.".format(str(elem.tag)))
entity = klass()
Entity._from_xml(entity, elem)
return entity
- elif elem.tag.lower() == "version":
+ elif str(elem.tag).lower() == "version":
return Version.from_xml(elem)
- elif elem.tag.lower() == "state":
+ elif str(elem.tag).lower() == "state":
return State.from_xml(elem)
- elif elem.tag.lower() == "emptystring":
+ elif str(elem.tag).lower() == "emptystring":
return ""
- elif elem.tag.lower() == "value":
- if len(elem) == 1 and elem[0].tag.lower() == "emptystring":
+ elif str(elem.tag).lower() == "value":
+ if len(elem) == 1 and str(elem[0].tag).lower() == "emptystring":
return ""
- elif len(elem) == 1 and elem[0].tag.lower() in classmap:
+ elif len(elem) == 1 and str(elem[0].tag).lower() in classmap:
return _parse_single_xml_element(elem[0])
elif elem.text is None or elem.text.strip() == "":
return None
return str(elem.text.strip())
- elif elem.tag.lower() == "querytemplate":
+ elif str(elem.tag).lower() == "querytemplate":
return QueryTemplate._from_xml(elem)
- elif elem.tag.lower() == 'query':
+ elif str(elem.tag).lower() == 'query':
return Query(elem)
- elif elem.tag.lower() == 'history':
+ elif str(elem.tag).lower() == 'history':
return Message(type='History', description=elem.get("transaction"))
- elif elem.tag.lower() == 'stats':
+ elif str(elem.tag).lower() == 'stats':
counts = elem.find("counts")
if counts is None:
raise LinkAheadException("'stats' element without a 'count' found.")
@@ -5323,7 +5322,7 @@ def _parse_single_xml_element(elem: etree._Element):
else:
code = elem.get("code")
return Message(
- type=elem.tag,
+ type=str(elem.tag),
code=int(code) if code is not None else None,
description=elem.get("description"),
body=elem.text,
diff --git a/src/linkahead/common/state.py b/src/linkahead/common/state.py
index e352f82d9820620d1692cb6337eb218210e799e6..b708ca13cb0a648aa2ca00507f39a531e4f55d14 100644
--- a/src/linkahead/common/state.py
+++ b/src/linkahead/common/state.py
@@ -20,11 +20,11 @@
# ** end header
from __future__ import annotations # Can be removed with 3.10.
-import copy
-from lxml import etree
+import copy
from typing import TYPE_CHECKING
-import sys
+
+from lxml import etree
if TYPE_CHECKING:
from typing import Optional
@@ -87,7 +87,8 @@ class Transition:
return self._to_state
def __repr__(self):
- return f'Transition(name="{self.name}", from_state="{self.from_state}", to_state="{self.to_state}", description="{self.description}")'
+ return (f'Transition(name="{self.name}", from_state="{self.from_state}", '
+ f'to_state="{self.to_state}", description="{self.description}")')
def __eq__(self, other):
return (
@@ -103,9 +104,9 @@ class Transition:
@staticmethod
def from_xml(xml: etree._Element) -> "Transition":
to_state = [to.get("name")
- for to in xml if to.tag.lower() == "tostate"]
+ for to in xml if str(to.tag).lower() == "tostate"]
from_state = [
- from_.get("name") for from_ in xml if from_.tag.lower() == "fromstate"
+ from_.get("name") for from_ in xml if str(from_.tag).lower() == "fromstate"
]
return Transition(
name=xml.get("name"),
@@ -199,7 +200,7 @@ class State:
result._id = xml.get("id")
result._description = xml.get("description")
transitions = [
- Transition.from_xml(t) for t in xml if t.tag.lower() == "transition"
+ Transition.from_xml(t) for t in xml if str(t.tag).lower() == "transition"
]
if transitions:
result._transitions = set(transitions)
diff --git a/src/linkahead/common/versioning.py b/src/linkahead/common/versioning.py
index 11cf5f6904b02954eb0b2bddc16478590df167e7..1c2999df8174e239a470cfc637533c3c8c302c33 100644
--- a/src/linkahead/common/versioning.py
+++ b/src/linkahead/common/versioning.py
@@ -101,11 +101,14 @@ class Version():
# pylint: disable=redefined-builtin
def __init__(self, id: Optional[str] = None, date: Optional[str] = None,
username: Optional[str] = None, realm: Optional[str] = None,
- predecessors: Optional[List[Version]] = None, successors: Optional[List[Version]] = None,
+ predecessors: Optional[List[Version]] = None,
+ successors: Optional[List[Version]] = None,
is_head: Union[bool, str, None] = False,
is_complete_history: Union[bool, str, None] = False):
- """Typically the `predecessors` or `successors` should not "link back" to an existing Version
- object."""
+ """Typically the `predecessors` or `successors` should not "link back" to an existing
+ Version object.
+
+ """
self.id = id
self.date = date
self.username = username
@@ -205,8 +208,8 @@ class Version():
version : Version
a new version instance
"""
- predecessors = [Version.from_xml(p) for p in xml if p.tag.lower() == "predecessor"]
- successors = [Version.from_xml(s) for s in xml if s.tag.lower() == "successor"]
+ predecessors = [Version.from_xml(p) for p in xml if str(p.tag).lower() == "predecessor"]
+ successors = [Version.from_xml(s) for s in xml if str(s.tag).lower() == "successor"]
return Version(id=xml.get("id"), date=xml.get("date"),
is_head=xml.get("head"),
is_complete_history=xml.get("completeHistory"),
diff --git a/src/linkahead/connection/authentication/interface.py b/src/linkahead/connection/authentication/interface.py
index b48e27c08312bf1358d32a9a1203627a9d0007c2..8288880583dc58fc82ab03d371861f067406b3d3 100644
--- a/src/linkahead/connection/authentication/interface.py
+++ b/src/linkahead/connection/authentication/interface.py
@@ -125,8 +125,9 @@ class AbstractAuthenticator(ABC):
Returns
-------
"""
- self.auth_token = parse_auth_token(
- response.getheader("Set-Cookie"))
+ new_token = parse_auth_token(response.getheader("Set-Cookie"))
+ if new_token is not None:
+ self.auth_token = new_token
def on_request(self, method: str, path: str, headers: QueryDict, **kwargs):
# pylint: disable=unused-argument
@@ -190,7 +191,7 @@ class CredentialsAuthenticator(AbstractAuthenticator):
def _logout(self):
self.logger.debug("[LOGOUT]")
if self.auth_token is not None:
- self._connection.request(method="DELETE", path="logout")
+ self._connection.request(method="GET", path="logout")
self.auth_token = None
def _login(self):
diff --git a/src/linkahead/connection/connection.py b/src/linkahead/connection/connection.py
index c95134fed3fd6b031b01b518c6362bf3b371c960..4c40842a7eaf5bbf0e35c978e658d7b4494a58e7 100644
--- a/src/linkahead/connection/connection.py
+++ b/src/linkahead/connection/connection.py
@@ -83,8 +83,10 @@ class _WrappedHTTPResponse(CaosDBHTTPResponse):
return self.response.status_code
def read(self, size: Optional[int] = None):
+ # FIXME This function behaves unexpectedly if `size` is larger than in the first run.
+
if self._stream_consumed is True:
- raise RuntimeError("Stream is consumed")
+ raise BufferError("Stream is consumed")
if self._buffer is None:
# the buffer has been drained in the previous call.
@@ -97,14 +99,14 @@ class _WrappedHTTPResponse(CaosDBHTTPResponse):
return self.response.content
if size is None or size == 0:
- raise RuntimeError(
- "size parameter should not be None if the stream is not consumed yet")
+ raise BufferError(
+ "`size` parameter can not be None or zero once reading has started with a non-zero "
+ "value.")
if len(self._buffer) >= size:
# still enough bytes in the buffer
- # FIXME: `chunk`` is used before definition
- result = chunk[:size]
- self._buffer = chunk[size:]
+ result = self._buffer[:size]
+ self._buffer = self._buffer[size:]
return result
if self._generator is None:
@@ -116,16 +118,16 @@ class _WrappedHTTPResponse(CaosDBHTTPResponse):
try:
# read new data into the buffer
chunk = self._buffer + next(self._generator)
- result = chunk[:size]
+ result = chunk[:size] # FIXME what if `size` is larger than at `iter_content(size)`?
if len(result) == 0:
self._stream_consumed = True
self._buffer = chunk[size:]
return result
except StopIteration:
# drain buffer
- result = self._buffer
+ last_result = self._buffer
self._buffer = None
- return result
+ return last_result
def getheader(self, name: str, default=None):
return self.response.headers[name] if name in self.response.headers else default
@@ -218,7 +220,7 @@ class _DefaultCaosDBServerConnection(CaosDBServerConnection):
"Connection failed. Network or server down? " + str(conn_err)
)
- def configure(self, **config):
+ def configure(self, **config) -> None:
"""configure.
Configure the http connection.
@@ -551,9 +553,9 @@ class _Connection(object): # pylint: disable=useless-object-inheritance
__instance = None
- def __init__(self):
+ def __init__(self) -> None:
self._delegate_connection: Optional[CaosDBServerConnection] = None
- self._authenticator: Optional[CredentialsAuthenticator] = None
+ self._authenticator: Optional[AbstractAuthenticator] = None
self.is_configured = False
@classmethod
@@ -563,7 +565,7 @@ class _Connection(object): # pylint: disable=useless-object-inheritance
return cls.__instance
- def configure(self, **config):
+ def configure(self, **config) -> _Connection:
self.is_configured = True
if "implementation" not in config:
@@ -571,8 +573,7 @@ class _Connection(object): # pylint: disable=useless-object-inheritance
"Missing CaosDBServerConnection implementation. You did not "
"specify an `implementation` for the connection.")
try:
- self._delegate_connection: CaosDBServerConnection = config["implementation"](
- )
+ self._delegate_connection = config["implementation"]()
if not isinstance(self._delegate_connection,
CaosDBServerConnection):
@@ -762,6 +763,7 @@ class _Connection(object): # pylint: disable=useless-object-inheritance
if self._authenticator is None:
raise ValueError(
"No authenticator set. Please call configure_connection() first.")
+ assert isinstance(self._authenticator, CredentialsAuthenticator)
if self._authenticator._credentials_provider is None:
raise ValueError(
"No credentials provider set. Please call configure_connection() first.")
diff --git a/src/linkahead/connection/mockup.py b/src/linkahead/connection/mockup.py
index 9b69971c0409708f221c402f540fac85ff9c527e..d3bc13bb474a70d48446e8532607c3e11931ff05 100644
--- a/src/linkahead/connection/mockup.py
+++ b/src/linkahead/connection/mockup.py
@@ -75,7 +75,7 @@ class MockUpServerConnection(CaosDBServerConnection):
just returns predefined responses which mimic the LinkAhead server."""
def __init__(self):
- self.resources = [self._login]
+ self.resources = [self._login, self._logout]
def _login(self, method, path, headers, body):
if method == "POST" and path == "login":
@@ -84,6 +84,12 @@ class MockUpServerConnection(CaosDBServerConnection):
"mockup-auth-token"},
body="")
+ def _logout(self, method, path, headers, body):
+ if method in ["DELETE", "GET"] and path == "logout":
+ return MockUpResponse(200,
+ headers={},
+ body="")
+
def configure(self, **kwargs):
"""This configure method does nothing."""
diff --git a/src/linkahead/utils/git_utils.py b/src/linkahead/utils/git_utils.py
index 7a58272a3bef1930f75a1e08364349388e2bb89f..4824d619bfc77925add0c383f72360a644dd7833 100644
--- a/src/linkahead/utils/git_utils.py
+++ b/src/linkahead/utils/git_utils.py
@@ -36,9 +36,9 @@ logger = logging.getLogger(__name__)
def get_origin_url_in(folder: str):
"""return the Fetch URL of the git repository in the given folder."""
- with tempfile.NamedTemporaryFile(delete=False, mode="w") as t:
- call(["git", "remote", "show", "origin"], stdout=t, cwd=folder)
- with open(t.name, "r") as t:
+ with tempfile.NamedTemporaryFile(delete=False, mode="w", encoding="utf8") as tempf:
+ call(["git", "remote", "show", "origin"], stdout=tempf, cwd=folder)
+ with open(tempf.name, "r", encoding="utf8") as t:
urlString = "Fetch URL:"
for line in t.readlines():
@@ -63,9 +63,9 @@ def get_branch_in(folder: str):
The command "git branch" is called in the given folder and the
output is returned
"""
- with tempfile.NamedTemporaryFile(delete=False, mode="w") as t:
- call(["git", "rev-parse", "--abbrev-ref", "HEAD"], stdout=t, cwd=folder)
- with open(t.name, "r") as t:
+ with tempfile.NamedTemporaryFile(delete=False, mode="w") as tempf:
+ call(["git", "rev-parse", "--abbrev-ref", "HEAD"], stdout=tempf, cwd=folder)
+ with open(tempf.name, "r") as t:
return t.readline().strip()
@@ -76,7 +76,7 @@ def get_commit_in(folder: str):
and the output is returned
"""
- with tempfile.NamedTemporaryFile(delete=False, mode="w") as t:
- call(["git", "log", "-1", "--format=%h"], stdout=t, cwd=folder)
- with open(t.name, "r") as t:
+ with tempfile.NamedTemporaryFile(delete=False, mode="w") as tempf:
+ call(["git", "log", "-1", "--format=%h"], stdout=tempf, cwd=folder)
+ with open(tempf.name, "r") as t:
return t.readline().strip()
diff --git a/src/linkahead/utils/plantuml.py b/src/linkahead/utils/plantuml.py
index 19594d6e856e740fe2c58c5128eead31c37485ce..59e3c34dd04c2425aef46b6d9e2411f75b747aca 100644
--- a/src/linkahead/utils/plantuml.py
+++ b/src/linkahead/utils/plantuml.py
@@ -130,9 +130,9 @@ def recordtypes_to_plantuml_string(iterable,
classes = [el for el in iterable
if isinstance(el, db.RecordType)]
- dependencies = {}
- inheritances = {}
- properties = [p for p in iterable if isinstance(p, db.Property)]
+ dependencies: dict = {}
+ inheritances: dict = {}
+ properties: list = [p for p in iterable if isinstance(p, db.Property)]
grouped = [g for g in iterable if isinstance(g, Grouped)]
def _add_properties(c, importance=None):
@@ -272,7 +272,8 @@ package \"The property P references an instance of D\" <<Rectangle>> {
return result
-def retrieve_substructure(start_record_types, depth, result_id_set=None, result_container=None, cleanup=True):
+def retrieve_substructure(start_record_types, depth, result_id_set=None, result_container=None,
+ cleanup=True):
"""Recursively retrieves LinkAhead record types and properties, starting
from given initial types up to a specific depth.
diff --git a/unittests/test_authentication_auth_token.py b/unittests/test_authentication_auth_token.py
index 3142f1f9f54230cb19666eeb8ff5809a906f9d49..4eb17bcc3892a0d0cad0f2c86289c2e8c625d426 100644
--- a/unittests/test_authentication_auth_token.py
+++ b/unittests/test_authentication_auth_token.py
@@ -96,6 +96,6 @@ def test_logout_calls_delete():
auth_token="[request token]",
implementation=MockUpServerConnection)
- c._delegate_connection.resources.append(logout_resource)
+ c._delegate_connection.resources.insert(1, logout_resource)
c._logout()
mock.method.assert_called_once()
diff --git a/unittests/test_connection.py b/unittests/test_connection.py
index a3a1eff705c64f59baec33088906bdd9a4daa14d..5d22efa46e3a6c10452085d735d1bd6f056a81fc 100644
--- a/unittests/test_connection.py
+++ b/unittests/test_connection.py
@@ -25,14 +25,18 @@
# pylint: disable=missing-docstring
from __future__ import print_function, unicode_literals
+import io
import re
from builtins import bytes, str # pylint: disable=redefined-builtin
+import requests
+
from linkahead import execute_query
from linkahead.configuration import _reset_config, get_config
from linkahead.connection.authentication.interface import CredentialsAuthenticator
from linkahead.connection.connection import (CaosDBServerConnection,
_DefaultCaosDBServerConnection,
+ _WrappedHTTPResponse,
configure_connection)
from linkahead.connection.mockup import (MockUpResponse, MockUpServerConnection,
_request_log_message)
@@ -216,9 +220,9 @@ def test_init_connection():
def test_resources_list():
connection = test_init_connection()
assert hasattr(connection, "resources")
- assert len(connection.resources) == 1
- connection.resources.append(lambda **kwargs: test_init_response())
assert len(connection.resources) == 2
+ connection.resources.append(lambda **kwargs: test_init_response())
+ assert len(connection.resources) == 3
return connection
@@ -324,3 +328,51 @@ def test_auth_token_connection():
"auth_token authenticator cannot log in "
"again. You must provide a new authentication "
"token.")
+
+
+def test_buffer_read():
+ """Test the buffering in _WrappedHTTPResponse.read()"""
+
+ class MockResponse(requests.Response):
+ def __init__(self, content: bytes):
+ """A mock response
+
+ Parameters
+ ----------
+ content : bytes
+ The fake content.
+ """
+ super().__init__()
+ self._content = content
+ bio = io.BytesIO(expected)
+ self.raw = bio
+
+ expected = b"This response."
+ MockResponse(expected)
+
+ #############################
+ # Check for some exceptions #
+ #############################
+ resp = _WrappedHTTPResponse(response=MockResponse(expected))
+ with raises(BufferError) as rte:
+ resp.read(4)
+ resp.read()
+ assert "`size` parameter can not be None" in str(rte.value)
+
+ resp = _WrappedHTTPResponse(response=MockResponse(expected))
+ with raises(BufferError) as rte:
+ resp.read(4)
+ resp.read(0)
+ assert "`size` parameter can not be None" in str(rte.value)
+
+ print("---")
+ resp = _WrappedHTTPResponse(response=MockResponse(expected))
+ result = (
+ resp.read(4)
+ + resp.read(2)
+ + resp.read(2) # This line failed before.
+ + resp.read(4) # Reading the rest in two chunks, because of current limitations in read().
+ + resp.read(2)
+ )
+
+ assert result == expected