From 6d4064e8887ed764bbfd6c02539e5771dd72901a Mon Sep 17 00:00:00 2001 From: Kenneth Kehl <@kkehl@flexion.us> Date: Wed, 28 Feb 2024 07:41:13 -0800 Subject: [PATCH 01/13] make sure original_file_name is stored as part of job (notify-admin-1148) --- app/job/rest.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/job/rest.py b/app/job/rest.py index 1aab2ca60..c5df0dddb 100644 --- a/app/job/rest.py +++ b/app/job/rest.py @@ -144,6 +144,7 @@ def get_jobs_by_service(service_id): ) + @job_blueprint.route("", methods=["POST"]) def create_job(service_id): service = dao_fetch_service_by_id(service_id) @@ -151,6 +152,7 @@ def create_job(service_id): raise InvalidRequest("Create job is not allowed: service is inactive ", 403) data = request.get_json() + original_file_name = data["original_file_name"] data.update({"service": service_id}) try: data.update(**get_job_metadata_from_s3(service_id, data["id"])) @@ -173,6 +175,8 @@ def create_job(service_id): data.update({"template_version": template.version}) job = job_schema.load(data) + # See admin #1148, for whatever reason schema loading doesn't load this + job.original_file_name = original_file_name if job.scheduled_for: job.job_status = JOB_STATUS_SCHEDULED From 689d82280b46e4d2a987d4948a63cc11d3b5e35a Mon Sep 17 00:00:00 2001 From: Kenneth Kehl <@kkehl@flexion.us> Date: Wed, 28 Feb 2024 08:23:56 -0800 Subject: [PATCH 02/13] fix tests --- app/job/rest.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/job/rest.py b/app/job/rest.py index c5df0dddb..d86a4ec62 100644 --- a/app/job/rest.py +++ b/app/job/rest.py @@ -144,7 +144,6 @@ def get_jobs_by_service(service_id): ) - @job_blueprint.route("", methods=["POST"]) def create_job(service_id): service = dao_fetch_service_by_id(service_id) @@ -152,7 +151,7 @@ def create_job(service_id): raise InvalidRequest("Create job is not allowed: service is inactive ", 403) data = request.get_json() - original_file_name = data["original_file_name"] + original_file_name = data.get("original_file_name") data.update({"service": service_id}) try: data.update(**get_job_metadata_from_s3(service_id, data["id"])) @@ -176,7 +175,8 @@ def create_job(service_id): job = job_schema.load(data) # See admin #1148, for whatever reason schema loading doesn't load this - job.original_file_name = original_file_name + if original_file_name is not None: + job.original_file_name = original_file_name if job.scheduled_for: job.job_status = JOB_STATUS_SCHEDULED From 611a8c8bc681b3fa63dbb4165a8362e0591d9517 Mon Sep 17 00:00:00 2001 From: Carlo Costino Date: Fri, 1 Mar 2024 12:23:05 -0500 Subject: [PATCH 03/13] Add E2E configuration information to docs This changeset adds a bit of missing information to our README and documentation for E2E test configuration. This is required for the project to be set up correctly, and while it will work out of the box, there are a couple of adjustments that need to be made to ensure everything is configured correctly. Signed-off-by: Carlo Costino --- README.md | 31 +++++++++++++++++++++++++++++++ docs/all.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+) diff --git a/README.md b/README.md index 94aea0c41..d435cfc7b 100644 --- a/README.md +++ b/README.md @@ -299,6 +299,36 @@ brew services start postgresql@15 brew services start redis ``` +### Final environment setup + +There's one final thing to adjust in the newly created `.env` file. This +project has support for end-to-end (E2E) tests and has some additional checks +for the presence of an E2E test user so that it can be authenticated properly. + +In the `.env` file, you should see this section: + +``` +############################################################# + +# E2E Testing + +NOTIFY_E2E_TEST_EMAIL=example@fake.gov +NOTIFY_E2E_TEST_PASSWORD="don't write secrets to the sample file" +``` + +You can leave the email address alone or change it to something else to your +liking. + +**You should absolutely change the `NOTIFY_E2E_TEST_PASSWORD` environment +variable to something else, preferably a lengthy passphrase.** + +With those two environment variable set, the database migrations will run +properly and an E2E test user will be ready to go for use in the admin project. + +_Note: Whatever you set these two environment variables to, you'll need to +match their values on the admin side. Please see the admin README and +documentation for more details._ + ## Running the Project and Routine Maintenance The first time you run the project you'll need to run the project setup from the @@ -410,6 +440,7 @@ instructions above for more details. - [CI testing](./docs/all.md#ci-testing) - [Manual testing](./docs/all.md#manual-testing) - [To run a local OWASP scan](./docs/all.md#to-run-a-local-owasp-scan) + - [End-to-end testing](./docs/all.md#end-to-end-testing) - [Deploying](./docs/all.md#deploying) - [Egress Proxy](./docs/all.md#egress-proxy) - [Managing environment variables](./docs/all.md#managing-environment-variables) diff --git a/docs/all.md b/docs/all.md index 4803102dd..57743f97c 100644 --- a/docs/all.md +++ b/docs/all.md @@ -11,6 +11,7 @@ - [CI testing](#ci-testing) - [Manual testing](#manual-testing) - [To run a local OWASP scan](#to-run-a-local-owasp-scan) + - [End-to-end testing](#end-to-end-testing) - [Deploying](#deploying) - [Egress Proxy](#egress-proxy) - [Managing environment variables](#managing-environment-variables) @@ -307,6 +308,37 @@ The equivalent command if you are running the API locally: docker run -v $(pwd):/zap/wrk/:rw -t owasp/zap2docker-weekly zap-api-scan.py -t http://host.docker.internal:6011/docs/openapi.yml -f openapi -c zap.conf -r report.html ``` +## End-to-end Testing + +In order to run end-to-end (E2E) tests, which are managed and handled in the +admin project, a bit of extra configuration needs to be accounted for here on +the API side as well. These instructions are in the README as they are +necessary for project setup, and they're copied here for reference. + +In the `.env` file, you should see this section: + +``` +############################################################# + +# E2E Testing + +NOTIFY_E2E_TEST_EMAIL=example@fake.gov +NOTIFY_E2E_TEST_PASSWORD="don't write secrets to the sample file" +``` + +You can leave the email address alone or change it to something else to your +liking. + +**You should absolutely change the `NOTIFY_E2E_TEST_PASSWORD` environment +variable to something else, preferably a lengthy passphrase.** + +With those two environment variable set, the database migrations will run +properly and an E2E test user will be ready to go for use in the admin project. + +_Note: Whatever you set these two environment variables to, you'll need to +match their values on the admin side. Please see the admin README and +documentation for more details._ + # Deploying The API has 3 deployment environments, all of which deploy to cloud.gov: From 08fe6beff764fc2f46bb0d6f94f7c23f5a88b69a Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Fri, 1 Mar 2024 12:13:29 -0700 Subject: [PATCH 04/13] Added commands to add test data to DB Updated old .uk strings in db.py --- app/commands.py | 154 ++++++++++++++++++++++++++++++++++++++++++++++++ tests/app/db.py | 6 +- 2 files changed, 156 insertions(+), 4 deletions(-) diff --git a/app/commands.py b/app/commands.py index 32cbd219b..d708da590 100644 --- a/app/commands.py +++ b/app/commands.py @@ -1,6 +1,7 @@ import csv import functools import itertools +import random import uuid from datetime import datetime, timedelta from os import getenv @@ -8,6 +9,7 @@ from os import getenv import click import flask from click_datetime import Datetime as click_dt +from faker import Faker from flask import current_app, json from notifications_python_client.authentication import create_jwt_token from notifications_utils.recipients import RecipientCSV @@ -64,6 +66,14 @@ from app.models import ( User, ) from app.utils import get_midnight_in_utc +from tests.app.db import ( + create_job, + create_notification, + create_organization, + create_service, + create_template, + create_user, +) @click.group(name="command", help="Additional commands") @@ -833,3 +843,147 @@ def purge_csv_bucket(): print("ABOUT TO RUN PURGE CSV BUCKET") s3.purge_bucket(bucket_name, access_key, secret, region) print("RAN PURGE CSV BUCKET") + + +""" +Commands to load test data into the database for +Orgs, Services, Users, Jobs, Notifications + +faker is used to generate some random fields. All +database commands were used from tests/app/db.py +where possible to enable better maintainability. +""" +fake = Faker(["en_US"]) + + +# generate n number of test orgs into the dev DB +@notify_command(name="add-test-organization-to-db") +@click.option("-g", "--generate", required=True, prompt=True, default=1) +def add_test_organization_to_db(generate): + def generate_gov_agency(): + agency_names = [ + "Bureau", + "Department", + "Administration", + "Authority", + "Commission", + "Division", + "Office", + "Institute", + "Agency", + "Council", + "Board", + "Committee", + "Corporation", + "Service", + "Center", + "Registry", + "Foundation", + "Task Force", + "Unit", + ] + + government_sectors = [ + "Healthcare", + "Education", + "Transportation", + "Defense", + "Law Enforcement", + "Environmental Protection", + "Housing and Urban Development", + "Finance and Economy", + "Social Services", + "Energy", + "Agriculture", + "Labor and Employment", + "Foreign Affairs", + "Trade and Commerce", + "Science and Technology", + ] + + agency = random.choice(agency_names) + speciality = random.choice(government_sectors) + + return f"{fake.word().capitalize()} {speciality} {agency}" + + for num in range(1, int(generate) + 1): + org = create_organization( + name=generate_gov_agency(), + organization_type=random.choice(["federal", "state", "other"]), + ) + print(f"{num} {org.name} created") + + +# generate n number of test services into the dev DB +@notify_command(name="add-test-service-to-db") +@click.option("-g", "--generate", required=True, prompt=True, default=1) +def add_test_service_to_db(generate): + if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: + current_app.logger.error("Can only be run in development") + return + + for num in range(1, int(generate) + 1): + service_name = f"{fake.company()} sample service" + service = create_service(service_name=service_name) + print(f"{num} {service.name} created") + + +# generate n number of test jobs into the dev DB +@notify_command(name="add-test-job-to-db") +@click.option("-g", "--generate", required=True, prompt=True, default=1) +def add_test_job_to_db(generate): + if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: + current_app.logger.error("Can only be run in development") + return + + for num in range(1, int(generate) + 1): + service = create_service(check_if_service_exists=True) + template = create_template(service=service) + job = create_job(template) + print(f"{num} {job.id} created") + + +# generate n number of notifications into the dev DB +@notify_command(name="add-test-notification-to-db") +@click.option("-g", "--generate", required=True, prompt=True, default=1) +def add_test_notification_to_db(generate): + if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: + current_app.logger.error("Can only be run in development") + return + + for num in range(1, int(generate) + 1): + service = create_service(check_if_service_exists=True) + template = create_template(service=service) + job = create_job(template=template) + notification = create_notification( + template=template, + job=job, + ) + print(f"{num} {notification.id} created") + + +# generate n number of test users into the dev DB +@notify_command(name="add-test-users") +@click.option("-g", "--generate", required=True, prompt=True, default="1") +@click.option("-s", "--state", default="active") +@click.option("-d", "--admin", default=False, type=bool) +def add_test_users(generate, state, admin): + if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: + current_app.logger.error("Can only be run in development") + return + + for num in range(1, int(generate) + 1): + + def fake_email(name): + first_name, last_name = name.split(maxsplit=1) + username = f"{first_name.lower()}.{last_name.lower()}" + return f"{username}@test.gsa.gov" + + name = fake.name() + user = create_user( + name=name, + email=fake_email(name), + state=state, + platform_admin=admin, + ) + print(f"{num} {user.email_address} created") diff --git a/tests/app/db.py b/tests/app/db.py index 56a33335f..a5d72a944 100644 --- a/tests/app/db.py +++ b/tests/app/db.py @@ -75,7 +75,7 @@ def create_user( data = { "id": id_ or uuid.uuid4(), "name": name, - "email_address": email or f"{uuid.uuid4()}@digital.cabinet-office.gov.uk", + "email_address": email or f"{uuid.uuid4()}@test.gsa.gov", "password": "password", "mobile_number": mobile_number, "state": state, @@ -133,9 +133,7 @@ def create_service( else service_name.lower().replace(" ", "."), created_by=user if user - else create_user( - email="{}@digital.cabinet-office.gov.uk".format(uuid.uuid4()) - ), + else create_user(email="{}@test.gsa.gov".format(uuid.uuid4())), prefix_sms=prefix_sms, organization_type=organization_type, organization=organization, From eb52cdff0d08f8ff31454b7062ed39760e856ddb Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Fri, 1 Mar 2024 12:34:01 -0700 Subject: [PATCH 05/13] New lock file --- poetry.lock | 159 ++++++++++++++++++++++++++-------------------------- 1 file changed, 79 insertions(+), 80 deletions(-) diff --git a/poetry.lock b/poetry.lock index 8f8b2f11f..089587a20 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.1 and should not be changed by hand. [[package]] name = "aiohttp" @@ -446,18 +446,18 @@ crt = ["awscrt (==0.19.12)"] [[package]] name = "build" -version = "1.0.3" +version = "1.1.1" description = "A simple, correct Python build frontend" optional = false python-versions = ">= 3.7" files = [ - {file = "build-1.0.3-py3-none-any.whl", hash = "sha256:589bf99a67df7c9cf07ec0ac0e5e2ea5d4b37ac63301c4986d1acb126aa83f8f"}, - {file = "build-1.0.3.tar.gz", hash = "sha256:538aab1b64f9828977f84bc63ae570b060a8ed1be419e7870b8b4fc5e6ea553b"}, + {file = "build-1.1.1-py3-none-any.whl", hash = "sha256:8ed0851ee76e6e38adce47e4bee3b51c771d86c64cf578d0c2245567ee200e73"}, + {file = "build-1.1.1.tar.gz", hash = "sha256:8eea65bb45b1aac2e734ba2cc8dad3a6d97d97901a395bd0ed3e7b46953d2a31"}, ] [package.dependencies] colorama = {version = "*", markers = "os_name == \"nt\""} -importlib-metadata = {version = ">=4.6", markers = "python_version < \"3.10\""} +importlib-metadata = {version = ">=4.6", markers = "python_full_version < \"3.10.2\""} packaging = ">=19.0" pyproject_hooks = "*" tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} @@ -1001,13 +1001,13 @@ test-randomorder = ["pytest-randomly"] [[package]] name = "cyclonedx-python-lib" -version = "6.4.1" +version = "6.4.2" description = "Python library for CycloneDX" optional = false python-versions = ">=3.8,<4.0" files = [ - {file = "cyclonedx_python_lib-6.4.1-py3-none-any.whl", hash = "sha256:42d50052c4604e8d6a91753e51bca33d668fb82adc1aab3f4eb54b89fa61cbc0"}, - {file = "cyclonedx_python_lib-6.4.1.tar.gz", hash = "sha256:aca5d8cf10f8d8420ba621e0cf4a24b98708afb68ca2ca72d7f2cc6394c75681"}, + {file = "cyclonedx_python_lib-6.4.2-py3-none-any.whl", hash = "sha256:47ed05c7a82d0aa355f09a7fd0048e13f1440b6a96b603dc26d02ba782e6274e"}, + {file = "cyclonedx_python_lib-6.4.2.tar.gz", hash = "sha256:b857972c6a7317faa66ec4ed4b6040dae7fca82e40eddfbeaa7f0f37f9a7cac7"}, ] [package.dependencies] @@ -2374,67 +2374,67 @@ xray = ["aws-xray-sdk (>=0.93,!=0.96)", "setuptools"] [[package]] name = "msgpack" -version = "1.0.7" +version = "1.0.8" description = "MessagePack serializer" optional = false python-versions = ">=3.8" files = [ - {file = "msgpack-1.0.7-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:04ad6069c86e531682f9e1e71b71c1c3937d6014a7c3e9edd2aa81ad58842862"}, - {file = "msgpack-1.0.7-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:cca1b62fe70d761a282496b96a5e51c44c213e410a964bdffe0928e611368329"}, - {file = "msgpack-1.0.7-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e50ebce52f41370707f1e21a59514e3375e3edd6e1832f5e5235237db933c98b"}, - {file = "msgpack-1.0.7-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4a7b4f35de6a304b5533c238bee86b670b75b03d31b7797929caa7a624b5dda6"}, - {file = "msgpack-1.0.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:28efb066cde83c479dfe5a48141a53bc7e5f13f785b92ddde336c716663039ee"}, - {file = "msgpack-1.0.7-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4cb14ce54d9b857be9591ac364cb08dc2d6a5c4318c1182cb1d02274029d590d"}, - {file = "msgpack-1.0.7-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:b573a43ef7c368ba4ea06050a957c2a7550f729c31f11dd616d2ac4aba99888d"}, - {file = "msgpack-1.0.7-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:ccf9a39706b604d884d2cb1e27fe973bc55f2890c52f38df742bc1d79ab9f5e1"}, - {file = "msgpack-1.0.7-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:cb70766519500281815dfd7a87d3a178acf7ce95390544b8c90587d76b227681"}, - {file = "msgpack-1.0.7-cp310-cp310-win32.whl", hash = "sha256:b610ff0f24e9f11c9ae653c67ff8cc03c075131401b3e5ef4b82570d1728f8a9"}, - {file = "msgpack-1.0.7-cp310-cp310-win_amd64.whl", hash = "sha256:a40821a89dc373d6427e2b44b572efc36a2778d3f543299e2f24eb1a5de65415"}, - {file = "msgpack-1.0.7-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:576eb384292b139821c41995523654ad82d1916da6a60cff129c715a6223ea84"}, - {file = "msgpack-1.0.7-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:730076207cb816138cf1af7f7237b208340a2c5e749707457d70705715c93b93"}, - {file = "msgpack-1.0.7-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:85765fdf4b27eb5086f05ac0491090fc76f4f2b28e09d9350c31aac25a5aaff8"}, - {file = "msgpack-1.0.7-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3476fae43db72bd11f29a5147ae2f3cb22e2f1a91d575ef130d2bf49afd21c46"}, - {file = "msgpack-1.0.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6d4c80667de2e36970ebf74f42d1088cc9ee7ef5f4e8c35eee1b40eafd33ca5b"}, - {file = "msgpack-1.0.7-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5b0bf0effb196ed76b7ad883848143427a73c355ae8e569fa538365064188b8e"}, - {file = "msgpack-1.0.7-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:f9a7c509542db4eceed3dcf21ee5267ab565a83555c9b88a8109dcecc4709002"}, - {file = "msgpack-1.0.7-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:84b0daf226913133f899ea9b30618722d45feffa67e4fe867b0b5ae83a34060c"}, - {file = "msgpack-1.0.7-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:ec79ff6159dffcc30853b2ad612ed572af86c92b5168aa3fc01a67b0fa40665e"}, - {file = "msgpack-1.0.7-cp311-cp311-win32.whl", hash = "sha256:3e7bf4442b310ff154b7bb9d81eb2c016b7d597e364f97d72b1acc3817a0fdc1"}, - {file = "msgpack-1.0.7-cp311-cp311-win_amd64.whl", hash = "sha256:3f0c8c6dfa6605ab8ff0611995ee30d4f9fcff89966cf562733b4008a3d60d82"}, - {file = "msgpack-1.0.7-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f0936e08e0003f66bfd97e74ee530427707297b0d0361247e9b4f59ab78ddc8b"}, - {file = "msgpack-1.0.7-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:98bbd754a422a0b123c66a4c341de0474cad4a5c10c164ceed6ea090f3563db4"}, - {file = "msgpack-1.0.7-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:b291f0ee7961a597cbbcc77709374087fa2a9afe7bdb6a40dbbd9b127e79afee"}, - {file = "msgpack-1.0.7-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ebbbba226f0a108a7366bf4b59bf0f30a12fd5e75100c630267d94d7f0ad20e5"}, - {file = "msgpack-1.0.7-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1e2d69948e4132813b8d1131f29f9101bc2c915f26089a6d632001a5c1349672"}, - {file = "msgpack-1.0.7-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bdf38ba2d393c7911ae989c3bbba510ebbcdf4ecbdbfec36272abe350c454075"}, - {file = "msgpack-1.0.7-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:993584fc821c58d5993521bfdcd31a4adf025c7d745bbd4d12ccfecf695af5ba"}, - {file = "msgpack-1.0.7-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:52700dc63a4676669b341ba33520f4d6e43d3ca58d422e22ba66d1736b0a6e4c"}, - {file = "msgpack-1.0.7-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:e45ae4927759289c30ccba8d9fdce62bb414977ba158286b5ddaf8df2cddb5c5"}, - {file = "msgpack-1.0.7-cp312-cp312-win32.whl", hash = "sha256:27dcd6f46a21c18fa5e5deed92a43d4554e3df8d8ca5a47bf0615d6a5f39dbc9"}, - {file = "msgpack-1.0.7-cp312-cp312-win_amd64.whl", hash = "sha256:7687e22a31e976a0e7fc99c2f4d11ca45eff652a81eb8c8085e9609298916dcf"}, - {file = "msgpack-1.0.7-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5b6ccc0c85916998d788b295765ea0e9cb9aac7e4a8ed71d12e7d8ac31c23c95"}, - {file = "msgpack-1.0.7-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:235a31ec7db685f5c82233bddf9858748b89b8119bf4538d514536c485c15fe0"}, - {file = "msgpack-1.0.7-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:cab3db8bab4b7e635c1c97270d7a4b2a90c070b33cbc00c99ef3f9be03d3e1f7"}, - {file = "msgpack-1.0.7-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0bfdd914e55e0d2c9e1526de210f6fe8ffe9705f2b1dfcc4aecc92a4cb4b533d"}, - {file = "msgpack-1.0.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:36e17c4592231a7dbd2ed09027823ab295d2791b3b1efb2aee874b10548b7524"}, - {file = "msgpack-1.0.7-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:38949d30b11ae5f95c3c91917ee7a6b239f5ec276f271f28638dec9156f82cfc"}, - {file = "msgpack-1.0.7-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:ff1d0899f104f3921d94579a5638847f783c9b04f2d5f229392ca77fba5b82fc"}, - {file = "msgpack-1.0.7-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:dc43f1ec66eb8440567186ae2f8c447d91e0372d793dfe8c222aec857b81a8cf"}, - {file = "msgpack-1.0.7-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:dd632777ff3beaaf629f1ab4396caf7ba0bdd075d948a69460d13d44357aca4c"}, - {file = "msgpack-1.0.7-cp38-cp38-win32.whl", hash = "sha256:4e71bc4416de195d6e9b4ee93ad3f2f6b2ce11d042b4d7a7ee00bbe0358bd0c2"}, - {file = "msgpack-1.0.7-cp38-cp38-win_amd64.whl", hash = "sha256:8f5b234f567cf76ee489502ceb7165c2a5cecec081db2b37e35332b537f8157c"}, - {file = "msgpack-1.0.7-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:bfef2bb6ef068827bbd021017a107194956918ab43ce4d6dc945ffa13efbc25f"}, - {file = "msgpack-1.0.7-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:484ae3240666ad34cfa31eea7b8c6cd2f1fdaae21d73ce2974211df099a95d81"}, - {file = "msgpack-1.0.7-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3967e4ad1aa9da62fd53e346ed17d7b2e922cba5ab93bdd46febcac39be636fc"}, - {file = "msgpack-1.0.7-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8dd178c4c80706546702c59529ffc005681bd6dc2ea234c450661b205445a34d"}, - {file = "msgpack-1.0.7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f6ffbc252eb0d229aeb2f9ad051200668fc3a9aaa8994e49f0cb2ffe2b7867e7"}, - {file = "msgpack-1.0.7-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:822ea70dc4018c7e6223f13affd1c5c30c0f5c12ac1f96cd8e9949acddb48a61"}, - {file = "msgpack-1.0.7-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:384d779f0d6f1b110eae74cb0659d9aa6ff35aaf547b3955abf2ab4c901c4819"}, - {file = "msgpack-1.0.7-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:f64e376cd20d3f030190e8c32e1c64582eba56ac6dc7d5b0b49a9d44021b52fd"}, - {file = "msgpack-1.0.7-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5ed82f5a7af3697b1c4786053736f24a0efd0a1b8a130d4c7bfee4b9ded0f08f"}, - {file = "msgpack-1.0.7-cp39-cp39-win32.whl", hash = "sha256:f26a07a6e877c76a88e3cecac8531908d980d3d5067ff69213653649ec0f60ad"}, - {file = "msgpack-1.0.7-cp39-cp39-win_amd64.whl", hash = "sha256:1dc93e8e4653bdb5910aed79f11e165c85732067614f180f70534f056da97db3"}, - {file = "msgpack-1.0.7.tar.gz", hash = "sha256:572efc93db7a4d27e404501975ca6d2d9775705c2d922390d878fcf768d92c87"}, + {file = "msgpack-1.0.8-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:505fe3d03856ac7d215dbe005414bc28505d26f0c128906037e66d98c4e95868"}, + {file = "msgpack-1.0.8-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e6b7842518a63a9f17107eb176320960ec095a8ee3b4420b5f688e24bf50c53c"}, + {file = "msgpack-1.0.8-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:376081f471a2ef24828b83a641a02c575d6103a3ad7fd7dade5486cad10ea659"}, + {file = "msgpack-1.0.8-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5e390971d082dba073c05dbd56322427d3280b7cc8b53484c9377adfbae67dc2"}, + {file = "msgpack-1.0.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:00e073efcba9ea99db5acef3959efa45b52bc67b61b00823d2a1a6944bf45982"}, + {file = "msgpack-1.0.8-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:82d92c773fbc6942a7a8b520d22c11cfc8fd83bba86116bfcf962c2f5c2ecdaa"}, + {file = "msgpack-1.0.8-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:9ee32dcb8e531adae1f1ca568822e9b3a738369b3b686d1477cbc643c4a9c128"}, + {file = "msgpack-1.0.8-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e3aa7e51d738e0ec0afbed661261513b38b3014754c9459508399baf14ae0c9d"}, + {file = "msgpack-1.0.8-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:69284049d07fce531c17404fcba2bb1df472bc2dcdac642ae71a2d079d950653"}, + {file = "msgpack-1.0.8-cp310-cp310-win32.whl", hash = "sha256:13577ec9e247f8741c84d06b9ece5f654920d8365a4b636ce0e44f15e07ec693"}, + {file = "msgpack-1.0.8-cp310-cp310-win_amd64.whl", hash = "sha256:e532dbd6ddfe13946de050d7474e3f5fb6ec774fbb1a188aaf469b08cf04189a"}, + {file = "msgpack-1.0.8-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:9517004e21664f2b5a5fd6333b0731b9cf0817403a941b393d89a2f1dc2bd836"}, + {file = "msgpack-1.0.8-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:d16a786905034e7e34098634b184a7d81f91d4c3d246edc6bd7aefb2fd8ea6ad"}, + {file = "msgpack-1.0.8-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e2872993e209f7ed04d963e4b4fbae72d034844ec66bc4ca403329db2074377b"}, + {file = "msgpack-1.0.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5c330eace3dd100bdb54b5653b966de7f51c26ec4a7d4e87132d9b4f738220ba"}, + {file = "msgpack-1.0.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:83b5c044f3eff2a6534768ccfd50425939e7a8b5cf9a7261c385de1e20dcfc85"}, + {file = "msgpack-1.0.8-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1876b0b653a808fcd50123b953af170c535027bf1d053b59790eebb0aeb38950"}, + {file = "msgpack-1.0.8-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:dfe1f0f0ed5785c187144c46a292b8c34c1295c01da12e10ccddfc16def4448a"}, + {file = "msgpack-1.0.8-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:3528807cbbb7f315bb81959d5961855e7ba52aa60a3097151cb21956fbc7502b"}, + {file = "msgpack-1.0.8-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e2f879ab92ce502a1e65fce390eab619774dda6a6ff719718069ac94084098ce"}, + {file = "msgpack-1.0.8-cp311-cp311-win32.whl", hash = "sha256:26ee97a8261e6e35885c2ecd2fd4a6d38252246f94a2aec23665a4e66d066305"}, + {file = "msgpack-1.0.8-cp311-cp311-win_amd64.whl", hash = "sha256:eadb9f826c138e6cf3c49d6f8de88225a3c0ab181a9b4ba792e006e5292d150e"}, + {file = "msgpack-1.0.8-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:114be227f5213ef8b215c22dde19532f5da9652e56e8ce969bf0a26d7c419fee"}, + {file = "msgpack-1.0.8-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:d661dc4785affa9d0edfdd1e59ec056a58b3dbb9f196fa43587f3ddac654ac7b"}, + {file = "msgpack-1.0.8-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d56fd9f1f1cdc8227d7b7918f55091349741904d9520c65f0139a9755952c9e8"}, + {file = "msgpack-1.0.8-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0726c282d188e204281ebd8de31724b7d749adebc086873a59efb8cf7ae27df3"}, + {file = "msgpack-1.0.8-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8db8e423192303ed77cff4dce3a4b88dbfaf43979d280181558af5e2c3c71afc"}, + {file = "msgpack-1.0.8-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:99881222f4a8c2f641f25703963a5cefb076adffd959e0558dc9f803a52d6a58"}, + {file = "msgpack-1.0.8-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:b5505774ea2a73a86ea176e8a9a4a7c8bf5d521050f0f6f8426afe798689243f"}, + {file = "msgpack-1.0.8-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:ef254a06bcea461e65ff0373d8a0dd1ed3aa004af48839f002a0c994a6f72d04"}, + {file = "msgpack-1.0.8-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:e1dd7839443592d00e96db831eddb4111a2a81a46b028f0facd60a09ebbdd543"}, + {file = "msgpack-1.0.8-cp312-cp312-win32.whl", hash = "sha256:64d0fcd436c5683fdd7c907eeae5e2cbb5eb872fafbc03a43609d7941840995c"}, + {file = "msgpack-1.0.8-cp312-cp312-win_amd64.whl", hash = "sha256:74398a4cf19de42e1498368c36eed45d9528f5fd0155241e82c4082b7e16cffd"}, + {file = "msgpack-1.0.8-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:0ceea77719d45c839fd73abcb190b8390412a890df2f83fb8cf49b2a4b5c2f40"}, + {file = "msgpack-1.0.8-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1ab0bbcd4d1f7b6991ee7c753655b481c50084294218de69365f8f1970d4c151"}, + {file = "msgpack-1.0.8-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:1cce488457370ffd1f953846f82323cb6b2ad2190987cd4d70b2713e17268d24"}, + {file = "msgpack-1.0.8-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3923a1778f7e5ef31865893fdca12a8d7dc03a44b33e2a5f3295416314c09f5d"}, + {file = "msgpack-1.0.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a22e47578b30a3e199ab067a4d43d790249b3c0587d9a771921f86250c8435db"}, + {file = "msgpack-1.0.8-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bd739c9251d01e0279ce729e37b39d49a08c0420d3fee7f2a4968c0576678f77"}, + {file = "msgpack-1.0.8-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:d3420522057ebab1728b21ad473aa950026d07cb09da41103f8e597dfbfaeb13"}, + {file = "msgpack-1.0.8-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:5845fdf5e5d5b78a49b826fcdc0eb2e2aa7191980e3d2cfd2a30303a74f212e2"}, + {file = "msgpack-1.0.8-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6a0e76621f6e1f908ae52860bdcb58e1ca85231a9b0545e64509c931dd34275a"}, + {file = "msgpack-1.0.8-cp38-cp38-win32.whl", hash = "sha256:374a8e88ddab84b9ada695d255679fb99c53513c0a51778796fcf0944d6c789c"}, + {file = "msgpack-1.0.8-cp38-cp38-win_amd64.whl", hash = "sha256:f3709997b228685fe53e8c433e2df9f0cdb5f4542bd5114ed17ac3c0129b0480"}, + {file = "msgpack-1.0.8-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:f51bab98d52739c50c56658cc303f190785f9a2cd97b823357e7aeae54c8f68a"}, + {file = "msgpack-1.0.8-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:73ee792784d48aa338bba28063e19a27e8d989344f34aad14ea6e1b9bd83f596"}, + {file = "msgpack-1.0.8-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f9904e24646570539a8950400602d66d2b2c492b9010ea7e965025cb71d0c86d"}, + {file = "msgpack-1.0.8-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e75753aeda0ddc4c28dce4c32ba2f6ec30b1b02f6c0b14e547841ba5b24f753f"}, + {file = "msgpack-1.0.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5dbf059fb4b7c240c873c1245ee112505be27497e90f7c6591261c7d3c3a8228"}, + {file = "msgpack-1.0.8-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4916727e31c28be8beaf11cf117d6f6f188dcc36daae4e851fee88646f5b6b18"}, + {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:7938111ed1358f536daf311be244f34df7bf3cdedb3ed883787aca97778b28d8"}, + {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:493c5c5e44b06d6c9268ce21b302c9ca055c1fd3484c25ba41d34476c76ee746"}, + {file = "msgpack-1.0.8-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5fbb160554e319f7b22ecf530a80a3ff496d38e8e07ae763b9e82fadfe96f273"}, + {file = "msgpack-1.0.8-cp39-cp39-win32.whl", hash = "sha256:f9af38a89b6a5c04b7d18c492c8ccf2aee7048aff1ce8437c4683bb5a1df893d"}, + {file = "msgpack-1.0.8-cp39-cp39-win_amd64.whl", hash = "sha256:ed59dd52075f8fc91da6053b12e8c89e37aa043f8986efd89e61fae69dc1b011"}, + {file = "msgpack-1.0.8-py3-none-any.whl", hash = "sha256:24f727df1e20b9876fa6e95f840a2a2651e34c0ad147676356f4bf5fbb0206ca"}, ] [[package]] @@ -2671,7 +2671,7 @@ werkzeug = "^3.0.1" type = "git" url = "https://github.com/GSA/notifications-utils.git" reference = "HEAD" -resolved_reference = "df8ece836cad303c5d161edf485cf9bbdc666688" +resolved_reference = "46af64b4f2540e44b3dda4a49cff04008dfe1ee8" [[package]] name = "numpy" @@ -2758,13 +2758,13 @@ asn1crypto = ">=1.5.1" [[package]] name = "packageurl-python" -version = "0.13.4" +version = "0.14.0" description = "A purl aka. Package URL parser and builder" optional = false python-versions = ">=3.7" files = [ - {file = "packageurl-python-0.13.4.tar.gz", hash = "sha256:6eb5e995009cc73387095e0b507ab65df51357d25ddc5fce3d3545ad6dcbbee8"}, - {file = "packageurl_python-0.13.4-py3-none-any.whl", hash = "sha256:62aa13d60a0082ff115784fefdfe73a12f310e455365cca7c6d362161067f35f"}, + {file = "packageurl-python-0.14.0.tar.gz", hash = "sha256:ff09147cddaae9e5c59ffcb12df8ec0e1b774b45099399f28c36b1a3dfdf52e2"}, + {file = "packageurl_python-0.14.0-py3-none-any.whl", hash = "sha256:cf5e55cdcd61e6de858f47c4986aa87ba493bfa56ba58de11103dfdc2c00e4e1"}, ] [package.extras] @@ -2858,13 +2858,13 @@ pip = "*" [[package]] name = "pip-audit" -version = "2.7.1" +version = "2.7.2" description = "A tool for scanning Python environments for known vulnerabilities" optional = false python-versions = ">=3.8" files = [ - {file = "pip_audit-2.7.1-py3-none-any.whl", hash = "sha256:b9b4230d1ac685d669b4a36b1d5f849ea3d1ce371501aff73047bd278b22c055"}, - {file = "pip_audit-2.7.1.tar.gz", hash = "sha256:66001c73bc6e5ebc998ef31a32432f7b479dc3bfeb40f7101d0fe7eb564a2c2a"}, + {file = "pip_audit-2.7.2-py3-none-any.whl", hash = "sha256:49907430115baacb8bb7ffc1a2b689acfeac9d8534a43bffad3c73f8d8b32d52"}, + {file = "pip_audit-2.7.2.tar.gz", hash = "sha256:a12905e42dd452f43a2dbf895606d59c35348deed27b8cbaff8516423576fdfb"}, ] [package.dependencies] @@ -2881,7 +2881,7 @@ toml = ">=0.10" [package.extras] dev = ["build", "bump (>=1.3.2)", "pip-audit[doc,lint,test]"] doc = ["pdoc"] -lint = ["interrogate", "mypy", "ruff (<0.2.2)", "types-html5lib", "types-requests", "types-toml"] +lint = ["interrogate", "mypy", "ruff (<0.2.3)", "types-html5lib", "types-requests", "types-toml"] test = ["coverage[toml] (>=7.0,!=7.3.3,<8.0)", "pretend", "pytest", "pytest-cov"] [[package]] @@ -3182,13 +3182,13 @@ files = [ [[package]] name = "py-serializable" -version = "1.0.1" +version = "1.0.2" description = "Library for serializing and deserializing Python Objects to and from JSON and XML." optional = false python-versions = ">=3.8,<4.0" files = [ - {file = "py_serializable-1.0.1-py3-none-any.whl", hash = "sha256:edcc51ac91a39e0cdde147463cae4dc34f5ab72907f7e71721ff3ecef3731a70"}, - {file = "py_serializable-1.0.1.tar.gz", hash = "sha256:98b81e565c23b3cc2ac799f5096dc7e11cafe8215c551d20a1c16dd38a113861"}, + {file = "py_serializable-1.0.2-py3-none-any.whl", hash = "sha256:f09dee8595a583117ba446c50be183eff9699b7d54529e0506d4f0f2e093e4a3"}, + {file = "py_serializable-1.0.2.tar.gz", hash = "sha256:158a98a7ffda067d21f844594ce571d97f36172ba538aee1a93196f8b5888bd8"}, ] [package.dependencies] @@ -3395,13 +3395,13 @@ testing = ["filelock"] [[package]] name = "python-dateutil" -version = "2.8.2" +version = "2.9.0.post0" description = "Extensions to the standard Python datetime module" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" files = [ - {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"}, - {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, + {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, + {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, ] [package.dependencies] @@ -3479,7 +3479,6 @@ files = [ {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_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {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"}, From c0e3a68a07f790f7383ec666e326b9eb64e121e8 Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Fri, 1 Mar 2024 12:43:35 -0700 Subject: [PATCH 06/13] Added faker to poetry lock file --- poetry.lock | 16 +++++++++++++++- pyproject.toml | 1 + 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/poetry.lock b/poetry.lock index 089587a20..00e656a4a 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1248,6 +1248,20 @@ files = [ [package.extras] tests = ["coverage", "coveralls", "dill", "mock", "nose"] +[[package]] +name = "faker" +version = "23.3.0" +description = "Faker is a Python package that generates fake data for you." +optional = false +python-versions = ">=3.8" +files = [ + {file = "Faker-23.3.0-py3-none-any.whl", hash = "sha256:117ce1a2805c1bc5ca753b3dc6f9d567732893b2294b827d3164261ee8f20267"}, + {file = "Faker-23.3.0.tar.gz", hash = "sha256:458d93580de34403a8dec1e8d5e6be2fee96c4deca63b95d71df7a6a80a690de"}, +] + +[package.dependencies] +python-dateutil = ">=2.4" + [[package]] name = "fastjsonschema" version = "2.19.1" @@ -4770,4 +4784,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = ">=3.9,<3.12" -content-hash = "ccfd855abf7309cf520ea5ca02e77fc9d8ab911819ea9690298fa0549a9d7c42" +content-hash = "ed0a2c9f32e010a33a24e243a58550c4849d10ee8205f6c459ecdde57d3509ac" diff --git a/pyproject.toml b/pyproject.toml index 970059f5a..4b8ab01ef 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -50,6 +50,7 @@ python-dotenv = "==1.0.0" sqlalchemy = "==1.4.40" werkzeug = "^3.0.1" strenum = "^0.4.15" +faker = "^23.3.0" [tool.poetry.group.dev.dependencies] From 980e32c86c1c0898b90572760046fc064a41c00f Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Fri, 1 Mar 2024 14:43:36 -0700 Subject: [PATCH 07/13] Swapped random for secrets --- app/commands.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/commands.py b/app/commands.py index 1377808db..6e401b3bd 100644 --- a/app/commands.py +++ b/app/commands.py @@ -1,7 +1,7 @@ import csv import functools import itertools -import random +import secrets import uuid from datetime import datetime, timedelta from os import getenv @@ -900,15 +900,15 @@ def add_test_organization_to_db(generate): "Science and Technology", ] - agency = random.choice(agency_names) - speciality = random.choice(government_sectors) + agency = secrets.choice(agency_names) + speciality = secrets.choice(government_sectors) return f"{fake.word().capitalize()} {speciality} {agency}" for num in range(1, int(generate) + 1): org = create_organization( name=generate_gov_agency(), - organization_type=random.choice(["federal", "state", "other"]), + organization_type=secrets.choice(["federal", "state", "other"]), ) print(f"{num} {org.name} created") From 0d856f07fc565b932a169e3619cf5124ad09afd9 Mon Sep 17 00:00:00 2001 From: Andrew Shumway Date: Mon, 4 Mar 2024 10:23:45 -0700 Subject: [PATCH 08/13] Removed gov.uk text from org invite --- app/organization/invite_rest.py | 2 +- tests/app/organization/test_invite_rest.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/app/organization/invite_rest.py b/app/organization/invite_rest.py index 18874e9a2..254de322c 100644 --- a/app/organization/invite_rest.py +++ b/app/organization/invite_rest.py @@ -55,7 +55,7 @@ def invite_user_to_org(organization_id): service=template.service, personalisation={ "user_name": ( - "The GOV.UK Notify team" + "The Notify.gov team" if invited_org_user.invited_by.platform_admin else invited_org_user.invited_by.name ), diff --git a/tests/app/organization/test_invite_rest.py b/tests/app/organization/test_invite_rest.py index c57fa8dd0..a68ec409f 100644 --- a/tests/app/organization/test_invite_rest.py +++ b/tests/app/organization/test_invite_rest.py @@ -13,7 +13,7 @@ from tests.app.db import create_invited_org_user @pytest.mark.parametrize( "platform_admin, expected_invited_by", - ((True, "The GOV.UK Notify team"), (False, "Test User")), + ((True, "The Notify.gov team"), (False, "Test User")), ) @pytest.mark.parametrize( "extra_args, expected_start_of_invite_url", From ee6dfacad15f106b5fdbfafb44ac5ffdeb31c127 Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Mon, 4 Mar 2024 14:34:41 -0700 Subject: [PATCH 09/13] Standardized command names and updated documentation --- app/commands.py | 20 ++++++++++---------- docs/all.md | 12 ++++++++++++ 2 files changed, 22 insertions(+), 10 deletions(-) diff --git a/app/commands.py b/app/commands.py index 6e401b3bd..2c6d6bf75 100644 --- a/app/commands.py +++ b/app/commands.py @@ -856,9 +856,9 @@ fake = Faker(["en_US"]) # generate n number of test orgs into the dev DB -@notify_command(name="add-test-organization-to-db") +@notify_command(name="add-test-organizations-to-db") @click.option("-g", "--generate", required=True, prompt=True, default=1) -def add_test_organization_to_db(generate): +def add_test_organizations_to_db(generate): def generate_gov_agency(): agency_names = [ "Bureau", @@ -914,9 +914,9 @@ def add_test_organization_to_db(generate): # generate n number of test services into the dev DB -@notify_command(name="add-test-service-to-db") +@notify_command(name="add-test-services-to-db") @click.option("-g", "--generate", required=True, prompt=True, default=1) -def add_test_service_to_db(generate): +def add_test_services_to_db(generate): if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: current_app.logger.error("Can only be run in development") return @@ -928,9 +928,9 @@ def add_test_service_to_db(generate): # generate n number of test jobs into the dev DB -@notify_command(name="add-test-job-to-db") +@notify_command(name="add-test-jobs-to-db") @click.option("-g", "--generate", required=True, prompt=True, default=1) -def add_test_job_to_db(generate): +def add_test_jobs_to_db(generate): if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: current_app.logger.error("Can only be run in development") return @@ -943,9 +943,9 @@ def add_test_job_to_db(generate): # generate n number of notifications into the dev DB -@notify_command(name="add-test-notification-to-db") +@notify_command(name="add-test-notifications-to-db") @click.option("-g", "--generate", required=True, prompt=True, default=1) -def add_test_notification_to_db(generate): +def add_test_notifications_to_db(generate): if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: current_app.logger.error("Can only be run in development") return @@ -962,11 +962,11 @@ def add_test_notification_to_db(generate): # generate n number of test users into the dev DB -@notify_command(name="add-test-users") +@notify_command(name="add-test-users-to-db") @click.option("-g", "--generate", required=True, prompt=True, default="1") @click.option("-s", "--state", default="active") @click.option("-d", "--admin", default=False, type=bool) -def add_test_users(generate, state, admin): +def add_test_users_to_db(generate, state, admin): if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: current_app.logger.error("Can only be run in development") return diff --git a/docs/all.md b/docs/all.md index 4803102dd..c131a92d6 100644 --- a/docs/all.md +++ b/docs/all.md @@ -495,6 +495,18 @@ cf run-task CLOUD-GOV-APP --command "flask command update-templates" --name YOUR [Here's more documentation](https://docs.cloudfoundry.org/devguide/using-tasks.html) about Cloud Foundry tasks. +# Commands for test loading the local dev database + +All commands use the `-g` or `--generate` to determine how many instances to load to the db. The `-g` or `--generate` option is required and will always defult to 1. An example: `flask command add-test-uses-to-db -g 6` will generate 6 random users and insert them into the db. + +## Test commands list +- `add-test-organizations-to-db` +- `add-test-services-to-db` +- `add-test-jobs-to-db` +- `add-test-notifications-to-db` +- `add-test-users-to-db` (extra options include `-s` or `--state` and `-d` or `--admin`) + + # How messages are queued and sent There are several ways for notifications to come into the API. From 6cf9c811ae53e620a1d2b2f89d2bd52267718cbc Mon Sep 17 00:00:00 2001 From: Anastasia Gradova <108748167+anagradova@users.noreply.github.com> Date: Mon, 4 Mar 2024 15:59:44 -0700 Subject: [PATCH 10/13] Update app/commands.py Co-authored-by: Carlo Costino --- app/commands.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/commands.py b/app/commands.py index 2c6d6bf75..707cab466 100644 --- a/app/commands.py +++ b/app/commands.py @@ -859,6 +859,9 @@ fake = Faker(["en_US"]) @notify_command(name="add-test-organizations-to-db") @click.option("-g", "--generate", required=True, prompt=True, default=1) def add_test_organizations_to_db(generate): + if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: + current_app.logger.error("Can only be run in development") + return def generate_gov_agency(): agency_names = [ "Bureau", From 117ac98491a039aa63eb67bf378a86321b82dc55 Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Mon, 4 Mar 2024 16:02:21 -0700 Subject: [PATCH 11/13] moved faker to under imports according to PEP-8 --- app/commands.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/commands.py b/app/commands.py index 2c6d6bf75..10e6f1f09 100644 --- a/app/commands.py +++ b/app/commands.py @@ -73,6 +73,8 @@ from tests.app.db import ( create_user, ) +#used in add-test-* commands +fake = Faker(["en_US"]) @click.group(name="command", help="Additional commands") def command_group(): @@ -852,8 +854,6 @@ faker is used to generate some random fields. All database commands were used from tests/app/db.py where possible to enable better maintainability. """ -fake = Faker(["en_US"]) - # generate n number of test orgs into the dev DB @notify_command(name="add-test-organizations-to-db") From 8e44e4d981ebd6bb7a636276719d289ca264e19d Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Tue, 5 Mar 2024 08:10:05 -0700 Subject: [PATCH 12/13] Corrected flake spacing --- app/commands.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/app/commands.py b/app/commands.py index 6fa858b75..17e8e1058 100644 --- a/app/commands.py +++ b/app/commands.py @@ -73,9 +73,10 @@ from tests.app.db import ( create_user, ) -#used in add-test-* commands +# used in add-test-* commands fake = Faker(["en_US"]) + @click.group(name="command", help="Additional commands") def command_group(): pass @@ -855,6 +856,7 @@ database commands were used from tests/app/db.py where possible to enable better maintainability. """ + # generate n number of test orgs into the dev DB @notify_command(name="add-test-organizations-to-db") @click.option("-g", "--generate", required=True, prompt=True, default=1) @@ -862,6 +864,7 @@ def add_test_organizations_to_db(generate): if getenv("NOTIFY_ENVIRONMENT", "") not in ["development", "test"]: current_app.logger.error("Can only be run in development") return + def generate_gov_agency(): agency_names = [ "Bureau", From 703500274bc85de99035b03a533b0b9400f8e54a Mon Sep 17 00:00:00 2001 From: Anastasia Gradova Date: Tue, 5 Mar 2024 08:43:20 -0700 Subject: [PATCH 13/13] Updated doucmentation in README and all.md --- README.md | 1 + docs/all.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index 94aea0c41..6f3aa924b 100644 --- a/README.md +++ b/README.md @@ -421,6 +421,7 @@ instructions above for more details. - [Migrations](./docs/all.md#migrations) - [Purging user data](./docs/all.md#purging-user-data) - [One-off tasks](./docs/all.md#one-off-tasks) +- [Test Loading Commands](./docs/all.md#commands-for-test-loading-the-local-dev-database) - [How messages are queued and sent](./docs/all.md#how-messages-are-queued-and-sent) - [Writing public APIs](./docs/all.md#writing-public-apis) - [Overview](./docs/all.md#overview) diff --git a/docs/all.md b/docs/all.md index c131a92d6..fecf705f4 100644 --- a/docs/all.md +++ b/docs/all.md @@ -22,6 +22,7 @@ - [Migrations](#migrations) - [Purging user data](#purging-user-data) - [One-off tasks](#one-off-tasks) +- [Test Loading Commands](#commands-for-test-loading-the-local-dev-database) - [How messages are queued and sent](#how-messages-are-queued-and-sent) - [Writing public APIs](#writing-public-apis) - [Overview](#overview)