fecgov / fecfile-web-api

Back-end API for FECfile application
8 stars 2 forks source link

Add URL parameter to API to turn on mock EFO endpoint #1029

Closed exalate-issue-sync[bot] closed 3 days ago

exalate-issue-sync[bot] commented 3 weeks ago

This change is to support Locust tests running on an environment that may be integrated with an actual efo system. We need to be able to override the integration configuration per request (force mocking the integration), so that we don’t touch an efo system while we load test.

In order to do load testing for Celery service and submitting reports, a parameter needs to be created to make sure the submit is mocked and not sent to testEFO:

example of code that sets up submit mock:https://github.com/fecgov/fecfile-web-api/blob/release/sprint-42/django-backend/fecfiler/web_services/dot_fec/dot_fec_submitter.py#L54

e.g. pass a URL parameter like “/?use_mock” or “test”

Also, our configuration of wether we’re integrated with an efo system or not is implicit:

FEC_FILING_API is defined → integrated

FEC_FILING_API is undefined → not integrated

Instead, explicitly declare whether we are mocking or not:

MOCK_EFO determines whether the api is set up to hit a real EFO system or just stubs the responses

FEC_FILING_API will now only specify that EFO systems

MOCK_EFO needs to be set on CircleCI for fecfile-web-api as True.

update the docker-compose.yml to default MOCK_EFO to True on local docker instances.

QA Notes

successful unit tests: [https://app.circleci.com/pipelines/github/fecgov/fecfile-web-api/4115/workflows/e8fdf54b-44f8-41f7-ae7d-0f6a085af982/jobs/12318|https://app.circleci.com/pipelines/github/fecgov/fecfile-web-api/4115/workflows/e8fdf54b-44f8-41f7-ae7d-0f6a085af982/jobs/12318]

!image-20240826-180725.png|width=1236,height=610,alt="image-20240826-180725.png"!

DEV Notes

null

Design

null

See full ticket and images here: FECFILE-1547

exalate-issue-sync[bot] commented 3 weeks ago

passes CR moving to QA

exalate-issue-sync[bot] commented 2 weeks ago

Added unit test results to ticket for verification

exalate-issue-sync[bot] commented 2 weeks ago

Shelly Wise commented: QA review verified Unit Test passes.

!image-20240827-171754.png|width=1228,height=570,alt="image-20240827-171754.png"! See image in Jira

QA Review Completed. Moved to Stage Ready.

exalate-issue-sync[bot] commented 3 days ago

Automation for Jira commented: Sprint accepted by Paul Clark at Sprint Review on comment date.