More tests and refactoring

hitier
2 parents 3ba117bb 7c7dae6d
Showing 13 changed files with 93 additions and 47 deletions Show diff stats
CHANGELOG.md
VERSION.txt
app/auth/models.py
app/auth/routes.py
app/commands/commands.py
app/commands/lesia_db.py
app/errors/handlers.py
resources/db_config.py
resources/lesia-btp.sqlite
tests/backend_tests.py
tests/cli_tests.py
tests/common_db_feed.py
tests/frontend_tests.py
@@ -23,6 +23,9 @@ Should be noted only functionnal changes,
 or major refactoring improvments.
  
 ## Unreleased
+## [0.3.pre-7] - 2021-05-03 - Better Tests Coverage
+### Changed
+Add tests and fix some code issues
  
 ## [0.3.pre-6] - 2021-04-30 - Nicer Display
 ### Changed
-0.3.pre-6
+0.3.pre-7
@@ -30,7 +30,7 @@ _nameToRole = {
 }
  
  
-def _checkRole(role):
+def _check_role(role):
     if isinstance(role, int):
         rv = role
     elif str(role) == role:
@@ -65,14 +65,14 @@ class User(UserMixin, db.Model):
             self.password = None
  
     def set_role(self, role):
-        self.role = _checkRole(role)
+        self.role = _check_role(role)
  
     def has_role(self, role):
-        role = _checkRole(role)
+        role = _check_role(role)
         return self.role == role
  
     def has_role_or_higher(self, role):
-        role = _checkRole(role)
+        role = _check_role(role)
         return self.role and (self.role >= role)
  
     def set_password(self, password):
@@ -7,6 +7,8 @@ from flask_login import login_user, logout_user
 from app.auth.models import User
 from app.auth import bp
  
+main_index = 'main.index'
+
  
 #
 # Decorator used to protect routes by role
@@ -30,10 +32,10 @@ def role_required(role):
             try:
                 is_authorised = current_user.has_role_or_higher(role)
             except ValueError:
-                raise Exception("Unknowk role provided %s" % role)
+                raise ValueError("Unknown role provided %s" % role)
             if not is_authorised:
                 flash("Vous n'avez pas les autorisations pour accéder à cette page", 'dark')
-                return redirect(url_for('main.index'))
+                return redirect(url_for(main_index))
             return f(*args, **kwargs)
  
         return decorated_function
@@ -50,12 +52,11 @@ def login():
 def login_post():
     user_login = request.form.get('login')
     user_password = request.form.get('password')
-    # user_remember = request.form.get('remember')
     user = User.query.filter_by(login=user_login).one_or_none()
     if user and user.check_password(user_password):
         login_user(user)
         flash("Connection Réussie !", 'success')
-        return redirect(url_for('main.index'))
+        return redirect(url_for(main_index))
     else:
         flash("Mauvais login ou mot de passe.", 'warning')
         return redirect(url_for('auth.login'))
@@ -65,4 +66,4 @@ def login_post():
 def logout():
     logout_user()
     flash("Vous êtes maintenant déconnecté", 'info')
-    return redirect(url_for('main.index'))
+    return redirect(url_for(main_index))
@@ -38,7 +38,7 @@ def create_db():
         sys.exit(-1)
  
     if sqlite_uri:
-        current_app.logger.info("Created sqlite db: " + sqlite_uri)
+        print("Created sqlite db: " + sqlite_uri)
  
  
 @bp.cli.command("feed_from_irap")
@@ -433,7 +433,7 @@ def feed_periods(begin_year, end_year):
 @click.option('--agent', '-a', 'agent', default=None, help="the agent id you want to charge")
 def feed_random_charges(agent):
     """ Randomly fill in the agents charges. """
-    for i in range(0, 100):
+    for _ in range(0, 100):
         if agent is None:
             agent_id = random.choice([i for (i,) in db.session.query(Agent.id).all()])
         else:
@@ -13,7 +13,8 @@ engine = create_engine(current_app.config[&#39;LESIA_AGENTS_DB_URI&#39;])
 # reflect the tables
 try:
     lesia_base.prepare(engine, reflect=True)
-except OperationalError:
+except OperationalError as oe:
+    current_app.logger.error(oe)
     current_app.logger.error("Please, configure the mysql database (see db_config.py)")
     sys.exit(-1)
  
@@ -2,30 +2,32 @@ from flask import render_template
 from app import db
 from . import bp
  
-
 # Inspired by:
 #   https://flask.palletsprojects.com/en/master/patterns/errorpages/
  
+error_page = 'error.html'
+
+
 @bp.app_errorhandler(403)
 def forbidden_error(error):
     error_title = "Page Interdite"
-    return render_template('error.html', error_title=error_title, error_msg=error), 403
+    return render_template(error_page, error_title=error_title, error_msg=error), 403
  
  
 @bp.app_errorhandler(404)
 def not_found_error(error):
     error_title = "Page Introuvable."
-    return render_template('error.html', error_title=error_title, error_msg=error), 404
+    return render_template(error_page, error_title=error_title, error_msg=error), 404
  
  
 @bp.app_errorhandler(405)
 def method_error(error):
     error_title = "Erreur de Méthode."
-    return render_template('error.html', error_title=error_title, error_msg=error), 405
+    return render_template(error_page, error_title=error_title, error_msg=error), 405
  
  
 @bp.app_errorhandler(500)
 def internal_error(error):
     db.session.rollback()
     error_title = "Erreur Interne. Administrateur Prévenu."
-    return render_template('error.html', error_title=error_title, error_msg=error), 500
+    return render_template(error_page, error_title=error_title, error_msg=error), 500
@@ -49,7 +49,7 @@ MYSQL_LESIA = {
     'host': '127.0.0.1',
     'port': '3306',
 }
-mysql_lesia_uri = 'mysql+pymysql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % MYSQL
+mysql_lesia_uri = 'mysql+pymysql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % MYSQL_LESIA
  
 # To set you databases uri,
 # uncomment the needed lines to fit your specific needs;
@@ -6,20 +6,14 @@ from shutil import copyfile
 from pdc_config import TestConfig
 from app import create_app, db_mgr, db
 from app.auth.models import User
+from tests.common_db_feed import resources_to_instancedb
  
  
 class BaseTestCase(unittest.TestCase):
     def setUp(self):
         # initialise app
         self.app = create_app(TestConfig)
-
-        # copy resource  demo db to test file
-        appdir = os.path.join(os.path.dirname(os.path.abspath(__file__)), os.pardir)
-        sqlite_file_name = os.path.abspath(os.path.join(appdir, 'resources', 'lesia-btp.sqlite'))
-        if not os.path.isdir(self.app.instance_path):
-            os.mkdir(self.app.instance_path)
-        self.db_path = os.path.join(self.app.instance_path, 'test.db')
-        copyfile(sqlite_file_name, self.db_path)
+        self.db_path = resources_to_instancedb(self.app)
  
         # force db path to newly create file
         self.app.config.update(
@@ -59,4 +53,3 @@ class DbMgrTestCase(BaseTestCase):
         stacked_charges = db_mgr.charges_by_project_stacked(60)
         # Waiting for 17 periods + headers line
         self.assertEqual(18, len(stacked_charges))
-
 import unittest
  
 from app import create_app, db, User
-from app.commands.commands import feed_from_irap, show_roles, user_add, user_show_all
+from app.commands.commands import feed_from_irap, show_roles, user_add, user_show_all, create_db
 from pdc_config import TestConfig
  
 from app.commands import bp as cli_bp
@@ -10,7 +10,8 @@ from app.commands import bp as cli_bp
 class CliBaseTestCase(unittest.TestCase):
  
     def setUp(self):
-        # Get rid of a strange 'ValueError: I/O operation' when app.logger outputs
+        # Get rid of a strange 'ValueError: I/O operation' when pytest catches app.logger outputs
+        # Error can also be bypassed with 'pytest -s' option
         TestConfig.PDC_LOGS_LEVEL = 'ERROR'
         # Force sqlite in memory db
         TestConfig.SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:'
@@ -24,16 +25,20 @@ class CliBaseTestCase(unittest.TestCase):
     def tearDown(self):
         pass
  
-    def test_hello3(self):
+    def test_create_db(self):
+        runner = self.app.test_cli_runner()
+        result = runner.invoke(create_db)
+        self.assertTrue('Created sqlite' in result.output)
+
+    def test_show_all(self):
         runner = self.app.test_cli_runner()
         result = runner.invoke(user_show_all)
-        print("\n")
-        print(result.output)
+        self.assertTrue('id' in result.output)
  
-    def test_hello2(self):
+    def test_show_roles(self):
         runner = self.app.test_cli_runner()
         result = runner.invoke(show_roles)
-        print(result.output)
+        self.assertTrue('PUBLIC' in result.output)
  
     def test_add_user(self):
         runner = self.app.test_cli_runner()
@@ -41,9 +46,7 @@ class CliBaseTestCase(unittest.TestCase):
         all_users = User.query.all()
         self.assertEqual(0, len(all_users))
         # invoke the command directly
-        arguments = ['geo@ici.fr', 'Joseph Hitier', 'joh', 'passwd', 'PUBLIC']
-        result = runner.invoke(user_add, arguments)
-        print(result.output)
+        arguments = ['geo@ici.fr', 'Géo Trouvetou', 'gt', 'passwd', 'PUBLIC']
+        runner.invoke(user_add, arguments)
         all_users = User.query.all()
-        print(len(all_users))
-        # self.assertEqual(1, len(all_users))
+        self.assertEqual(1, len(all_users))
+import os
+from shutil import copyfile
+
 from app.models import Category, db, Label, Project, ProjectLabel
  
+
+def resources_to_instancedb(app):
+    # copy resource  demo db to test file
+    appdir = os.path.join(os.path.dirname(os.path.abspath(__file__)), os.pardir)
+    sqlite_file_name = os.path.abspath(os.path.join(appdir, 'resources', 'lesia-btp.sqlite'))
+    if not os.path.isdir(app.instance_path):
+        os.mkdir(app.instance_path)
+    db_path = os.path.join(app.instance_path, 'test.db')
+    copyfile(sqlite_file_name, db_path)
+    return db_path
+
+
 categorized_labels = {'pole': ['Spatial', 'Sol'], 'domaine': ['soleil-terre', 'atmosphere', 'r&t', 'géologie']}
 projects_categories = {'ChemCam': {'pole': 'Spatial', 'domaine': 'géologie'},
                        'Pilot': {'pole': 'Spatial', 'domaine': 'atmosphere'},
@@ -30,7 +45,7 @@ def feed_projects():
             n_l = db.session.query(Label).filter(Label.name == l_name).one()
             n_pc = ProjectLabel(project=n_p, category=n_c, label=n_l)
             db.session.add(n_pc)
-            
+
     db.session.commit()
  
  
 import os
 import urllib.request
  
+from flask import url_for
 from flask_testing import LiveServerTestCase
 from selenium import webdriver
  
 from app import create_app
 from pdc_config import TestConfig
+from tests.common_db_feed import resources_to_instancedb
  
  
 class BaseFrontTestCase(LiveServerTestCase):
@@ -18,18 +20,18 @@ class BaseFrontTestCase(LiveServerTestCase):
         os.environ['WERKZEUG_RUN_MAIN'] = 'true'
  
         # pass in test configurations
-        app = create_app(TestConfig)
-        self.db_path = os.path.join(app.instance_path, 'test-app.db')
-        app.config.update(
+        self.app = create_app(TestConfig)
+        self.db_path = resources_to_instancedb(self.app)
+        self.app.config.update(
             # Specify the test database as the default in_memory wont work for web tests
             SQLALCHEMY_DATABASE_URI='sqlite:///' + self.db_path,
             # Change the port that the liveserver listens on as we dont want to conflict with running:5000
             LIVESERVER_PORT=8943
         )
  
-        self.app_context = app.app_context()
+        self.app_context = self.app.app_context()
         self.app_context.push()
-        return app
+        return self.app
  
     def setUp(self):
         self.driver = self.create_chrome_driver()
@@ -86,4 +88,30 @@ class AccessTestCase(BaseFrontTestCase):
  
     def test_server_is_up_and_running(self):
         response = urllib.request.urlopen(self.get_server_url())
-        self.assertEqual(response.code, 200)
 \ No newline at end of file
+        self.assertEqual(response.code, 200)
+
+    def test_agents_page(self):
+        target_url = self.get_server_url() + url_for('main.agents')
+        self.driver.get(target_url)
+        self.assertEqual(self.driver.current_url, 'http://localhost:8943/agents')
+
+    def test_agent_page(self):
+        agent_id = 60
+        target_url = self.get_server_url() + url_for('main.agent', agent_id=agent_id)
+        self.driver.get(target_url)
+        self.assertEqual(self.driver.current_url, f'http://localhost:8943/agent/{agent_id}')
+        td_elmts = self.driver.find_elements_by_xpath("//table[@id='charge_table']/tbody/tr/td")
+        self.assertEqual(260, len(td_elmts))
+
+    def test_projects_page(self):
+        target_url = self.get_server_url() + url_for('main.projects')
+        self.driver.get(target_url)
+        self.assertEqual(self.driver.current_url, 'http://localhost:8943/projects')
+
+    def test_project_page(self):
+        project_id = 8
+        target_url = self.get_server_url() + url_for('main.project', project_id=project_id)
+        self.driver.get(target_url)
+        self.assertEqual(self.driver.current_url, f'http://localhost:8943/project/{project_id}')
+        td_elmts = self.driver.find_elements_by_xpath("//table[@id='charge_table']/tbody/tr/td")
+        self.assertEqual(1085, len(td_elmts))