apache/openwhisk

Validate API-level tests against Swagger spec

Open

#3959 opened on Aug 9, 2018

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

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

Tech stack
None
Domain
backendtestingapi
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
knowledge of Scalaunderstanding of Swagger/OpenAPIfamiliarity with test automation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine existing Swagger validation in the system.basic test suite to understand the validator implementation. Review the Swagger spec at core/controller/src/main/resources/apiv1swagger.json. Identify test files in the whisk/core/controller package that need to be enhanced. Ensure that request/response validation aligns with the spec. Look for any maintainer comments in the issue or related PRs for additional context.