foreman_leapp 0.0.2

data/locale/foreman_leapp.pot

@@ -0,0 +1,19 @@
+# foreman_leapp
+#
+# This file is distributed under the same license as foreman_leapp.
+#
+#, 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,4 @@
+# frozen_string_literal: true
+
+# Matches foreman_leapp.gemspec
+_('A foreman plugin to support inplace RHEL 7 -> RHEL 8 upgrades with Leapp utility.')

data/test/factories/foreman_leapp_factories.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :preupgrade_report do
+    host
+    reported_at { Time.now.utc }
+    type { 'PreupgradeReport' }
+    status { '0' }
+  end
+
+  factory :preupgrade_report_entry do
+    host
+    preupgrade_report
+    sequence(:title) { |n| "Leap report entry title #{n}" }
+    sequence(:actor) { |n| "leapp_actor#{n}" }
+    hostname { host.name }
+    audience { 'sys_admin' }
+    severity { 'medium' }
+    leapp_run_id { SecureRandom.hex(8) }
+    tags { %w[tag1 tag2] }
+    summary { '' }
+    detail do
+      { remediations: [{ type: 'hint', context: 'meh.' },
+                       { type: 'command', context: ['yum', '-y', 'remove', 'leapp_pkg'] }] }
+    end
+  end
+end

data/test/functional/api/v2/preupgrade_reports_controller_test.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module Api
+  module V2
+    class PreupgradeReportsControllerTest < ActionController::TestCase
+      setup do
+        @host = FactoryBot.create(:host)
+        @report = FactoryBot.create(:preupgrade_report, host: @host)
+        @entry = FactoryBot.create(:preupgrade_report_entry, host: @host, preupgrade_report: @report)
+      end
+
+      test 'should get index' do
+        get :index, session: set_session_user
+        assert_response :success
+        assert_not_empty ActiveSupport::JSON.decode(@response.body)['results']
+      end
+
+      test 'should get detail of report and its entries' do
+        get :show, params: { id: @report.id }
+        assert_response :success
+
+        response = ActiveSupport::JSON.decode(@response.body)
+        assert_equal response['id'], @report.id
+        assert_not_empty response['preupgrade_report_entries']
+      end
+    end
+  end
+end

data/test/functional/preupgrade_reports_controller_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class PreupgradeReportsControllerTest < ActionController::TestCase
+  setup do
+    @host = FactoryBot.create :host
+    FactoryBot.create :preupgrade_report, host: @host
+  end
+
+  test 'should get index' do
+    get :index, session: set_session_user
+    response = ActiveSupport::JSON.decode(@response.body)
+    assert_equal @host.id, response['results'].first['host_id']
+  end
+end

data/test/helpers/template_helper_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanLeapp
+  class TemplateHelperTest < ActionView::TestCase
+    let(:host) { FactoryBot.create(:host) }
+    let(:report) { FactoryBot.create(:preupgrade_report, host: host) }
+    let(:entry) { FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report) }
+
+    describe 'build_remediation_plan' do
+      test 'with remediation commands' do
+        template = build_remediation_plan([entry.id], host)
+        assert_equal template, "yum -y remove leapp_pkg\n"
+      end
+
+      test 'without remediation commands' do
+        empty_entry = FactoryBot.create(:preupgrade_report_entry, host: host, preupgrade_report: report,
+                                                                  detail: { remediations: [{ type: 'hint',
+                                                                                             context: 'meh.' }] })
+        template = build_remediation_plan([empty_entry.id], host)
+        assert_equal template, ''
+      end
+
+      test 'only for current host' do
+        template = build_remediation_plan([entry.id], FactoryBot.create(:host))
+        assert_equal template, ''
+      end
+    end
+  end
+end

data/test/models/preupgrade_report_entry_test.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class PreupgradeReportEntryTest < ActiveSupport::TestCase
+  should belong_to(:preupgrade_report)
+  should belong_to(:host)
+
+  should validate_presence_of(:preupgrade_report)
+  should validate_presence_of(:host)
+  should validate_presence_of(:hostname)
+  should validate_presence_of(:title)
+  should validate_presence_of(:actor)
+  should validate_presence_of(:audience)
+  should validate_presence_of(:severity)
+  should validate_presence_of(:leapp_run_id)
+
+  describe 'remediation_details' do
+    setup do
+      @host = FactoryBot.create(:host)
+
+      report = FactoryBot.create(:preupgrade_report)
+      @entry1 = FactoryBot.create(:preupgrade_report_entry, preupgrade_report: report, host: @host)
+      @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
+
+      details = PreupgradeReportEntry.remediation_details([@entry1.id, @entry2.id], FactoryBot.create(:host))
+      assert_equal details.size, 0
+    end
+  end
+end

data/test/models/preupgrade_report_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class PreupgradeReportTest < ActiveSupport::TestCase
+  should belong_to(:job_invocation)
+  should have_many(:preupgrade_report_entries).dependent(:destroy)
+
+  describe '#create_report' do
+    let(:job_invocation) { FactoryBot.create(:job_invocation) }
+    let(:host) { FactoryBot.create(:host) }
+
+    it 'with commands and hints' do
+      data = { 'leapp_run_id' => 'leapp_c13e471c',
+               'entries' => [sample_entry_1, sample_entry_2] }
+
+      assert_difference -> { PreupgradeReport.count } => 1, -> { PreupgradeReportEntry.count } => 2 do
+        PreupgradeReport.create_report(host, data, job_invocation)
+      end
+    end
+
+    it 'no entries' do
+      data = { 'leapp_run_id' => 'leapp_c13e471c' }
+
+      assert_difference -> { PreupgradeReport.count } => 1, -> { PreupgradeReportEntry.count } => 0 do
+        PreupgradeReport.create_report(host, data, job_invocation)
+      end
+    end
+  end
+
+  def sample_entry_1
+    { 'severity' => 'low', 'title' => 'SElinux will be set to permissive mode',
+      'tags' => %w[selinux security], 'actor' => 'check_se_linux',
+      'summary' => 'sum', 'audience' => 'sysadmin', 'id' => 'id1' }
+  end
+
+  def sample_entry_2
+    { 'severity' => 'high', 'tags' => ['kernel'], 'title' => 'Multiple devel kernels installed',
+      'detail' => { 'remediations' => [
+        { 'type' => 'hint', 'context' => 'Some context' },
+        { 'type' => 'command', 'context' => ['yum', '-y', 'remove', 'kernel-devel-3.10.0.1127.el7'] }
+      ] },
+      'actor' => 'check_installed_devel_kernels', 'summary' => 'Sum', 'audience' => 'sysadmin',
+      'flags' => ['inhibitor'], 'id' => 'id2' }
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+require 'dynflow/testing'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryBot.definition_file_paths << "#{ForemanTasks::Engine.root}/test/factories"
+FactoryBot.definition_file_paths << "#{ForemanRemoteExecution::Engine.root}/test/factories"
+FactoryBot.reload

data/test/unit/actions/preupgrade_job_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanLeapp
+  class PreupgradeJobTest < ActiveSupport::TestCase
+    include Dynflow::Testing
+
+    let(:host) { FactoryBot.create(:host) }
+    let(:job_template) do
+      FactoryBot.create(:job_template, template: 'echo "1"', job_category: 'leapp',
+                                       provider_type: 'SSH', name: 'Leapp preupgrade')
+    end
+    let(:job_invocation) { FactoryBot.create(:job_invocation, job_category: ::ForemanLeapp::JOB_CATEGORY) }
+    let(:template_invocation) do
+      FactoryBot.create(:template_invocation, template: job_template, job_invocation: job_invocation)
+    end
+
+    let(:action) { create_action(Actions::ForemanLeapp::PreupgradeJob) }
+    let(:planned_action) { plan_action(action, job_invocation, host, template_invocation) }
+
+    setup do
+      RemoteExecutionFeature.find_by(label: 'leapp_preupgrade').update(job_template: job_template)
+    end
+
+    describe 'plan' do
+      test 'run plan phase' do
+        assert_equal planned_action.input['host_id'], host.id
+        assert_equal planned_action.input['job_invocation_id'], job_invocation.id
+      end
+    end
+
+    describe '#format_output' do
+      let(:output) { "first_line\n===leap_upgrade_report_start===\n{\n\"report\": \"yes!\"\n}\nExit status: 0\n" }
+
+      it { assert action.send(:format_output, output), '{"report": "yes!"}' }
+    end
+
+    describe 'finalize' do
+      it { assert_finalize_phase planned_action }
+    end
+  end
+end

data/test/unit/helpers/job_helper_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module Helpers
+  class JobHelperTest < ActionView::TestCase
+    let(:helper) { ::Helpers::JobHelper }
+    # let(:host) { FactoryBot.create(:host) }
+    let(:job_template) do
+      FactoryBot.create(:job_template, template: 'echo "1"', job_category: 'leapp',
+                                       provider_type: 'SSH', name: 'Leapp preupgrade')
+    end
+    let(:job_invocation) { FactoryBot.create(:job_invocation, job_category: ::ForemanLeapp::JOB_CATEGORY) }
+
+    describe 'correct_feature?' do
+      setup do
+        RemoteExecutionFeature.find_by(label: 'leapp_preupgrade').update(job_template: job_template)
+        FactoryBot.create(:template_invocation, template: job_template, job_invocation: job_invocation)
+      end
+
+      it 'correct category & feature' do
+        assert helper.correct_feature?(job_invocation, 'leapp_preupgrade')
+      end
+
+      it 'wrong category' do
+        job_invocation = FactoryBot.create(:job_invocation, job_category: 'NOPE')
+        FactoryBot.create(:template_invocation, template: job_template, job_invocation: job_invocation)
+
+        assert_not helper.correct_feature?(job_invocation, 'leapp_preupgrade')
+      end
+
+      it 'wrong feature' do
+        assert_not helper.correct_feature?(job_invocation, 'leapp_preupgrade2')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: foreman_leapp
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Foreman Leapp team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foreman_remote_execution
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+description: A Foreman plugin to support inplace RHEL 7 -> RHEL 8 upgrades with Leapp
+  utility.
+email:
+- foreman-dev@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/api/v2/preupgrade_reports_controller.rb
+- app/controllers/preupgrade_reports_controller.rb
+- app/helpers/concerns/foreman_leapp/hosts_helper_extensions.rb
+- app/helpers/concerns/foreman_leapp/remote_execution_helper_extension.rb
+- app/helpers/foreman_leapp/template_helper.rb
+- app/lib/actions/preupgrade_job.rb
+- app/lib/helpers/job_helper.rb
+- app/models/concerns/foreman_leapp/job_invocation_extensions.rb
+- app/models/preupgrade_report.rb
+- app/models/preupgrade_report_entry.rb
+- app/views/api/v2/preupgrade_report_entries/base.json.rabl
+- app/views/api/v2/preupgrade_reports/base.json.rabl
+- app/views/api/v2/preupgrade_reports/index.json.rabl
+- app/views/api/v2/preupgrade_reports/show.json.rabl
+- app/views/foreman_leapp/job_templates/preupgrade.erb
+- app/views/foreman_leapp/job_templates/remediation.erb
+- app/views/foreman_leapp/job_templates/upgrade.erb
+- app/views/job_invocations/_leapp_preupgrade_report.html.erb
+- app/views/preupgrade_report_entries/base.json.rabl
+- app/views/preupgrade_reports/index.json.rabl
+- app/views/preupgrade_reports/show.json.rabl
+- config/routes.rb
+- db/migrate/20200320104040_preupgrade_report_entries.rb
+- db/migrate/20200326142259_add_job_id_to_report.rb
+- db/migrate/20200327091009_add_host_to_report.rb
+- db/seeds.d/10_leapp_preupgrade.rb
+- lib/foreman_leapp.rb
+- lib/foreman_leapp/engine.rb
+- lib/foreman_leapp/version.rb
+- lib/tasks/foreman_leapp_tasks.rake
+- locale/Makefile
+- locale/en/foreman_leapp.po
+- locale/foreman_leapp.pot
+- locale/gemspec.rb
+- test/factories/foreman_leapp_factories.rb
+- test/functional/api/v2/preupgrade_reports_controller_test.rb
+- test/functional/preupgrade_reports_controller_test.rb
+- test/helpers/template_helper_test.rb
+- test/models/preupgrade_report_entry_test.rb
+- test/models/preupgrade_report_test.rb
+- test/test_plugin_helper.rb
+- test/unit/actions/preupgrade_job_test.rb
+- test/unit/helpers/job_helper_test.rb
+homepage: https://github.com/oamg/foreman_leapp
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Foreman plugin for Leapp utility.
+test_files:
+- test/functional/api/v2/preupgrade_reports_controller_test.rb
+- test/functional/preupgrade_reports_controller_test.rb
+- test/models/preupgrade_report_test.rb
+- test/models/preupgrade_report_entry_test.rb
+- test/unit/helpers/job_helper_test.rb
+- test/unit/actions/preupgrade_job_test.rb
+- test/test_plugin_helper.rb
+- test/helpers/template_helper_test.rb
+- test/factories/foreman_leapp_factories.rb