foreman_openbolt 0.0.1

data/config/routes.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+ForemanOpenbolt::Engine.routes.draw do
+  # React-rendered pages
+  get 'page_launch_task', to: 'task#page_launch_task', as: :page_launch_task
+  get 'page_task_execution', to: 'task#page_task_execution', as: :page_task_execution
+  get 'page_task_history', to: 'task#page_task_history', as: :page_task_history
+
+  # API endpoints
+  get 'fetch_tasks', to: 'task#fetch_tasks'
+  get 'reload_tasks', to: 'task#reload_tasks'
+  get 'fetch_openbolt_options', to: 'task#fetch_openbolt_options'
+  post 'launch_task', to: 'task#launch_task'
+  get 'job_status', to: 'task#job_status'
+  get 'job_result', to: 'task#job_result'
+
+  # 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
+  mount ForemanOpenbolt::Engine, at: '/foreman_openbolt'
+end

data/db/migrate/20250819000000_create_openbolt_task_jobs.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class CreateOpenboltTaskJobs < ActiveRecord::Migration[6.1]
+  def change
+    create_table :openbolt_task_jobs, id: false do |t|
+      t.string :job_id, null: false, primary_key: true
+      t.references :smart_proxy, null: false, foreign_key: true, index: true
+      t.string :task_name, null: false
+      t.string :status, null: false, default: 'pending'
+
+      # JSON columns for complex data
+      t.jsonb :targets, default: []
+      t.jsonb :task_parameters, default: {}
+      t.jsonb :openbolt_options, default: {}
+      t.jsonb :result
+
+      t.text :log
+
+      t.datetime :submitted_at, null: false, index: true
+      t.datetime :completed_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250925000000_add_command_to_openbolt_task_jobs.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddCommandToOpenboltTaskJobs < ActiveRecord::Migration[6.1]
+  def change
+    add_column :openbolt_task_jobs, :command, :string
+  end
+end

data/db/migrate/20251001000000_add_task_description_to_task_jobs.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddTaskDescriptionToTaskJobs < ActiveRecord::Migration[6.1]
+  def change
+    add_column :openbolt_task_jobs, :task_description, :text
+  end
+end

data/db/seeds.d/001_add_openbolt_feature.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+f = Feature.where(name: 'OpenBolt').first_or_create
+raise "Unable to create OpenBolt proxy feature: #{format_errors f}" if f.nil? || f.errors.any?

data/lib/foreman_openbolt/engine.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module ForemanOpenbolt
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanOpenbolt
+    engine_name 'foreman_openbolt'
+
+    # Add any db migrations
+    initializer 'foreman_openbolt.load_app_instance_data' do |app|
+      ForemanOpenbolt::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    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'
+          register_gettext
+
+          settings do
+            category :openbolt, N_('OpenBolt') do
+              # The setting name should be prefixed by 'openbolt_' and otherwise exactly
+              # match the OpenBolt option name defined in main.rb of smart_proxy_openbolt.
+              # At some point, we should figure out the best way to deduplicate this definition
+              # here and in the smart proxy.
+              # The proxy needs the information for validation and a custom field to tell
+              # the UI which settings apply to which transports, which we can't embed here
+              # easily. And the Foreman Settings UI needs these defined here on plugin load.
+              # Maybe the proxy can just hold a map of settings to transports and pull the
+              # settings from here. However, we'll need to figure out the best way of doing
+              # Proxy -> Foreman communication with the variety of auth methods people use.
+
+              # rubocop:disable Lint/ConstantDefinitionInBlock
+              TRANSPORTS = {
+                'ssh': N_('SSH'),
+                'winrm': N_('WinRM'),
+              }.freeze
+              LOG_LEVELS = {
+                'error': N_('Error'),
+                'warning': N_('Warning'),
+                'info': N_('Info'),
+                'debug': N_('Debug'),
+                'trace': N_('Trace'),
+              }.freeze
+              # rubocop:enable Lint/ConstantDefinitionInBlock
+
+              setting 'openbolt_transport',
+                type: :string,
+                default: 'ssh',
+                full_name: N_('Transport'),
+                description: N_('The transport method to use for connecting to target hosts'),
+                collection: proc { TRANSPORTS }
+              setting 'openbolt_log-level',
+                type: :string,
+                default: 'debug',
+                full_name: N_('Log Level'),
+                description: N_('Set the log level during OpenBolt execution'),
+                collection: proc { LOG_LEVELS }
+              setting 'openbolt_verbose',
+                type: :boolean,
+                default: false,
+                full_name: N_('Verbose'),
+                description: N_(
+                  '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',
+                type: :boolean,
+                default: false,
+                full_name: N_('No Operation'),
+                description: N_(
+                  'Run the OpenBolt command with the --noop flag, which will make no changes to the target host'
+                )
+              setting 'openbolt_tmpdir',
+                type: :string,
+                default: '',
+                full_name: N_('Temporary Directory'),
+                description: N_('Directory to use for temporary files on target hosts during OpenBolt execution')
+              setting 'openbolt_user',
+                type: :string,
+                default: '',
+                full_name: N_('User'),
+                description: N_('Username used for SSH or WinRM authentication')
+              setting 'openbolt_password',
+                type: :string,
+                default: '',
+                full_name: N_('Password'),
+                description: N_('Password used for SSH or WinRM authentication'),
+                encrypted: true
+              setting 'openbolt_host-key-check',
+                type: :boolean,
+                default: true,
+                full_name: N_('SSH Host Key Check'),
+                description: N_('Whether to perform host key verification when connecting to targets over SSH')
+              setting 'openbolt_private-key',
+                type: :string,
+                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 ' +
+                  'readable by the foreman-proxy user.'
+                )
+              setting 'openbolt_run-as',
+                type: :string,
+                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 ' +
+                  'in the "user" option has permission to run commands as this user.'
+                )
+              setting 'openbolt_sudo-password',
+                type: :string,
+                default: '',
+                full_name: N_('SSH Sudo Password'),
+                description: N_('Password used for privilege escalation when using SSH'),
+                encrypted: true
+              setting 'openbolt_ssl',
+                type: :boolean,
+                default: true,
+                full_name: N_('WinRM SSL'),
+                description: N_('Use SSL when connecting to hosts via WinRM')
+              setting 'openbolt_ssl-verify',
+                type: :boolean,
+                default: true,
+                full_name: N_('WinRM SSL Verify'),
+                description: N_('Verify remote host SSL certificate when connecting to hosts via WinRM')
+            end
+          end
+
+          # Right now, this is really only pulling in routes. But leaving
+          # it as a general global JS file for future expansion.
+          register_global_js_file 'global'
+
+          security_block :foreman_openbolt do
+            permission :execute_openbolt,
+              { :'foreman_openbolt/task' => [
+                :page_launch_task, :page_task_execution, :page_task_history,
+                :fetch_tasks, :reload_tasks, :fetch_openbolt_options,
+                :launch_task, :job_status, :job_result, :fetch_task_history, :show
+              ] }
+            permission :view_smart_proxies_openbolt, :smart_proxies => [:index, :show], :resource_type => 'SmartProxy'
+          end
+
+          role 'OpenBolt Executor', [:execute_openbolt]
+          add_all_permissions_to_default_roles
+
+          sub_menu :top_menu, :openbolt,
+            icon: 'fa fa-bolt',
+            caption: N_('OpenBolt'),
+            after: :hosts_menu do
+            menu :top_menu, :page_launch_task,
+              caption: N_('Launch Task'),
+              engine: ForemanOpenbolt::Engine
+            menu :top_menu, :page_task_history,
+              caption: N_('Task History'),
+              engine: ForemanOpenbolt::Engine
+          end
+        end
+      end
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanOpenbolt::Engine.load_seed
+      end
+    end
+  end
+end

data/lib/foreman_openbolt/version.rb

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

data/lib/foreman_openbolt.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'foreman-tasks'
+require 'foreman_openbolt/engine'
+
+module ForemanOpenbolt
+end

data/lib/proxy_api/openbolt.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ProxyAPI
+  class Openbolt < Resource
+    def initialize(args)
+      @url = args[:url]
+      super args
+    end
+
+    def fetch_tasks
+      @tasks = JSON.parse(get('/openbolt/tasks').body)
+    end
+
+    def tasks
+      @tasks ||= fetch_tasks
+    end
+
+    def reload_tasks
+      @tasks = JSON.parse(get('/openbolt/tasks/reload').body)
+    end
+
+    def task_names
+      tasks.keys
+    end
+
+    def openbolt_options
+      @openbolt_options ||= JSON.parse(get('/openbolt/tasks/options').body)
+    end
+
+    def launch_task(name:, targets:, parameters: {}, options: {})
+      JSON.parse(post({
+        name: name,
+        targets: targets,
+        parameters: parameters,
+        options: options,
+      }.to_json, '/openbolt/launch/task').body)
+    end
+
+    def job_status(job_id:)
+      JSON.parse(get("/openbolt/job/#{job_id}/status").body)
+    end
+
+    def job_result(job_id:)
+      JSON.parse(get("/openbolt/job/#{job_id}/result").body)
+    end
+
+    def delete_job_artifacts(job_id:)
+      JSON.parse(delete("/openbolt/job/#{job_id}/artifacts").body)
+    end
+  end
+end

data/lib/tasks/foreman_openbolt_tasks.rake

@@ -0,0 +1,48 @@
+# 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
+    puts "Refreshing smart proxies to detect OpenBolt feature"
+    proxies = SmartProxy.unscoped
+    proxies.each do |proxy|
+      print "Refreshing #{proxy.name}... "
+      begin
+        proxy.refresh
+        proxy.reload
+        has_feature = proxy.features.map(&:name).include?('OpenBolt')
+        puts has_feature ? 'OpenBolt FOUND' : 'OpenBolt NOT FOUND'
+      rescue StandardError => e
+        puts "FAILED: #{e.message}"
+      end
+    end
+
+    if proxies.count.zero?
+      puts "No smart proxies found"
+    else
+      openbolt_count = proxies.with_features('OpenBolt').count
+      puts "Total proxies with OpenBolt: #{openbolt_count}/#{proxies.count}"
+    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/Makefile

@@ -0,0 +1,73 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).name')
+VERSION = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+JSFILES = $(shell find ../app/assets/javascripts/*/locale -name '$(DOMAIN).js')
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+%.edit.po: %.po.time_stamp
+	touch $@
+
+# gettext will trash the .edit.po file if the time stamp doesn't exist or is older than the po file
+%.po.time_stamp: %.po
+	touch --reference $< $@
+
+# Prevent make from treating this as an intermediate file to be cleaned up
+.PRECIOUS: %.po.time_stamp
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	# Initialize new languages
+	cd .. && tx pull -f --all --minimum-perc 50
+	# Force update all existing languages
+	cd .. && tx pull -f --minimum-perc 0
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation
+	@echo then run rake plugin:po_to_json[$(DOMAIN)] from the Foreman installation
+	@echo then run make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) $(JSFILES) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_openbolt.po

@@ -0,0 +1,19 @@
+# foreman_openbolt
+#
+# This file is distributed under the same license as foreman_openbolt.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+

data/locale/foreman_openbolt.pot

@@ -0,0 +1,19 @@
+# foreman_openbolt
+#
+# This file is distributed under the same license as foreman_openbolt.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Matches foreman_openbolt.gemspec
+_(
+  'This plugin adds OpenBolt integration into Foreman, allowing users to run tasks ' +
+  'present in their environment.'
+)

data/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "foreman_openbolt",
+  "version": "0.0.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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theforeman/foreman_openbolt.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_openbolt/issues"
+  },
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 6.0.0"
+  },
+  "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",
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.7.2",
+    "prettier": "^1.19.1",
+    "stylelint-config-standard": "^18.0.0",
+    "stylelint": "^9.3.0"
+  }
+}

data/test/factories/foreman_openbolt_factories.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :host do
+    name 'foreman_openbolt'
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.reload

data/test/unit/foreman_openbolt_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class ForemanOpenboltTest < ActiveSupport::TestCase
+  setup do
+    User.current = User.find_by login: 'admin'
+  end
+
+  test 'the truth' do
+    assert true
+  end
+end

data/webpack/global_index.js

@@ -0,0 +1,4 @@
+import { registerRoutes } from 'foremanReact/routes/RoutingService';
+import Routes from './src/Router/routes';
+
+registerRoutes('ForemanOpenbolt', Routes);

data/webpack/global_test_setup.js

@@ -0,0 +1,11 @@
+// runs before each test to make sure console.error output will
+// fail a test (i.e. default PropType missing). Check the error
+// output and traceback for actual error.
+global.console.error = (error, stack) => {
+  /* eslint-disable-next-line no-console */
+  if (stack) console.log(stack); // Prints out original stack trace
+  throw new Error(error);
+};
+
+// Increase jest timeout as some tests using multiple http mocks can time out on CI systems.
+jest.setTimeout(10000);

data/webpack/index.js

@@ -0,0 +1,19 @@
+import componentRegistry from 'foremanReact/components/componentRegistry';
+
+import LaunchTask from './src/Components/LaunchTask';
+import TaskExecution from './src/Components/TaskExecution';
+
+const components = [
+  {
+    name: 'LaunchTask',
+    type: LaunchTask,
+  },
+  {
+    name: 'TaskExecution',
+    type: TaskExecution,
+  },
+];
+
+components.forEach(component => {
+  componentRegistry.register(component);
+});

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

@@ -0,0 +1,24 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import {
+  EmptyState,
+  EmptyStateIcon,
+  EmptyStateHeader,
+} from '@patternfly/react-core';
+import { InfoCircleIcon } from '@patternfly/react-icons';
+
+const EmptyContent = ({ title }) => (
+  <EmptyState>
+    <EmptyStateHeader
+      titleText={title}
+      icon={<EmptyStateIcon icon={InfoCircleIcon} />}
+      headingLevel="h4"
+    />
+  </EmptyState>
+);
+
+EmptyContent.propTypes = {
+  title: PropTypes.string.isRequired,
+};
+
+export default EmptyContent;