foreman_openbolt 1.2.0 → 1.3.0

data/test/unit/lib/proxy_api/openbolt_test.rb

@@ -29,11 +29,11 @@ class ProxyApiOpenboltTest < ForemanOpenbolt::PluginTestCase
       assert_equal tasks, result
     end
 
-    test 'raises on proxy HTTP error' do
+    test 'wraps proxy HTTP errors as ProxyException' do
       stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
         .to_return(status: 500, body: 'Internal Server Error')
 
-      assert_raises(RestClient::InternalServerError) { @api.fetch_tasks }
+      assert_raises(ProxyAPI::ProxyException) { @api.fetch_tasks }
     end
 
     test 'raises ProxyException on unparseable response body' do
@@ -159,16 +159,131 @@ class ProxyApiOpenboltTest < ForemanOpenbolt::PluginTestCase
   end
 
   context 'connection errors' do
-    test 'raises on timeout' do
+    test 'wraps timeouts as ProxyException' do
       stub_request(:get, "#{PROXY_URL}/openbolt/tasks").to_timeout
 
-      assert_raises(RestClient::Exceptions::OpenTimeout) { @api.fetch_tasks }
+      assert_raises(ProxyAPI::ProxyException) { @api.fetch_tasks }
     end
 
-    test 'raises on connection refused' do
+    test 'wraps connection refused as ProxyException' do
       stub_request(:get, "#{PROXY_URL}/openbolt/tasks").to_raise(Errno::ECONNREFUSED)
 
-      assert_raises(Errno::ECONNREFUSED) { @api.fetch_tasks }
+      assert_raises(ProxyAPI::ProxyException) { @api.fetch_tasks }
+    end
+
+    test 'wraps SocketError as ProxyException' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks").to_raise(SocketError.new('host not found'))
+
+      assert_raises(ProxyAPI::ProxyException) { @api.fetch_tasks }
+    end
+
+    test 'wraps SSL errors as ProxyException' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
+        .to_raise(OpenSSL::SSL::SSLError.new('bad cert'))
+
+      assert_raises(ProxyAPI::ProxyException) { @api.fetch_tasks }
+    end
+  end
+
+  # The proxy reports domain errors as HTTP 200 with {"error": {"message":
+  # ...}}. ProxyReportedError makes those loud everywhere except launch_task,
+  # which passes the envelope through so the caller renders a 400.
+  context 'proxy-reported errors (200 + error envelope)' do
+    error_body = { 'error' => { 'message' => 'Job not found: bogus' } }.to_json
+
+    test 'fetch_tasks raises ProxyReportedError' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      error = assert_raises(ProxyAPI::Openbolt::ProxyReportedError) { @api.fetch_tasks }
+      assert_match(/Job not found: bogus/, error.message)
+    end
+
+    test 'reload_tasks raises ProxyReportedError' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks/reload")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      assert_raises(ProxyAPI::Openbolt::ProxyReportedError) { @api.reload_tasks }
+    end
+
+    test 'openbolt_options raises ProxyReportedError' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks/options")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      assert_raises(ProxyAPI::Openbolt::ProxyReportedError) { @api.openbolt_options }
+    end
+
+    test 'job_status raises ProxyReportedError' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/job/test-123/status")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      assert_raises(ProxyAPI::Openbolt::ProxyReportedError) { @api.job_status(job_id: 'test-123') }
+    end
+
+    test 'job_result raises ProxyReportedError' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/job/test-123/result")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      assert_raises(ProxyAPI::Openbolt::ProxyReportedError) { @api.job_result(job_id: 'test-123') }
+    end
+
+    test 'delete_job_artifacts raises ProxyReportedError' do
+      stub_request(:delete, "#{PROXY_URL}/openbolt/job/test-123/artifacts")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      assert_raises(ProxyAPI::Openbolt::ProxyReportedError) { @api.delete_job_artifacts(job_id: 'test-123') }
+    end
+
+    test 'launch_task returns the error envelope unchanged' do
+      stub_request(:post, "#{PROXY_URL}/openbolt/launch/task")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      result = @api.launch_task(name: 'bogus', targets: 'host1', parameters: {}, options: {})
+      assert_equal('Job not found: bogus', result['error']['message'])
+    end
+
+    test 'launch_task still wraps transport errors' do
+      stub_request(:post, "#{PROXY_URL}/openbolt/launch/task").to_timeout
+
+      assert_raises(ProxyAPI::ProxyException) do
+        @api.launch_task(name: 'mymod::install', targets: 'host1', parameters: {}, options: {})
+      end
+    end
+
+    test 'ProxyReportedError is a ProxyException so existing rescue_from chains catch it' do
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
+        .to_return(status: 200, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      assert_raises(ProxyAPI::ProxyException) { @api.fetch_tasks }
+    end
+
+    test 'a task named error does not raise ProxyReportedError' do
+      tasks = {
+        'error' => { 'description' => 'Raise an error on the target' },
+        'mymod::install' => { 'description' => 'Install a package' },
+      }
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
+        .to_return(status: 200, body: tasks.to_json, headers: { 'Content-Type' => 'application/json' })
+
+      assert_equal tasks, @api.fetch_tasks
+    end
+
+    test 'top-level error key with a string value is not treated as an envelope' do
+      body = { 'error' => 'Plain string error' }
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
+        .to_return(status: 200, body: body.to_json,
+          headers: { 'Content-Type' => 'application/json' })
+
+      assert_equal body, @api.fetch_tasks
+    end
+
+    test 'error hash without a message key is not treated as an envelope' do
+      body = { 'error' => { 'code' => 42 } }
+      stub_request(:get, "#{PROXY_URL}/openbolt/tasks")
+        .to_return(status: 200, body: body.to_json,
+          headers: { 'Content-Type' => 'application/json' })
+
+      assert_equal body, @api.fetch_tasks
     end
   end
 end

data/test/unit/models/task_job_test.rb

@@ -200,6 +200,17 @@ class TaskJobTest < ForemanOpenbolt::PluginTestCase
       end
       assert_equal({ 'items' => [] }, job.reload.result)
     end
+
+    test 'cleanup_proxy_artifacts schedules Dynflow action when log is saved without result' do
+      job = FactoryBot.create(:task_job, status: 'success', completed_at: Time.current)
+      ForemanTasks.expects(:async_task).with(
+        ::Actions::ForemanOpenbolt::CleanupProxyArtifacts,
+        job.smart_proxy_id,
+        job.job_id
+      )
+
+      job.update!(log: 'task finished')
+    end
   end
 
   context 'create_from_execution!' do

data/webpack/src/Components/LaunchTask/__tests__/LaunchTask.test.js

@@ -4,7 +4,7 @@ import { Provider } from 'react-redux';
 import { createStore } from 'redux';
 import { MemoryRouter } from 'react-router-dom';
 import { API } from 'foremanReact/redux/API';
-import LaunchTask from '../index';
+import LaunchTask, { buildLaunchPayload } from '../index';
 
 // Mock HostSelector to avoid Apollo/GraphQL dependency chain
 jest.mock('../HostSelector', () => {
@@ -81,3 +81,46 @@ describe('LaunchTask', () => {
     });
   });
 });
+
+describe('buildLaunchPayload', () => {
+  test('passes "parameters" key through correctly', () => {
+    const body = buildLaunchPayload({
+      proxyId: 1,
+      taskName: 'mymod::install',
+      targets: ['host1.example.com'],
+      parameters: { name: 'nginx', version: '1.21' },
+      options: { transport: 'ssh' },
+    });
+
+    expect(body).toHaveProperty('parameters', {
+      name: 'nginx',
+      version: '1.21',
+    });
+  });
+
+  test('joins targets with comma into a single string', () => {
+    const body = buildLaunchPayload({
+      proxyId: 1,
+      taskName: 'mymod::install',
+      targets: ['host1', 'host2', 'host3'],
+      parameters: {},
+      options: {},
+    });
+
+    expect(body.targets).toBe('host1,host2,host3');
+  });
+
+  test('forwards smart_proxy_id, task_name, and options unchanged', () => {
+    const body = buildLaunchPayload({
+      proxyId: 42,
+      taskName: 'puppet_conf::set',
+      targets: ['host1'],
+      parameters: {},
+      options: { transport: 'choria', 'run-as': 'root' },
+    });
+
+    expect(body.smart_proxy_id).toBe(42);
+    expect(body.task_name).toBe('puppet_conf::set');
+    expect(body.options).toEqual({ transport: 'choria', 'run-as': 'root' });
+  });
+});

data/webpack/src/Components/LaunchTask/hooks/__tests__/useOpenBoltOptions.test.js

@@ -42,6 +42,9 @@ describe('useOpenBoltOptions', () => {
       await result.current.fetchOpenBoltOptions(42);
     });
 
+    expect(API.get).toHaveBeenCalledWith(
+      expect.stringContaining('smart_proxy_id=42')
+    );
     expect(result.current.openBoltOptionsMetadata).toEqual(options);
     expect(result.current.openBoltOptions).toEqual({
       transport: 'ssh',

data/webpack/src/Components/LaunchTask/hooks/__tests__/useTasksData.test.js

@@ -42,14 +42,14 @@ describe('useTasksData', () => {
       expect.stringContaining('fetch_tasks')
     );
     expect(API.get).toHaveBeenCalledWith(
-      expect.stringContaining('proxy_id=42')
+      expect.stringContaining('smart_proxy_id=42')
     );
     expect(result.current.taskMetadata).toEqual(tasks);
     expect(result.current.isLoadingTasks).toBe(false);
   });
 
-  test('fetchTasks uses reload endpoint when forceReload is true', async () => {
-    API.get.mockResolvedValue({ data: {} });
+  test('fetchTasks uses POST to the reload endpoint when forceReload is true', async () => {
+    API.post.mockResolvedValue({ data: {} });
 
     const { result } = renderHook(() => useTasksData(), { wrapper });
 
@@ -57,9 +57,10 @@ describe('useTasksData', () => {
       await result.current.fetchTasks(42, true);
     });
 
-    expect(API.get).toHaveBeenCalledWith(
+    expect(API.post).toHaveBeenCalledWith(
       expect.stringContaining('reload_tasks')
     );
+    expect(API.get).not.toHaveBeenCalled();
   });
 
   test('fetchTasks resets state before fetching', async () => {

data/webpack/src/Components/LaunchTask/hooks/useOpenBoltOptions.js

@@ -21,7 +21,7 @@ export const useOpenBoltOptions = () => {
 
       try {
         const { data } = await API.get(
-          `${ROUTES.API.FETCH_OPENBOLT_OPTIONS}?proxy_id=${proxyId}`
+          `${ROUTES.API.FETCH_OPENBOLT_OPTIONS}?smart_proxy_id=${proxyId}`
         );
 
         setOpenBoltOptionsMetadata(data || {});

data/webpack/src/Components/LaunchTask/hooks/useTasksData.js

@@ -24,7 +24,10 @@ export const useTasksData = () => {
         const endpoint = forceReload
           ? ROUTES.API.RELOAD_TASKS
           : ROUTES.API.FETCH_TASKS;
-        const { data } = await API.get(`${endpoint}?proxy_id=${proxyId}`);
+        const method = forceReload ? 'post' : 'get';
+        const { data } = await API[method](
+          `${endpoint}?smart_proxy_id=${proxyId}`
+        );
 
         setTaskMetadata(data || {});
 

data/webpack/src/Components/LaunchTask/index.js

@@ -29,6 +29,21 @@ import { useTasksData } from './hooks/useTasksData';
 import { useOpenBoltOptions } from './hooks/useOpenBoltOptions';
 import { useShowMessage, extractErrorMessage } from '../common/helpers';
 
+// Exported so tests can use the launch wire format
+export const buildLaunchPayload = ({
+  proxyId,
+  taskName,
+  targets,
+  parameters,
+  options,
+}) => ({
+  smart_proxy_id: proxyId,
+  task_name: taskName,
+  targets: targets.join(','),
+  parameters,
+  options,
+});
+
 const LaunchTask = () => {
   const history = useHistory();
   const showMessage = useShowMessage();
@@ -165,13 +180,13 @@ const LaunchTask = () => {
           }
         );
 
-        const body = {
-          proxy_id: selectedProxy,
-          task_name: selectedTask,
-          targets: targets.join(','),
-          params: taskParameters,
+        const body = buildLaunchPayload({
+          proxyId: selectedProxy,
+          taskName: selectedTask,
+          targets,
+          parameters: taskParameters,
           options: visibleOptions,
-        };
+        });
 
         const { data } = await API.post(ROUTES.API.LAUNCH_TASK, body);
 

data/webpack/src/Components/TaskExecution/__tests__/TaskExecution.test.js

@@ -53,7 +53,7 @@ describe('TaskExecution', () => {
   test('strips ANSI codes from log output when result is available', async () => {
     const statusData = {
       status: 'success',
-      task_name: 'test::task',
+      name: 'test::task',
       targets: ['host1'],
       submitted_at: '2026-01-01T00:00:00Z',
       completed_at: '2026-01-01T00:01:00Z',

data/webpack/src/Components/TaskExecution/hooks/__tests__/useJobPolling.test.js

@@ -22,9 +22,9 @@ describe('useJobPolling', () => {
       status: 'success',
       submitted_at: '2026-01-01T00:00:00Z',
       completed_at: '2026-01-01T00:01:00Z',
-      task_name: 'test::task',
-      task_description: 'A test task',
-      task_parameters: { name: 'nginx' },
+      name: 'test::task',
+      description: 'A test task',
+      parameters: { name: 'nginx' },
       targets: ['host1.example.com'],
       smart_proxy: { id: 1, name: 'proxy1' },
     };
@@ -60,7 +60,7 @@ describe('useJobPolling', () => {
   test('does not fetch result for INVALID status', async () => {
     const statusData = {
       status: 'invalid',
-      task_name: 'broken::task',
+      name: 'broken::task',
       targets: [],
     };
 
@@ -96,7 +96,7 @@ describe('useJobPolling', () => {
   test('handles result fetch failure gracefully', async () => {
     const statusData = {
       status: 'success',
-      task_name: 'test::task',
+      name: 'test::task',
       targets: [],
     };
 
@@ -119,7 +119,7 @@ describe('useJobPolling', () => {
   test('cancels polling on unmount', async () => {
     const statusData = {
       status: 'running',
-      task_name: 'long::task',
+      name: 'long::task',
       targets: [],
     };
     API.get.mockResolvedValue({ data: statusData });
@@ -145,12 +145,12 @@ describe('useJobPolling', () => {
   test('loads metadata only once across multiple polls', async () => {
     API.get
       .mockResolvedValueOnce({
-        data: { status: 'running', task_name: 'my::task', targets: ['host1'] },
+        data: { status: 'running', name: 'my::task', targets: ['host1'] },
       })
       .mockResolvedValueOnce({
         data: {
           status: 'success',
-          task_name: 'changed::name',
+          name: 'changed::name',
           targets: ['host2'],
         },
       })

data/webpack/src/Components/TaskExecution/hooks/useJobPolling.js

@@ -55,9 +55,9 @@ const useJobPolling = jobId => {
           // Task metadata only needs to be set once since it never changes
           if (!metadataLoaded.current) {
             setSubmittedAt(statusData.submitted_at || null);
-            setTaskName(statusData.task_name || null);
-            setTaskDescription(statusData.task_description || null);
-            setTaskParameters(statusData.task_parameters || {});
+            setTaskName(statusData.name || null);
+            setTaskDescription(statusData.description || null);
+            setTaskParameters(statusData.parameters || {});
             setTargets(statusData.targets || []);
             setSmartProxy(statusData.smart_proxy || null);
             metadataLoaded.current = true;

data/webpack/src/Components/TaskHistory/__tests__/TaskHistory.test.js

@@ -18,9 +18,9 @@ afterEach(() => {
 const sampleJobs = [
   {
     job_id: 'job-1',
-    task_name: 'mymod::install',
-    task_description: 'Install a package',
-    task_parameters: { name: 'nginx' },
+    name: 'mymod::install',
+    description: 'Install a package',
+    parameters: { name: 'nginx' },
     status: 'success',
     targets: ['host1.example.com'],
     submitted_at: '2026-01-15T10:00:00Z',
@@ -29,9 +29,9 @@ const sampleJobs = [
   },
   {
     job_id: 'job-2',
-    task_name: 'mymod::mytask',
-    task_description: 'Restart a service',
-    task_parameters: {},
+    name: 'mymod::mytask',
+    description: 'Restart a service',
+    parameters: {},
     status: 'running',
     targets: ['host2.example.com'],
     submitted_at: '2026-01-15T11:00:00Z',

data/webpack/src/Components/TaskHistory/index.js

@@ -138,9 +138,9 @@ const TaskHistory = () => {
             <Tr key={job.job_id}>
               <Td hasRightBorder>
                 <TaskPopover
-                  taskName={job.task_name}
-                  taskDescription={job.task_description}
-                  taskParameters={job.task_parameters}
+                  taskName={job.name}
+                  taskDescription={job.description}
+                  taskParameters={job.parameters}
                 />
               </Td>
               <Td hasRightBorder>{getStatusLabel(job.status)}</Td>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_openbolt
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Overlook InfraTech
@@ -18,7 +18,7 @@ dependencies:
         version: 11.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: 11.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
 description: This plugin adds OpenBolt integration into Foreman, allowing users to
   run tasks and plans present in their environment.
 email:
@@ -40,6 +40,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/api/v2/openbolt_jobs_controller.rb
+- app/controllers/api/v2/openbolt_tasks_controller.rb
+- app/controllers/concerns/foreman_openbolt/common.rb
+- app/controllers/concerns/foreman_openbolt/jobs.rb
+- app/controllers/concerns/foreman_openbolt/tasks.rb
 - app/controllers/foreman_openbolt/task_controller.rb
 - app/lib/actions/foreman_openbolt/cleanup_proxy_artifacts.rb
 - app/lib/actions/foreman_openbolt/poll_task_status.rb
@@ -49,6 +54,7 @@ files:
 - db/migrate/20250819000000_create_openbolt_task_jobs.rb
 - db/migrate/20250925000000_add_command_to_openbolt_task_jobs.rb
 - db/migrate/20251001000000_add_task_description_to_task_jobs.rb
+- db/migrate/20260824000000_remove_view_smart_proxies_openbolt_permission.rb
 - db/seeds.d/001_add_openbolt_feature.rb
 - lib/foreman_openbolt.rb
 - lib/foreman_openbolt/engine.rb
@@ -61,6 +67,7 @@ files:
 - locale/gemspec.rb
 - package.json
 - test/acceptance/acceptance_helper.rb
+- test/acceptance/api_acceptance_helper.rb
 - test/acceptance/docker/docker-compose.yml
 - test/acceptance/docker/foreman/Dockerfile
 - test/acceptance/docker/foreman/entrypoint.sh
@@ -79,6 +86,10 @@ files:
 - test/acceptance/fixtures/modules/acceptance/tasks/target_conditional.json
 - test/acceptance/fixtures/modules/acceptance/tasks/target_conditional.sh
 - test/acceptance/fixtures/openbolt.yml
+- test/acceptance/tests/api/authn_authz_test.rb
+- test/acceptance/tests/api/jobs_test.rb
+- test/acceptance/tests/api/launch_test.rb
+- test/acceptance/tests/api/proxy_tasks_test.rb
 - test/acceptance/tests/error_handling_test.rb
 - test/acceptance/tests/host_selector_test.rb
 - test/acceptance/tests/launch_task_test.rb
@@ -89,6 +100,8 @@ files:
 - test/acceptance/tests/task_history_test.rb
 - test/acceptance/tests/transport_options_test.rb
 - test/test_plugin_helper.rb
+- test/unit/controllers/api/v2/openbolt_jobs_controller_test.rb
+- test/unit/controllers/api/v2/openbolt_tasks_controller_test.rb
 - test/unit/controllers/task_controller_test.rb
 - test/unit/docker/Dockerfile
 - test/unit/docker/docker-compose.yml
@@ -180,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Foreman OpenBolt integration
 test_files: []