spcl/serverless-benchmarks

Sanitize input on Python benchmarks

Open

#118 opened on Feb 20, 2023

View on GitHubContributor guide
 (18 comments) (2 reactions) (0 assignees)Python (99 forks)auto 404
buggood first issue

Repository metrics

Stars
 (196 stars)
PR merge metrics
 (Avg merge 2d 9h) (6 merged PRs in 30d)

Description

All Python benchmarks require JSON as input. However, we never verify that the provided input matches expectations. When users invoke benchmarks incorrectly, they should receive a helpful notification. Right now, they usually receive a Python exception where a variable loaded from JSON ends up being None.

All benchmarks should verify that the input values are provided in the JSON and are of correct type, and return a clear error message upon a failure.

Contributor guide

Research direction
Add input validation functions in each Python benchmark to verify JSON input structure and types, returning clear error messages for misuse.
Tech stack
python
Domain
backendtesting
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.
Half day
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
PythonJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70