ansible/awx

Add option to textarea survey input to automatically convert to list

Open

#13554 opened on Feb 10, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
communitycomponent:uihelp wantedtype:enhancement

Description

Please confirm the following

  • I agree to follow this project's code of conduct.
  • I have checked the current issues for duplicates.
  • I understand that AWX is open source software provided for free and that I might not receive a timely response.

Feature type

New Feature

Feature Summary

A common use case with textarea is free form list input. This requires the extra step of calling .splitlines() or .split('/n') on the resulting variable in the playbook which is easy enough but extra steps. There should be a check box when configuring the survey question to automatically split the lines into a list potentially also to trim the lines.

Select the relevant components

  • UI
  • API
  • Docs
  • Collection
  • CLI
  • Other

Steps to reproduce

Provide multiple lines of text to a textarea question in a survey.

Current results

Currently there is no configuration options and if the input is being utilized as a list extra steps are required to split the values within the playbook.

Sugested feature result

Two configuration check boxes when adding a textarea question to a survey.

  1. Convert to List. This sets the variable to be a list of the split lines not a string with new line characters.
  2. Trim lines. Remove whitespace around lines.

Additional information

No response

Contributor guide

Tech stack
pythondjangoreact
Domain
frontend
Issue type
feature
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Ansible survey conceptsAWX UI component structurePython/Django basicsReact basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the AWX UI codebase for survey question configuration. Look at the survey creation form in the UI, possibly in components like 'SurveyQuestionField' or similar. On the backend, check models for SurveyQuestion to see if a field for 'convert to list' can be added. Review any existing tests for survey functionality. The issue is clear but no maintainer response; consider discussing in the project's community chat or opening a draft PR.