Merge pull request #50 from CSCfi/devel

bump to 0.5.8

.github/workflows/style.yml

@@ -8,7 +8,7 @@ jobs:
       max-parallel: 4
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.7]
+        python-version: [3.7, 3.8]
 
     runs-on: ${{ matrix.os }}
 
@@ -24,5 +24,7 @@ jobs:
         pip install tox tox-gh-actions
     - name: Test flake8 syntax with tox
       run: tox -e flake8
+    - name: Test mypy typing with tox
+      run: tox -e mypy
     - name: bandit static check
       run: tox -e bandit

.github/workflows/unit.yml

@@ -8,7 +8,7 @@ jobs:
       max-parallel: 4
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.6, 3.7]
+        python-version: [3.7, 3.8]
 
     runs-on: ${{ matrix.os }}
 

swift_x_account_sharing/__init__.py

@@ -2,6 +2,6 @@
 
 
 __name__ = "swift_x_account_sharing"
-__version__ = "0.5.7"
+__version__ = "0.5.8"
 __author__ = "CSC Developers"
 __license__ = "MIT License"

swift_x_account_sharing/api.py

@@ -16,6 +16,7 @@ async def has_access_handler(
         request: aiohttp.web.Request
 ) -> aiohttp.web.Response:
     """Handle has-access endpoint query."""
+    access_list = []
     try:
         access_list = await request.app["db_conn"].get_access_list(
             request.match_info["user"]
@@ -35,6 +36,7 @@ async def access_details_handler(
         request: aiohttp.web.Request
 ) -> aiohttp.web.Response:
     """Handle access-details endpoint query."""
+    access_details = dict()
     try:
         access_details = \
             await request.app["db_conn"].get_access_container_details(
@@ -56,6 +58,7 @@ async def gave_access_handler(
         request: aiohttp.web.Request
 ) -> aiohttp.web.Response:
     """Handle gave-access endpoint query."""
+    shared_list = []
     try:
         shared_list = await request.app["db_conn"].get_shared_list(
             request.match_info["owner"]
@@ -76,6 +79,7 @@ async def shared_details_handler(
         request: aiohttp.web.Request
 ) -> aiohttp.web.Response:
     """Handle shared-details endpoint query."""
+    shared_details = dict()
     try:
         shared_details = \
             await request.app["db_conn"].get_shared_container_details(
@@ -97,6 +101,7 @@ async def share_container_handler(
         request: aiohttp.web.Request
 ) -> aiohttp.web.Response:
     """Handle share-container endpoint query."""
+    shared: bool = False
     try:
         shared = await request.app["db_conn"].add_share(
             request.match_info["owner"],
@@ -110,7 +115,8 @@ async def share_container_handler(
 
     MODULE_LOGGER.log(
         logging.DEBUG,
-        "Added following new shares: %s", str(shared)
+        "Added following new shared containers: %s",
+        str(request.match_info["container"])
     )
 
     return aiohttp.web.json_response(shared)
@@ -120,6 +126,7 @@ async def edit_share_handler(
         request: aiohttp.web.Request
 ) -> aiohttp.web.Response:
     """Handle container shared rights editions."""
+    edited: bool = False
     try:
         edited = await request.app["db_conn"].edit_share(
             request.match_info["owner"],
@@ -132,7 +139,8 @@ async def edit_share_handler(
 
     MODULE_LOGGER.log(
         logging.DEBUG,
-        "Edited following shares: %s", str(edited)
+        "Edited following shared containers: %s",
+        str(request.match_info["container"])
     )
 
     return aiohttp.web.json_response(edited)
@@ -143,7 +151,7 @@ async def delete_share_handler(
 ) -> aiohttp.web.Response:
     """Handle unshare-container endpoint query."""
     try:
-        deleted = await request.app["db_conn"].delete_share(
+        await request.app["db_conn"].delete_share(
             request.match_info["owner"],
             request.match_info["container"],
             request.query["user"].split(",")
@@ -158,7 +166,8 @@ async def delete_share_handler(
 
     MODULE_LOGGER.log(
         logging.DEBUG,
-        "Deleted following shares: %s", str(deleted)
+        "Deleted following shared containers: %s",
+        str(request.match_info["container"])
     )
 
     return aiohttp.web.Response(
@@ -172,7 +181,7 @@ async def delete_container_shares_handler(
 ) -> aiohttp.web.Response:
     """Delete all shares from a container."""
     try:
-        deleted = await request.app["db_conn"].delete_container_shares(
+        await request.app["db_conn"].delete_container_shares(
             request.match_info["owner"],
             request.match_info["container"]
         )
@@ -181,7 +190,8 @@ async def delete_container_shares_handler(
 
     MODULE_LOGGER.log(
         logging.DEBUG,
-        "Deleted following shares: %s", str(deleted)
+        "Deleted following shared container: %s",
+        str(request.match_info["container"])
     )
 
     return aiohttp.web.Response(
@@ -202,7 +212,7 @@ async def handle_user_add_token(
     except KeyError:
         try:
             formdata = await request.post()
-            token = formdata["token"]
+            token = str(formdata["token"])
         except KeyError:
             raise aiohttp.web.HTTPBadRequest(
                 reason="No token present"
@@ -243,7 +253,7 @@ async def handle_user_list_tokens(
 ) -> aiohttp.web.Response:
     """Get project token listing."""
     project = request.match_info["project"]
-
+    tokens = []
     try:
         tokens = await request.app["db_conn"].get_tokens(project)
     except InterfaceError:

swift_x_account_sharing/auth.py

@@ -36,7 +36,7 @@
 
 async def read_in_keys(
         app: aiohttp.web.Application
-):
+) -> None:
     """Read in keys to the application."""
     keys = os.environ.get("SWIFT_UI_API_AUTH_TOKENS", None)
     app["tokens"] = keys.split(",") if keys is not None else []
@@ -51,7 +51,7 @@ async def test_signature(
         signature: str,
         message: str,
         validity: str,
-):
+) -> None:
     """Validate signature against the given tokens."""
     # Check signature expiration
     if int(validity) < time.time():
@@ -87,6 +87,7 @@ async def handle_validate_authentication(
             reason="Query string missing validity or signature."
         )
 
+    project: typing.Union[None, str]
     project_tokens = []
     try:
         project = request.match_info["project"]

swift_x_account_sharing/bindings/bind.py

@@ -15,16 +15,16 @@ class SwiftXAccountSharing:
     def __init__(
             self,
             url: str
-    ):
+    ) -> None:
         """."""
         self.url = url
         self.session = aiohttp.ClientSession()
 
-    async def __aenter__(self):
+    async def __aenter__(self) -> 'SwiftXAccountSharing':
         """."""
         return self
 
-    async def __aexit__(self, *excinfo):
+    async def __aexit__(self, *excinfo: BaseException) -> None:
         """."""
         await self.session.close()
 

swift_x_account_sharing/bindings/signature.py

@@ -14,7 +14,7 @@ def sign_api_request(
     to_sign = (valid_until + path).encode("utf-8")
 
     digest = hmac.new(
-        key=os.environ.get("SWIFT_UI_API_KEY").encode("utf-8"),
+        key=os.environ.get("SWIFT_UI_API_KEY", "").encode("utf-8"),
         msg=to_sign,
         digestmod="sha256"
     ).hexdigest()

swift_x_account_sharing/db.py

@@ -16,7 +16,7 @@
 
 def handle_dropped_connection(
         request: aiohttp.web.Request
-):
+) -> None:
     """Handle dropped database connection."""
     MODULE_LOGGER.log(
         logging.ERROR,
@@ -34,16 +34,16 @@ def handle_dropped_connection(
 class DBConn:
     """Class for the account sharing database functionality."""
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize connection variable."""
-        self.conn = None
+        self.conn: asyncpg.connection.Connection = None
         self.log = MODULE_LOGGER
 
-    def erase(self):
+    def erase(self) -> None:
         """Erase the connection."""
         self.conn = None
 
-    async def open(self):
+    async def open(self) -> None:
         """Initialize the database connection."""
         while self.conn is None:
             try:
@@ -82,7 +82,7 @@ async def open(self):
                 slp = random.randint(5, 15)  # nosec
                 await asyncio.sleep(slp)
 
-    async def close(self):
+    async def close(self) -> None:
         """Safely close the database connection."""
         if self.conn is not None:
             await self.conn.close()
@@ -341,7 +341,7 @@ async def revoke_token(
             self,
             token_owner: str,
             token_identifier: str
-    ):
+    ) -> None:
         """Remove a token from the database."""
         async with self.conn.transaction():
             await self.conn.execute(
@@ -361,7 +361,7 @@ async def add_token(
             token_owner: str,
             token: str,
             identifier: str
-    ):
+    ) -> None:
         """Add a token to the database."""
         async with self.conn.transaction():
             await self.conn.execute(

swift_x_account_sharing/preflight.py

@@ -2,9 +2,12 @@
 
 
 import aiohttp.web
+import typing
 
 
-async def handle_delete_preflight(_) -> aiohttp.web.Response:
+async def handle_delete_preflight(
+        _: typing.Union[aiohttp.web.Request, None]
+) -> aiohttp.web.Response:
     """Serve correct response headers to allowed DELETE preflight query."""
     resp = aiohttp.web.Response(
         headers={

swift_x_account_sharing/server.py

@@ -4,7 +4,7 @@
 import sys
 import logging
 import asyncio
-
+import typing
 
 import aiohttp.web
 import uvloop
@@ -44,14 +44,14 @@
 
 async def resume_on_start(
         app: aiohttp.web.Application
-):
+) -> None:
     """Resume old instance from start."""
     await app["db_conn"].open()
 
 
 async def save_on_shutdown(
         app: aiohttp.web.Application
-):
+) -> None:
     """Flush the database on shutdown."""
     if app["db_conn"] is not None:
         await app["db_conn"].close()
@@ -61,10 +61,10 @@ async def init_server() -> aiohttp.web.Application:
     """Initialize the server."""
     app = aiohttp.web.Application(
         middlewares=[
-            add_cors,
-            check_db_conn,
-            handle_validate_authentication,
-            catch_uniqueness_error,
+            add_cors,  # type:ignore
+            check_db_conn,  # type:ignore
+            handle_validate_authentication,  # type:ignore
+            catch_uniqueness_error,  # type:ignore
         ]
     )
 
@@ -104,8 +104,8 @@ async def init_server() -> aiohttp.web.Application:
 
 
 def run_server_devel(
-        app: aiohttp.web.Application
-):
+        app: typing.Coroutine[typing.Any, typing.Any, aiohttp.web.Application]
+) -> None:
     """Run the server in development mode (without HTTPS)."""
     aiohttp.web.run_app(
         app,
@@ -114,7 +114,7 @@ def run_server_devel(
     )
 
 
-def main():
+def main() -> None:
     """Run the server with the default run function."""
     if sys.version_info < (3, 6):
         logging.error("swift-x-account-sharing requires >= python3.6")

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = flake8, bandit, pytest
+envlist = flake8, bandit, pytest, mypy
 skipdist = True
 
 [testenv:bandit]
@@ -8,14 +8,29 @@ deps = bandit
 commands = bandit -r ./swift_x_account_sharing
 
 [flake8]
-ignore = W503,D203,D212,D100,D104
+ignore = W503,D203,D212,D100,D104,ANN101
+exclude = .git/, ./venv/, ./.tox/, build/, swift_x_account_sharing.egg-info/
+# Not using type hints in tests, ignore all errors
+per-file-ignores =
+    tests/*:ANN
 
 [testenv:flake8]
 skip_install = True
 deps =
     flake8
     flake8-docstrings
-commands = flake8 .
+    flake8-annotations
+commands = flake8 swift_x_account_sharing tests
+
+[testenv:mypy]
+skip_install = true
+deps =
+    -rrequirements.txt
+    mypy
+# Mypy fails if 3rd party library doesn't have type hints configured.
+# Alternative to ignoring imports would be to write custom stub files, which
+# could be done at some point.
+commands = mypy --ignore-missing-imports swift_x_account_sharing/
 
 [testenv:pytest]
 deps =
@@ -31,5 +46,5 @@ deps =
 
 [gh-actions]
 python =
-    3.6: pytest
-    3.7: flake8, pytest, bandit
+    3.8: pytest, mypy
+    3.7: flake8, pytest, bandit, mypy