Miserlou/Zappa

Check Config Files for Allowed Values

Open

#1165 opened on Oct 11, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (11,903 stars) (1,286 forks)batch import
hacktoberfesthelp wanted

Description

Context

Was not seeing my remote environment variables because my config value was "remote_evn". Mistake on my part, but it would be nice if zappa checked config files to ensure that values being set were even values used by zappa.

Expected Behavior

When a user gives a config value not used by Zappa, it tells the user and suggests that it might be a typo. Just lowers the learning curve slightly and improves QOL.

Actual Behavior

Users are allowed to wallow in their mistakes

Possible Fix

Keep a white list of config keys and test against those.

Contributor guide

Tech stack
python
Domain
backenddevops
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonZappa config knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue suggests adding a whitelist of valid config keys in Zappa's configuration validation. Look at files like 'zappa/cli.py' or 'zappa/settings.py' where config parsing occurs. The maintainers have not provided additional guidance; the proposed fix is to maintain a set of allowed keys and check against user provided keys, emitting a warning or error for unknown keys.