microsoft/restler-fuzzer

handling different string formats in RESTler

Open

#369 opened on Oct 8, 2021

View on GitHub
 (3 comments) (1 reaction) (1 assignee)Python (329 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (2,929 stars)
PR merge metrics
 (PR metrics pending)

Description

Any value can be used as the "format" value for string types in an OpenAPI specification. To better support domain-specific formats, RESTler could handle this in a generic way by generating a new dictionary entry, which the user could then populate. If empty, it would be treated as a restler_fuzzable_string.

For example: restler_custom_payload_format("date") restler_custom_payload_format("uri")

and in the dictionary:

"restler_custom_payload_format": {
  "date": ["2021-10-02"],
  "uri": ["https://example.com"]
}

Contributor guide

Research direction
Study the existing handling of string formats in the RESTler codebase, identify where format specific logic is applied, and implement a generic mechanism to allow users to define custom payloads for arbitrary formats via the dictionary.
Tech stack
python
Domain
apitesting qa
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
PythonREST APIGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75