Page MenuHomePhabricator

<spike> Test Plan for API Gateway feature testing
Open, HighPublicSpike

Description

Background/Goal

Prepare a comprehensive testing plan for API Gateway feature and per service testing. Our goal is to eventually have heavily used APIs on the gateway for production traffic routing, authentication, and analytics.

User stories
  • As an API gateway engineer, I need to know what the testing plan is, so my work can ladder up to the testing plan process needs.
  • As a QAT for the API Gateway, I need to know the testing requirements and process, so API Gateway features and services can be successfully prepared for deployment and maintenance.
Considerations
  • What tests are critical vs nice-to-have?
  • What tests have the biggest impact?
  • What tests have the most dependencies?
  • How can we scope and resource this work in a way that delivers incremental benefits?
Requirements
  • A brief description of what the use case is
  • Review existing testing methods
  • Analyze API Gateway as a product
  • Design test strategy
  • Define test objectives
  • Define test criteria
  • Resource estimations for testing
  • Plan test environment
  • Bullet internal/external impacts of testing strategy
  • List of what this blocks (if anything) and why. Include examples.
  • Documents and links to existing artifacts, tickets, etc.
  • Open questions/additional areas to explore

Upon completion of the above:

  • Tech Lead & Engineering Manager review
    • Bullet list of what the related infrastructure capabilities are
    • Bullet list of potential/expected development/engineering impacts (both positive and negative)
    • Bullet list of potential/expected design impacts (both positive and negative)
    • Describe WHAT phases or chunks of work could be done and by WHO
    • List any dependencies we have on any tools, teams, etc.
    • Meeting set to review scope with Product Manager
  • Once scope completed and agreed to, next steps defined (ex: create Epic w/ subtasks)
Acceptance criteria
  • It is clear to see how the tests impact end-users
  • It is clear how the tests impact WMF staff
  • Impact can be delivered incrementally, without having to wait months or to the end of a project to see impact
  • Non-technical audiences can understand why this work matters and how it impacts the community

Related Objects

StatusSubtypeAssignedTask
In ProgressNone
OpenSpikeNone

Event Timeline

Restricted Application changed the subtype of this task from "Task" to "Spike". · View Herald TranscriptSep 19 2022, 4:46 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
VirginiaPoundstone moved this task from Incoming to Must do now on the API Platform board.