From 8d772ea725dca516cdbec4021bbe0c855977f077 Mon Sep 17 00:00:00 2001
From: root <root@my-multipurpose-srv.subnet12291634.vcn12291634.oraclevcn.com>
Date: Sat, 20 Sep 2025 12:35:43 +0530
Subject: [PATCH 1/5] vars_prompt: add choices support for input validation

Add support for 'choices' key in vars_prompt to restrict user input
to predefined options. When choices are specified:
- Interactive prompts validate user input against allowed choices
- Values from --extra-vars are also validated
- Invalid values raise ValueError with clear error message

This enhancement improves playbook usability by preventing invalid
input and providing clear feedback to users.
---
 .../fragments/vars_prompt_choices_support.yml |  3 ++
 lib/ansible/executor/playbook_executor.py     | 49 ++++++++++++++++---
 lib/ansible/playbook/play.py                  |  2 +-
 3 files changed, 46 insertions(+), 8 deletions(-)
 create mode 100644 changelogs/fragments/vars_prompt_choices_support.yml

diff --git a/changelogs/fragments/vars_prompt_choices_support.yml b/changelogs/fragments/vars_prompt_choices_support.yml
new file mode 100644
index 00000000000..48c173ce277
--- /dev/null
+++ b/changelogs/fragments/vars_prompt_choices_support.yml
@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - vars_prompt now supports a `choices` key for input validation. If choices are defined, users must pick one of the provided options. Values supplied via `--extra-vars` are also validated against the choices list.
diff --git a/lib/ansible/executor/playbook_executor.py b/lib/ansible/executor/playbook_executor.py
index 9bd7317615c..9c50dcc8f77 100644
--- a/lib/ansible/executor/playbook_executor.py
+++ b/lib/ansible/executor/playbook_executor.py
@@ -139,13 +139,48 @@ class PlaybookExecutor:
                             salt = var.get("salt", None)
                             unsafe = boolean(var.get("unsafe", False))
 
-                            if vname not in self._variable_manager.extra_vars:
-                                if self._tqm:
-                                    self._tqm.send_callback('v2_playbook_on_vars_prompt', vname, private, prompt, encrypt, confirm, salt_size, salt,
-                                                            default, unsafe)
-                                    play.vars[vname] = display.do_var_prompt(vname, private, prompt, encrypt, confirm, salt_size, salt, default, unsafe)
-                                else:  # we are either in --list-<option> or syntax check
-                                    play.vars[vname] = default
+                            # 🔹 New: support for choices
+                            choices = var.get("choices")
+
+                            if self._tqm:
+                                self._tqm.send_callback(
+                                    'v2_playbook_on_vars_prompt',
+                                    vname, private, prompt, encrypt, confirm,
+                                    salt_size, salt, default, unsafe
+                                )
+
+                                # Skip prompt if provided via --extra-vars
+                                if vname in self._variable_manager.extra_vars:
+                                    play.vars[vname] = self._variable_manager.extra_vars[vname]
+
+                                    # If choices are defined, validate extra-vars value too
+                                    if choices and play.vars[vname] not in choices:
+                                        raise ValueError(
+                                            f"Invalid value for '{vname}': "
+                                            f"'{play.vars[vname]}' not in allowed choices {choices}"
+                                        )
+                                    continue
+
+                                answer = display.do_var_prompt(
+                                    vname, private, prompt, encrypt, confirm,
+                                    salt_size, salt, default, unsafe
+                                )
+
+                                # 🔹 Check choices for interactive input
+                                if choices:
+                                    while answer not in choices:
+                                        display.display(
+                                            f"Invalid choice. Must be one of: {choices}",
+                                            color='red'
+                                        )
+                                        answer = display.do_var_prompt(
+                                            vname, private, prompt, encrypt, confirm,
+                                            salt_size, salt, default, unsafe
+                                        )
+
+                                play.vars[vname] = answer
+                            else:
+                                play.vars[vname] = default
 
                     # Post validate so any play level variables are templated
                     all_vars = self._variable_manager.get_vars(play=play)
diff --git a/lib/ansible/playbook/play.py b/lib/ansible/playbook/play.py
index 12e3e304bb8..1967ce69397 100644
--- a/lib/ansible/playbook/play.py
+++ b/lib/ansible/playbook/play.py
@@ -255,7 +255,7 @@ class Play(Base, Taggable, CollectionSearch):
                 if 'name' not in prompt_data:
                     raise AnsibleParserError("Invalid vars_prompt data structure, missing 'name' key", obj=ds)
                 for key in prompt_data:
-                    if key not in ('name', 'prompt', 'default', 'private', 'confirm', 'encrypt', 'salt_size', 'salt', 'unsafe'):
+                    if key not in ('name', 'prompt', 'default', 'private', 'confirm', 'encrypt', 'salt_size', 'salt', 'unsafe', 'choices'):
                         raise AnsibleParserError("Invalid vars_prompt data structure, found unsupported key '%s'" % key, obj=ds)
                 vars_prompts.append(prompt_data)
         return vars_prompts

From 31c6f6b8d2107f7c083922827e69abb1d9f081cf Mon Sep 17 00:00:00 2001
From: root <root@my-multipurpose-srv.subnet12291634.vcn12291634.oraclevcn.com>
Date: Tue, 23 Sep 2025 12:51:00 +0530
Subject: [PATCH 2/5] tests: add integration tests for vars_prompt choices
 option

---
 .../targets/vars_prompt_choices/aliases       |  1 +
 .../targets/vars_prompt_choices/main.yml      | 11 ++++++++
 .../vars_prompt_choices/tasks/main.yml        | 27 +++++++++++++++++++
 3 files changed, 39 insertions(+)
 create mode 100644 test/integration/targets/vars_prompt_choices/aliases
 create mode 100644 test/integration/targets/vars_prompt_choices/main.yml
 create mode 100644 test/integration/targets/vars_prompt_choices/tasks/main.yml

diff --git a/test/integration/targets/vars_prompt_choices/aliases b/test/integration/targets/vars_prompt_choices/aliases
new file mode 100644
index 00000000000..1af1cf90b6a
--- /dev/null
+++ b/test/integration/targets/vars_prompt_choices/aliases
@@ -0,0 +1 @@
+context/controller
diff --git a/test/integration/targets/vars_prompt_choices/main.yml b/test/integration/targets/vars_prompt_choices/main.yml
new file mode 100644
index 00000000000..6922284e35f
--- /dev/null
+++ b/test/integration/targets/vars_prompt_choices/main.yml
@@ -0,0 +1,11 @@
+- hosts: localhost
+  gather_facts: no
+  vars_prompt:
+    - name: color
+      prompt: "Choose a color"
+      choices:
+        - red
+        - green
+  tasks:
+    - debug:
+        var: color
diff --git a/test/integration/targets/vars_prompt_choices/tasks/main.yml b/test/integration/targets/vars_prompt_choices/tasks/main.yml
new file mode 100644
index 00000000000..0719997f4a0
--- /dev/null
+++ b/test/integration/targets/vars_prompt_choices/tasks/main.yml
@@ -0,0 +1,27 @@
+- name: Run playbook with valid choice
+  command: >
+    ansible-playbook test/integration/targets/vars_prompt_choices/main.yml
+    --extra-vars "color=red"
+  args:
+    chdir: "{{ lookup('env', 'ANSIBLE_TESTS') | default('/root/devs/ansible', true) }}"
+  register: result_valid
+  ignore_errors: yes
+
+- name: Assert valid choice succeeded
+  assert:
+    that:
+      - result_valid.rc == 0
+
+- name: Run playbook with invalid choice
+  command: >
+    ansible-playbook test/integration/targets/vars_prompt_choices/main.yml
+    --extra-vars "color=blue"
+  args:
+    chdir: "{{ lookup('env', 'ANSIBLE_TESTS') | default('/root/devs/ansible', true) }}"
+  register: result_invalid
+  ignore_errors: yes
+
+- name: Assert invalid choice failed
+  assert:
+    that:
+      - result_invalid.rc != 0

From c07858b18064f87d333b03419e080f0db6f1be50 Mon Sep 17 00:00:00 2001
From: Krishnendu Bhowmick <krishnendu2u@gmail.com>
Date: Tue, 23 Sep 2025 13:11:23 +0530
Subject: [PATCH 3/5] tests: fix integration aliases for vars_prompt_choices.

---
 test/integration/targets/vars_prompt_choices/aliases | 1 +
 1 file changed, 1 insertion(+)

diff --git a/test/integration/targets/vars_prompt_choices/aliases b/test/integration/targets/vars_prompt_choices/aliases
index 1af1cf90b6a..13e01f0c947 100644
--- a/test/integration/targets/vars_prompt_choices/aliases
+++ b/test/integration/targets/vars_prompt_choices/aliases
@@ -1 +1,2 @@
+shippable/posix/group1
 context/controller

From 899d4141a4c0c9c8a3d31da3fc1ffb0a7e269c6e Mon Sep 17 00:00:00 2001
From: Krishnendu Bhowmick <krishnendu2u@gmail.com>
Date: Tue, 23 Sep 2025 13:23:22 +0530
Subject: [PATCH 4/5] tests: fix controller-only integration aliases for
 vars_prompt_choices

---
 test/integration/targets/vars_prompt_choices/aliases | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test/integration/targets/vars_prompt_choices/aliases b/test/integration/targets/vars_prompt_choices/aliases
index 13e01f0c947..8278ec8bcc7 100644
--- a/test/integration/targets/vars_prompt_choices/aliases
+++ b/test/integration/targets/vars_prompt_choices/aliases
@@ -1,2 +1,2 @@
-shippable/posix/group1
+shippable/posix/group3
 context/controller

From fd1d09803a9b1c7a55ac28e9258ca8e49a3f5995 Mon Sep 17 00:00:00 2001
From: Krishnendu Bhowmick <krishnendu2u@gmail.com>
Date: Tue, 23 Sep 2025 14:10:26 +0530
Subject: [PATCH 5/5] tests: fix playbook path in vars_prompt_choices
 integration test

---
 .../targets/vars_prompt_choices/tasks/main.yml         | 10 +++-------
 1 file changed, 3 insertions(+), 7 deletions(-)

diff --git a/test/integration/targets/vars_prompt_choices/tasks/main.yml b/test/integration/targets/vars_prompt_choices/tasks/main.yml
index 0719997f4a0..5f7ec6fd9e0 100644
--- a/test/integration/targets/vars_prompt_choices/tasks/main.yml
+++ b/test/integration/targets/vars_prompt_choices/tasks/main.yml
@@ -1,9 +1,7 @@
 - name: Run playbook with valid choice
   command: >
-    ansible-playbook test/integration/targets/vars_prompt_choices/main.yml
+    ansible-playbook targets/vars_prompt_choices/main.yml
     --extra-vars "color=red"
-  args:
-    chdir: "{{ lookup('env', 'ANSIBLE_TESTS') | default('/root/devs/ansible', true) }}"
   register: result_valid
   ignore_errors: yes
 
@@ -14,14 +12,12 @@
 
 - name: Run playbook with invalid choice
   command: >
-    ansible-playbook test/integration/targets/vars_prompt_choices/main.yml
+    ansible-playbook targets/vars_prompt_choices/main.yml
     --extra-vars "color=blue"
-  args:
-    chdir: "{{ lookup('env', 'ANSIBLE_TESTS') | default('/root/devs/ansible', true) }}"
   register: result_invalid
   ignore_errors: yes
 
 - name: Assert invalid choice failed
   assert:
     that:
-      - result_invalid.rc != 0
+      - result_invalid.rc != 0
\ No newline at end of file