Unit tests

conda-lock.yml

@@ -478,15 +478,15 @@ package:
   category: main
   optional: false
 - name: filelock
-  version: 3.12.2
+  version: 3.12.3
   manager: conda
   platform: linux-64
   dependencies:
     python: '>=3.7'
-  url: https://conda.anaconda.org/conda-forge/noarch/filelock-3.12.2-pyhd8ed1ab_0.conda
+  url: https://conda.anaconda.org/conda-forge/noarch/filelock-3.12.3-pyhd8ed1ab_0.conda
   hash:
-    md5: 53522ec72e6adae42bd373ef58357230
-    sha256: 1cbae9f05860f2e566e2977f14dfcd5494beb22c028b0a853ade4ec381d9de71
+    md5: 3104cf0ab9fb9de393051bf92b10dbe9
+    sha256: 47635be45aa6cbfd6af65c13b5f649aef84c484e1897aef625e4ad717663eebc
   category: main
   optional: false
 - name: greenlet
@@ -1568,15 +1568,15 @@ package:
   category: main
   optional: false
 - name: filelock
-  version: 3.12.2
+  version: 3.12.3
   manager: conda
   platform: osx-64
   dependencies:
     python: '>=3.7'
-  url: https://conda.anaconda.org/conda-forge/noarch/filelock-3.12.2-pyhd8ed1ab_0.conda
+  url: https://conda.anaconda.org/conda-forge/noarch/filelock-3.12.3-pyhd8ed1ab_0.conda
   hash:
-    md5: 53522ec72e6adae42bd373ef58357230
-    sha256: 1cbae9f05860f2e566e2977f14dfcd5494beb22c028b0a853ade4ec381d9de71
+    md5: 3104cf0ab9fb9de393051bf92b10dbe9
+    sha256: 47635be45aa6cbfd6af65c13b5f649aef84c484e1897aef625e4ad717663eebc
   category: main
   optional: false
 - name: greenlet

environment.yml

@@ -41,3 +41,4 @@ dependencies:
     - wtforms-sqlalchemy
     - flask-dance
     - bootstrap-flask ~=2.3.0
+    # - mock-alchemy~=0.2.6

pyproject.toml

@@ -1,3 +1,7 @@
+[tool.pytest.ini_options]
+testpaths = ['tests']
+pythonpath = ['.']
+
 [tool.black]
 target-version = ['py310']
 skip-string-normalization = true

tasks/test.py

@@ -29,6 +29,13 @@ def typecheck(ctx):
     print('🎉🦆 Type checking passed.')
 
 
+@task()
+def unit(ctx):
+    """Run unit tests."""
+    print_and_run(f'cd {PROJECT_DIR} && pytest')
+    print('🎉🦆 Unit checking passed.')
+
+
 @task(
     pre=[typecheck],
     default=True,

tests/conftest.py

@@ -0,0 +1,38 @@
+from unittest import mock
+
+import pytest
+from flask_login import FlaskLoginClient
+from mock_alchemy.mocking import UnifiedAlchemyMagicMock
+
+from usaon_vta_survey import app as my_app
+from usaon_vta_survey.models.tables import User
+
+
+@pytest.fixture()
+def app():
+    yield my_app
+
+
+@pytest.fixture()
+def client(app):
+    return app.test_client()
+
+
+@pytest.fixture()
+def session_with_user():
+    session = UnifiedAlchemyMagicMock(
+        data=[
+            (
+                [mock.call.query(User), mock.call.get(1)],
+                [User(id=1, email='[email protected]', name='foo bar', role_id='admin')],
+            )
+        ]
+    )
+    return session
+
+
+@pytest.fixture()
+def client_logged_in(app, session_with_user):
+    app.test_client_class = FlaskLoginClient
+    user = session_with_user.query(User).get(1)
+    return app.test_client(user=user)

tests/test_logged_in.py

@@ -0,0 +1,5 @@
+def test_logged_in(client_logged_in):
+    actual = client_logged_in.get('/')
+    # breakpoint()
+    expected = ...
+    assert actual == expected

tests/test_logged_out.py

@@ -0,0 +1,4 @@
+def test_logged_out(client):
+    actual = client.get('/').location
+    expected = '/login?next=%2F'
+    assert actual == expected

tests/test_version.py

@@ -0,0 +1,7 @@
+from usaon_vta_survey.constants.version import VERSION
+
+
+def test_version_matches(client):
+    actual = client.get('/login', follow_redirects=True).text
+    expected = VERSION
+    assert expected in actual

usaon_vta_survey/__init__.py

@@ -3,6 +3,7 @@
 
 from flask import Flask
 from flask_bootstrap import Bootstrap5
+from flask_login import LoginManager
 from flask_sqlalchemy import SQLAlchemy
 from sqlalchemy import MetaData
 from sqlalchemy import inspect as sqla_inspect
@@ -25,6 +26,7 @@
     )
 )
 
+
 app = Flask(__name__)
 app.config['SECRET_KEY'] = os.environ.get('FLASK_SECRET_KEY', 'youcanneverguess')
 app.config['LOGIN_DISABLED'] = envvar_is_true("USAON_VTA_LOGIN_DISABLED")
@@ -33,6 +35,10 @@
 db.init_app(app)
 bootstrap = Bootstrap5(app)
 
+login_manager = LoginManager(app)
+login_manager.login_view = 'login'
+login_manager.login_message_category = 'info'
+
 app.jinja_env.globals.update(sqla_inspect=sqla_inspect, __version__=__version__)
 
 # NOTE: This is a circular import, but it's specified by the Flask docs:

usaon_vta_survey/routes/login.py

@@ -1,7 +1,7 @@
 import os
 import time
 
-from flask import redirect, session, url_for
+from flask import redirect, render_template, session, url_for
 from flask_dance.contrib.google import google, make_google_blueprint
 from flask_login import login_user
 
@@ -18,6 +18,11 @@
 
 @app.route("/login")
 def login():
+    return render_template('login.html')
+
+
+@app.route("/login_start")
+def login_start():
     if not google.authorized:
         return redirect(url_for("google.login"))
     resp = google.get("/oauth2/v2/userinfo")

usaon_vta_survey/routes/logout.py

@@ -1,10 +1,11 @@
 from flask import redirect
-from flask_login import logout_user
+from flask_login import login_required, logout_user
 
 from usaon_vta_survey import app
 
 
 @app.route("/logout")
+@login_required
 def logout():
     logout_user()
     return redirect("/")

usaon_vta_survey/routes/response/applications.py

@@ -1,4 +1,5 @@
 from flask import redirect, render_template, request, url_for
+from flask_login import login_required
 
 from usaon_vta_survey import app, db
 from usaon_vta_survey.forms import FORMS_BY_MODEL
@@ -8,6 +9,7 @@
 
 
 @app.route('/response/<string:survey_id>/applications', methods=['GET', 'POST'])
+@login_required
 def view_response_applications(survey_id: str):
     """View and add to applications associated with a response."""
     Form = FORMS_BY_MODEL[ResponseApplication]

usaon_vta_survey/routes/response/data_products.py

@@ -1,4 +1,5 @@
 from flask import redirect, render_template, request, url_for
+from flask_login import login_required
 
 from usaon_vta_survey import app, db
 from usaon_vta_survey.forms import FORMS_BY_MODEL
@@ -7,6 +8,7 @@
 
 
 @app.route('/response/<string:survey_id>/data_products', methods=['GET', 'POST'])
+@login_required
 def view_response_data_products(survey_id: str):
     """View and add to data products associated with a response."""
     Form = FORMS_BY_MODEL[ResponseDataProduct]

usaon_vta_survey/routes/response/relationships/application_societal_benefit_area.py

@@ -1,4 +1,5 @@
 from flask import Request, redirect, render_template, request, url_for
+from flask_login import login_required
 from flask_wtf import FlaskForm
 from wtforms import FormField
 
@@ -134,6 +135,7 @@ def _request_args(request: Request) -> tuple[int | None, int | None]:
     '/response/<string:survey_id>/application_societal_benefit_area_relationships',
     methods=['GET', 'POST'],
 )
+@login_required
 def view_response_application_societal_benefit_area_relationships(survey_id: str):
     """View and add application/SBA relationships to a response.
 

usaon_vta_survey/routes/response/relationships/data_product_application.py

@@ -1,4 +1,5 @@
 from flask import Request, redirect, render_template, request, url_for
+from flask_login import login_required
 from flask_wtf import FlaskForm
 from wtforms import FormField
 
@@ -125,6 +126,7 @@ def _request_args(request: Request) -> tuple[int | None, int | None]:
     '/response/<string:survey_id>/data_product_application_relationships',
     methods=['GET', 'POST'],
 )
+@login_required
 def view_response_data_product_application_relationships(survey_id: str):
     """View and add application/dataproduct relationships to a response.
 

usaon_vta_survey/routes/response/relationships/observing_system_data_product.py

@@ -1,4 +1,5 @@
 from flask import Request, redirect, render_template, request, url_for
+from flask_login import login_required
 from flask_wtf import FlaskForm
 from wtforms import FormField
 
@@ -129,6 +130,7 @@ def _request_args(request: Request) -> tuple[int | None, int | None]:
     '/response/<string:survey_id>/observing_system_data_product_relationships',
     methods=['GET', 'POST'],
 )
+@login_required
 def view_response_observing_system_data_product_relationships(survey_id: str):
     """View and add observing system/dataproduct relationships to a response.
 

usaon_vta_survey/routes/response/sbas.py

@@ -1,4 +1,5 @@
 from flask import redirect, render_template, request, url_for
+from flask_login import login_required
 
 from usaon_vta_survey import app, db
 from usaon_vta_survey.forms import FORMS_BY_MODEL
@@ -13,6 +14,7 @@
 @app.route(
     '/response/<string:survey_id>/societal_benefit_areas', methods=['GET', 'POST']
 )
+@login_required
 def view_response_sbas(survey_id: str):
     """View and add to observing systems associated with a response."""
     sbas = SocietalBenefitArea.query.all()

usaon_vta_survey/routes/survey.py

@@ -1,11 +1,13 @@
 from flask import redirect, render_template, request, url_for
+from flask_login import login_required
 
 from usaon_vta_survey import app, db
 from usaon_vta_survey.forms import FORMS_BY_MODEL
 from usaon_vta_survey.models.tables import Survey
 
 
 @app.route('/survey/new', methods=['GET', 'POST'])
+@login_required
 def new_survey():
     Form = FORMS_BY_MODEL[Survey]
     survey = Survey()
@@ -26,6 +28,7 @@ def new_survey():
 
 
 @app.route('/survey/<string:survey_id>')
+@login_required
 def view_survey(survey_id: str):
     # Fetch survey by id
     survey = db.get_or_404(Survey, survey_id)

usaon_vta_survey/routes/surveys.py

@@ -1,11 +1,14 @@
 from flask import render_template
+from flask_login import login_required
 
 from usaon_vta_survey import app
 from usaon_vta_survey.models.tables import Survey
 
 
 @app.route('/surveys')
+@login_required
 def view_surveys():
+    # NOTE: if we're logged out we don't want to talk to the DB at all.
     surveys = Survey.query.order_by(Survey.created_timestamp).all()
     return render_template(
         'surveys.html',

usaon_vta_survey/routes/user.py

@@ -1,12 +1,10 @@
 from flask import flash, render_template, request
-from flask_login import LoginManager, current_user
+from flask_login import current_user, login_required
 
-from usaon_vta_survey import app, db
+from usaon_vta_survey import app, db, login_manager
 from usaon_vta_survey.forms import FORMS_BY_MODEL
 from usaon_vta_survey.models.tables import User
 
-login_manager = LoginManager(app)
-
 
 @login_manager.user_loader
 def load_user(user_id: str) -> User:
@@ -28,6 +26,7 @@ def _validate_role_change(user: User, form) -> None:
 
 
 @app.route('/user/<user_id>', methods=['POST', 'GET'])
+@login_required
 def user(user_id: str):
     Form = FORMS_BY_MODEL[User]
     user = db.get_or_404(User, user_id)

usaon_vta_survey/routes/users.py

@@ -1,10 +1,12 @@
 from flask import render_template
+from flask_login import login_required
 
 from usaon_vta_survey import app
 from usaon_vta_survey.models.tables import User
 
 
 @app.route('/users')
+@login_required
 def view_users():
     users = User.query.order_by(User.name).all()
     return render_template(

usaon_vta_survey/templates/base.html

@@ -22,11 +22,7 @@ <h1>US AON VTA Survey System</h1>
     </header>
 
 
-    {% if not current_user.is_authenticated %}
-      <h3>Please login to use this application.</h3>
-    {% else %}
-      {% block content %}{% endblock %}
-    {% endif %}
+    {% block content %}{% endblock %}
 
   </section>
   <footer>

usaon_vta_survey/templates/login.html

@@ -0,0 +1,7 @@
+{% extends 'base.html' %}
+
+{% block content %}
+
+<h1>{% block title %}Please log in.{% endblock %}</h1>
+
+{% endblock %}

usaon_vta_survey/templates/macros/nav_buttons.j2

@@ -13,6 +13,6 @@
       {{ render_nav_item("logout", "Log out")}}
     {% endif %}
   {% else %}
-    {{ render_nav_item("login", "Log in")}}
+    {{ render_nav_item("login_start", "Log in")}}
   {% endif %}
 {%- endmacro -%}