add known_user feature in userApi + tests

backend/tracim_backend/exceptions.py

@@ -203,3 +203,7 @@ class PageOfPreviewNotFound(NotFound):
 
 class PreviewDimNotAllowed(TracimException):
     pass
+
+
+class TooShortAutocompleteString(TracimException):
+    pass

backend/tracim_backend/lib/core/user.py

@@ -3,13 +3,17 @@ from smtplib import SMTPException
 
 import transaction
 import typing as typing
+
+from sqlalchemy import or_
 from sqlalchemy.orm import Session
+from sqlalchemy.orm import Query
 from sqlalchemy.orm.exc import NoResultFound
 
 from tracim_backend import CFG
 from tracim_backend.models.auth import User
 from tracim_backend.models.auth import Group
 from tracim_backend.exceptions import NoUserSetted
+from tracim_backend.exceptions import TooShortAutocompleteString
 from tracim_backend.exceptions import PasswordDoNotMatch
 from tracim_backend.exceptions import EmailValidationFailed
 from tracim_backend.exceptions import UserDoesNotExist
@@ -20,6 +24,7 @@ from tracim_backend.exceptions import UserNotActive
 from tracim_backend.models.context_models import UserInContext
 from tracim_backend.lib.mail_notifier.notifier import get_email_manager
 from tracim_backend.models.context_models import TypeUser
+from tracim_backend.models.data import UserRoleInWorkspace
 
 
 class UserApi(object):
@@ -94,8 +99,41 @@ class UserApi(object):
             raise UserDoesNotExist('There is no current user')
         return self._user
 
+    def _get_all_query(self) -> Query:
+        return self._session.query(User).order_by(User.display_name)
+
     def get_all(self) -> typing.Iterable[User]:
-        return self._session.query(User).order_by(User.display_name).all()
+        return self._get_all_query().all()
+
+    def get_known_user(
+            self,
+            acp: str,
+    ) -> typing.Iterable[User]:
+        """
+        Return list of know user by current UserApi user.
+        :param acp: autocomplete filter by name/email
+        :return: List of found users
+        """
+        if len(acp) < 2:
+            raise TooShortAutocompleteString(
+                '"{acp}" is a too short string, acp string need to have more than one character'.format(acp=acp)  # nopep8
+            )
+        query = self._get_all_query()
+        query = query.filter(or_(User.display_name.ilike('%{}%'.format(acp)), User.email.ilike('%{}%'.format(acp))))  # nopep8
+
+        # INFO - G.M - 2018-07-27 - if user is set and is simple user, we
+        # should show only user in same workspace as user
+        if self._user and self._user.profile.id <= Group.TIM_USER:
+            user_workspaces_id_query = self._session.\
+                query(UserRoleInWorkspace.workspace_id).\
+                distinct(UserRoleInWorkspace.workspace_id).\
+                filter(UserRoleInWorkspace.user_id == self._user.user_id)
+            users_in_workspaces = self._session.\
+                query(UserRoleInWorkspace.user_id).\
+                distinct(UserRoleInWorkspace.user_id).\
+                filter(UserRoleInWorkspace.workspace_id.in_(user_workspaces_id_query.subquery())).subquery()  # nopep8
+            query = query.filter(User.user_id.in_(users_in_workspaces))
+        return query.all()
 
     def find(
             self,

backend/tracim_backend/tests/library/test_user_api.py

@@ -1,14 +1,19 @@
 # -*- coding: utf-8 -*-
 import pytest
 import transaction
+from tracim_backend import models
 
-from tracim_backend.exceptions import AuthenticationFailed
+from tracim_backend.exceptions import AuthenticationFailed, \
+    TooShortAutocompleteString
 from tracim_backend.exceptions import UserDoesNotExist
 from tracim_backend.exceptions import UserNotActive
 from tracim_backend.lib.core.group import GroupApi
 from tracim_backend.lib.core.user import UserApi
+from tracim_backend.lib.core.userworkspace import RoleApi
+from tracim_backend.lib.core.workspace import WorkspaceApi
 from tracim_backend.models import User
 from tracim_backend.models.context_models import UserInContext
+from tracim_backend.models.data import UserRoleInWorkspace
 from tracim_backend.tests import DefaultTest
 from tracim_backend.tests import eq_
 
@@ -107,6 +112,184 @@ class TestUserApi(DefaultTest):
         # u1 + Admin user from BaseFixture
         assert 2 == len(users)
 
+    def test_unit__get_known__user__admin__too_short_acp_str(self):
+        api = UserApi(
+            current_user=None,
+            session=self.session,
+            config=self.config,
+        )
+        u1 = api.create_user(
+            email='email@email',
+            name='name',
+            do_notify=False,
+            do_save=True,
+        )
+        with pytest.raises(TooShortAutocompleteString):
+            api.get_known_user('e')
+
+    def test_unit__get_known__user__admin__by_email(self):
+        api = UserApi(
+            current_user=None,
+            session=self.session,
+            config=self.config,
+        )
+        u1 = api.create_user(
+            email='email@email',
+            name='name',
+            do_notify=False,
+            do_save=True,
+        )
+
+        users = api.get_known_user('email')
+        assert len(users) == 1
+        assert users[0] == u1
+
+    def test_unit__get_known__user__user__no_workspace_empty_known_user(self):
+        admin = self.session.query(models.User) \
+            .filter(models.User.email == 'admin@admin.admin') \
+            .one()
+        api = UserApi(
+            current_user=admin,
+            session=self.session,
+            config=self.config,
+        )
+        u1 = api.create_user(
+            email='email@email',
+            name='name',
+            do_notify=False,
+            do_save=True,
+        )
+        api2 = UserApi(
+            current_user=u1,
+            session=self.session,
+            config=self.config,
+        )
+        users = api2.get_known_user('email')
+        assert len(users) == 0
+
+    def test_unit__get_known__user__same_workspaces_users_by_name(self):
+        admin = self.session.query(models.User) \
+            .filter(models.User.email == 'admin@admin.admin') \
+            .one()
+        api = UserApi(
+            current_user=None,
+            session=self.session,
+            config=self.config,
+        )
+        u1 = api.create_user(
+            email='email@email',
+            name='name',
+            do_notify=False,
+            do_save=True,
+        )
+        u2 = api.create_user(
+            email='email2@email2',
+            name='name2',
+            do_notify=False,
+            do_save=True,
+        )
+        u3 = api.create_user(
+            email='notfound@notfound',
+            name='notfound',
+            do_notify=False,
+            do_save=True,
+        )
+        wapi = WorkspaceApi(
+            current_user=admin,
+            session=self.session,
+            config=self.app_config,
+        )
+        workspace = wapi.create_workspace(
+            'test workspace n°1',
+            save_now=True)
+        role_api = RoleApi(
+            current_user=admin,
+            session=self.session,
+            config=self.app_config,
+        )
+        role_api.create_one(u1, workspace, UserRoleInWorkspace.READER, False)
+        role_api.create_one(u2, workspace, UserRoleInWorkspace.READER, False)
+        role_api.create_one(u3, workspace, UserRoleInWorkspace.READER, False)
+        api2 = UserApi(
+            current_user=u1,
+            session=self.session,
+            config=self.config,
+        )
+        users = api2.get_known_user('name')
+        assert len(users) == 2
+        assert users[0] == u1
+        assert users[1] == u2
+
+    def test_unit__get_known__user__same_workspaces_users_by_email(self):
+        admin = self.session.query(models.User) \
+            .filter(models.User.email == 'admin@admin.admin') \
+            .one()
+        api = UserApi(
+            current_user=None,
+            session=self.session,
+            config=self.config,
+        )
+        u1 = api.create_user(
+            email='email@email',
+            name='name',
+            do_notify=False,
+            do_save=True,
+        )
+        u2 = api.create_user(
+            email='email2@email2',
+            name='name2',
+            do_notify=False,
+            do_save=True,
+        )
+        u3 = api.create_user(
+            email='notfound@notfound',
+            name='notfound',
+            do_notify=False,
+            do_save=True,
+        )
+        wapi = WorkspaceApi(
+            current_user=admin,
+            session=self.session,
+            config=self.app_config,
+        )
+        workspace = wapi.create_workspace(
+            'test workspace n°1',
+            save_now=True)
+        role_api = RoleApi(
+            current_user=admin,
+            session=self.session,
+            config=self.app_config,
+        )
+        role_api.create_one(u1, workspace, UserRoleInWorkspace.READER, False)
+        role_api.create_one(u2, workspace, UserRoleInWorkspace.READER, False)
+        role_api.create_one(u3, workspace, UserRoleInWorkspace.READER, False)
+        api2 = UserApi(
+            current_user=u1,
+            session=self.session,
+            config=self.config,
+        )
+        users = api2.get_known_user('email')
+        assert len(users) == 2
+        assert users[0] == u1
+        assert users[1] == u2
+
+    def test_unit__get_known__user__admin__by_name(self):
+        api = UserApi(
+            current_user=None,
+            session=self.session,
+            config=self.config,
+        )
+        u1 = api.create_user(
+            email='email@email',
+            name='name',
+            do_notify=False,
+            do_save=True,
+        )
+
+        users = api.get_known_user('nam')
+        assert len(users) == 1
+        assert users[0] == u1
+
     def test_unit__get_one__ok__nominal_case(self):
         api = UserApi(
             current_user=None,