foreman_leapp 0.0.6 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a75680a7afc44c4a8e90727d2319a53b231748a6db1f8a1c3627c319b3483902
-  data.tar.gz: 8506877b49e172205eeadb3a898d9ee5e8e1235525155673d52b98efdfb7441f
+  metadata.gz: 59cdca70be055403d924f568f8ccdd333123fbbdd6d6665bdaa7ca59706b7410
+  data.tar.gz: f1e4859e8b1c84faf8807d58656205ee60d2a8139ad304ec220810c64976f8c7
 SHA512:
-  metadata.gz: 18a93546178c2252cd530f913d98633e24808dbf66698ddff5d4249d2eec0c9df2513447a304df59cd55e4b54c0bcefb31cae0713dd002ca1895bb78bb19be28
-  data.tar.gz: 4993f008708cdb78a9defd9cd311cadb7396e75ad16f0827675ab32e0361e5ad5154810d3e8b1d5f9504d1db2849c6aebe9addae16006a9ff8698b70719b2247
+  metadata.gz: 89d6b5ebb3171d2a286f91995fd719652bcd486d3038b3e349ea8a147925464d41d1cc47e52d0b4e719a57c1aa88ca458eb36745870d7e1b3796a8c33779c42a
+  data.tar.gz: ffe034b5513860e72b8c4672b5a444c886334f21a7f7d232b4eb82e9b92d8defd8fca5150fc257d69ce7263c38f12941d2558ac04809aa023cdba7109a240834

data/README.md

@@ -1,32 +1,23 @@
 # ForemanLeapp
 
-This plugin allows to run inplace upgrades for rhel7 vms in foreman using leapp tool.
-For more information about leapp check [github](https://github.com/oamg/leapp) or
-[developer docs](https://leapp.readthedocs.io/en/latest/).
+This plugin allows to run inplace upgrades for RHEL 7 hosts in Foreman using Leapp tool.
+For more information about Leapp tool check [github](https://github.com/oamg/leapp) or [developer docs](https://leapp.readthedocs.io/en/latest/).
 
 ## Installation
 
-See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
-for how to install Foreman plugins
+See [Plugins Manual](https://www.theforeman.org/plugins/#2.Installation) for how to install Foreman plugins.
 
 ## Usage
 
-The plugin will add 2 remote execution jobs, "Run preupgrade via leapp" and "Run upgrade via leapp". Only
-preupgrade reports storage and retrieval has been implemented so far.
+The plugin will add following jobs:
+- Run preupgrade via Leapp
+- Remediation plan
+- Run upgrade via Leapp
 
-After running a preupgrade remote execution job on one or more foreman hosts the report can be retrieved from foreman db.
-
-The retrieval api looks like:
-
-- to fetch a specific preupgrade report - GET http://FOREMAN_URL:FOREMAN_PORT/api/v2/preupgrade_reports/REPORT_ID.
-- to fetch all reports for specific job invocation - GET http://FOREMAN_URL:FOREMAN_PORT/api/v2/aggregation/JOB_INVOCATION_ID.
-- to fetch last preupgrade report per host - GET http://FOREMAN_URL:FOREMAN_PORT/api/v2/preupgrade_reports/hosts/HOST_NAME_OR_ID/last.
-
-## TODO
-
-- Unit tests
-- Automate rubocop checks
-- Frontend (either from scratch or adapt the react/patternfly/typescript one for cockpit upgrades)
+## Api
+- `GET /api/preupgrade_reports` List Preupgrade reports
+- `GET /api/preupgrade_reports/:id` Show Preupgrade report
+- `GET /api/job_invocations/:id/preupgrade_reports` List Preupgrade reports for Job invocation
 
 ## Contributing
 

data/app/controllers/api/v2/concerns/api_authorizer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ApiAuthorizer
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :hosts_permission
+  end
+
+  private
+
+  def hosts_permission
+    return if User.current.can?('view_hosts')
+
+    render_error 'access_denied', status: :forbidden,
+                                  locals: { details: _('Missing one of the required permissions: view_hosts'),
+                                            missing_permissions: 'view_hosts' }
+  end
+
+  def resource_scope(_options = {})
+    @resource_scope ||= begin
+      scope = PreupgradeReport.joins(:host).merge(Host.authorized(:view_hosts, Host))
+      scope = scope.where(job_invocation_id: params[:id]) if action_name == 'job_invocation'
+      scope
+    end
+  end
+end

data/app/controllers/api/v2/preupgrade_reports_controller.rb

@@ -3,7 +3,9 @@
 module Api
   module V2
     class PreupgradeReportsController < ::Api::V2::BaseController
-      before_action :find_resource, only: %i[show]
+      include ApiAuthorizer
+
+      layout 'api/v2/layouts/index_layout', except: %i[show]
 
       api :GET, '/preupgrade_reports/', N_('List Preupgrade reports')
       param_group :search_and_pagination, ::Api::V2::BaseController
@@ -13,7 +15,24 @@ module Api
 
       api :GET, '/preupgrade_reports/:id', N_('Show Preupgrade report')
       param :id, :identifier, required: true
-      def show; end
+      def show
+        @preupgrade_report = resource_scope.find(params[:id])
+      end
+
+      api :GET, '/job_invocations/:id/preupgrade_reports', N_('List Preupgrade reports for Job invocation')
+      param :id, :identifier, required: true
+      def job_invocation
+        @preupgrade_reports = resource_scope_for_index.where(job_invocation_id: params[:id])
+      end
+
+      private
+
+      # By overriding path_to_authenticate we can require REX's permission view_job_invocations
+      def path_to_authenticate
+        params['action'] = 'show' if params['action'] == 'job_invocation'
+        Foreman::AccessControl.normalize_path_hash params.slice(:action, :id, :user_id)
+                                                         .merge({ controller: 'api/v2/job_invocations' })
+      end
     end
   end
 end

data/app/controllers/preupgrade_reports_controller.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
 class PreupgradeReportsController < ::Api::V2::BaseController
+  include ApiAuthorizer
+
   def index
-    @preupgrade_reports = resource_scope.search_for(*search_options)
+    @preupgrade_reports = resource_scope.includes(:preupgrade_report_entries).search_for(*search_options)
+  end
+
+  private
+
+  # By overriding :path_to_authenticate we can require REX's :view_job_invocations permission
+  def path_to_authenticate
+    Foreman::AccessControl.normalize_path_hash params.slice(:action, :id, :user_id)
+                                                     .merge({ controller: 'job_invocations' })
   end
 end

data/app/lib/actions/preupgrade_job.rb

@@ -8,7 +8,8 @@ module Actions
       end
 
       def plan(job_invocation, host, *_args)
-        return unless ::Helpers::JobHelper.correct_feature?(job_invocation, 'leapp_preupgrade')
+        return unless ::Helpers::JobHelper.correct_feature?(job_invocation, 'leapp_preupgrade') ||
+                      ::Helpers::JobHelper.correct_feature?(job_invocation, 'leapp_remediation_plan')
 
         plan_self(host_id: host.id, job_invocation_id: job_invocation.id)
       end

data/app/lib/helpers/job_helper.rb

@@ -4,10 +4,9 @@ module Helpers
   module JobHelper
     class << self
       def correct_feature?(job_invocation, feature)
-        job_invocation.job_category == ::ForemanLeapp::JOB_CATEGORY &&
-          RemoteExecutionFeature.find_by(job_template_id: job_invocation.pattern_template_invocations
-                                                                        .pluck(:template_id)
-                                                                        .first)&.label == feature
+        RemoteExecutionFeature.where(job_template_id: job_invocation.pattern_template_invocations
+                                                                    .first
+                                                                    .template_id, label: feature).any?
       end
     end
   end

data/app/models/preupgrade_report.rb

@@ -27,6 +27,7 @@ class PreupgradeReport < ::Report
       leapp_run_id: data['leapp_run_id'],
       summary: entry['summary'],
       tags: entry['tags'],
+      flags: entry['flags'],
       detail: entry['detail'] }
   end
 end

data/app/models/preupgrade_report_entry.rb

@@ -5,6 +5,7 @@ class PreupgradeReportEntry < ApplicationRecord
   belongs_to_host
 
   serialize :tags, Array
+  serialize :flags, Array
   serialize :detail, JSON
 
   validates :preupgrade_report, :host, :hostname, :title, :actor, :audience, :severity, :leapp_run_id, presence: true

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

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

data/app/views/api/v2/preupgrade_reports/job_invocation.json.rabl

@@ -0,0 +1,3 @@
+collection @preupgrade_reports
+
+extends 'api/v2/preupgrade_reports/base'

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

@@ -0,0 +1,15 @@
+<%#
+name: Check Leapp
+description_format: 'Check if Leapp package is installed.'
+kind: job_template
+job_category: Leapp
+provider_type: SSH
+snippet: true
+model: JobTemplate
+%>
+
+if ! command -v leapp > /dev/null
+then
+  echo "Leapp is not installed."
+  exit 1
+fi

data/app/views/foreman_leapp/job_templates/{preupgrade.erb → leapp_preupgrade.erb}

@@ -1,14 +1,17 @@
 <%#
 kind: job_template
 name: Run preupgrade via Leapp
-job_category: Leapp
+job_category: Leapp - Preupgrade
 description_format: 'Upgradeability check for RHEL 7 host'
 provider_type: SSH
 feature: leapp_preupgrade
+model: JobTemplate
 %>
 
+<%= render_template 'Check Leapp' %>
+
+rm -f /var/log/leapp/leapp-report.json
 leapp preupgrade
-[ $? -eq 0 ]  || exit 1
 
 echo "===leap_upgrade_report_start==="
 cat /var/log/leapp/leapp-report.json

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

@@ -0,0 +1,29 @@
+<%#
+kind: job_template
+name: Run remediation plan via Leapp
+job_category: Other
+description_format: 'Run remediation plan via Leapp'
+provider_type: SSH
+feature: leapp_remediation_plan
+model: JobTemplate
+template_inputs:
+- name: remediation_ids
+  required: true
+  advanced: true
+  input_type: user
+  value_type: plain
+  description: List of remediation ids
+- name: run_preupgrade
+  description: Run preupgrade check again when remediation entries are fixed.
+  input_type: user
+  required: true
+  options: "true\nfalse"
+  default: "true"
+%>
+
+<%= render_template 'Check Leapp' %>
+
+<%= build_remediation_plan(input('remediation_ids').split(','), @host) %>
+<% if input('run_preupgrade') == 'true' %>
+  <%= render_template 'Run preupgrade via Leapp' %>
+<% end %>

data/app/views/foreman_leapp/job_templates/{upgrade.erb → leapp_upgrade.erb}

@@ -1,24 +1,26 @@
 <%#
 kind: job_template
 name: Run upgrade via Leapp
-job_category: Ansible Playbook
+job_category: Leapp - Upgrade
 description_format: 'Upgrade RHEL 7 host'
 provider_type: Ansible
 feature: leapp_upgrade
+model: JobTemplate
 template_inputs:
-- name: reboot
-  description: reboot the vm automaticaly to continue with the upgrade
+- name: Reboot
+  description: Reboot the host automaticaly to continue with the upgrade
   input_type: user
-  required: false
-  options: "false\ntrue"
+  required: true
+  default: "true"
+  options: "true\nfalse"
 %>
 ---
 - hosts: all
   tasks:
     - name: Run Leapp Upgrade
       command: leapp upgrade
-<% if input('reboot') == "true" %>
+<%- if input('Reboot') == "true" -%>
     - name: Reboot the machine
       reboot:
         reboot_timeout: 1800
-<% end %>
+<%- end -%>

data/config/routes.rb

@@ -4,8 +4,9 @@ Rails.application.routes.draw do
   resources :preupgrade_reports, :only => %i[index]
 
   namespace :api, defaults: { format: 'json' } do
-    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2'}, apiv: /v2/, constraints: ApiConstraints.new( version: 2, default: true) do
+    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v2/, constraints: ApiConstraints.new( version: 2, default: true) do
       resources :preupgrade_reports, only: %i[index show]
+      get 'job_invocations/:id/preupgrade_reports', to: 'preupgrade_reports#job_invocation'
     end
   end
 end

data/db/migrate/20200429080939_report_entries_flags.rb

@@ -0,0 +1,5 @@
+class ReportEntriesFlags < ActiveRecord::Migration[6.0]
+  def change
+    add_column :preupgrade_report_entries, :flags, :text
+  end
+end

data/db/seeds.d/10_leapp_preupgrade.rb

@@ -9,7 +9,7 @@ User.as_anonymous_admin do
                     'job_templates/**/*.erb')].each do |template|
         template = JobTemplate.import_raw!(File.read(template),
                                            :default => true,
-                                           :locked => true,
+                                           :lock => true,
                                            :update => true)
         template.organizations = organizations if template.present?
         template.locations = locations if template.present?

data/lib/foreman_leapp/engine.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 module ForemanLeapp
-  JOB_CATEGORY = 'Leapp'
-
   class Engine < ::Rails::Engine
     engine_name 'foreman_leapp'
 
@@ -23,7 +21,7 @@ module ForemanLeapp
 
     initializer 'foreman_leapp.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_leapp do
-        requires_foreman '>= 1.16'
+        requires_foreman '>= 2.1'
 
         apipie_documented_controllers ["#{ForemanLeapp::Engine.root}/app/controllers/api/v2/*.rb"]
         extend_template_helpers ForemanLeapp::TemplateHelper
@@ -33,7 +31,10 @@ module ForemanLeapp
                          partial: 'job_invocations/leapp_preupgrade_report',
                          name: _('Leapp preupgrade report'),
                          id: 'leapp_preupgrade_report',
-                         onlyif: proc { |subject| ::Helpers::JobHelper.correct_feature?(subject, 'leapp_preupgrade') }
+                         onlyif: proc { |subject|
+                           ::Helpers::JobHelper.correct_feature?(subject, 'leapp_preupgrade') ||
+                             ::Helpers::JobHelper.correct_feature?(subject, 'leapp_remediation_plan')
+                         }
         end
       end
     end
@@ -41,8 +42,8 @@ module ForemanLeapp
     # Include concerns in this config.to_prepare block
     config.to_prepare do
       begin
-        HostsHelper.prepend ForemanLeapp::HostsHelperExtensions
-        Host::JobInvocation.include ForemanLeapp::JobInvocationExtensions
+        ::HostsHelper.prepend ForemanLeapp::HostsHelperExtensions
+        ::JobInvocation.include ForemanLeapp::JobInvocationExtensions
       rescue StandardError => e
         Rails.logger.warn "ForemanLeapp: skipping engine hook (#{e})"
       end

data/lib/foreman_leapp/version.rb

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

data/locale/action_names.rb

@@ -0,0 +1,6 @@
+# Autogenerated!
+_("Preupgrade job")
+_("Remote action:")
+_("Import Puppet classes")
+_("Import facts")
+_("Action with sub plans")

data/locale/en/foreman_leapp.po

@@ -2,12 +2,10 @@
 #
 # 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:54+0100\n"
 "Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
 "Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
@@ -17,3 +15,107 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
+msgid "A foreman plugin to support inplace RHEL 7 -> RHEL 8 upgrades with Leapp utility."
+msgstr ""
+
+msgid "All"
+msgstr ""
+
+msgid "Command"
+msgstr ""
+
+msgid "Fix Selected"
+msgstr ""
+
+msgid "Fix Type"
+msgstr ""
+
+msgid "Has Remediation?"
+msgstr ""
+
+msgid "High"
+msgstr ""
+
+msgid "Hint"
+msgstr ""
+
+msgid "Host"
+msgstr ""
+
+msgid "Info"
+msgstr ""
+
+msgid "Inhibitor"
+msgstr ""
+
+msgid "Inhibitor?"
+msgstr ""
+
+msgid "Leapp preupgrade report"
+msgstr ""
+
+msgid "List Preupgrade reports"
+msgstr ""
+
+msgid "List Preupgrade reports for Job invocation"
+msgstr ""
+
+msgid "Low"
+msgstr ""
+
+msgid "Medium"
+msgstr ""
+
+msgid "Missing one of the required permissions: view_hosts"
+msgstr ""
+
+msgid "No"
+msgstr ""
+
+msgid "No Preupgrade Report Available"
+msgstr ""
+
+msgid "Preupgrade check with Leapp"
+msgstr ""
+
+msgid "Remediation plan"
+msgstr ""
+
+msgid "Rerun preupgrade check"
+msgstr ""
+
+msgid "Risk Factor"
+msgstr ""
+
+msgid "Run Leapp Preupgrade check again"
+msgstr ""
+
+msgid "Run Leapp upgrade job for RHEL 7 host"
+msgstr ""
+
+msgid "Run Remediation plan with Leapp"
+msgstr ""
+
+msgid "Run Upgrade"
+msgstr ""
+
+msgid "Show Preupgrade report"
+msgstr ""
+
+msgid "The preupgrade report will be available after the job finishes"
+msgstr ""
+
+msgid "This issue inhibits the upgrade."
+msgstr ""
+
+msgid "Title"
+msgstr ""
+
+msgid "Upgrade with Leapp"
+msgstr ""
+
+msgid "Upgradeability check for RHEL 7 host"
+msgstr ""
+
+msgid "Yes"
+msgstr ""