Access to test run informations from outside Test Management

Submitted by abe on Wed, 02/23/2022 - 10:33
Business phase
Specification status
Reviewed
Implementation status
Available
Description

Gazelle Test Management shall offer a webserice API to access the test runs (formerly known as test instances) from external tools. The user shall not be asked to authenticate itself; instead, the calling tool will provide its API key.

Two methods shall be offered:

  • GetTestSessionList:
    • Inputs:
      • organisation's keyword as registered in Gazelle Test Management
      • API key
    • Output:
      • The list of activated test sessions where the organisation has systems under test with status "accepted"
        • Test session description
        • Test session id
      • In case one of the inputs is missing, return HTTP code 400
      • In case the organisation's keyword is unknown, return HTTP code 404
      • In case the API key is unknown, return HTTP code 401
      • In case the organisation does not have system in any of the test session, return HTTP code 204
  • GetTestRuns
    • Inputs:
      • organisation's keyword as registered in Gazelle Test Management
      • API key 
      • Test session id
    • Outputs:
      • The list of test runs where at least one SUT from the organisation is involved, for each test run
        • Systems under test which executed the test;
        • Name of the organisations involved in the test;
        • Type of the test case (Projectathon, Connectathon...);
        • Name of the test case;
        • Version of the test case;
        • Id of the test run;
        • Status of the test run;
        • Permanent URL to the test run;
        • Date and time of the last update of the test run.
      • In case one of the inputs is missing, return HTTP code 400
      • In case the organisation's keyword and/or the test session id is unknown, return HTTP code 404
      • In case the API key is unknown, return HTTP code 401
      • In case the organisation does not have test runs in the given test session, return HTTP code 204

 

Swagger: https://app.swaggerhub.com/apis/laurent.guedon/apiconv/1.0.4#/AIPOs

 

Stories in feature