apache/openwhisk

Validate API-level tests against Swagger spec

Open

#3,959 opened on Aug 9, 2018

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Scala (1,177 forks)batch import
help wantedtesting

Repository metrics

Stars
 (6,777 stars)
PR merge metrics
 (Avg merge 17h 31m) (3 merged PRs in 30d)

Description

The goal is to include validation of requests and responses (maybe only responses) in *ApiTests which are mostly located under whisk/core/controller package in the test suite. This validation is already in place for the tests in system.basic package.

Provide the expected results and outputs:

The validator should check that request and response conforms to the Swagger spec in core/controller/src/main/resources/apiv1swagger.json

Additional information you deem important:

Some test from the system.basic test suite might be later moved to the API-level tests as long as we have the swagger spec validation in place.

Contributor guide

Research direction
Examine existing API level tests in whisk/core/controller and the Swagger spec at core/controller/src/main/resources/apiv1swagger.json to understand how validation is done in system.basic tests, then implement similar validation for request/response conformance.
Tech stack
scala
Domain
backend
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60