Include New Citizenship Status Value #3428

elipe17 · 2025-01-15T20:35:55Z

Summary of Changes

Updated appropriate schemas to include the new value.
Updated tests
Pull request closes Update Citizenship/Immigration Status Acceptable Values (TANF only) #3386

How to Test

List the steps to test the PR
These steps are generic, please adjust as necessary.

cd tdrs-frontend && docker-compose up
cd tdrs-backend && docker-compose up

Open http://localhost:3000/ and sign in.
Modify the value of CITIZENSHIP_STATUS in a Active file to be a 3
Assert the value doesn't generate a parser error

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

Each TANF Active and Closed file T2, T3, and T5 allows 3 as a valid input for Citizenship/Immigration Status.
Testing Checklist has been run and all tests pass
README is updated, if necessary

Deliverable 2: Tested Code

Are all areas of code introduced in this PR meaningfully tested?
- If this PR introduces backend code changes, are they meaningfully tested?
- If this PR introduces frontend code changes, are they meaningfully tested?
Are code coverage minimums met?
- Frontend coverage: [insert coverage %] (see CodeCov Report comment in PR)
- Backend coverage: [insert coverage %] (see CodeCov Report comment in PR)

Deliverable 3: Properly Styled Code

Are backend code style checks passing on CircleCI?
Are frontend code style checks passing on CircleCI?
Are code maintainability principles being followed?

Deliverable 4: Accessible

Does this PR complete the epic?
Are links included to any other gov-approved PRs associated with epic?
Does PR include documentation for Raft's a11y review?
Did automated and manual testing with iamjolly and ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

Does this PR provide background for why coding decisions were made?
If this PR introduces backend code, is that code easy to understand and sufficiently documented, both inline and overall?
If this PR introduces frontend code, is that code easy to understand and sufficiently documented, both inline and overall?
If this PR introduces dependencies, are their licenses documented?
Can reviewer explain and take ownership of these elements presented in this code review?

Deliverable 7: Secure

Does the OWASP Scan pass on CircleCI?
Do manual code review and manual testing detect any new security issues?
If new issues detected, is investigation and/or remediation plan documented?

Deliverable 8: User Research

Research product(s) clearly articulate(s):

the purpose of the research
methods used to conduct the research
who participated in the research
what was tested and how
impact of research on TDP
(if applicable) final design mockups produced for TDP development

- Update test message

codecov · 2025-01-15T21:39:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.43%. Comparing base (099b230) to head (e67e58a).
Report is 12 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #3428   +/-   ##
========================================
  Coverage    91.43%   91.43%           
========================================
  Files          300      300           
  Lines         8647     8647           
  Branches       640      640           
========================================
  Hits          7906     7906           
  Misses         621      621           
  Partials       120      120

Flag	Coverage Δ
dev-backend	`91.29% <ø> (ø)`
dev-frontend	`92.44% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...-backend/tdpservice/parsers/schema_defs/tanf/t2.py	`100.00% <ø> (ø)`
...-backend/tdpservice/parsers/schema_defs/tanf/t3.py	`100.00% <ø> (ø)`
...-backend/tdpservice/parsers/schema_defs/tanf/t5.py	`100.00% <ø> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d275470...e67e58a. Read the comment docs.

…m/raft-tech/TANF-app into 3386-citizenship-status-new-value

raftmsohani

LGTM!

tdrs-backend/tdpservice/parsers/schema_defs/tanf/t3.py

ADPennington · 2025-01-30T18:06:59Z

tdrs-backend/tdpservice/parsers/schema_defs/tanf/t5.py

@@ -364,7 +364,7 @@
                    required=False,
                    validators=[
                        category3.orValidators([
-                            category3.isBetween(0, 2, inclusive=True),
+                            category3.isBetween(0, 3, inclusive=True),


@elipe17 @klinkoberstar this change works as expected, but i am also noticing that 0 is allowed and seems inconsistent with the coding instructions for item 25 (see screenshot here)

ADPennington

@elipe17 these changes look good to me. screenshots of before and after below.

S= staging (before)
Q = qasp (after)

please note my comment in the code re: item 25 for closed case files, which is also evident in the error message for closed case data files (staging) below. cc: @klinkoberstar

closed

Active

ADPennington · 2025-01-30T18:13:56Z

added discussion label to PR re: my comment above, mostly for dev to decide if this fix should be made here or a separate ticket. this is otherwise ready to merge @lhuxraft

klinkoberstar · 2025-01-30T18:22:32Z

tdrs-backend/tdpservice/parsers/schema_defs/tanf/t2.py

@@ -415,7 +415,7 @@
                    startIndex=57,
                    endIndex=58,
                    required=False,
-                    validators=[category2.isOneOf([0, 1, 2, 9])],


@ADPennington We also treat 0 as a valid value for Item 42 in the T2 file as a Cat 2 check. I'm not sure if this is intentional or an oversight. Is there any reason why would have wanted to give STTs the flexibility to submit blank/0 in this field rather than 9 ?

Good catch. I believe it was a relic of an earlier version of the updated coding instructions. I believe it was before we tested whether 0 would cause problems in FTANF. We can test it again to be sure and spin up a new ticket to remove it. 0 should only be possible if the field is "optional" for certain types of reported individuals.

This is helpful! I'll make a note to investigate and work on a follow up ticket!

Just want to confirm that this can merge then, or does zero need to be removed from possible values?

yep @elipe17 -- let's proceed with merging. 🚀 cc: @klinkoberstar @lhuxraft

lhuxraft · 2025-01-30T19:20:55Z

added discussion label to PR re: my comment above, mostly for dev to decide if this fix should be made here or a separate ticket. this is otherwise ready to merge @lhuxraft

Flagged for dev to take a look at - we can also discuss at standup tomorrow if needed 🙂

- Add new value to appropriate schemas

083104b

- Update test message

elipe17 added backend dev raft review This issue is ready for raft review labels Jan 15, 2025

elipe17 self-assigned this Jan 15, 2025

Merge branch 'develop' into 3386-citizenship-status-new-value

4c20a59

elipe17 added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jan 18, 2025

elipe17 added 2 commits January 17, 2025 22:24

- updated cat3 validators

da27e04

Merge branch '3386-citizenship-status-new-value' of https://github.co…

778e08a

…m/raft-tech/TANF-app into 3386-citizenship-status-new-value

elipe17 requested review from andrew-jameson, raftmsohani and jtimpe January 21, 2025 13:46

elipe17 removed the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jan 21, 2025

raftmsohani approved these changes Jan 21, 2025

View reviewed changes

andrew-jameson approved these changes Jan 21, 2025

View reviewed changes

jtimpe reviewed Jan 21, 2025

View reviewed changes

tdrs-backend/tdpservice/parsers/schema_defs/tanf/t3.py Outdated Show resolved Hide resolved

- Fix fat fingered value

6871ea6

elipe17 requested a review from jtimpe January 21, 2025 16:28

jtimpe approved these changes Jan 21, 2025

View reviewed changes

elipe17 added QASP Review and removed raft review This issue is ready for raft review labels Jan 22, 2025

Merge branch 'develop' into 3386-citizenship-status-new-value

06d41eb

elipe17 requested a review from ADPennington January 23, 2025 15:27

ADPennington added the Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI label Jan 23, 2025

Merge branch 'develop' into 3386-citizenship-status-new-value

e67e58a

ADPennington reviewed Jan 30, 2025

View reviewed changes

ADPennington approved these changes Jan 30, 2025

View reviewed changes

ADPennington removed QASP Review Deploy with CircleCI-qasp Deploy to https://tdp-frontend-qasp.app.cloud.gov through CircleCI labels Jan 30, 2025

ADPennington added the discussion label Jan 30, 2025

ADPennington added the Ready to Merge label Jan 30, 2025

klinkoberstar reviewed Jan 30, 2025

View reviewed changes

ADPennington removed the discussion label Jan 31, 2025

elipe17 merged commit 90e2823 into develop Jan 31, 2025
19 checks passed

elipe17 deleted the 3386-citizenship-status-new-value branch January 31, 2025 15:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include New Citizenship Status Value #3428

Include New Citizenship Status Value #3428

elipe17 commented Jan 15, 2025 •

edited by ADPennington

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading

raftmsohani left a comment

ADPennington Jan 30, 2025

ADPennington left a comment

ADPennington commented Jan 30, 2025 •

edited

Loading

klinkoberstar Jan 30, 2025

ADPennington Jan 30, 2025

klinkoberstar Jan 30, 2025

elipe17 Jan 30, 2025

ADPennington Jan 31, 2025

lhuxraft commented Jan 30, 2025

Include New Citizenship Status Value #3428

Include New Citizenship Status Value #3428

Conversation

elipe17 commented Jan 15, 2025 • edited by ADPennington Loading

Summary of Changes

How to Test

Deliverables

codecov bot commented Jan 15, 2025 • edited Loading

Codecov Report

raftmsohani left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ADPennington left a comment

Choose a reason for hiding this comment

ADPennington commented Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lhuxraft commented Jan 30, 2025

elipe17 commented Jan 15, 2025 •

edited by ADPennington

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading

ADPennington commented Jan 30, 2025 •

edited

Loading