Add initial Windows support

.gitignore

@@ -5,4 +5,5 @@ mount/
 /.run_tests.sh
 .cov2emacs.log
 /.coverage
-/dist/
+/dist/
+.mypy_cache/

.travis.yml

@@ -17,7 +17,7 @@ cache:
 
 matrix:
   include:
-    - python: "3.6-dev" # 3.6 development branch
+    - python: "3.7-dev" # 3.7 development branch
 
 addons:
   apt:
@@ -33,8 +33,7 @@ before_install:
 
 install:
   - pip install -U wheel
-  - pip install coveralls pytest-cov
-  - pip install codecov
+  - pip install coveralls pytest-cov codecov
   - pip install .
   - which cgfs
   - pip install celery[redis]
@@ -62,6 +61,8 @@ before_script:
 
 script:
   - make test
+  - pip install mypy
+  - mypy codegra_fs
 
 after_script:
   cat server.log

codegra_fs/__init__.py

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: AGPL-3.0-only
+
+__version__ = (0, 4, 0)
+__author__ = 'Olmo Kramer, Thomas Schaper'
+__email__ = 'info@CodeGra.de'
+__license__ = 'AGPL-3.0-only'
+__maintainer__ = 'CodeGrade'
+
+import codegra_fs.utils as utils

codegra_fs/api_consumer.py

@@ -1,11 +1,13 @@
 #!/usr/bin/env python3
+# SPDX-License-Identifier: AGPL-3.0-only
+
 import os
 import sys
 import json
 import socket
 
 
-def print_usage():
+def print_usage() -> None:
     print(
         (
             'Usage:\n'
@@ -20,7 +22,7 @@ def print_usage():
     )
 
 
-def recv(s):
+def recv(s: socket.socket) -> str:
     message = b''
 
     while True:
@@ -32,7 +34,7 @@ def recv(s):
     return message.decode()
 
 
-def is_file(s, file):
+def is_file(s: socket.socket, file: str) -> int:
     s.send(
         bytes(
             json.dumps({
@@ -47,7 +49,7 @@ def is_file(s, file):
         return 2
 
 
-def get_comments(s, file):
+def get_comments(s: socket.socket, file: str) -> int:
     s.send(
         bytes(
             json.
@@ -72,7 +74,7 @@ def get_comments(s, file):
         return 2
 
 
-def delete_comment(s, file, line):
+def delete_comment(s: socket.socket, file: str, line: int) -> int:
     s.send(
         bytes(
             json.dumps(
@@ -90,7 +92,7 @@ def delete_comment(s, file, line):
         return 2
 
 
-def set_comment(s, file, line, message):
+def set_comment(s: socket.socket, file: str, line: int, message: str) -> int:
     s.send(
         bytes(
             json.dumps(
@@ -109,14 +111,18 @@ def set_comment(s, file, line, message):
         return 2
 
 
-def main():
-    path = '/'
+def main() -> None:
+    if sys.platform.startswith('win32'):
+        path = ''
+    else:
+        path = '/'
+
     if len(sys.argv) < 3:
         print_usage()
         sys.exit(1)
 
-    for p in os.path.abspath(sys.argv[2]).split('/'):
-        if not p:
+    for p in os.path.abspath(sys.argv[2]).split(os.sep):
+        if path and not p:
             continue
         path = os.path.join(path, p)
         if os.path.isfile(os.path.join(path, '.api.socket')):
@@ -125,8 +131,15 @@ def main():
         print('Socket not found', file=sys.stderr)
         sys.exit(3)
 
-    s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
-    s.connect(open(os.path.join(path, '.api.socket'), 'r').read())
+    with open(os.path.join(path, '.api.socket'), 'r') as f:
+        socketfile_content = f.read().strip()
+
+    if sys.platform.startswith('win32'):
+        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        s.connect(('localhost', int(socketfile_content)))
+    else:
+        s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        s.connect(socketfile_content)
 
     try:
         if sys.argv[1] == 'set-comment':

codegra_fs/cgapi.py

@@ -1,13 +1,18 @@
 # -*- coding: utf-8 -*-
+# SPDX-License-Identifier: AGPL-3.0-only
 
+import typing as t
 import logging
 from enum import IntEnum
+from functools import partial
 from urllib.parse import quote
 
 import requests
 
 DEFAULT_CGAPI_BASE_URL = 'https://codegra.de/api/v1'
 
+logger = logging.getLogger(__name__)
+
 
 class APIRoutes():
     def __init__(self, base, owner='auto'):
@@ -28,15 +33,15 @@ def get_submissions(self, assignment_id):
             base=self.base, assignment_id=assignment_id
         )
 
-    def get_files(self, submission_id):
+    def get_files(self, submission_id: int) -> str:
         return ('{base}/submissions/{submission_id}'
                 '/files/?owner={owner}').format(
                     base=self.base,
                     submission_id=submission_id,
                     owner=self.owner,
                 )
 
-    def get_file(self, submission_id, path):
+    def get_file(self, submission_id: int, path: str) -> str:
         return (
             '{base}/submissions/{submission_id}/'
             'files/?path={path}&owner={owner}'
@@ -141,7 +146,13 @@ def __str__(self):  # pragma: no cover
 
 
 class CGAPI():
-    def __init__(self, username, password, base=None, fixed=False):
+    def __init__(
+        self,
+        username: str,
+        password: str,
+        base: t.Optional[str]=None,
+        fixed: bool=False
+    ) -> None:
         owner = 'student' if fixed else 'auto'
         self.routes = APIRoutes(base or DEFAULT_CGAPI_BASE_URL, owner)
 
@@ -164,6 +175,11 @@ def __init__(self, username, password, base=None, fixed=False):
         self.s.headers = {
             'Authorization': 'Bearer ' + self.access_token,
         }
+        self.s.get = partial(self.s.get, timeout=3)  # type: ignore
+        self.s.patch = partial(self.s.patch, timeout=3)  # type: ignore
+        self.s.post = partial(self.s.post, timeout=3)  # type: ignore
+        self.s.delete = partial(self.s.delete, timeout=3)  # type: ignore
+        self.s.put = partial(self.s.put, timeout=3)  # type: ignore
 
     def _handle_response_error(self, request):
         if request.status_code >= 400:
@@ -216,15 +232,15 @@ def rename_file(self, file_id, new_path):
 
         return r.json()
 
-    def get_file(self, file_id):
+    def get_file(self, file_id: int) -> bytes:
         url = self.routes.get_file_buf(file_id=file_id)
         r = self.s.get(url)
 
         self._handle_response_error(r)
 
         return r.content
 
-    def patch_file(self, file_id, buf):
+    def patch_file(self, file_id: int, buf: bytes) -> t.Dict[str, t.Any]:
         url = self.routes.get_file_buf(file_id=file_id)
         r = self.s.patch(url, data=buf)
 
@@ -319,13 +335,21 @@ def get_submission(self, submission_id):
 
         return r.json()
 
-    def set_submission(self, submission_id, grade=None, feedback=None):
+    def set_submission(
+        self,
+        submission_id: int,
+        grade: t.Union[None, float, str]=None,
+        feedback: t.Optional[bytes]=None
+    ):
         url = self.routes.set_submission(submission_id)
-        d = {}
+        d = {}  # type: t.Dict[str, t.Union[bytes, float, None]]
         if grade is not None:
-            d['grade'] = grade
-        if grade == 'delete':
-            d['grade'] = None
+            if grade == 'delete':
+                d['grade'] = None
+            else:
+                assert not isinstance(grade, str)
+                d['grade'] = grade
+
         if feedback is not None:
             d['feedback'] = feedback
         r = self.s.patch(url, json=d)