better user lib : clear error messages + renaming Exception

tracim/exceptions.py

@@ -93,5 +93,5 @@ class WrongUserPassword(TracimException):
     pass
 
 
-class UserNotExist(TracimException):
+class UserDoesNotExist(TracimException):
     pass

tracim/lib/core/user.py

@@ -9,7 +9,7 @@ from sqlalchemy.orm import Session
 from tracim import CFG
 from tracim.models.auth import User, Group
 from sqlalchemy.orm.exc import NoResultFound
-from tracim.exceptions import WrongUserPassword, UserNotExist
+from tracim.exceptions import WrongUserPassword, UserDoesNotExist
 from tracim.exceptions import AuthenticationFailed
 from tracim.models.context_models import UserInContext
 
@@ -48,8 +48,8 @@ class UserApi(object):
         """
         try:
             user = self._base_query().filter(User.user_id == user_id).one()
-        except NoResultFound:
-            raise UserNotExist()
+        except NoResultFound as exc:
+            raise UserDoesNotExist('User "{}" not found in database'.format(user_id)) from exc  # nopep8
         return user
 
     def get_one_by_email(self, email: str) -> User:
@@ -60,8 +60,8 @@ class UserApi(object):
         """
         try:
             user = self._base_query().filter(User.email == email).one()
-        except NoResultFound:
-            raise UserNotExist()
+        except NoResultFound as exc:
+            raise UserDoesNotExist('User "{}" not found in database'.format(email)) from exc  # nopep8
         return user
 
     # FIXME - G.M - 24-04-2018 - Duplicate method with get_one.
@@ -73,7 +73,7 @@ class UserApi(object):
         Get current_user
         """
         if not self._user:
-            raise UserNotExist()
+            raise UserDoesNotExist()
         return self._user
 
     def get_all(self) -> typing.Iterable[User]:
@@ -103,7 +103,7 @@ class UserApi(object):
                 return user
             else:
                 raise WrongUserPassword()
-        except (WrongUserPassword, NoResultFound, UserNotExist):
+        except (WrongUserPassword, UserDoesNotExist):
             raise AuthenticationFailed()
 
     # Actions

tracim/lib/utils/authentification.py

@@ -4,7 +4,7 @@ from pyramid.request import Request
 from sqlalchemy.orm.exc import NoResultFound
 
 from tracim import TracimRequest
-from tracim.exceptions import UserNotExist
+from tracim.exceptions import UserDoesNotExist
 from tracim.lib.core.user import UserApi
 from tracim.models import User
 
@@ -51,6 +51,6 @@ def _get_basic_auth_unsafe_user(
         if not login:
             return None
         user = uapi.get_one_by_email(login)
-    except (NoResultFound, UserNotExist):
+    except (NoResultFound, UserDoesNotExist):
         return None
     return user

tracim/lib/utils/request.py

@@ -5,7 +5,7 @@ TracimRequest and related functions
 from pyramid.request import Request
 from sqlalchemy.orm.exc import NoResultFound
 
-from tracim.exceptions import NotAuthentificated, UserNotExist
+from tracim.exceptions import NotAuthentificated, UserDoesNotExist
 from tracim.exceptions import WorkspaceNotFound
 from tracim.exceptions import ImmutableAttribute
 from tracim.lib.core.user import UserApi
@@ -142,7 +142,7 @@ def get_candidate_user(
         if 'user_id' in request.matchdict:
             login = request.matchdict['user_id']
         if not login:
-            raise UserNotExist('no user_id found, incorrect request ?')
+            raise UserDoesNotExist('no user_id found, incorrect request ?')
         user = uapi.get_one(login)
     except NoResultFound:
         raise NotAuthentificated('User not found')

tracim/tests/library/test_user_api.py

@@ -4,7 +4,7 @@ from sqlalchemy.orm.exc import NoResultFound
 
 import transaction
 
-from tracim.exceptions import UserNotExist, AuthenticationFailed
+from tracim.exceptions import UserDoesNotExist, AuthenticationFailed
 from tracim.lib.core.user import UserApi
 from tracim.models import User
 from tracim.models.context_models import UserInContext
@@ -60,7 +60,7 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        with pytest.raises(UserNotExist):
+        with pytest.raises(UserDoesNotExist):
             api.get_one_by_email('unknown')
 
     # def test_unit__get_all__ok__nominal_case(self):
@@ -127,7 +127,7 @@ class TestUserApi(DefaultTest):
             session=self.session,
             config=self.config,
         )
-        with pytest.raises(UserNotExist):
+        with pytest.raises(UserDoesNotExist):
             api.get_current_user()
 
     def test_unit__authenticate_user___ok__nominal_case(self):

tracim/views/core_api/user_controller.py

@@ -12,7 +12,7 @@ except ImportError:
 
 from tracim import hapic, TracimRequest
 from tracim.exceptions import NotAuthentificated, InsufficientUserProfile, \
-    UserNotExist
+    UserDoesNotExist
 from tracim.lib.core.user import UserApi
 from tracim.lib.core.workspace import WorkspaceApi
 from tracim.views.controllers import Controller
@@ -25,7 +25,7 @@ class UserController(Controller):
     @hapic.with_api_doc()
     @hapic.handle_exception(NotAuthentificated, HTTPStatus.UNAUTHORIZED)
     @hapic.handle_exception(InsufficientUserProfile, HTTPStatus.FORBIDDEN)
-    @hapic.handle_exception(UserNotExist, HTTPStatus.NOT_FOUND)
+    @hapic.handle_exception(UserDoesNotExist, HTTPStatus.NOT_FOUND)
     @require_same_user_or_profile(Group.TIM_ADMIN)
     @hapic.input_path(UserIdPathSchema())
     @hapic.output_body(WorkspaceDigestSchema(many=True),)