ansible/awx

Validate `pod_spec_override` on InstanceGroupSerializer

Open

#8182 opened on Sep 18, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
component:apihelp wantedtype:bug

Description

ISSUE TYPE
  • Feature Idea
SUMMARY

Right now there is no validation for pod_spec_override on InstanceGroupSerializer. Validate that it is a valid JSON.

Contributor guide

Tech stack
pythondjango
Domain
backendapi
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
knowledge of Django REST Framework serializersunderstanding JSON validation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The validation for `pod spec override` should be added to the InstanceGroupSerializer. In Django REST Framework, you can add a custom validator to the field to check that the input is valid JSON. Look at the serializers in awx/api/serializers.py for existing validation patterns. The validator should use json.loads() and catch JSONDecodeError to raise a serializers.ValidationError. Ensure the field is already defined; if not, it may need to be added as a JSONField or CharField with the validator.