foreman_leapp 0.0.2

data/Rakefile

@@ -0,0 +1,49 @@
+#!/usr/bin/env rake
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanLeapp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError => _e
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Api
+  module V2
+    class PreupgradeReportsController < ::Api::V2::BaseController
+      before_action :find_resource, only: %i[show]
+
+      api :GET, '/preupgrade_reports/', N_('List Preupgrade reports')
+      param_group :search_and_pagination, ::Api::V2::BaseController
+      def index
+        @preupgrade_reports = resource_scope_for_index
+      end
+
+      api :GET, '/preupgrade_reports/:id', N_('Show Preupgrade report')
+      param :id, :identifier, required: true
+      def show; end
+    end
+  end
+end

data/app/controllers/preupgrade_reports_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class PreupgradeReportsController < ::Api::V2::BaseController
+  def index
+    @preupgrade_reports = resource_scope.search_for(*search_options)
+  end
+end

data/app/helpers/concerns/foreman_leapp/hosts_helper_extensions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ForemanLeapp
+  module HostsHelperExtensions
+    def multiple_actions
+      super + [[_('Preupgrade check with Leapp'), new_job_invocation_path(feature: 'leapp_preupgrade'), false],
+               [_('Upgrade with Leapp'), new_job_invocation_path(feature: 'leapp_upgrade'), false]]
+    end
+
+    def rex_host_features(*args)
+      super + [link_to(_('Preupgrade check with Leapp'),
+                       new_job_invocation_path(host_ids: [args.first.id], feature: 'leapp_preupgrade')),
+               link_to(_('Upgrade with Leapp'),
+                       new_job_invocation_path(host_ids: [args.first.id], feature: 'leapp_upgrade'))]
+    end
+  end
+end

data/app/helpers/concerns/foreman_leapp/remote_execution_helper_extension.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ForemanLeapp
+  module RemoteExecutionHelperExtension
+    def job_invocation_task_buttons(task)
+      return super unless ::Helpers::JobHelper.correct_feature?(@job_invocation, 'leapp_remediation_plan')
+
+      super.insert(2, link_to(_('Rerun preupgrade check'),
+                              new_job_invocation_path(host_ids: @resource_base.map(&:id), feature: 'leapp_preupgrade'),
+                              class: 'btn btn-default',
+                              title: _('Run Leapp Preupgrade check again'),
+                              method: :get))
+    end
+  end
+end

data/app/helpers/foreman_leapp/template_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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" }
+                           .join
+    end
+  end
+end

data/app/lib/actions/preupgrade_job.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Actions
+  module ForemanLeapp
+    class PreupgradeJob < Actions::EntryAction
+      def self.subscribe
+        Actions::RemoteExecution::RunHostJob
+      end
+
+      def plan(job_invocation, host, *_args)
+        return unless ::Helpers::JobHelper.correct_feature?(job_invocation, 'leapp_preupgrade')
+
+        plan_self(host_id: host.id, job_invocation_id: job_invocation.id)
+      end
+
+      def finalize(*_args)
+        host = Host.find(input[:host_id])
+        leapp_report = format_output(task.main_action.continuous_output.humanize)
+
+        PreupgradeReport.create_report(host, leapp_report, input[:job_invocation_id])
+      end
+
+      private
+
+      def format_output(job_output)
+        output = job_output.each_line(chomp: true)
+                           .drop_while { |l| !l.start_with? '===leap_upgrade_report_start===' }.drop(1)
+                           .take_while { |l| !l.start_with? 'Exit status:' }
+                           .reject(&:empty?)
+                           .join('')
+        JSON.parse(output)
+      end
+    end
+  end
+end

data/app/lib/helpers/job_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_leapp/job_invocation_extensions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanLeapp
+  module JobInvocationExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :preupgrade_reports, dependent: :destroy
+    end
+  end
+end

data/app/models/preupgrade_report.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class PreupgradeReport < ::Report
+  belongs_to :job_invocation
+  has_many :preupgrade_report_entries, dependent: :destroy
+
+  scoped_search on: :job_invocation_id, only_explicit: true
+
+  def self.create_report(host, data, job_invocation_id)
+    report = PreupgradeReport.create(host: host, status: 0,
+                                     job_invocation_id: job_invocation_id,
+                                     reported_at: DateTime.now.utc)
+
+    data['entries']&.each do |entry|
+      PreupgradeReportEntry.create! entry_params(report, entry, host, data)
+    end
+  end
+
+  def self.entry_params(report, entry, host, data)
+    { preupgrade_report: report,
+      host_id: host.id,
+      hostname: host.name,
+      title: entry['title'],
+      actor: entry['actor'],
+      audience: entry['audience'],
+      severity: entry['severity'],
+      leapp_run_id: data['leapp_run_id'],
+      summary: entry['summary'],
+      tags: entry['tags'],
+      detail: entry['detail'] }
+  end
+end

data/app/models/preupgrade_report_entry.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class PreupgradeReportEntry < ApplicationRecord
+  belongs_to :preupgrade_report
+  belongs_to_host
+
+  serialize :tags, Array
+  serialize :detail, JSON
+
+  validates :preupgrade_report, :host, :hostname, :title, :actor, :audience, :severity, :leapp_run_id, presence: true
+
+  def self.remediation_details(remediation_ids, host)
+    where(id: remediation_ids, host: host).where.not(detail: nil).pluck(:detail)
+  end
+end

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

@@ -0,0 +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

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

@@ -0,0 +1,3 @@
+object @preupgrade_report
+
+attributes :id, :host_id, :reported_at, :status, :metrics, :type, :origin, :job_invocation_id

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

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

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

@@ -0,0 +1,7 @@
+object @preupgrade_report
+
+extends 'api/v2/preupgrade_reports/base'
+
+child :preupgrade_report_entries do
+  extends 'api/v2/preupgrade_report_entries/base'
+end

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

@@ -0,0 +1,14 @@
+<%#
+kind: job_template
+name: Run preupgrade via Leapp
+job_category: Leapp
+description_format: 'Upgradeability check for RHEL 7 host'
+provider_type: SSH
+feature: leapp_preupgrade
+%>
+
+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/remediation.erb

@@ -0,0 +1,17 @@
+<%#
+kind: job_template
+name: Remediation plan
+job_category: Leapp
+description_format: 'Run Remediation plan with Leapp'
+provider_type: SSH
+feature: leapp_remediation_plan
+template_inputs:
+- name: remediation_ids
+  required: true
+  advanced: true
+  input_type: user
+  value_type: plain
+  description: List of remediation ids
+%>
+
+<%= build_remediation_plan(input('remediation_ids').split(','), @host) %>

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

@@ -0,0 +1,16 @@
+<%#
+kind: job_template
+name: Run upgrade via Leapp
+job_category: Leapp
+description_format: 'Upgrade RHEL 7 host'
+provider_type: SSH
+feature: leapp_upgrade
+template_inputs:
+- name: reboot
+  description: reboot the vm automaticaly to continue with the upgrade
+  input_type: user
+  required: false
+  options: "false\ntrue"
+%>
+
+leapp upgrade <%= "--reboot" if input('reboot') == "true" %>

data/app/views/job_invocations/_leapp_preupgrade_report.html.erb

@@ -0,0 +1,10 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_leapp %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_leapp %>
+<% end %>
+
+<%= react_component('PreupgradeReports', {
+  :url => preupgrade_reports_path(:search => "job_invocation_id = #{@job_invocation.id}")
+}) %>

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

@@ -0,0 +1,4 @@
+object @preupgrade_report_entry
+
+extends "api/v2/preupgrade_report_entries/base"
+attribute :detail

data/app/views/preupgrade_reports/index.json.rabl

@@ -0,0 +1,3 @@
+collection @preupgrade_reports
+
+extends 'preupgrade_reports/show'

data/app/views/preupgrade_reports/show.json.rabl

@@ -0,0 +1,7 @@
+object @preupgrade_report
+
+extends "api/v2/preupgrade_reports/base"
+
+child :preupgrade_report_entries => :entries do
+  extends "preupgrade_report_entries/base"
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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
+      resources :preupgrade_reports, only: %i[index show]
+    end
+  end
+end

data/db/migrate/20200320104040_preupgrade_report_entries.rb

@@ -0,0 +1,25 @@
+class PreupgradeReportEntries < ActiveRecord::Migration[5.2]
+  def up
+    create_table :preupgrade_report_entries do |t|
+      t.integer :preupgrade_report_id, null: false
+      t.string :hostname, null: false
+      t.string :title, null: false
+      t.string :actor, null: false
+      t.string :audience, null: false
+      t.string :severity, null: false
+      t.string :leapp_run_id, null: false
+      t.text :summary
+      t.text :tags
+      t.text :detail
+
+      t.timestamps
+    end
+
+    add_index :preupgrade_report_entries, :preupgrade_report_id
+  end
+
+  def down
+    remove_index :preupgrade_report_entries, :preupgrade_report_id
+    drop_table :preupgrade_report_entries
+  end
+end

data/db/migrate/20200326142259_add_job_id_to_report.rb

@@ -0,0 +1,6 @@
+class AddJobIdToReport < ActiveRecord::Migration[5.2]
+  def change
+    add_column :reports, :job_invocation_id, :integer
+    add_index  :reports, :job_invocation_id
+  end
+end

data/db/migrate/20200327091009_add_host_to_report.rb

@@ -0,0 +1,6 @@
+class AddHostToReport < ActiveRecord::Migration[5.2]
+  def change
+    add_column :preupgrade_report_entries, :host_id, :integer, null: false
+    add_index :preupgrade_report_entries, :host_id
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+organizations = Organization.unscoped.all
+locations = Location.unscoped.all
+User.as_anonymous_admin do
+  RemoteExecutionFeature.without_auditing do
+    JobTemplate.without_auditing do
+      Dir[File.join("#{ForemanLeapp::Engine.root}/app/views/foreman_leapp/"\
+                    'job_templates/**/*.erb')].each do |template|
+        template = JobTemplate.import_raw!(File.read(template),
+                                           :default => true,
+                                           :locked => true,
+                                           :update => true)
+        template.organizations = organizations if template.present?
+        template.locations = locations if template.present?
+      end
+    end
+  end
+end

data/lib/foreman_leapp/engine.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ForemanLeapp
+  JOB_CATEGORY = 'Leapp'
+
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_leapp'
+
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/controllers/api/v2/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/overrides"]
+    config.autoload_paths += Dir["#{config.root}/app/lib/helpers"]
+    config.autoload_paths += Dir["#{config.root}/test/"]
+
+    # Add any db migrations
+    initializer 'foreman_leapp.load_app_instance_data' do |app|
+      ForemanLeapp::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_leapp.register_plugin', before: :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_leapp do
+        requires_foreman '>= 1.16'
+
+        extend_template_helpers ForemanLeapp::TemplateHelper
+
+        extend_page 'job_invocations/show' do |cx|
+          cx.add_pagelet :main_tabs,
+                         partial: 'job_invocations/leapp_preupgrade_report',
+                         name: _('Leapp preupgrade report'),
+                         id: 'leapp_preupgrade_report',
+                         onlyif: proc { |subject| ::Helpers::JobHelper.correct_feature?(subject, 'leapp_preupgrade') }
+        end
+      end
+    end
+
+    # Include concerns in this config.to_prepare block
+    config.to_prepare do
+      begin
+        HostsHelper.prepend ForemanLeapp::HostsHelperExtensions
+        Host::JobInvocation.include ForemanLeapp::JobInvocationExtensions
+      rescue StandardError => e
+        Rails.logger.warn "ForemanLeapp: skipping engine hook (#{e})"
+      end
+
+      RemoteExecutionFeature.register(
+        :leapp_preupgrade,
+        N_('Preupgrade check with Leapp'),
+        description: N_('Upgradeability check for RHEL 7 host'),
+        host_action_button: false
+      )
+
+      RemoteExecutionFeature.register(
+        :leapp_upgrade,
+        N_('Upgrade with Leapp'),
+        description: N_('Run Leapp upgrade job for RHEL 7 host'),
+        host_action_button: false
+      )
+
+      RemoteExecutionFeature.register(
+        :leapp_remediation_plan,
+        N_('Remediation plan'),
+        description: N_('Run Remediation plan with Leapp'),
+        host_action_button: false
+      )
+    end
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanLeapp::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_leapp.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
+      locale_domain = 'foreman_leapp'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+
+    initializer 'foreman_leapp.require_dynflow',
+                before: 'foreman_tasks.initialize_dynflow',
+                after: 'foreman_remote_execution.require_dynflow' do |_app|
+      ForemanTasks.dynflow.require!
+      ForemanTasks.dynflow.config.eager_load_paths << File.join(ForemanLeapp::Engine.root, 'app/lib/actions')
+    end
+
+    initializer('foreman_leapp.extend_remote_execution',
+                after: 'foreman_leapp.require_foreman_remote_execution') do |_app|
+      RemoteExecutionHelper.prepend ForemanLeapp::RemoteExecutionHelperExtension
+    end
+  end
+end

data/lib/foreman_leapp/version.rb

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

data/lib/foreman_leapp.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'foreman_remote_execution'
+require 'foreman_leapp/engine'
+
+module ForemanLeapp
+end

data/lib/tasks/foreman_leapp_tasks.rake

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_leapp do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanLeapp'
+  Rake::TestTask.new(:foreman_leapp) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_leapp do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_leapp) do |task|
+        task.patterns = ["#{ForemanLeapp::Engine.root}/app/**/*.rb",
+                         "#{ForemanLeapp::Engine.root}/lib/**/*.rb",
+                         "#{ForemanLeapp::Engine.root}/test/**/*.rb"]
+      end
+    rescue StandardError
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_leapp'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_leapp']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_leapp', 'foreman_leapp:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,60 @@
+#
+# 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 = foreman_leapp
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.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))
+
+%.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:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	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, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_leapp.po

@@ -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: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"
+