Merge pull request 'Logging' (#7) from feature-logging into main

Reviewed-on: #7

.gitignore

@@ -1 +1,2 @@
 /.env
+*.pyc

Pipfile

@@ -14,6 +14,7 @@ pyyaml = "~=5.4.1"
 
 [dev-packages]
 flake8 = "~=3.9.2"
+yapf = "~=0.31.0"
 
 [requires]
 python_version = "3.8"

README.md

@@ -21,7 +21,6 @@ rm data/ki.sqlite
 cp env.dev .env
 pipenv install --dev
 pipenv shell
-export FLASK_APP=app.py
 flask db upgrade
 flask seed
 flask run
@@ -43,6 +42,13 @@ python -m unittest discover ki
 flake8
 ```
 
+### Formatierung
+
+Um ein einheitliches Quellcode-Erlebnis zu haben, kann der Code mit yapf neu formatiert werden:
+
+```
+yapf -i --recursive ki/
+```
 
 ### Testbenutzer
 

app.py

@@ -1,3 +1,4 @@
+import logging
 import os
 
 from dotenv import load_dotenv, find_dotenv
@@ -7,9 +8,14 @@ from flask_migrate import Migrate
 
 load_dotenv(find_dotenv())
 
+loglevel = os.getenv("KI_LOGLEVEL", logging.WARNING)
+loglevel = int(loglevel)
+logging.basicConfig(level=loglevel)
+logging.debug("Hello from KI")
+
 app = Flask(__name__)
-app.config['SQLALCHEMY_DATABASE_URI'] = os.getenv("SQLALCHEMY_DATABASE_URI")
+app.config["SQLALCHEMY_DATABASE_URI"] = os.getenv("SQLALCHEMY_DATABASE_URI")
-app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
 app.config["KI_DATA_DIR"] = os.path.dirname(__file__) + "/data"
 app.config["KI_AUTH"] = os.getenv("KI_AUTH")
 db = SQLAlchemy(app)

env.dev

@@ -1,3 +1,9 @@
 SQLALCHEMY_DATABASE_URI = 'sqlite:///data/ki.sqlite'
 
+FLASK_APP=app.py
+FLASK_ENV=development
+
 KI_AUTH=file
+
+# 10 = debug
+KI_LOGLEVEL=10

ki/auth.py

@@ -5,41 +5,28 @@ from app import app, db
 from ki.models import User, Token
 
 
-class UserWrongCredentialsException(Exception):
-    pass
-
-
-class UserAllreadyLoggedInException(Exception):
-    pass
-
-
 def auth(username, password):
     auth_file_path = app.config["KI_DATA_DIR"] + "/auth.yml"
 
     with open(auth_file_path, "r") as auth_file_stream:
+        users = yaml.safe_load(auth_file_stream)
 
-        try:
+        if username not in users:
-            users = yaml.safe_load(auth_file_stream)
-
-        except yaml.YAMLError:
-            print('Could not parse auth.yml.')
-
-        try:
-            auth_user = users[username]
-
-            if auth_user["password"] != password:
-                raise UserWrongCredentialsException
-
-        except (UserWrongCredentialsException, KeyError):
-            print('Wrong username/password combination')
             return None
 
-        else:
+        auth_user = users[username]
-            user = User.query.filter(User.auth_id.__eq__(username)).first()
 
-            token = Token(token=str(uuid.uuid4()), user=user)
+        if auth_user["password"] != password:
+            return None
 
-            db.session.add(token)
+        user = User.query.filter(User.auth_id.__eq__(username)).first()
-            db.session.commit()
 
-            return token
+        if user is None:
+            user = User(auth_id=username)
+            db.session.add(user)
+
+        token = Token(token=str(uuid.uuid4()), user=user)
+        db.session.add(token)
+        db.session.commit()
+
+    return token

ki/module.py

@@ -1 +1 @@
-from ki import models, commands, routes # noqa
+from ki import models, commands, routes  # noqa

ki/routes.py

@@ -99,7 +99,7 @@ def login():
     if token is None:
         return make_response({}, 403)
 
-    return make_response({"token": token.token})
+    return make_response({"token": token.token, "user_id": token.user_id})
 
 
 @app.route("/users/<user_id>/profile")

ki/test/test_skills_endpoint.py

@@ -22,13 +22,14 @@ class TestSkillsEndpoint(unittest.TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertEqual(
             {
-                "skills": [
+                "skills": [{
-                    {"id": 1, "name": "PHP"},
+                    "id": 1,
-                    {"id": 3, "name": "Python"}
+                    "name": "PHP"
-                ]
+                }, {
-            },
+                    "id": 3,
-            response.json
+                    "name": "Python"
-        )
+                }]
+            }, response.json)
 
 
 if __name__ == "main":