foreman_leapp 4.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b21b7465db5f87cfccd517c018e30bb3aa5f6c7878cbef6e314c981b5c21870
-  data.tar.gz: dd0f2a71a7d5c5858aa3c6336d4d92fafb6ebd3c890404265262491ce2311057
+  metadata.gz: 0b1d949c6e610cc2063defc9a50b0cf522f37fdf6ca8c839a4fb506cffd7460f
+  data.tar.gz: 927658988954a6db9379f26497f27c6bb68253e1f8ccb11dc1061a21169a2ee1
 SHA512:
-  metadata.gz: c6e3d0c62affb53415a88dc5fd5ab55f44a9a3dfa601964a8fdf85bf7264f6a3e41622e63f8a213547197f7f23b5bcb139ed3f034df27ac25e564c915c0a622e
-  data.tar.gz: 021af94cf62a318c7aadace3ed71f8171862f2820a5f7d67dcd800ffc8d52ef0caeb4df53be11a8a7bad4c722db43486095e1f10184234f7c8b84c873a8764da
+  metadata.gz: d93ffcc5320a5339bc97d9a3130bdf3ee0d3b96028d8d883c0895bdeb8abb8ec15dd4593aecbfeedd578027eb85606684f194b5fc19771d2c5c9947d82be87fe
+  data.tar.gz: 9b2e14599a9949e7c5040c71b3eb7d193a1cd88dc29ad388e05a49c8b71cf93a7253484481f7e54584b8002bd2fcb86675018afd9f096b3ac8ffa26adcd3fb5f

data/app/helpers/foreman_leapp/template_helper.rb

@@ -4,11 +4,8 @@ module ForemanLeapp
   module TemplateHelper
     def build_remediation_plan(remediation_ids, host)
       PreupgradeReportEntry.remediation_details(remediation_ids, host)
-                           .map { |e| e['remediations'] }
-                           .flatten
-                           .compact
-                           .select { |r| r['type'] == 'command' }
-                           .map { |r| "#{r['context'].join(' ')}\n" }
+                           .group_by { |_detail, leapp_version| leapp_version }
+                           .map { |leapp_version, pairs| RemediationPlan.build(pairs.map(&:first), leapp_version) }
                            .join
     end
   end

data/app/lib/actions/foreman_leapp/preupgrade_job.rb

@@ -3,6 +3,9 @@
 module Actions
   module ForemanLeapp
     class PreupgradeJob < Actions::EntryAction
+      # The `rpm -q leapp` line of the job output, e.g. leapp-0.21.0-1.el8.noarch
+      LEAPP_NVR = /^leapp-(\d[\d.]*)/.freeze
+
       def self.subscribe
         Actions::RemoteExecution::RunHostJob
       end
@@ -15,9 +18,11 @@ module Actions
 
       def finalize(*_args)
         host = Host.find(input[:host_id])
-        leapp_report = format_output(task.main_action.continuous_output.humanize)
+        job_output = task.main_action.continuous_output.humanize
+        leapp_report = format_output(job_output)
 
-        PreupgradeReport.create_report(host, leapp_report, input[:job_invocation_id])
+        PreupgradeReport.create_report(host, leapp_report, input[:job_invocation_id],
+          leapp_version(job_output))
       end
 
       private
@@ -30,6 +35,12 @@ module Actions
                            .join('')
         JSON.parse(output)
       end
+
+      # The version of the leapp package the report was generated with. It drives
+      # how the remediation commands from the report have to be quoted.
+      def leapp_version(job_output)
+        job_output[LEAPP_NVR, 1]
+      end
     end
   end
 end

data/app/lib/foreman_leapp/remediation_plan.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+
+module ForemanLeapp
+  # Assembles the shell script out of the command remediations found in a leapp report.
+  #
+  # Leapp changed the way remediation commands are quoted. Up to leapp 0.21 the
+  # arguments in the "context" list were already quoted by leapp itself, so they
+  # were meant to be joined verbatim. Starting with leapp 0.22 the arguments are
+  # reported as they are and have to be escaped by the consumer of the report.
+  # See https://github.com/oamg/leapp-repository/pull/1520
+  #
+  # The new quoting is shipped by leapp-upgrade-el<X>toel<Y> 0.25, which is released
+  # together with leapp 0.22, so the version of the leapp package tells the two
+  # formats apart.
+  module RemediationPlan
+    # The first leapp version that reports remediation command arguments unquoted.
+    UNQUOTED_ARGUMENTS_SINCE = Gem::Version.new('0.22')
+
+    class << self
+      def build(detail, leapp_version)
+        quoted = quoted_by_leapp?(leapp_version)
+        Array.wrap(detail)
+             .flat_map { |d| d['remediations'] }
+             .compact
+             .select { |remediation| remediation['type'] == 'command' }
+             .map { |remediation| "#{command_line(remediation['context'], quoted)}\n" }
+             .join
+      end
+
+      def command_line(context, quoted)
+        arguments = Array.wrap(context)
+        return arguments.join(' ') if quoted
+
+        arguments.map { |argument| Shellwords.escape(argument) }.join(' ')
+      end
+
+      # Unknown versions are treated as old leapp, so that reports collected
+      # before the version was recorded keep rendering the way they used to.
+      def quoted_by_leapp?(leapp_version)
+        version = Gem::Version.new(leapp_version.to_s[/\A[0-9][0-9.]*/].to_s.chomp('.'))
+        version < UNQUOTED_ARGUMENTS_SINCE
+      rescue ArgumentError
+        true
+      end
+    end
+  end
+end

data/app/models/preupgrade_report.rb

@@ -6,7 +6,7 @@ class PreupgradeReport < ::Report
 
   scoped_search on: :job_invocation_id, only_explicit: true
 
-  def self.create_report(host, data, job_invocation_id)
+  def self.create_report(host, data, job_invocation_id, leapp_version = nil)
     # We don't have specific permissions for the Preupgrade leapp reports,
     # so we need to skip the permission check for non-admin users.
     # The user is still required to have permission to run the job and view the hosts.
@@ -16,12 +16,12 @@ class PreupgradeReport < ::Report
                                         reported_at: DateTime.now.utc
 
       data['entries']&.each do |entry|
-        PreupgradeReportEntry.create! entry_params(report, entry, host, data)
+        PreupgradeReportEntry.create! entry_params(report, entry, host, data, leapp_version)
       end
     end
   end
 
-  def self.entry_params(report, entry, host, data)
+  def self.entry_params(report, entry, host, data, leapp_version = nil)
     { preupgrade_report: report,
       host_id: host.id,
       hostname: host.name,
@@ -30,6 +30,7 @@ class PreupgradeReport < ::Report
       audience: entry['audience'],
       severity: entry['severity'],
       leapp_run_id: data['leapp_run_id'],
+      leapp_version: leapp_version,
       summary: entry['summary'],
       tags: entry['tags'],
       flags: entry['flags'],

data/app/models/preupgrade_report_entry.rb

@@ -50,8 +50,10 @@ class PreupgradeReportEntry < ApplicationRecord
     ))
   }
 
+  # Returns [detail, leapp_version] pairs. The leapp version is needed because
+  # the quoting of the remediation commands differs between leapp versions.
   def self.remediation_details(remediation_ids, host)
-    where(id: remediation_ids, host: host).where.not(detail: nil).pluck(:detail)
+    where(id: remediation_ids, host: host).where.not(detail: nil).pluck(:detail, :leapp_version)
   end
 
   def self.search_yes_no_fields(key, operator, value)

data/app/views/api/v2/preupgrade_report_entries/base.json.rabl

@@ -1,4 +1,5 @@
 object @preupgrade_report_entry
 
 attributes :id, :detail, :preupgrade_report_id, :host_id, :hostname, :title, :actor, :audience,
-           :severity, :leapp_run_id, :summary, :tags, :flags, :created_at, :updated_at
+           :severity, :leapp_run_id, :leapp_version, :summary, :tags, :flags, :created_at,
+           :updated_at

data/app/views/foreman_leapp/job_templates/leapp_preupgrade.erb

@@ -27,6 +27,8 @@ template_inputs:
 
 <%= render_template 'Check Leapp' %>
 
+rpm -q leapp
+
 rm -f /var/log/leapp/leapp-report.json
 leapp preupgrade <%= options_string %>
 

data/db/migrate/20260825120000_add_leapp_version_to_report_entries.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddLeappVersionToReportEntries < ActiveRecord::Migration[7.0]
+  def change
+    add_column :preupgrade_report_entries, :leapp_version, :string
+  end
+end

data/lib/foreman_leapp/engine.rb

@@ -17,7 +17,7 @@ module ForemanLeapp
     initializer 'foreman_leapp.register_plugin', before: :finisher_hook do |app|
       app.reloader.to_prepare do
         Foreman::Plugin.register :foreman_leapp do
-          requires_foreman '>= 5.0'
+          requires_foreman '>= 5.1'
           register_gettext
 
           apipie_documented_controllers ["#{ForemanLeapp::Engine.root}/app/controllers/api/v2/*.rb"]

data/lib/foreman_leapp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanLeapp
-  VERSION = '4.3.0'
+  VERSION = '5.0.0'
 end

data/package.json

@@ -4,12 +4,7 @@
   "description": "Plugin for RHEL upgrades using Foreman.",
   "main": "index.js",
   "scripts": {
-    "lint": "tfm-lint --plugin -d /webpack",
-    "link-leapp-js": "./script/link_leapp_js.sh",
-    "test": "tfm-test --plugin --config jest.config.js",
-    "test:watch": "tfm-test --plugin --watchAll",
-    "test:current": "tfm-test --plugin --watch",
-    "publish-coverage": "tfm-publish-coverage"
+    "link-leapp-js": "./script/link_leapp_js.sh"
   },
   "repository": {
     "type": "git",
@@ -21,16 +16,8 @@
     "url": "http://projects.theforeman.org/projects/foreman_leapp/issues"
   },
   "homepage": "https://github.com/oamg/foreman_leapp",
-  "peerDependencies": {
-    "@theforeman/vendor": ">= 12.0.1"
-  },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@theforeman/builder": ">= 12.0.1",
-    "@theforeman/eslint-plugin-foreman": ">= 12.0.1",
-    "@theforeman/eslint-plugin-rules": ">= 12.0.1",
-    "@theforeman/test": ">= 12.0.1",
-    "@theforeman/vendor-dev": ">= 12.0.1",
     "babel-eslint": "^10.0.0",
     "eslint": "^6.8.0",
     "prettier": "^1.19.1"

data/test/helpers/template_helper_test.rb

@@ -8,6 +8,17 @@ module ForemanLeapp
     let(:report) { FactoryBot.create(:preupgrade_report, host: host) }
     let(:entry) { FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report) }
 
+    let(:quoting_context) do
+      {
+        remediations: [
+          {
+            type: 'command',
+            context: ['bash', '-c', 'ln -snf "var/log/leapp" "/space space"'],
+          },
+        ],
+      }
+    end
+
     describe 'build_remediation_plan' do
       test 'with remediation commands' do
         template = build_remediation_plan([entry.id], host)
@@ -26,6 +37,40 @@ module ForemanLeapp
         template = build_remediation_plan([entry.id], FactoryBot.create(:host))
         assert_equal template, ''
       end
+
+      test 'joins the arguments verbatim for reports from leapp older than 0.22' do
+        old_entry = FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report,
+          leapp_version: '0.21.0', detail: quoting_context)
+
+        template = build_remediation_plan([old_entry.id], host)
+
+        assert_equal "bash -c ln -snf \"var/log/leapp\" \"/space space\"\n", template
+      end
+
+      test 'escapes the arguments for reports from leapp 0.22 and newer' do
+        new_entry = FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report,
+          leapp_version: '0.22.0', detail: quoting_context)
+
+        template = build_remediation_plan([new_entry.id], host)
+
+        assert_equal ['bash', '-c', 'ln -snf "var/log/leapp" "/space space"'],
+          Shellwords.split(template)
+      end
+
+      test 'quotes every entry according to the leapp version it was reported by' do
+        old_entry = FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report,
+          leapp_version: '0.21.0', detail: quoting_context)
+        new_entry = FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report,
+          leapp_version: '0.22.0', detail: quoting_context)
+
+        lines = build_remediation_plan([old_entry.id, new_entry.id], host).lines
+        verbatim_line = "bash -c ln -snf \"var/log/leapp\" \"/space space\"\n"
+
+        assert_equal 2, lines.size
+        assert_includes lines, verbatim_line
+        assert_equal ['bash', '-c', 'ln -snf "var/log/leapp" "/space space"'],
+          Shellwords.split(lines.find { |line| line != verbatim_line })
+      end
     end
   end
 end

data/test/models/preupgrade_report_entry_test.rb

@@ -20,14 +20,15 @@ class PreupgradeReportEntryTest < ActiveSupport::TestCase
       @host = FactoryBot.create(:host)
 
       report = FactoryBot.create(:preupgrade_report)
-      @entry1 = FactoryBot.create(:preupgrade_report_entry, preupgrade_report: report, host: @host)
+      @entry1 = FactoryBot.create(:preupgrade_report_entry, preupgrade_report: report, host: @host,
+        leapp_version: '0.22.0')
       @entry2 = FactoryBot.create(:preupgrade_report_entry, preupgrade_report: report, host: @host, detail: nil)
     end
 
     it do
       details = PreupgradeReportEntry.remediation_details([@entry1.id, @entry2.id], @host.id)
       assert_equal details.size, 1
-      assert_equal details[0], @entry1.detail
+      assert_equal details[0], [@entry1.detail, '0.22.0']
 
       details = PreupgradeReportEntry.remediation_details([@entry1.id, @entry2.id], FactoryBot.create(:host))
       assert_equal details.size, 0

data/test/models/preupgrade_report_test.rb

@@ -19,6 +19,22 @@ class PreupgradeReportTest < ActiveSupport::TestCase
       end
     end
 
+    it 'stores the leapp version the report was generated with' do
+      data = { 'leapp_run_id' => 'leapp_c13e471c', 'entries' => [sample_entry_1] }
+
+      PreupgradeReport.create_report(host, data, job_invocation, '0.22.0')
+
+      assert_equal ['0.22.0'], PreupgradeReportEntry.where(host: host).pluck(:leapp_version)
+    end
+
+    it 'leaves the leapp version empty when it is not known' do
+      data = { 'leapp_run_id' => 'leapp_c13e471c', 'entries' => [sample_entry_1] }
+
+      PreupgradeReport.create_report(host, data, job_invocation)
+
+      assert_nil PreupgradeReportEntry.where(host: host).first.leapp_version
+    end
+
     it 'no entries' do
       data = { 'leapp_run_id' => 'leapp_c13e471c' }
 

data/test/unit/actions/preupgrade_job_test.rb

@@ -40,4 +40,31 @@ module ForemanLeapp
       it { assert_finalize_phase planned_action }
     end
   end
+
+  # Parsing the job output does not need any of the remote execution setup.
+  class PreupgradeJobOutputTest < ActiveSupport::TestCase
+    include Dynflow::Testing
+
+    let(:action) { create_action(Actions::ForemanLeapp::PreupgradeJob) }
+
+    describe '#leapp_version' do
+      test 'picks the leapp version up from the rpm output' do
+        output = "leapp-0.22.0-1.el9.noarch\n===leap_upgrade_report_start===\n{}\nExit status: 0\n"
+
+        assert_equal '0.22.0', action.send(:leapp_version, output)
+      end
+
+      test 'ignores other leapp packages' do
+        output = "leapp-upgrade-el8toel9-0.25.0-1.el8.noarch\nleapp-0.22.0-1.el8.noarch\n"
+
+        assert_equal '0.22.0', action.send(:leapp_version, output)
+      end
+
+      test 'returns nil when the leapp package is not reported' do
+        output = "package leapp is not installed\n===leap_upgrade_report_start===\n{}\n"
+
+        assert_nil action.send(:leapp_version, output)
+      end
+    end
+  end
 end

data/test/unit/remediation_plan_test.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanLeapp
+  class RemediationPlanTest < ActiveSupport::TestCase
+    # Taken from a leapp <= 0.21 report - leapp quoted the arguments itself.
+    OLD_SYMLINK_CONTEXT = [
+      'sh',
+      '-c',
+      '"ln -snf usr/lib /lib && ln -snf var/log/leapp /space space && ' \
+      'ln -snf var/log/leapp /quote\'quote"',
+    ].freeze
+
+    # The very same remediation as reported by leapp >= 0.22 - the arguments
+    # are reported verbatim. https://github.com/oamg/leapp-repository/pull/1520
+    NEW_SYMLINK_CONTEXT = [
+      'bash',
+      '-c',
+      'ln -snf "usr/lib" "/lib" && ln -snf "var/log/leapp" "/space space" && ' \
+      'ln -snf "var/log/leapp" "/quote\'quote"',
+    ].freeze
+
+    describe '#command_line' do
+      test 'joins the arguments verbatim when leapp did the quoting' do
+        assert_equal OLD_SYMLINK_CONTEXT.join(' '),
+          RemediationPlan.command_line(OLD_SYMLINK_CONTEXT, true)
+      end
+
+      test 'escapes the arguments when leapp reports them verbatim' do
+        line = RemediationPlan.command_line(NEW_SYMLINK_CONTEXT, false)
+
+        assert_equal NEW_SYMLINK_CONTEXT, Shellwords.split(line)
+      end
+
+      test 'escapes shell metacharacters when leapp reports them verbatim' do
+        context = ['sed', '-i', 's/^AllowZoneDrifting=.*/AllowZoneDrifting=no/',
+                   '/etc/firewalld/firewalld.conf']
+
+        line = RemediationPlan.command_line(context, false)
+
+        assert_equal context, Shellwords.split(line)
+        assert_not_includes line, '.*'
+      end
+    end
+
+    describe '#quoted_by_leapp?' do
+      test 'true for leapp older than 0.22' do
+        assert RemediationPlan.quoted_by_leapp?('0.21.0')
+      end
+
+      test 'false for leapp 0.22 and newer' do
+        assert_not RemediationPlan.quoted_by_leapp?('0.22.0')
+        assert_not RemediationPlan.quoted_by_leapp?('0.22')
+      end
+
+      test 'keeps the old quoting when the leapp version is unknown' do
+        [nil, ''].each do |leapp_version|
+          assert RemediationPlan.quoted_by_leapp?(leapp_version)
+        end
+      end
+
+      test 'keeps the old quoting when the leapp version cannot be parsed' do
+        assert RemediationPlan.quoted_by_leapp?('not-a-version')
+      end
+
+      test 'handles a leapp version with a release suffix' do
+        assert_not RemediationPlan.quoted_by_leapp?('0.22.0-1.el9')
+      end
+    end
+
+    describe '#build' do
+      let(:detail) do
+        { 'remediations' => [
+          { 'type' => 'hint', 'context' => 'Set AllowZoneDrifting=no' },
+          { 'type' => 'command', 'context' => %w[vgimportdevices] },
+          { 'type' => 'command', 'context' => NEW_SYMLINK_CONTEXT },
+        ] }
+      end
+
+      test 'renders one line per command remediation and skips the hints' do
+        lines = RemediationPlan.build(detail, '0.22.0').lines
+
+        assert_equal 2, lines.size
+        assert_equal ['vgimportdevices'], Shellwords.split(lines.first)
+        assert_equal NEW_SYMLINK_CONTEXT, Shellwords.split(lines.second)
+      end
+
+      test 'returns an empty plan when there is nothing to run' do
+        assert_equal '', RemediationPlan.build(nil, '0.22.0')
+        assert_equal '',
+          RemediationPlan.build({ 'remediations' => [{ 'type' => 'hint', 'context' => 'meh.' }] },
+            '0.22.0')
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foreman_leapp
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Foreman Leapp team
 bindir: bin
 cert_chain: []
-date: 2026-10-09 00:00:00.000000000 Z
+date: 2026-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman_remote_execution
@@ -61,6 +61,7 @@ files:
 - app/helpers/foreman_leapp/hosts_helper.rb
 - app/helpers/foreman_leapp/template_helper.rb
 - app/lib/actions/foreman_leapp/preupgrade_job.rb
+- app/lib/foreman_leapp/remediation_plan.rb
 - app/lib/helpers/job_helper.rb
 - app/models/concerns/foreman_leapp/job_invocation_extensions.rb
 - app/models/preupgrade_report.rb
@@ -82,6 +83,7 @@ files:
 - db/migrate/20200326142259_add_job_id_to_report.rb
 - db/migrate/20200327091009_add_host_to_report.rb
 - db/migrate/20200429080939_report_entries_flags.rb
+- db/migrate/20260825120000_add_leapp_version_to_report_entries.rb
 - db/seeds.d/10_leapp_preupgrade.rb
 - lib/foreman_leapp.rb
 - lib/foreman_leapp/engine.rb
@@ -115,6 +117,7 @@ files:
 - test/test_plugin_helper.rb
 - test/unit/actions/preupgrade_job_test.rb
 - test/unit/helpers/job_helper_test.rb
+- test/unit/remediation_plan_test.rb
 - webpack/__mocks__/foremanReact/Root/Context/ForemanContext.js
 - webpack/components/PreupgradeReportsTable/PreupgradeReportsTable.scss
 - webpack/components/PreupgradeReportsTable/PreupgradeReportsTableHelpers.js
@@ -157,3 +160,4 @@ test_files:
 - test/test_plugin_helper.rb
 - test/unit/actions/preupgrade_job_test.rb
 - test/unit/helpers/job_helper_test.rb
+- test/unit/remediation_plan_test.rb