foreman_openbolt 1.1.0 → 1.2.0

data/test/acceptance/tests/parameter_table_test.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../acceptance_helper'
+
+# Tests the parameter table rendering logic: required indicator
+# based on the Optional[...] type prefix, and the expandable row
+# that reveals type and description for each parameter.
+class ParameterTableTest < AcceptanceTestCase
+  def setup
+    super
+    foreman_login
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+    select_first_proxy
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::complex_params', from: 'task-name-input'
+    assert_selector '#param_required_string', wait: 10
+  end
+
+  def test_required_param_shows_required_indicator
+    # ParametersSection flags params whose type does not start with
+    # "optional" as required, and FieldTable renders a span with
+    # role=img and aria-label="Required" in those rows.
+    within(:xpath, "//tr[.//input[@id='param_required_string']]") do
+      assert_selector 'span[role="img"][aria-label="Required"]'
+    end
+  end
+
+  def test_optional_param_has_no_required_indicator
+    within(:xpath, "//tr[.//input[@id='param_optional_string']]") do
+      assert_no_selector 'span[role="img"][aria-label="Required"]'
+    end
+  end
+
+  def test_expanding_required_param_row_shows_type_description_and_required_warning
+    within(:xpath, "//tr[.//input[@id='param_required_string']]") do
+      first('button').click
+    end
+
+    # The expanded row is a sibling in the same Tbody. Assertions on
+    # the page level since the ExpandableRowContent is outside the
+    # trigger row's scope.
+    assert_selector '.pf-v5-c-helper-text__item',
+      text: 'This field is required', wait: 5
+    assert_selector '.pf-v5-c-helper-text__item code', text: 'String'
+    assert_selector '.pf-v5-c-helper-text__item',
+      text: 'A required string parameter'
+  end
+
+  def test_expanding_optional_param_row_shows_type_and_description_without_required_warning
+    within(:xpath, "//tr[.//input[@id='param_optional_string']]") do
+      first('button').click
+    end
+
+    assert_selector '.pf-v5-c-helper-text__item code', text: 'Optional[String]'
+    assert_selector '.pf-v5-c-helper-text__item',
+      text: 'An optional string parameter'
+    assert_no_selector '.pf-v5-c-helper-text__item',
+      text: 'This field is required'
+  end
+end

data/test/acceptance/tests/settings_test.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../acceptance_helper'
+
+# Tests that Foreman settings correctly populate the OpenBolt options UI
+# and that changes to settings are reflected in the plugin's behavior.
+# This exercises the settings lookup bug fix (Foreman.settings vs Setting.where).
+class SettingsTest < AcceptanceTestCase
+  def setup
+    super
+    foreman_login
+  end
+
+  def test_openbolt_user_setting_populates_default
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+    select_first_proxy
+
+    # The user option should show the value configured during acceptance:up
+    assert_selector '#param_user', wait: 10
+    assert_equal 'openbolt', find_by_id('param_user').value
+  end
+
+  # The string the UI shows in an encrypted-default field so the user can tell
+  # a saved value exists without exposing it to the browser. Kept in sync with
+  # ENCRYPTED_PLACEHOLDER in task_controller.rb and ENCRYPTED_DEFAULT_PLACEHOLDER
+  # in webpack/src/Components/common/constants.js.
+  ENCRYPTED_DEFAULT_PLACEHOLDER = '[Use saved encrypted default]'
+
+  def test_encrypted_setting_shows_placeholder_and_is_overrideable
+    # Scope the saved password to this test so it does not leak into other
+    # task launches (merge_encrypted_defaults would inject it into bolt).
+    update_foreman_setting('openbolt_password', 'acceptance-test-password')
+    begin
+      visit '/foreman_openbolt/page_launch_task'
+      assert_selector '#smart-proxy-input', wait: 15
+      select_first_proxy
+
+      # With a saved encrypted setting, the field prefills with the placeholder
+      # string so the user knows the saved value will be used. The real value
+      # is never sent to the browser.
+      field = find_by_id('param_password', wait: 10)
+      assert_equal 'password', field['type']
+      assert_equal ENCRYPTED_DEFAULT_PLACEHOLDER, field.value.to_s
+
+      # Expanding the row reveals a warning that an encrypted default is saved.
+      # The FieldTable renders an expand toggle in the first cell of each row;
+      # click the first button within the row containing our field.
+      within(:xpath, "//tr[.//input[@id='param_password']]") do
+        first('button').click
+      end
+      assert_selector '.pf-v5-c-helper-text__item',
+        text: /saved, encrypted default/i, wait: 10
+
+      # Typing a new value must replace the placeholder so the task uses
+      # what the user entered instead of the saved default.
+      field.fill_in with: 'override-value'
+      assert_equal 'override-value', field.value.to_s
+    ensure
+      update_foreman_setting('openbolt_password', '')
+    end
+  end
+
+  def test_changing_user_setting_updates_launch_page
+    # Change the setting through the Foreman settings UI
+    update_foreman_setting('openbolt_user', 'newuser')
+
+    # Verify the launch page reflects the change
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+    select_first_proxy
+    assert_selector '#param_user', wait: 10
+    assert_equal 'newuser', find_by_id('param_user').value
+
+    # Restore the original value
+    update_foreman_setting('openbolt_user', 'openbolt')
+  end
+
+  def test_host_key_check_setting_flows_through_to_checkbox_state
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+    select_first_proxy
+
+    # openbolt_host-key-check is a boolean Foreman setting; the
+    # acceptance fixture (rakelib/acceptance.rake) sets it to false so
+    # SSH does not reject the ephemeral target containers. The registered
+    # default in engine.rb is true, so if the Foreman setting lookup
+    # were broken, the checkbox would render checked. Asserting
+    # unchecked here proves the configured value (false) flowed through.
+    field = find_by_id('param_host-key-check', wait: 10)
+    assert_equal 'checkbox', field['type']
+    refute field.checked?,
+      'Expected host-key-check to be unchecked, matching the acceptance fixture value'
+  end
+end

data/test/acceptance/tests/ssh_options_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../acceptance_helper'
+
+# Tests that SSH transport options are correctly passed through to the
+# OpenBolt CLI and affect task execution.
+class SshOptionsTest < AcceptanceTestCase
+  def setup
+    super
+    foreman_login
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+    select_first_proxy
+  end
+
+  def test_default_user_passed_to_bolt
+    select_hosts_via_search('target1')
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::echo', from: 'task-name-input'
+    fill_in 'param_message', with: 'user test'
+    click_button 'Launch Task'
+    assert_selector 'h1', text: 'Task Execution', wait: 15
+
+    assert_task_completed
+    # The default user (from settings) should appear in the bolt command on the Log Output tab
+    assert_log_contains '--user=openbolt'
+  end
+
+  def test_user_override_passed_to_bolt
+    select_hosts_via_search('target1')
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::echo', from: 'task-name-input'
+    fill_in 'param_message', with: 'override test'
+
+    set_openbolt_option('user', 'root')
+    click_button 'Launch Task'
+    assert_selector 'h1', text: 'Task Execution', wait: 15
+
+    # Task may fail because root doesn't have the SSH key, but the
+    # command should show the overridden user
+    assert_selector '.pf-v5-c-label', text: /Success|Failed/i, wait: 120
+    assert_log_contains '--user=root'
+  end
+
+  def test_host_key_check_false_passed_to_bolt
+    select_hosts_via_search('target1')
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::noop_task', from: 'task-name-input'
+
+    # host-key-check is a boolean OpenBolt option and must render as a
+    # checkbox (ParameterField's boolean branch), not a text input.
+    assert_equal 'checkbox', find_by_id('param_host-key-check')['type']
+
+    set_openbolt_option('host-key-check', false)
+    click_button 'Launch Task'
+    assert_selector 'h1', text: 'Task Execution', wait: 15
+
+    assert_task_completed
+    assert_log_contains '--no-host-key-check'
+  end
+
+  def test_verbose_flag_passed_to_bolt
+    select_hosts_via_search('target1')
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::noop_task', from: 'task-name-input'
+
+    # verbose is boolean and must render as a checkbox.
+    assert_equal 'checkbox', find_by_id('param_verbose')['type']
+
+    set_openbolt_option('verbose', true)
+    click_button 'Launch Task'
+    assert_selector 'h1', text: 'Task Execution', wait: 15
+
+    assert_task_completed
+    assert_log_contains '--verbose'
+  end
+end

data/test/acceptance/tests/task_execution_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative '../acceptance_helper'
+
+# Tests for the Task Execution page: URL validation, tab switching, and
+# task metadata display on the Task Details tab.
+class TaskExecutionTest < AcceptanceTestCase
+  def setup
+    super
+    foreman_login
+  end
+
+  def test_execution_page_without_job_id_redirects_to_launch
+    # Visiting the execution URL without a job_id query parameter should
+    # client-side redirect back to the Launch page (TaskExecution/index.js
+    # useEffect with !jobId calls history.push(LAUNCH_TASK)).
+    visit '/foreman_openbolt/page_task_execution'
+    assert_selector 'h1', text: 'Launch OpenBolt Task', wait: 15
+  end
+
+  def test_task_details_tab_shows_task_name_and_submitted_parameters
+    launch_task_via_ui('acceptance::echo',
+      params: { 'message' => 'details tab test' })
+    assert_task_completed
+
+    # Click the "Task Details" tab (second tab in ExecutionDisplay).
+    find('.pf-v5-c-tabs__link', text: 'Task Details').click
+
+    # TaskDetails renders task name in a DescriptionList and the
+    # submitted parameters in a table with aria-label="Task parameters".
+    assert_selector 'dt', text: 'Task Name', wait: 10
+    assert_selector 'dd', text: 'acceptance::echo'
+
+    assert_selector 'table[aria-label="Task parameters"]', wait: 10
+    within 'table[aria-label="Task parameters"]' do
+      assert_selector 'td', text: 'message'
+      assert_selector 'td', text: 'details tab test'
+    end
+  end
+end

data/test/acceptance/tests/task_history_test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative '../acceptance_helper'
+
+# Tests the task history page: listing, navigation, and new entry creation.
+class TaskHistoryTest < AcceptanceTestCase
+  def setup
+    super
+    foreman_login
+  end
+
+  def test_history_shows_completed_tasks_and_navigation
+    # Launch a task to seed history
+    launch_task_via_ui('acceptance::echo', params: { 'message' => 'history test' })
+    assert_task_completed
+
+    # Visit history and verify the entry appears
+    visit '/foreman_openbolt/page_task_history'
+    assert_selector 'h1', text: 'Task History', wait: 15
+    assert_no_selector '[aria-label="Loading task history"]', wait: 15
+    assert_selector 'table[aria-label="Task history table"] tbody tr', minimum: 1
+    # Capture the first row so we can confirm a newer entry lands above it.
+    # History paginates (default 20 rows), so counting rows is unreliable
+    # once history fills the first page.
+    first_row_before = first('table[aria-label="Task history table"] tbody tr').text
+
+    # Navigate to execution details from history
+    first('a[aria-label="View Details"]').click
+    assert_selector 'h1', text: 'Task Execution', wait: 15
+
+    # Launch another task and verify it appears at the top of history.
+    launch_task_via_ui('acceptance::noop_task')
+    assert_task_completed
+
+    visit '/foreman_openbolt/page_task_history'
+    assert_selector 'table[aria-label="Task history table"] tbody tr', minimum: 1, wait: 15
+    first_row_after = first('table[aria-label="Task history table"] tbody tr').text
+    assert_not_equal first_row_before, first_row_after,
+      'Expected newly launched task to appear as the first history row'
+  end
+
+  def test_hosts_popover_lists_targets_from_history_row
+    # 'target' matches both target1 and target2, so the popover count
+    # will be 2.
+    launch_task_via_ui('acceptance::noop_task')
+    assert_task_completed
+
+    visit '/foreman_openbolt/page_task_history'
+    assert_no_selector '[aria-label="Loading task history"]', wait: 15
+    assert_selector 'table[aria-label="Task history table"] tbody tr', minimum: 1, wait: 15
+
+    # The hosts count button has aria-label '<count> target hosts'
+    within first('table[aria-label="Task history table"] tbody tr') do
+      find('button[aria-label$=" target hosts"]').click
+    end
+
+    # Popover content is portaled to document body
+    assert_selector 'table[aria-label="Target hosts"]', wait: 10
+    within 'table[aria-label="Target hosts"]' do
+      assert_selector 'td', text: 'target1'
+      assert_selector 'td', text: 'target2'
+    end
+  end
+
+  def test_task_popover_shows_submitted_parameters_on_history_row
+    launch_task_via_ui('acceptance::echo',
+      params: { 'message' => 'popover history param' })
+    assert_task_completed
+
+    visit '/foreman_openbolt/page_task_history'
+    assert_no_selector '[aria-label="Loading task history"]', wait: 15
+    assert_selector 'table[aria-label="Task history table"] tbody tr', minimum: 1, wait: 15
+
+    # The task name is rendered as a popover trigger whose aria-label is
+    # "View details for task <name>"
+    first('button[aria-label="View details for task acceptance::echo"]').click
+
+    assert_selector 'table[aria-label="Task parameters"]', wait: 10
+    within 'table[aria-label="Task parameters"]' do
+      assert_selector 'td', text: 'message'
+      assert_selector 'td', text: 'popover history param'
+    end
+  end
+end

data/test/acceptance/tests/transport_options_test.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative '../acceptance_helper'
+
+# Tests that the proxy correctly loads and exposes tasks, and that
+# task metadata (parameters) is displayed in the UI.
+class TransportOptionsTest < AcceptanceTestCase
+  def setup
+    super
+    foreman_login
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+    select_first_proxy
+  end
+
+  def test_proxy_selection_populates_task_list
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+  end
+
+  def test_all_fixture_tasks_discoverable
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    options = all('#task-name-input option').map(&:text)
+
+    %w[echo complex_params failing_task noop_task slow_task target_conditional].each do |task|
+      assert options.any?("acceptance::#{task}"),
+        "Expected acceptance::#{task} in task list, got: #{options}"
+    end
+  end
+
+  def test_echo_task_shows_message_param_as_empty_text_input
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::echo', from: 'task-name-input'
+    message = find_by_id('param_message', wait: 10)
+    assert_equal 'text', message['type']
+    assert_equal '', message.value
+  end
+
+  def test_complex_params_task_populates_fields_with_correct_defaults
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::complex_params', from: 'task-name-input'
+
+    # No-default fields render empty.
+    assert_equal '', find_by_id('param_required_string', wait: 10).value
+    assert_equal '', find_by_id('param_array_param').value
+    # with_default has a 'default_value' default in its task metadata;
+    # the launch page must populate it when the task is selected
+    # (handleTaskChange in LaunchTask/index.js).
+    assert_equal 'default_value', find_by_id('param_with_default').value
+  end
+
+  def test_slow_task_shows_seconds_param_with_default_value
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::slow_task', from: 'task-name-input'
+    # slow_task.json declares "default": 5
+    assert_equal '5', find_by_id('param_seconds', wait: 10).value
+  end
+
+  def test_target_conditional_shows_succeed_on_param_as_empty_text_input
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::target_conditional', from: 'task-name-input'
+    succeed_on = find_by_id('param_succeed_on', wait: 10)
+    assert_equal 'text', succeed_on['type']
+    assert_equal '', succeed_on.value
+  end
+
+  def test_switching_tasks_swaps_parameter_fields_and_defaults
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+
+    select 'acceptance::echo', from: 'task-name-input'
+    assert_equal '', find_by_id('param_message', wait: 10).value
+
+    select 'acceptance::slow_task', from: 'task-name-input'
+    assert_no_selector '#param_message', wait: 5
+    # Asserting the seconds default of 5 (not just field presence)
+    # proves the new task's metadata loaded rather than stale state.
+    assert_equal '5', find_by_id('param_seconds', wait: 10).value
+  end
+
+  def test_deselecting_proxy_clears_task_selection_and_parameters
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select 'acceptance::echo', from: 'task-name-input'
+    assert_selector '#param_message', wait: 10
+
+    # Deselect by choosing the placeholder option (value="")
+    select 'Select Smart Proxy', from: 'smart-proxy-input'
+
+    # Task selection and its parameters should be cleared, showing the
+    # "Select a task to see parameters" empty state.
+    assert_no_selector '#param_message', wait: 10
+    assert_selector '.pf-v5-c-empty-state',
+      text: 'Select a task to see parameters', wait: 10
+  end
+
+  def test_transport_option_renders_as_select_with_ssh_winrm_and_choria
+    # The transport OpenBolt option has type ["ssh", "winrm", "choria"]
+    # and ParameterField renders array-typed values as a <select>.
+    field = find_by_id('param_transport', wait: 10)
+    assert_equal 'select', field.tag_name
+    option_values = all('#param_transport option').map(&:value)
+    assert_equal %w[ssh winrm choria], option_values
+    assert_equal 'ssh', field.value
+  end
+
+  def test_switching_transport_to_winrm_hides_ssh_only_options
+    # SSH-only options (private-key, host-key-check) are present on load
+    # because the default transport is ssh.
+    assert_selector '#param_host-key-check', wait: 10
+    assert_selector '#param_private-key', wait: 10
+
+    # Switching transport to winrm should hide options whose metadata
+    # tags them as ssh-only (OpenBoltOptionsSection filters by transport).
+    select 'winrm', from: 'param_transport'
+    assert_no_selector '#param_host-key-check', wait: 10
+    assert_no_selector '#param_private-key', wait: 10
+
+    # Switching back restores them
+    select 'ssh', from: 'param_transport'
+    assert_selector '#param_host-key-check', wait: 10
+    assert_selector '#param_private-key', wait: 10
+  end
+
+  def test_switching_transport_to_choria_hides_ssh_only_options_and_shows_choria_options
+    # SSH-only options are present on load because the default transport is ssh.
+    assert_selector '#param_host-key-check', wait: 10
+    assert_selector '#param_private-key', wait: 10
+    assert_selector '#param_run-as', wait: 10
+    assert_selector '#param_sudo-password', wait: 10
+
+    # Switching transport to choria should hide ssh-only options and reveal
+    # choria-tagged options (OpenBoltOptionsSection filters by transport).
+    select 'choria', from: 'param_transport'
+    assert_no_selector '#param_host-key-check', wait: 10
+    assert_no_selector '#param_private-key', wait: 10
+    assert_no_selector '#param_run-as', wait: 10
+    assert_no_selector '#param_sudo-password', wait: 10
+
+    assert_selector '#param_choria-config-file', wait: 10
+    assert_selector '#param_choria-ssl-ca', wait: 10
+    assert_selector '#param_choria-brokers', wait: 10
+
+    # choria-task-agent must render as a <select> whose options match the
+    # proxy's enum exactly. The launch form gets the enum from the proxy's
+    # option metadata type array, so a drift in the proxy-side enum (or a
+    # mismatch with engine.rb's CHORIA_TASK_AGENTS collection shown on the
+    # Settings page) would only surface at task launch time otherwise.
+    task_agent = find_by_id('param_choria-task-agent', wait: 10)
+    assert_equal 'select', task_agent.tag_name
+    assert_equal %w[bolt_tasks shell], all('#param_choria-task-agent option').map(&:value)
+    assert_equal 'bolt_tasks', task_agent.value
+
+    # Switching back to ssh restores ssh-only options and hides choria-only ones.
+    # Includes the select-type field so a future regression that special-cases
+    # selects in the transport filter would be caught here.
+    select 'ssh', from: 'param_transport'
+    assert_selector '#param_host-key-check', wait: 10
+    assert_selector '#param_private-key', wait: 10
+    assert_no_selector '#param_choria-config-file', wait: 10
+    assert_no_selector '#param_choria-task-agent', wait: 10
+    assert_no_selector '#param_choria-brokers', wait: 10
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'dynflow/testing'
+
+# Load plugin factories and foreman-tasks factories
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'unit', 'factories')
+FactoryBot.definition_file_paths << File.join(ForemanTasks::Engine.root, 'test', 'factories')
+FactoryBot.reload
+
+module ForemanOpenbolt
+  class PluginTestCase < ActiveSupport::TestCase
+    teardown do
+      WebMock.reset!
+    end
+  end
+end