foreman_openbolt 1.0.0 → 1.1.1

data/app/lib/actions/foreman_openbolt/poll_task_status.rb

@@ -6,10 +6,8 @@
 module Actions
   module ForemanOpenbolt
     class PollTaskStatus < Actions::EntryAction
-      include Actions::RecurringAction
-
       POLL_INTERVAL = 5.seconds
-      RETRY_LIMIT = 60 # Number of retries before giving up (5 minutes)
+      RETRY_LIMIT = 60 # 5 minutes at 5-second intervals
 
       # Set up the action when it is first scheduled, storing
       # IDs needed to get information from the proxy.
@@ -24,52 +22,54 @@ module Actions
         if event.nil? || event.to_sym == :poll
           poll_and_reschedule
         else
-          error("Received unknown event '#{event}' for OpenBolt job #{input[:job_id]}. Finishing the action.")
+          log("Received unknown event '#{event}' for OpenBolt job #{input[:job_id]}", :error)
           finish
         end
       end
 
-      def finalize
-        Rails.logger.info("Finalized polling for OpenBolt job #{input[:job_id]}")
+      def log(msg, level = :debug)
+        output[:log] ||= []
+        output[:log] << "[#{Time.now.getlocal.strftime('%Y-%m-%d %H:%M:%S')}] [#{level.upcase}] #{msg}"
+        Rails.logger.send(level, msg)
       end
 
-      private
-
-      def append_output(key, message)
-        output[key] ||= []
-        output[key] << message
+      def exception(msg, e)
+        log("#{msg}: #{e.class}: #{e.message}", :error)
+        log(e.backtrace.join("\n"), :error) if e.backtrace
       end
 
-      def log(message)
-        append_output(:log, "[#{Time.now.getlocal.strftime('%Y-%m-%d %H:%M:%S')}] #{message}")
+      def finish
+        log("Polling finished for OpenBolt job #{input[:job_id]}")
       end
 
-      def error(message)
-        append_output(:error, message)
-      end
+      def extract_proxy_error(response)
+        error_value = response&.dig('error')
+        return nil if error_value.nil? || (error_value.respond_to?(:empty?) && error_value.empty?)
 
-      def exception(e)
-        append_output(:exception, e.message)
-        append_output(:exception_backtrace, e.backtrace.join("\n"))
-      end
-
-      def finish
-        log("Polling finished for OpenBolt job #{input[:job_id]}")
+        error_value.is_a?(Hash) ? error_value['message'] || error_value.to_s : error_value.to_s
       end
 
       def poll_and_reschedule
         job_id = input[:job_id]
+        task_job = ::ForemanOpenbolt::TaskJob.find_by(job_id: job_id)
 
-        # If task doesn't exist or is already complete, finish
-        if task_job.nil? || task_job.completed?
+        if task_job.nil?
+          log("TaskJob record not found for job #{job_id}", :error)
+          finish
+          return
+        end
+
+        if task_job.completed?
           finish
           return
         end
 
         # If the smart proxy has been deleted somehow or is unknown,
         # we can't poll for status, so finish.
-        if proxy.nil?
-          error("Smart Proxy with ID #{input[:proxy_id]} not found for OpenBolt job #{job_id}. Finishing the action.")
+        proxy = ::SmartProxy.find_by(id: input[:proxy_id])
+        unless proxy
+          log("Smart Proxy with ID #{input[:proxy_id]} not found for OpenBolt job #{job_id}", :error)
+          task_job.update!(status: 'exception')
           finish
           return
         end
@@ -80,24 +80,42 @@ module Actions
           # Fetch current status
           status_result = api.job_status(job_id: job_id)
 
-          # Update status if changed
-          if status_result && status_result['status']
-            input[:retry_count] = 0
-            task_job.update!(status: status_result['status'])
-            log("Status: #{status_result['status']}")
-
-            # If completed, fetch full results
-            if task_job.completed?
-              result = api.job_result(job_id: job_id)
-              if result
-                task_job.update_from_proxy_result!(result)
-                log("OpenBolt job #{job_id} completed with status '#{task_job.status}'")
-              else
-                log("WARNING: No result returned from proxy for completed OpenBolt job #{job_id}")
-              end
-              finish
-              return
+          proxy_error = extract_proxy_error(status_result)
+          if proxy_error
+            log("Proxy returned error for job #{job_id}: #{proxy_error}", :error)
+            task_job.update!(status: 'exception')
+            finish
+            return
+          end
+
+          unless status_result&.dig('status')
+            log("Proxy returned response without status for job #{job_id}: #{status_result.inspect}", :error)
+            task_job.update!(status: 'exception')
+            finish
+            return
+          end
+
+          input[:retry_count] = 0
+          new_status = status_result['status']
+          if new_status == task_job.status
+            log("Poll for OpenBolt job #{job_id}: status=#{new_status}")
+          else
+            previous_status = task_job.status
+            task_job.update!(status: new_status)
+            log("OpenBolt job #{job_id} status changed from '#{previous_status}' to '#{new_status}'", :info)
+          end
+
+          # If completed, fetch full results
+          if task_job.completed?
+            result = api.job_result(job_id: job_id)
+            if result.present?
+              task_job.update_from_proxy_result!(result)
+              log("OpenBolt job #{job_id} completed with status '#{task_job.status}'", :info)
+            else
+              log("No result returned from proxy for completed OpenBolt job #{job_id}", :error)
             end
+            finish
+            return
           end
 
           # Still running, schedule next poll in 5 seconds
@@ -105,14 +123,14 @@ module Actions
             world.clock.ping(suspended_action, POLL_INTERVAL.from_now.to_time, :poll)
           end
         rescue StandardError => e
-          error("Error polling task status for job #{job_id}")
-          exception(e)
+          exception("Error polling task status for job #{job_id}", e)
 
           retry_count = (input[:retry_count] || 0) + 1
           input[:retry_count] = retry_count
 
           if retry_count > RETRY_LIMIT
-            error("Could not successfully poll task status for job #{job_id} after #{retry_count} attempts. Giving up.")
+            log("Polling gave up for job #{job_id} after #{retry_count} attempts", :error)
+            task_job.update!(status: 'exception')
             finish
             return
           end
@@ -132,19 +150,11 @@ module Actions
       end
 
       def humanized_input
-        input.slice(:job_id, :proxy_id).merge(
-          # Using & to handle possible nil values just in case
-          proxy_name: proxy&.name,
-          task_name: task_job&.task_name
-        )
-      end
-
-      def task_job
-        @task_job ||= ::ForemanOpenbolt::TaskJob.find_by(job_id: input[:job_id])
-      end
-
-      def proxy
-        @proxy ||= ::SmartProxy.find_by(id: input[:proxy_id])
+        proxy_name = ::SmartProxy.find_by(id: input[:proxy_id])&.name || '(unknown)'
+        task_name = ::ForemanOpenbolt::TaskJob.find_by(job_id: input[:job_id])&.task_name
+        parts = ["job #{input[:job_id]} on #{proxy_name}"]
+        parts << "task: #{task_name}" if task_name
+        parts.join(', ')
       end
     end
   end

data/app/models/foreman_openbolt/task_job.rb

@@ -18,7 +18,6 @@ module ForemanOpenbolt
     validates :job_id, presence: true, uniqueness: true
     validates :status, inclusion: { in: STATUSES }
     validates :targets, presence: true
-    validates :submitted_at, presence: true
 
     # Scopes
     scope :running, -> { where(status: RUNNING_STATUSES) }
@@ -27,7 +26,6 @@ module ForemanOpenbolt
     scope :for_proxy, ->(proxy) { where(smart_proxy: proxy) }
 
     # Callbacks
-    before_validation :set_submitted_at, on: :create
     before_update :set_completed_at, if: :status_changed_to_completed?
     after_update :cleanup_proxy_artifacts, if: :saved_result_and_log?
 
@@ -41,8 +39,8 @@ module ForemanOpenbolt
         targets: targets,
         task_parameters: parameters,
         openbolt_options: options,
-        status: 'pending'
-        # submitted_at is set by callback
+        status: 'pending',
+        submitted_at: Time.current
       )
     end
 
@@ -61,7 +59,10 @@ module ForemanOpenbolt
 
     # Result/log will already be scrubbed by the proxy
     def update_from_proxy_result!(proxy_result)
-      return if proxy_result.blank?
+      if proxy_result.blank?
+        Rails.logger.warn("Received blank proxy result for job #{job_id}, skipping update")
+        return
+      end
 
       transaction do
         self.status = proxy_result['status'] if proxy_result['status'].present?
@@ -80,12 +81,6 @@ module ForemanOpenbolt
       targets&.join(', ') || ''
     end
 
-    private
-
-    def set_submitted_at
-      self.submitted_at ||= Time.current
-    end
-
     def set_completed_at
       self.completed_at ||= Time.current if completed?
     end
@@ -98,13 +93,17 @@ module ForemanOpenbolt
       saved_change_to_result? || saved_change_to_log?
     end
 
+    # Schedule cleanup of proxy artifacts if we have successfully saved the results
     def cleanup_proxy_artifacts
-      return unless result.present? && log.present?
-      # Schedule cleanup of proxy artifacts if we have successfully saved the results
-      # ForemanTasks.async_task(::Actions::ForemanOpenbolt::CleanupProxyArtifacts,
-      #   smart_proxy_id,
-      #   job_id)
-      # Rails.logger.info("Scheduled cleanup for job #{job_id} on proxy #{smart_proxy_id}")
+      return unless completed?
+
+      ForemanTasks.async_task(::Actions::ForemanOpenbolt::CleanupProxyArtifacts,
+        smart_proxy_id,
+        job_id)
+      Rails.logger.debug { "Scheduled cleanup for job #{job_id} on proxy #{smart_proxy_id}" }
+    rescue StandardError => e
+      Rails.logger.error("Failed to schedule cleanup for job #{job_id}: #{e.class}: #{e.message}")
+      Rails.logger.error(e.backtrace.join("\n")) if e.backtrace
     end
   end
 end

data/config/routes.rb

@@ -16,7 +16,6 @@ ForemanOpenbolt::Engine.routes.draw do
 
   # Task job management endpoints
   get 'fetch_task_history', to: 'task#fetch_task_history'
-  get 'fetch_task_history/:id', to: 'task#show', as: :task_job
 end
 
 Foreman::Application.routes.draw do

data/lib/foreman_openbolt/engine.rb

@@ -15,7 +15,7 @@ module ForemanOpenbolt
     initializer 'foreman_openbolt.register_plugin', before: :finisher_hook do |app|
       app.reloader.to_prepare do
         Foreman::Plugin.register :foreman_openbolt do
-          requires_foreman '>= 3.14.0'
+          requires_foreman '>= 3.17.0'
           register_gettext
 
           settings do
@@ -33,15 +33,15 @@ module ForemanOpenbolt
 
               # rubocop:disable Lint/ConstantDefinitionInBlock
               TRANSPORTS = {
-                'ssh': N_('SSH'),
-                'winrm': N_('WinRM'),
+                ssh: N_('SSH'),
+                winrm: N_('WinRM'),
               }.freeze
               LOG_LEVELS = {
-                'error': N_('Error'),
-                'warning': N_('Warning'),
-                'info': N_('Info'),
-                'debug': N_('Debug'),
-                'trace': N_('Trace'),
+                error: N_('Error'),
+                warning: N_('Warning'),
+                info: N_('Info'),
+                debug: N_('Debug'),
+                trace: N_('Trace'),
               }.freeze
               # rubocop:enable Lint/ConstantDefinitionInBlock
 
@@ -62,7 +62,7 @@ module ForemanOpenbolt
                 default: false,
                 full_name: N_('Verbose'),
                 description: N_(
-                  'Run the OpenBolt command with the --verbose flag. This prints additional information ' +
+                  'Run the OpenBolt command with the --verbose flag. This prints additional information ' \
                   'during OpenBolt execution and will print any out::verbose plan statements.'
                 )
               setting 'openbolt_noop',
@@ -98,7 +98,7 @@ module ForemanOpenbolt
                 default: '',
                 full_name: N_('SSH Private Key'),
                 description: N_(
-                  'Path on the smart proxy host to the private key used for SSH authentication. This key must be ' +
+                  'Path on the smart proxy host to the private key used for SSH authentication. This key must be ' \
                   'readable by the foreman-proxy user.'
                 )
               setting 'openbolt_run-as',
@@ -106,7 +106,7 @@ module ForemanOpenbolt
                 default: '',
                 full_name: N_('SSH Run As User'),
                 description: N_(
-                  'The user to run commands as on the target host. This requires that the user specified ' +
+                  'The user to run commands as on the target host. This requires that the user specified ' \
                   'in the "user" option has permission to run commands as this user.'
                 )
               setting 'openbolt_sudo-password',

data/lib/foreman_openbolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanOpenbolt
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

data/lib/proxy_api/openbolt.rb

@@ -6,11 +6,11 @@ module ProxyAPI
   class Openbolt < Resource
     def initialize(args)
       @url = args[:url]
-      super args
+      super
     end
 
     def fetch_tasks
-      @tasks = JSON.parse(get('/openbolt/tasks').body)
+      @tasks = parse_response(get('/openbolt/tasks'), 'fetch_tasks')
     end
 
     def tasks
@@ -18,7 +18,7 @@ module ProxyAPI
     end
 
     def reload_tasks
-      @tasks = JSON.parse(get('/openbolt/tasks/reload').body)
+      @tasks = parse_response(get('/openbolt/tasks/reload'), 'reload_tasks')
     end
 
     def task_names
@@ -26,28 +26,44 @@ module ProxyAPI
     end
 
     def openbolt_options
-      @openbolt_options ||= JSON.parse(get('/openbolt/tasks/options').body)
+      @openbolt_options ||= parse_response(get('/openbolt/tasks/options'), 'openbolt_options')
     end
 
     def launch_task(name:, targets:, parameters: {}, options: {})
-      JSON.parse(post({
+      response = post({
         name: name,
         targets: targets,
         parameters: parameters,
         options: options,
-      }.to_json, '/openbolt/launch/task').body)
+      }.to_json, '/openbolt/launch/task')
+      parse_response(response, 'launch_task')
     end
 
     def job_status(job_id:)
-      JSON.parse(get("/openbolt/job/#{job_id}/status").body)
+      parse_response(get("/openbolt/job/#{job_id}/status"), 'job_status')
     end
 
     def job_result(job_id:)
-      JSON.parse(get("/openbolt/job/#{job_id}/result").body)
+      parse_response(get("/openbolt/job/#{job_id}/result"), 'job_result')
     end
 
     def delete_job_artifacts(job_id:)
-      JSON.parse(delete("/openbolt/job/#{job_id}/artifacts").body)
+      parse_response(delete("/openbolt/job/#{job_id}/artifacts"), 'delete_job_artifacts')
+    end
+
+    def parse_response(response, operation)
+      raise ProxyException.new(@url, nil, "No response from Smart Proxy during #{operation}") unless response
+
+      body = response.body
+      raise ProxyException.new(@url, nil, "Empty response body from Smart Proxy during #{operation}") if body.nil?
+
+      JSON.parse(body)
+    rescue JSON::ParserError => e
+      raise ProxyException.new(
+        @url, nil,
+        "Invalid JSON from Smart Proxy during #{operation}: #{e.message}. " \
+        "Response body (first 500 chars): #{body.to_s[0..500]}"
+      )
     end
   end
 end

data/lib/tasks/foreman_openbolt_tasks.rake

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'rake/testtask'
-
-# Tasks
 namespace :openbolt do
   desc 'Refresh smart proxy features to detect OpenBolt feature'
   task refresh_proxies: :environment do
@@ -20,7 +17,7 @@ namespace :openbolt do
       end
     end
 
-    if proxies.count.zero?
+    if proxies.none?
       puts "No smart proxies found"
     else
       openbolt_count = proxies.with_features('OpenBolt').count
@@ -28,21 +25,3 @@ namespace :openbolt do
     end
   end
 end
-
-# Tests
-namespace :test do
-  desc 'Test ForemanOpenbolt'
-  Rake::TestTask.new(:foreman_openbolt) do |t|
-    test_dir = File.expand_path('../../test', __dir__)
-    t.libs << 'test'
-    t.libs << test_dir
-    t.pattern = "#{test_dir}/**/*_test.rb"
-    t.verbose = true
-    t.warning = false
-  end
-end
-
-Rake::Task[:test].enhance ['test:foreman_openbolt']
-
-load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_openbolt', 'foreman_openbolt:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

data/locale/gemspec.rb

@@ -2,6 +2,6 @@
 
 # Matches foreman_openbolt.gemspec
 _(
-  'This plugin adds OpenBolt integration into Foreman, allowing users to run tasks ' +
+  'This plugin adds OpenBolt integration into Foreman, allowing users to run tasks ' \
   'present in their environment.'
 )

data/package.json

@@ -1,15 +1,13 @@
 {
   "name": "foreman_openbolt",
-  "version": "0.1.1",
+  "version": "1.1.1",
   "description": "OpenBolt integration into Foreman",
   "main": "index.js",
   "scripts": {
     "lint": "tfm-lint --plugin -d /webpack",
     "test": "tfm-test --config jest.config.js",
     "test:watch": "tfm-test --plugin --watchAll",
-    "test:current": "tfm-test --plugin --watch",
-    "publish-coverage": "tfm-publish-coverage",
-    "create-react-component": "yo react-domain"
+    "test:current": "tfm-test --plugin --watch"
   },
   "repository": {
     "type": "git",
@@ -19,23 +17,21 @@
     "url": "http://projects.theforeman.org/projects/foreman_openbolt/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": ">= 6.0.0"
+    "@theforeman/vendor": ">= 15.0.1"
   },
   "dependencies": {
     "react-intl": "^2.8.0"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@sheerun/mutationobserver-shim": "^0.3.3",
-    "@theforeman/builder": ">= 6.0.0",
-    "@theforeman/eslint-plugin-foreman": "6.0.0",
-    "@theforeman/find-foreman": "^4.8.0",
-    "@theforeman/test": "^8.0.0",
-    "@theforeman/vendor-dev": "^6.0.0",
+    "@testing-library/react": "^10.4.9",
+    "@testing-library/react-hooks": "^3.7.0",
+    "@theforeman/builder": ">= 15.0.1",
+    "@theforeman/eslint-plugin-foreman": ">= 15.0.1",
+    "@theforeman/test": ">= 15.0.1",
+    "@theforeman/vendor-dev": ">= 15.0.1",
     "babel-eslint": "^10.0.3",
-    "eslint": "^6.7.2",
-    "prettier": "^1.19.1",
-    "stylelint-config-standard": "^18.0.0",
-    "stylelint": "^9.3.0"
+    "eslint": "^6.8.0",
+    "prettier": "^1.19.1"
   }
 }

data/test/acceptance/acceptance_helper.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'capybara'
+require 'capybara/dsl'
+require 'selenium-webdriver'
+require 'test/unit'
+
+# Base class for acceptance tests using Capybara + Selenium Chrome.
+# Connects to Foreman through a remote ChromeDriver container and
+# exercises the plugin UI as a real user would.
+class AcceptanceTestCase < Test::Unit::TestCase
+  include Capybara::DSL
+
+  # Chrome runs in a separate container and reaches Foreman via the Docker
+  # network service name. The test runner connects to ChromeDriver via the
+  # exposed port 4444 on the host.
+  FOREMAN_URL = ENV.fetch('FOREMAN_URL', 'https://foreman')
+  FOREMAN_USER = ENV.fetch('FOREMAN_USER', 'admin')
+  FOREMAN_PASS = ENV.fetch('FOREMAN_PASS', 'changeme')
+  CHROMEDRIVER_URL = ENV.fetch('CHROMEDRIVER_URL', 'http://localhost:4444')
+
+  def setup
+    Capybara.app_host = FOREMAN_URL
+    Capybara.run_server = false
+    Capybara.default_max_wait_time = 15
+
+    Capybara.register_driver :remote_chrome do |app|
+      options = Selenium::WebDriver::Chrome::Options.new
+      options.add_argument('--headless') unless ENV['HEADFUL']
+      options.add_argument('--no-sandbox')
+      options.add_argument('--disable-dev-shm-usage')
+      options.add_argument('--disable-gpu')
+      options.add_argument('--window-size=1280,720')
+      options.add_argument('--ignore-certificate-errors')
+
+      Capybara::Selenium::Driver.new(
+        app,
+        browser: :remote,
+        url: CHROMEDRIVER_URL,
+        options: options
+      )
+    end
+
+    Capybara.default_driver = :remote_chrome
+    Capybara.javascript_driver = :remote_chrome
+  end
+
+  def teardown
+    visit '/users/logout'
+    Capybara.reset_sessions!
+  end
+
+  def foreman_login(user: FOREMAN_USER, password: FOREMAN_PASS)
+    visit '/users/login'
+    fill_in 'login_login', with: user
+    fill_in 'login_password', with: password
+    click_button 'Log In'
+  end
+
+  # --- Launch page helpers ---
+
+  def select_first_proxy
+    assert_selector '#smart-proxy-input option', minimum: 2, wait: 15
+    proxy_option = first('#smart-proxy-input option:not([value=""])')
+    select proxy_option.text, from: 'smart-proxy-input'
+  end
+
+  def select_hosts_via_search(query)
+    find('[aria-label="Select host targeting method"]').click
+    find('[data-ouia-component-id="host_methods"]').find('li', text: 'Search query').click
+    search_input = find('.foreman-search-field input[type="text"]', wait: 10)
+    search_input.fill_in with: query
+  end
+
+  def launch_task_via_ui(task_name, targets: 'target', params: {})
+    visit '/foreman_openbolt/page_launch_task'
+    assert_selector '#smart-proxy-input', wait: 15
+
+    select_first_proxy
+    select_hosts_via_search(targets)
+
+    assert_selector '#task-name-input option', minimum: 2, wait: 15
+    select task_name, from: 'task-name-input'
+
+    params.each do |name, value|
+      assert_selector "#param_#{name}", wait: 10
+      fill_in "param_#{name}", with: value
+    end
+
+    click_button 'Launch Task'
+    assert_selector 'h1', text: 'Task Execution', wait: 15
+  end
+
+  def assert_task_completed
+    assert_selector '.pf-v5-c-label', text: /Success|Complete/i, wait: 120
+  end
+
+  def assert_task_failed
+    assert_selector '.pf-v5-c-label', text: /Failed|Failure|Error/i, wait: 120
+  end
+
+  def assert_result_contains(text)
+    assert_selector '.pf-v5-c-code-block__code', text: text, wait: 15
+  end
+
+  def assert_result_has_content
+    assert_no_selector '.pf-v5-c-empty-state', text: 'No result data', wait: 15
+    assert_selector '.pf-v5-c-code-block__code', wait: 15
+  end
+
+  def assert_log_contains(text)
+    # Click the "Log Output" tab to see the bolt command and log
+    find('.pf-v5-c-tabs__link', text: 'Log Output').click
+    assert_selector '.pf-v5-c-code-block__code', text: text, wait: 15
+  end
+
+  # OpenBolt options and task parameters both use param_ prefix for field IDs
+  def set_openbolt_option(name, value)
+    field = find("#param_#{name}", wait: 10)
+    if field.tag_name == 'select'
+      field.select value
+    elsif field['type'] == 'checkbox'
+      value ? field.check : field.uncheck
+    else
+      field.fill_in with: value
+    end
+  end
+
+  # --- Settings page helpers ---
+
+  # Update a Foreman setting through the /settings UI. Each setting row
+  # has an inline edit button with id=<setting_name> that reveals an
+  # input with id=setting-input-<setting_name> and a submit button with
+  # ouiaId=submit-edit-btn (see Foreman's SettingValueCell /
+  # SettingValueEdit components).
+  def update_foreman_setting(setting_name, new_value, category: 'openbolt')
+    visit '/settings'
+    find("a[href='##{category}_settings_tab']", wait: 10).click
+
+    within("##{category}_settings_tab", wait: 10) do
+      find("button##{setting_name}", wait: 10).click
+      find("#setting-input-#{setting_name}", wait: 10).fill_in with: new_value
+      find("[data-ouia-component-id='submit-edit-btn']").click
+    end
+  end
+end