1.05. Align Quoting-Services Sequence Diagram with TTK Collection

[mdebarros]

Goal:

As an Ops team member supporting a Switch
I want to have a relational reference between the sequence diagrams for the Quoting-service and the TTK test collection
so that I could use it for debugging purposes so that I can quickly find the root cause of an issue

Acceptance Criteria:

• As-is sequence diagrams (and steps) in quoting-service have corresponding TTK tests

Complexity: Low - We won't be creating new Sequence diagrams in this story

Uncertainty: Medium - There is a level of uncertainty with regards to missing TTK tests and sequence diagrams

---

Tasks:

• Naming & Referencing conventions for TTK tests & sequence diagram
• Identify and document gaps in the test collections [@oderayi]
  • Missing Tests [Create missing TTK tests for Bulk Quotes API #1665]:
    • POST /quotes
    • PUT /quotes/{id} (-ve scenarios)
    • PUT /quotes/{id}/error
    • POST /bulkQuotes
    • PUT /bulkQuotes/{id}
    • PUT /bulkQuotes/{id}/error
    • GET /bulkquotes/{id} (-ve scenarios)
    • PUT /bulkQuotes/{id} (-ve scenarios)
• Identify and document gaps in the sequence diagrams [@oderayi]
  • Missing Diagrams [Follow-up stories Create sequence diagrams for Quoting Service to cover scenarios not covered in existing sequence diagrams #1602 Create sequence diagrams for Bulk Quotes API #1643]
    • GET /quotes/{id}
    • POST /quotes
    • PUT /quotes/{id}
    • PUT /post/{id}/error
    • POST /bulkQuotes
    • PUT /bulkQuotes/{id}
    • PUT /bulkQuotes/{id}/error
    • GET /bulkQuotes/{id}
• Other gaps identified [Follow-up story #1603] :
  • POST /quotes handler needs to aligned with sequence diagram e.g. 202 response is not returned immediately as seen in diagram
• Refactor outdated sequence diagrams [@oderayi]
• Update test collections to correlate with Sequence diagrams [@oderayi]
  • POST /quotes [@oderayi]
  • POST /quotes (-ve scenarios) [@oderayi]
  • PUT /quotes/{id} (-ve scenarios) [@oderayi]
  • PUT /quotes/{id}/error [@oderayi]
• Refactor existing TTK Golden Path tests to add new tests for missing functionality [@oderayi]
• Peer review [@Team]
• Create follow-up stories for missing sequence diagrams and tests [@oderayi]

Done

• Acceptance Criteria pass
• Designs are up-to date
• TTK Tests pass

Pull Requests:

• #1513: Fix errors with quoting service sequence diagram documentation#251
• #1513: Add endpoints to support unhappy path testing for quoting service simulator#207
• #1513: Upgrade legacy simulator to v11.0.0 helm#369
• #1513: Update FSP onboarding scripts for noresponsepayefsp postman#164

Follow-up:

• Create sequence diagrams for Quoting Service to cover scenarios not covered in existing sequence diagrams #1602
• Change Quoting service from Sync to Async #1603
• Create sequence diagrams for Bulk Quotes API #1643
• Align AS-IS Bulk Quotes Mojasim tests to Sequence diagrams #1646
• Create missing TTK tests for Bulk Quotes API #1665

Dependencies:

• N/A

Accountability:

• Owner: TBC
• QA/Review: @amarmodus @elnyry-sam-k