55597 mocked auth data profiles

[bramleyjl]

Summary

• This PR adds the credential_list route to the Mocked Authentication module. This route takes a CSP type parameter and searches for all CSP user attribute profiles of that type currently in the vets-api-mockdata directory, controlled by Settings.sign_in.mock_credential_dir. The mock profile filenames should be the user_identifier, which is the user's email stripped of any non-word characters. This filenaming is used by the Mocked Authentication mock profile creator, and any files with non-word characters such as . will not be read by the reader. The mock data reader then creates and returns a mock_profiles hash that looks like:

mock_profiles: {
  bobloblaw: { 'credential_payload': { given_name: 'Bob', family_name: 'Loblaw', email: 'bobloblaw@gmail.com', ... },
               'encoded_credential': 'eyJjcmVkZW50aWFsX3V1aWQiOiIzY2I3OTJiZ...yLTc4NDgifQ==' },
  geneparmesan: { 'credential_payload': { given_name: 'Gene', family_name: 'Parmesan', email: 'geneparmesan@gmail.com', ... },
                  'encoded_credential': '1jZjBlMzM4N2IzYWIiLCJlbWFpbCI6Im1vY2...iZm9ybWF0dGVk==' }
}

Each entry is keyed to its user_identifier and possesses a credential_payload of attributes that differs depending on the CSP, as well as that payload cast to JSON and encoded as the encoded_credential field that can be passed back to the Mocked Authentication /authorize endpoint.

Related issue(s)

• create Mocked Auth user profiles va.gov-team#55597

Testing done

• Unit tests added to cover the controller
• To test, first ensure that you have credential data in your vets-api-mockdata/credentials/ directory for the CSP type you wish to test. You can create new mock credential data for ID.me, DSLogon, and Login.gov by performing an actual CSP authentication in localhost & enabling response logging.
• Navigate to the mocked_authentication/credential_list endpoint with your selected CSP type:

  curl http://localhost:3000/mocked_authentication/credential_list?type=logingov
  

Screenshots

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas)

Acceptance criteria

• I fixed|updated|added unit tests and integration tests for each feature (if applicable).
• Documentation has been updated (link to documentation)
• I added a screenshot of the developed feature

[github-actions]

1 Warning

⚠️

This PR changes 209 LoC (not counting whitespace/newlines). In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding 200. Expect some delays getting reviews. File Summary Files modules/mocked_authentication/app/controllers/mocked_authentication/credential_controller.rb (+19/-0) modules/mocked_authentication/config/routes.rb (+1/-0) modules/mocked_authentication/lib/mockdata/reader.rb (+62/-0) modules/mocked_authentication/lib/mockdata/writer.rb (+1/-1) modules/mocked_authentication/spec/lib/mockdata/reader_spec.rb (+41/-0) modules/mocked_authentication/spec/lib/mockdata/writer_spec.rb (+1/-1) modules/mocked_authentication/spec/requests/credential_request_spec.rb (+82/-0) Note: We exclude files matching the following when considering PR size: *.csv, *.json, *.tsv, *.txt, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/ Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

[bosawt]

Mostly comments around some code quality stuff, also have what (I think) will fix your CodeQL issue

[bosawt]

Just a small set of nitpicks this time for code quality. I did confirm it works so behaviorally seems good

[bosawt]

Looks good to me, thanks for making the changes!

[bosawt]

I've gotta admit, seeing the hashes like this after the Ruby 3.1 upgrade still catches me off guard for a second before I realize this is how it's supposed to be, ha

[bramleyjl]

I'm starting to get used to it surprisingly quickly! It really does cut a lot of unnecessary text out.