Merge pull request #214 from eReuse/bugfix/login-workflow

Bugfix login workflow

CHANGELOG.md

@@ -8,7 +8,8 @@ ml).
 ## master
 
 ## testing
-- [changed] #2970 #2971 Print DHID-QR label for selected devices.
+- [changed] #211 Print DHID-QR label for selected devices.
+- [fixed] #214 Login workflow
 
 ## [2.0.0] - 2022-03-15
 First server render HTML version. Completely rewrites views of angular JS client on flask.

ereuse_devicehub/devicehub.py

@@ -10,7 +10,7 @@ from ereuse_utils.session import DevicehubClient
 from flask import _app_ctx_stack, g
 from flask_login import LoginManager, current_user
 from flask_sqlalchemy import SQLAlchemy
-from teal.db import SchemaSQLAlchemy
+from teal.db import ResourceNotFound, SchemaSQLAlchemy
 from teal.teal import Teal
 
 from ereuse_devicehub.auth import Auth
@@ -29,32 +29,49 @@ class Devicehub(Teal):
     Dummy = Dummy
     jinja_environment = Environment
 
-    def __init__(self,
+    def __init__(
-                 inventory: str,
+        self,
-                 config: DevicehubConfig = DevicehubConfig(),
+        inventory: str,
-                 db: SQLAlchemy = db,
+        config: DevicehubConfig = DevicehubConfig(),
-                 import_name=__name__.split('.')[0],
+        db: SQLAlchemy = db,
-                 static_url_path=None,
+        import_name=__name__.split('.')[0],
-                 static_folder='static',
+        static_url_path=None,
-                 static_host=None,
+        static_folder='static',
-                 host_matching=False,
+        static_host=None,
-                 subdomain_matching=False,
+        host_matching=False,
-                 template_folder='templates',
+        subdomain_matching=False,
-                 instance_path=None,
+        template_folder='templates',
-                 instance_relative_config=False,
+        instance_path=None,
-                 root_path=None,
+        instance_relative_config=False,
-                 Auth: Type[Auth] = Auth):
+        root_path=None,
+        Auth: Type[Auth] = Auth,
+    ):
         assert inventory
-        super().__init__(config, db, inventory, import_name, static_url_path, static_folder,
+        super().__init__(
-                         static_host,
+            config,
-                         host_matching, subdomain_matching, template_folder, instance_path,
+            db,
-                         instance_relative_config, root_path, False, Auth)
+            inventory,
+            import_name,
+            static_url_path,
+            static_folder,
+            static_host,
+            host_matching,
+            subdomain_matching,
+            template_folder,
+            instance_path,
+            instance_relative_config,
+            root_path,
+            False,
+            Auth,
+        )
         self.id = inventory
         """The Inventory ID of this instance. In Teal is the app.schema."""
         self.dummy = Dummy(self)
 
-        @self.cli.group(short_help='Inventory management.',
+        @self.cli.group(
-                        help='Manages the inventory {}.'.format(os.environ.get('dhi')))
+            short_help='Inventory management.',
+            help='Manages the inventory {}.'.format(os.environ.get('dhi')),
+        )
         def inv():
             pass
 
@@ -69,43 +86,68 @@ class Devicehub(Teal):
         # configure Flask-Login
         login_manager = LoginManager()
         login_manager.init_app(self)
+        login_manager.login_view = "core.login"
 
         @login_manager.user_loader
         def load_user(user_id):
-            return User.query.get(user_id)
+            # TODO(@slamora) refactor when teal library has been drop.
+            # `load_user` expects None if the user ID is invalid or the
+            # session has expired so we need to handle Exception raised
+            # by teal (it's overriding default behaviour of flask-sqlalchemy
+            # which already returns None)
+            try:
+                return User.query.get(user_id)
+            except ResourceNotFound:
+                return None
 
     # noinspection PyMethodOverriding
-    @click.option('--name', '-n',
+    @click.option(
-                  default='Test 1',
+        '--name', '-n', default='Test 1', help='The human name of the inventory.'
-                  help='The human name of the inventory.')
+    )
-    @click.option('--org-name', '-on',
+    @click.option(
-                  default='My Organization',
+        '--org-name',
-                  help='The name of the default organization that owns this inventory.')
+        '-on',
-    @click.option('--org-id', '-oi',
+        default='My Organization',
-                  default='foo-bar',
+        help='The name of the default organization that owns this inventory.',
-                  help='The Tax ID of the organization.')
+    )
-    @click.option('--tag-url', '-tu',
+    @click.option(
-                  type=ereuse_utils.cli.URL(scheme=True, host=True, path=False),
+        '--org-id', '-oi', default='foo-bar', help='The Tax ID of the organization.'
-                  default='http://example.com',
+    )
-                  help='The base url (scheme and host) of the tag provider.')
+    @click.option(
-    @click.option('--tag-token', '-tt',
+        '--tag-url',
-                  type=click.UUID,
+        '-tu',
-                  default='899c794e-1737-4cea-9232-fdc507ab7106',
+        type=ereuse_utils.cli.URL(scheme=True, host=True, path=False),
-                  help='The token provided by the tag provider. It is an UUID.')
+        default='http://example.com',
-    @click.option('--erase/--no-erase',
+        help='The base url (scheme and host) of the tag provider.',
-                  default=False,
+    )
-                  help='Delete the schema before? '
+    @click.option(
-                       'If --common is set this includes the common database.')
+        '--tag-token',
-    @click.option('--common/--no-common',
+        '-tt',
-                  default=False,
+        type=click.UUID,
-                  help='Creates common databases. Only execute if the database is empty.')
+        default='899c794e-1737-4cea-9232-fdc507ab7106',
-    def init_db(self, name: str,
+        help='The token provided by the tag provider. It is an UUID.',
-                org_name: str,
+    )
-                org_id: str,
+    @click.option(
-                tag_url: boltons.urlutils.URL,
+        '--erase/--no-erase',
-                tag_token: uuid.UUID,
+        default=False,
-                erase: bool,
+        help='Delete the schema before? '
-                common: bool):
+        'If --common is set this includes the common database.',
+    )
+    @click.option(
+        '--common/--no-common',
+        default=False,
+        help='Creates common databases. Only execute if the database is empty.',
+    )
+    def init_db(
+        self,
+        name: str,
+        org_name: str,
+        org_id: str,
+        tag_url: boltons.urlutils.URL,
+        tag_token: uuid.UUID,
+        erase: bool,
+        common: bool,
+    ):
         """Creates an inventory.
 
         This creates the database and adds the inventory to the
@@ -120,10 +162,14 @@ class Devicehub(Teal):
         with click_spinner.spinner():
             if erase:
                 self.db.drop_all(common_schema=common)
-            assert not db.has_schema(self.id), 'Schema {} already exists.'.format(self.id)
+            assert not db.has_schema(self.id), 'Schema {} already exists.'.format(
+                self.id
+            )
             exclude_schema = 'common' if not common else None
             self._init_db(exclude_schema=exclude_schema)
-            InventoryDef.set_inventory_config(name, org_name, org_id, tag_url, tag_token)
+            InventoryDef.set_inventory_config(
+                name, org_name, org_id, tag_url, tag_token
+            )
             DeviceSearch.set_all_devices_tokens_if_empty(self.db.session)
             self._init_resources(exclude_schema=exclude_schema)
             self.db.session.commit()
@@ -138,8 +184,11 @@ class Devicehub(Teal):
 
         return True
 
-    @click.confirmation_option(prompt='Are you sure you want to delete the inventory {}?'
+    @click.confirmation_option(
-                               .format(os.environ.get('dhi')))
+        prompt='Are you sure you want to delete the inventory {}?'.format(
+            os.environ.get('dhi')
+        )
+    )
     def delete_inventory(self):
         """Erases an inventory.
 
@@ -161,8 +210,9 @@ class Devicehub(Teal):
     def _prepare_request(self):
         """Prepares request stuff."""
         inv = g.inventory = Inventory.current  # type: Inventory
-        g.tag_provider = DevicehubClient(base_url=inv.tag_provider,
+        g.tag_provider = DevicehubClient(
-                                         token=DevicehubClient.encode_token(inv.tag_token))
+            base_url=inv.tag_provider, token=DevicehubClient.encode_token(inv.tag_token)
+        )
         # NOTE: models init methods expects that current user is
         #   available on g.user (e.g. to initialize object owner)
         g.user = current_user

ereuse_devicehub/views.py

@@ -11,6 +11,11 @@ from ereuse_devicehub.utils import is_safe_url
 core = Blueprint('core', __name__)
 
 
+@core.route("/")
+def index():
+    return flask.redirect(flask.url_for('core.login'))
+
+
 class LoginView(View):
     methods = ['GET', 'POST']
     template_name = 'ereuse_devicehub/user_login.html'