add check to avoid deployment with invalid features (#405)

* add check to avoid deployment with invalid features

* add test for check_features role

---------

Co-authored-by: Arvind Jangir <ajangir@ajangir-thinkpadt14gen5.punetw6.csb>

Author: arvind4501

src/filter_plugins/foremanctl.py

@@ -73,6 +73,10 @@ def list_all_features(enabled_features, only_enabled=False):
 
     return "\n".join(output)
 
+def invalid_features(features):
+    """Return a list of unknown features not defined in features.yaml."""
+    return [feature for feature in features if feature not in FEATURE_MAP]
+
 def foreman_proxy_plugins(value):
     dependencies = list(get_dependencies(filter_features(value)))
     plugins = [FEATURE_MAP.get(feature, {}).get('foreman_proxy', {}).get('plugin_name') for feature in filter_features(value + dependencies)]
@@ -94,4 +98,5 @@ def filters(self):
             'features_to_foreman_proxy_plugins': foreman_proxy_plugins,
             'available_foreman_proxy_plugins': available_foreman_proxy_plugins,
             'list_all_features': list_all_features,
+            'invalid_features': invalid_features,
         }

src/roles/check_features/tasks/main.yaml

@@ -0,0 +1,15 @@
+---
+- name: Validate requested features
+  ansible.builtin.assert:
+    that:
+      - found_invalid_features | length == 0
+    fail_msg: |
+      ERROR: Unknown feature(s) requested: {{ found_invalid_features | join(', ') }}
+
+      To remove them, run:
+        foremanctl deploy {% for feature in found_invalid_features %}--remove-feature={{ feature }} {% endfor %}
+
+      Run 'foremanctl features' to list all available features.
+  vars:
+    found_invalid_features: "{{ features | invalid_features }}"
+  when: features | length > 0

src/roles/checks/tasks/main.yml

@@ -2,6 +2,7 @@
 - name: Execute checks
   ansible.builtin.include_tasks: execute_check.yml
   loop:
+    - check_features
     - check_hostname
     - check_database_connection
     - check_system_requirements

tests/features_test.py

@@ -20,3 +20,13 @@ def test_foremanctl_features_list_enabled():
 
     assert 'enabled' in result.stdout
     assert 'available' not in result.stdout
+
+def test_invalid_feature_rejected():
+    command = ['./foremanctl', 'deploy', '--add-feature', 'invalid-feature']
+    result = subprocess.run(command, capture_output=True, text=True)
+
+    assert result.returncode == 2
+
+    assert 'Unknown feature(s) requested: invalid-feature' in result.stdout
+    assert '--remove-feature=invalid' in result.stdout
+    assert "Run 'foremanctl features' to list all available features." in result.stdout