VA Profile Mockdata solution

[rmtolmach]

Problem

There is no mockdata for VA Profile. Mockdata is important for testing in lower environments, especially when using a service where you need to be on the VA network to access. We need to be able to access mockdata for external services. The routes are tested on the network and then the responses are copied into the mockdata repo.

Solution

Record mockdata. Follow instructions in Mockdata repo for Create mock data for a brand new service. The instructions don't seem comprehensive, so there is some unknown to this ticket. Reach out to people who have committed to the repo or possibly Tom Harrison.

These are Trevor's steps:

• Generate a cURL for the call you're trying to make
• On Citrix machine, copy the cURL into a terminal and run it against the service I'm testing
• Copy the response into a folder in the vets-api-mockdata repository
• On my service in vets-api, add the middleware to mock with Betamocks and the ruleset to define where in vets-api-mockdata to find the mocked response
• Test on localhost as if the integration were live

Acceptance Criteria

Generated by Zenhub AI

• [ ] Scenario 1: Record mockdata for VA Profile

  • Given that I am a developer
  • When I follow the instructions in the Mockdata repo for creating mock data for a brand new service
  • Then I should be able to record mockdata for VA Profile

• [ ] Scenario 2: Access mockdata for VA Profile

  • Given that I am a developer
  • When I need to access mockdata for VA Profile in lower environments
  • Then I should be able to access the recorded mockdata

• [ ] Scenario 3: Test VA Profile routes with mockdata

  • Given that I am a developer
  • When I test VA Profile routes using the recorded mockdata
  • Then the responses should match the recorded mockdata

• [ ] Scenario 4: Verify instructions in the Mockdata repo

  • Given that I am a developer
  • When I review the instructions in the Mockdata repo for creating mock data for a brand new service
  • Then the instructions should be comprehensive and provide clear guidance

• [ ] Scenario 5: Seek assistance for unknowns in the instructions

  • Given that I am a developer
  • When I encounter unknowns while following the instructions in the Mockdata repo for creating mock data for a brand new service
  • Then I should reach out to people who have committed to the repo or possibly Tom Harrison for assistance

Related issues

VA Profile Contact Information can completed concurrently with this ticket.

[jennb33]

Could we record this and include mock data and setting up the port forwarding to the fwd proxy. Could use C&CC time for this exercise.

[jennb33]

@rmtolmach to announce in Backend-COP that we are doing this exercise as a team on C&CC on Friday 2/2/24

[rmtolmach]

➡️ Branch and diff: 68412_vaprofile_betamocks

We made some progress on this during Friday morning meeting. Got through step 3 in Create mock data for a brand new service. I hadn't set up my settings.local.yaml, so I did that before starting the steps. Used this command from the vets-api README:

cp config/settings.local.yml.example config/settings.local.yml

In services_config.yml, we have this so far:

# VA Profile
- :name: "VA Profile"
  :base_uri: <%= "#{URI(Settings.vet360.url).host}:#{URI(Settings.vet360.url).port}" %>
  :endpoints:
    - :method: :get
      :path: "profile-service/profile/v3/*/*"
      :file_path: "va_profile/military_info"

One unknown is how bio paths fit into this. In VA Profile, the bioPath is how you specify your endpoint.

[rmtolmach]

Rachal's branch with more progress: https://github.com/department-of-veterans-affairs/vets-api/compare/master...mockdata-setup

[rmtolmach]

We made more progress on this today. We followed the documents Tom shared with Gia:

1. https://github.com/department-of-veterans-affairs/va.gov-team-sensitive/blob/master/products/identity-personalization/developer/mock_data.md
2. https://github.com/department-of-veterans-affairs/va.gov-team-sensitive/blob/master/products/identity-personalization/developer/mock_va_profile_service_history.md

We got through 1, didn't start 2 yet.

[rmtolmach]

Ryan M and I got stuck on the "Run Applications" section of the first doc 😑

[rmtolmach]

Moving it out a couple sprints. Now that most of us have had some exposure to this work, it can be picked up and completed by one person during a sprint and not during C&CC like we were doing.

[jennb33]

Executive decision made during C&CC on 3/1/2024 - this should be assigned to one individual or a couple , since the entire team has been exposed.