linuxboot / linuxboot/contest

Provide implicit pre-validation of test step parameters

Open
#18 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
20
Forks
17
PR merge metrics
No merged PRs in 30d

Description

**Issue by [insomniacslk](https://github.com/insomniacslk)**
_Monday Feb 24, 2020 at 18:32 GMT_
_Originally opened as https://github.com/facebookincubator/contest/issues/53_

----

Almost every plugin will have to replicate certain steps to validate its parameters, e.g.:
* ensure that all and only the supported parameters are passed
* ensure that the passed parameters have the right types
* ensure that a parameters receives the correct number of parameters (e.g. zero, more-than-zero, at-least-one, between-2-and-3, etc)

All of the above checks can be offloaded from the plugin developer, and done in a consistent and declarative manner

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by locating how test steps and plugin parameters are represented, then review existing plugin validation behavior. Done should mean supported names, types, and parameter counts are checked consistently before a plugin handles a step.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.