Skip to content

[APP-522] fix: convert qa 05 library to python#3214

Open
mcmcgrath13 wants to merge 12 commits into
mainfrom
mcm/pylib-qa-05
Open

[APP-522] fix: convert qa 05 library to python#3214
mcmcgrath13 wants to merge 12 commits into
mainfrom
mcm/pylib-qa-05

Conversation

@mcmcgrath13
Copy link
Copy Markdown
Contributor

@mcmcgrath13 mcmcgrath13 commented May 7, 2026

Description

Convert QA 5 library to python

Confluence card:
https://cdc-nbs.atlassian.net/wiki/spaces/NE/database/2145779742?contentId=2145779742&entryId=255da10a-35dd-47a7-8a97-107e0d1f6934&savedViewId=0030073a-ae3e-4225-af11-74f57f91494d

jira ticket:
https://cdc-nbs.atlassian.net/browse/APP-522

Checklist for adding a library:

  • Copy this checklist into your (draft) PR description
  • Check the existing description for the library in apps/modernization-api/src/main/resources/db/changelog/report/execution/03_ODSE_Data_Report_Library_Init.sql
    • If the report execution service is not yet in use by any STLT (even beta), you should update this file
    • Update the description in the library-specific migration
  • Add a migration to apps/modernization-api/src/main/resources/db/report/execution/libraries named <your library name>.sql
    • Copy another migration and update the variables at the top of the file
  • Add the migration to apps/modernization-api/src/main/resources/db/report-execution-changelog.yml. It should be added to the latest changeSet since the last release - this could require a new changeSet if there isn't one since last release
  • Check the migration works by building/running the containerized dev setup
  • Add a python library file to apps/report-execution/src/libraries named in lowercase, but generally following the naming convention of SAS (needs to be human recognizable as the same library)
  • Follow the pattern established in existing libraries to create your library. The execute function is the required method and its signature will (someday) be checked for validity
    • Make sure pertinent text embedded in the reports is included in the description of the report
    • Note in the doc string any deviation from the SAS
  • Keep an eye out for things in the sas library that are/could be centralized to pre- or post-processing or a util would be helpful for (e.g. common formatting needs)
  • Add integration tests in a apps/report-execution/tests/libraries/<your_library_here>py file following the conventions established for other libraries
    • The subset_sql can be assumed to be well tested by the modernization-api, so focus on any logic and additional joins/queries/analysis that is added in the library
    • The database used in integration testing is our standard golden db + seed used in other testing - if additional data is needed to test the report, add it to the seeding process
  • Add e2e test coverage for the report
    • If this step is not set up, create a ticket to track this as follow on work needed for this report
  • Check that the report has parity with the NBS 6 version using (https://cdc-nbs.atlassian.net/wiki/spaces/NE/pages/2372272139/Comparison+Testing+Libraries)
  • Keep an eye out for opportunities to:
    • Consolidate reports by using parameters (parameter design tbd)
    • Improve the report spec or result expectations
  • Update the SAS to Python tracking spreadsheet with information about the newly converted library
  • Update/clarify these instructions in the epic based on your experience

Tickets

@mcmcgrath13 mcmcgrath13 changed the title fix: wip - convert qa 05 [APP-522] fix: convert qa 05 library to python May 11, 2026
@mcmcgrath13 mcmcgrath13 marked this pull request as ready for review May 11, 2026 15:48
@mcmcgrath13 mcmcgrath13 requested a review from a team as a code owner May 11, 2026 15:48
@mcmcgrath13 mcmcgrath13 requested review from JordanGuinn and krista-skylight and removed request for a team May 11, 2026 15:48

DECLARE @sr11Id BIGINT = (SELECT library_uid FROM [dbo].[Report_Library] WHERE library_name = @pyLib)
DECLARE @sr12Id BIGINT = (SELECT library_uid FROM [dbo].[Report_Library] WHERE library_name = @sasLib)
IF EXISTS ((SELECT library_uid FROM [dbo].[Report_Library] WHERE library_name = @sasLib))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to prevent failure if run twice

Comment thread apps/modernization-api/src/main/resources/db/report/execution/libraries/qa_05.sql Outdated
Comment thread apps/report-execution/tests/conftest.py Outdated
@sonarqubecloud
Copy link
Copy Markdown

@emyl3 emyl3 requested review from emyl3 May 12, 2026 16:59
Copy link
Copy Markdown
Contributor

@JordanGuinn JordanGuinn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

content = trx.query(
f"""
WITH v_event_metric as ({subset_query}),
PROG_AREA as (
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(q, nb): I'm not sure if it would even be doable within Python's multi-line strings, but there could be some readability value in extracting the sub-queries for the various columns into variables? Not a particularly huge deal either way, just figured I'd bring it up as this took me a good while to grok as-is

Copy link
Copy Markdown
Contributor

@emyl3 emyl3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me code-wise! Will wait to approve after I can run the QA05.sas report locally to check the functional testing portion!! 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants