diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml new file mode 100644 index 00000000..d126b7e3 --- /dev/null +++ b/.github/workflows/unit_tests.yml @@ -0,0 +1,31 @@ +name: Run Unit Tests + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + unit_test: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.11 + + - name: Install Poetry + run: pip install poetry + + - name: Install dependencies + run: poetry install + + - name: Run Pytest tests + run: poetry run pytest --cov=app/main --cov-report term-missing -vvv app/tests/ diff --git a/app/main/routes.py b/app/main/routes.py index dd01beb8..4c206004 100644 --- a/app/main/routes.py +++ b/app/main/routes.py @@ -15,7 +15,7 @@ from app.main import bp from app.main.forms import CookiesForm -from app.data.data import consignment_response, consignment_files_response +# from app.data.data import consignment_response, consignment_files_response from keycloak import KeycloakOpenID @@ -58,10 +58,6 @@ ] -# Get WellKnown -config_well_known = keycloak_openid.well_known() - - @bp.route("/", methods=["GET"]) def index(): return render_template("index.html") @@ -153,13 +149,13 @@ def quick_access(): return render_template("quick-access.html") -@bp.route("/record", methods=["GET"]) -def record(): - return render_template( - "record.html", - consignment=consignment_response, - consignment_files=consignment_files_response, - ) +# @bp.route("/record", methods=["GET"]) +# def record(): +# return render_template( +# "record.html", +# consignment=consignment_response, +# consignment_files=consignment_files_response, +# ) @bp.route("/all-departments", methods=["GET"]) diff --git a/app/tests/test_footer_links.py b/app/tests/__init__.py similarity index 100% rename from app/tests/test_footer_links.py rename to app/tests/__init__.py diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 00000000..6a1767e9 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,15 @@ +import pytest +from app import create_app + + +@pytest.fixture +def app(): + app = create_app() + app.config["TESTING"] = True + app.config["WTF_CSRF_ENABLED"] = False + yield app + + +@pytest.fixture +def client(app): + return app.test_client() diff --git a/app/tests/test_example.py b/app/tests/test_example.py deleted file mode 100644 index 6bb5f266..00000000 --- a/app/tests/test_example.py +++ /dev/null @@ -1,19 +0,0 @@ -import re -from playwright.sync_api import Page, expect - - -def test_has_title(page: Page): - page.goto("https://playwright.dev/") - - # Expect a title "to contain" a substring. - expect(page).to_have_title(re.compile("Playwright")) - - -def test_get_started_link(page: Page): - page.goto("https://playwright.dev/") - - # Click the get started link. - page.get_by_role("link", name="Get started").click() - - # Expects page to have a heading with the name of Installation. - expect(page.get_by_role("heading", name="Installation")).to_be_visible() diff --git a/app/tests/test_login.py b/app/tests/test_login.py deleted file mode 100644 index e69de29b..00000000 diff --git a/app/tests/test_record_metadata.py b/app/tests/test_record_metadata.py deleted file mode 100644 index 5d15d11c..00000000 --- a/app/tests/test_record_metadata.py +++ /dev/null @@ -1,17 +0,0 @@ -import re -from playwright.sync_api import Page, expect - - -def test_page_title_and_header(page: Page): - page.goto("http://localhost:5000/record") - expect(page).to_have_title( - re.compile("Record – AYR - Access Your Records – GOV.UK") - ) - expect(page.get_by_text("Record metadata")).to_be_visible() - - -def test_back_link(page: Page): - page.goto("http://localhost:5000/record") - page.get_by_role("link", name="Back", exact=True).click() - page.wait_for_url("/") - page.close() diff --git a/app/tests/test_search.py b/app/tests/test_search.py index e69de29b..3dac95ea 100644 --- a/app/tests/test_search.py +++ b/app/tests/test_search.py @@ -0,0 +1,15 @@ +from flask.testing import FlaskClient + + +def test_poc_search_get(client: FlaskClient): + """ + Given a user accessing the search page + When they make a GET request + Then they should see the search form and page content. + """ + response = client.get("/poc-search-view", follow_redirects=True) + + assert response.status_code == 200 + assert b"Search design PoC" in response.data + assert b"Search for digital records" in response.data + assert b"Search" in response.data diff --git a/config.py b/config.py index 8d24d825..7aae0aeb 100644 --- a/config.py +++ b/config.py @@ -2,15 +2,15 @@ class Config(object): - CONTACT_EMAIL = os.environ.get("CONTACT_EMAIL") - CONTACT_PHONE = os.environ.get("CONTACT_PHONE") - DEPARTMENT_NAME = os.environ.get("DEPARTMENT_NAME") - DEPARTMENT_URL = os.environ.get("DEPARTMENT_URL") + CONTACT_EMAIL = os.environ.get("CONTACT_EMAIL", "") + CONTACT_PHONE = os.environ.get("CONTACT_PHONE", "") + DEPARTMENT_NAME = os.environ.get("DEPARTMENT_NAME", "") + DEPARTMENT_URL = os.environ.get("DEPARTMENT_URL", "") RATELIMIT_HEADERS_ENABLED = True - RATELIMIT_STORAGE_URI = os.environ.get("REDIS_URL") - SECRET_KEY = os.environ.get("SECRET_KEY") - SERVICE_NAME = os.environ.get("SERVICE_NAME") - SERVICE_PHASE = os.environ.get("SERVICE_PHASE") - SERVICE_URL = os.environ.get("SERVICE_URL") + RATELIMIT_STORAGE_URI = os.environ.get("REDIS_URL", "") + SECRET_KEY = os.environ.get("SECRET_KEY", "") + SERVICE_NAME = os.environ.get("SERVICE_NAME", "") + SERVICE_PHASE = os.environ.get("SERVICE_PHASE", "") + SERVICE_URL = os.environ.get("SERVICE_URL", "") SESSION_COOKIE_HTTPONLY = True SESSION_COOKIE_SECURE = True diff --git a/app/tests/test_header.py b/e2e_tests/__init__.py similarity index 100% rename from app/tests/test_header.py rename to e2e_tests/__init__.py diff --git a/app/tests/test_homepage.py b/e2e_tests/test_homepage.py similarity index 84% rename from app/tests/test_homepage.py rename to e2e_tests/test_homepage.py index 2e429c89..7b707dd2 100644 --- a/app/tests/test_homepage.py +++ b/e2e_tests/test_homepage.py @@ -3,7 +3,7 @@ def test_has_title(page: Page): - page.goto("http://localhost:5000/") + page.goto("/") # Expect a title "to contain" a substring. expect(page).to_have_title(re.compile("AYR - Access Your Records – GOV.UK")) diff --git a/e2e_tests/test_record_metadata.py b/e2e_tests/test_record_metadata.py new file mode 100644 index 00000000..a12cb68e --- /dev/null +++ b/e2e_tests/test_record_metadata.py @@ -0,0 +1,17 @@ +# import re +# from playwright.sync_api import Page, expect + + +# def test_page_title_and_header(page: Page): +# page.goto("/record") +# expect(page).to_have_title( +# re.compile("Record – AYR - Access Your Records – GOV.UK") +# ) +# expect(page.get_by_text("Record metadata")).to_be_visible() + + +# def test_back_link(page: Page): +# page.goto("/record") +# page.get_by_role("link", name="Back", exact=True).click() +# page.wait_for_url("/") +# page.close() diff --git a/poetry.lock b/poetry.lock index b1d4f582..4bdf9056 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.5.1 and should not be changed by hand. [[package]] name = "async-timeout" @@ -755,6 +755,19 @@ memcached = ["limits[memcached]"] mongodb = ["limits[mongodb]"] redis = ["limits[redis]"] +[[package]] +name = "flask-pytest" +version = "0.0.5" +description = "Runs pytest in a background process when DEBUG is True." +optional = false +python-versions = "*" +files = [ + {file = "flask-pytest-0.0.5.zip", hash = "sha256:1a55570e76909b98a988e8d64af9fab14b3b8d55ae1e14431b8644fafb94e9da"}, +] + +[package.dependencies] +pytest = ">=2.7.0" + [[package]] name = "flask-talisman" version = "1.1.0" @@ -1116,16 +1129,6 @@ files = [ {file = "MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5bbe06f8eeafd38e5d0a4894ffec89378b6c6a625ff57e3028921f8ff59318ac"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win32.whl", hash = "sha256:dd15ff04ffd7e05ffcb7fe79f1b98041b8ea30ae9234aed2a9168b5797c3effb"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:134da1eca9ec0ae528110ccc9e48041e0828d79f24121a1a146161103c76e686"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f698de3fd0c4e6972b92290a45bd9b1536bffe8c6759c62471efaa8acb4c37bc"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:aa57bd9cf8ae831a362185ee444e15a93ecb2e344c8e52e4d721ea3ab6ef1823"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ffcc3f7c66b5f5b7931a5aa68fc9cecc51e685ef90282f4a82f0f5e9b704ad11"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47d4f1c5f80fc62fdd7777d0d40a2e9dda0a05883ab11374334f6c4de38adffd"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1f67c7038d560d92149c060157d623c542173016c4babc0c1913cca0564b9939"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9aad3c1755095ce347e26488214ef77e0485a3c34a50c5a5e2471dff60b9dd9c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:14ff806850827afd6b07a5f32bd917fb7f45b046ba40c57abdb636674a8b559c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8f9293864fe09b8149f0cc42ce56e3f0e54de883a9de90cd427f191c346eb2e1"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win32.whl", hash = "sha256:715d3562f79d540f251b99ebd6d8baa547118974341db04f5ad06d5ea3eb8007"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:1b8dd8c3fd14349433c79fa8abeb573a55fc0fdd769133baac1f5e07abf54aeb"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8e254ae696c88d98da6555f5ace2279cf7cd5b3f52be2b5cf97feafe883b58d2"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cb0932dc158471523c9637e807d9bfb93e06a95cbf010f1a38b98623b929ef2b"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9402b03f1a1b4dc4c19845e5c749e3ab82d5078d16a2a4c2cd2df62d57bb0707"}, @@ -1588,7 +1591,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1596,15 +1598,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1621,7 +1616,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1629,7 +1623,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -2043,4 +2036,4 @@ email = ["email-validator"] [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "2dedf9f63f81f2a73396104e6b1bf784e90bac9154b90d367ba1667f99371093" +content-hash = "638541e4899a745e28f3e989a3a2de7957bb398d5b1413c21d18a041cfaf1537" diff --git a/pyproject.toml b/pyproject.toml index a02e70bc..17839592 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,7 @@ python-dotenv = "1.0.0" redis = "5.0.1" python-keycloak = "3.3.0" pytest-playwright = "0.4.3" +flask-pytest = "^0.0.5" [tool.poetry.group.dev.dependencies] bandit = "1.7.5"