ansible/awx

Hostnames in dev environment fail validator, makes no-op PATCH error

Open

#13292 opened on Dec 6, 2022

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

Description

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • API
SUMMARY

A new Instance hostname validator fails with the basic docker development environment.

Also, we seem to validate the field even when it's not changing, which makes it hard to do other things in the API.

ENVIRONMENT
  • AWX install method: developer environment
STEPS TO REPRODUCE

Start the docker-compose development environment with 1 hybrid instance.

PATCH with default data

https://localhost:8043/api/v2/instances/1/

EXPECTED RESULTS

A 200 response code.

ACTUAL RESULTS

A 400 response code with

{
    "hostname": [
        "illegal characters detected in hostname=awx_1. Please verify."
    ]
}
ADDITIONAL INFORMATION

It seems questionable that we allow registration with a hostname that would fail validation?

Provided that we don't want to fix that, then we must assume that we have invalid hostnames in all cases, and it would be nice to only validate when it is changing.

Contributor guide

Tech stack
pythondjangorest api
Domain
api
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonDjangoREST API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate the hostname validation logic in the AWX API. Look for where the validator is defined (likely in a model or serializer file) and why it rejects hostnames with underscores (e.g., 'awx 1'). Also, check how the PATCH request handles the hostname field to ensure validation is skipped if the field is not being updated. The test suite may have relevant tests for instance update.