foreman_rescue 0.1.0

data/README.md

@@ -0,0 +1,30 @@
+# ForemanRescue
+
+This plugin allows a user to boot a Foreman host into a rescue system via PXE.
+
+## 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.
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) 2018 dm-drogerie markt GmbH & Co. KG, https://dm.de
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+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    = 'ForemanRescue'
+  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', __FILE__)
+
+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 => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/controllers/foreman_rescue/hosts_controller.rb

@@ -0,0 +1,43 @@
+module ForemanRescue
+  class HostsController < ::HostsController
+    before_action :find_resource, :only => [:rescue, :set_rescue, :cancel_rescue]
+    define_action_permission ['rescue', 'set_rescue', 'cancel_rescue'], :rescue
+
+    def rescue; end
+
+    def set_rescue
+      forward_url_options
+      if @host.set_rescue
+        if params[:host] && params[:host][:rescue_mode] == '1'
+          begin
+            message = if @host.power.reset
+                        _('Enabled %s for reboot into rescue system.')
+                      else
+                        _('Enabled %s for boot into rescue system on next boot, but failed to power cycle the host.')
+                      end
+            process_success :success_msg => message % @host, :success_redirect => :back
+          rescue => error
+            message = _('Failed to reboot %s.') % @host
+            warning(message)
+            Foreman::Logging.exception(message, error)
+            process_success :success_msg => _('Enabled %s for rescue system on next boot.') % @host, :success_redirect => :back
+          end
+        else
+          process_success :success_msg => _('Enabled %s for rescue system on next boot.') % @host, :success_redirect => :back
+        end
+      else
+        process_error :redirect => :back, :error_msg => _('Failed to enable %{host} for rescue system: %{errors}') % { :host => @host, :errors => @host.errors.full_messages.to_sentence }
+      end
+    end
+
+    def cancel_rescue
+      if @host.cancel_rescue
+        process_success :success_msg => _('Canceled booting into rescue system for %s.') % @host.name, :success_redirect => :back
+      else
+        process_error :redirect => :back,
+                      :error_msg => _('Failed to cancel booting into rescue system for %{hostname} with the following errors: %{errors}') %
+                                    { :hostname => @host.name, :errors => @host.errors.full_messages.to_sentence }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module ForemanRescue
+  module HostsHelperExtensions
+    def host_title_actions(host)
+      title_actions(
+        button_group(
+          if host.rescue_mode?
+            link_to_if_authorized(_('Cancel rescue'), hash_for_cancel_rescue_host_path(:id => host).merge(:auth_object => host, :permission => 'rescue_hosts'),
+                                  :disabled => host.can_be_rescued?,
+                                  :title    => _('Cancel rescue system for this host.'),
+                                  :class => 'btn btn-default',
+                                  :method => :put)
+          else
+            link_to_if_authorized(_('Rescue'), hash_for_rescue_host_path(:id => host).merge(:auth_object => host, :permission => 'rescue_hosts'),
+                                  :disabled => !host.can_be_rescued?,
+                                  :title    => _('Activate rescue mode for this host.'),
+                                  :class    => 'btn btn-default')
+          end
+        )
+      )
+      super
+    end
+  end
+end

data/app/models/concerns/foreman_rescue/host_extensions.rb

@@ -0,0 +1,32 @@
+module ForemanRescue
+  module HostExtensions
+    def self.prepended(base)
+      base.class_eval do
+        validate :build_and_rescue_mode
+      end
+    end
+
+    def can_be_rescued?
+      managed? && SETTINGS[:unattended] && pxe_build? && !build? && !rescue_mode?
+    end
+
+    def can_be_built?
+      super && !rescue_mode?
+    end
+
+    def set_rescue
+      update(rescue_mode: true)
+    end
+
+    def cancel_rescue
+      update(rescue_mode: false)
+    end
+
+    private
+
+    def build_and_rescue_mode
+      errors.add(:base, 'can either be in build mode or rescue mode, not both.') if build? && rescue_mode?
+      true
+    end
+  end
+end

data/app/models/concerns/foreman_rescue/orchestration/tftp.rb

@@ -0,0 +1,50 @@
+module ForemanRescue
+  module Orchestration
+    module TFTP
+      def self.prepended(base)
+        base.class_eval do
+          after_validation :queue_tftp_rescue
+          delegate :rescue_mode, :rescue_mode?, :to => :host
+        end
+      end
+
+      def queue_tftp_rescue
+        return unless tftp? || tftp6?
+        return if new_record?
+        queue_tftp_update_rescue unless new_record?
+      end
+
+      # Overwritten because we do not want to
+      # queue the tasks multiple times
+      def queue_tftp_create
+        super unless tftp_queued?
+      end
+
+      def queue_tftp_update_rescue
+        queue_tftp_create if old.host.rescue_mode? != host.rescue_mode?
+      end
+
+      private
+
+      # We have to overwrite default_pxe_render to hook
+      # in the rescue tftp template rendering
+      def default_pxe_render(kind)
+        return rescue_mode_pxe_render(kind) if rescue_mode?
+        super
+      end
+
+      def rescue_mode_pxe_render(kind)
+        template_name = Setting["rescue_#{kind.downcase}_tftp_template"]
+        template = ::ProvisioningTemplate.find_by_name(template_name)
+        return unless template.present?
+        unattended_render template
+      rescue => e
+        failure _("Unable to render %{kind} rescue template '%{name}' for TFTP: %{e}") % { :kind => kind, :name => template.try(:name), :e => e }, e
+      end
+
+      def tftp_queued?
+        queue.all.select { |task| task.action[1] == :setTFTP }.present?
+      end
+    end
+  end
+end

data/app/models/setting/rescue.rb

@@ -0,0 +1,43 @@
+class Setting
+  class Rescue < ::Setting
+    def self.default_settings
+      [
+        set('rescue_pxelinux_tftp_template',
+            N_('PXELinux template used when booting rescue system'),
+            'create', N_('PXELinux rescue template'), nil,
+            { :collection => proc { Setting::Rescue.templates('PXELinux') } }),
+        set('rescue_pxegrub_tftp_template',
+            N_('PXEGrub template used when booting rescue system'),
+            'create', N_('PXEGrub rescue template'), nil,
+            { :collection => proc { Setting::Rescue.templates('PXEGrub') } }),
+        set('rescue_pxegrub2_tftp_template',
+            N_('PXEGrub2 template used when booting rescue system'),
+            'create', N_('PXEGrub2 rescue template'), nil,
+            { :collection => proc { Setting::Rescue.templates('PXEGrub 2') } })
+      ]
+    end
+
+    def self.load_defaults
+      # Check the table exists
+      return unless super
+
+      self.transaction do
+        default_settings.each { |s| self.create! s.update(:category => 'Setting::Rescue') }
+      end
+
+      true
+    end
+
+    def self.templates(kind)
+      template_kind = TemplateKind.find_by_name(kind)
+      templates = ProvisioningTemplate.where(:template_kind => template_kind)
+      templates.each_with_object({}) do |template, hsh|
+        hsh[template.name] = template.name
+      end
+    end
+
+    def self.humanized_category
+      N_('Rescue System')
+    end
+  end
+end

data/app/views/foreman_rescue/hosts/rescue.html.erb

@@ -0,0 +1,68 @@
+<% title @host.to_label, icon(@host.operatingsystem) + @host.to_label %>
+<div class="blank-slate-pf">
+  <div class="blank-slate-pf-icon">
+    <%= icon_text('medkit', '', :kind => 'fa', :class => @host.rescue_mode? ? 'text-success' : '') %>
+  </div>
+  <h1><%= _('Rescue Mode') %></h1>
+  <p>
+  <% if @host.rescue_mode? %>
+    <%= _("This host has rescue mode enabled.") %></br>
+  <% elsif !@host.can_be_rescued? %>
+    <%= _("This host can not be booted into rescue mode.") %></br>
+  <% else %>
+    <%= _("This host does not have rescue mode enabled.") %></br>
+  <% end %>
+  </p>
+  <div class="blank-slate-pf-main-action">
+    <% if @host.rescue_mode? %>
+      <%= link_to_if_authorized(_("Back to host"), hash_for_host_path(:id => @host), :title => _("Back to host"), :class => 'btn btn-default btn-lg') %>
+      <%= link_to_if_authorized(
+        _('Cancel rescue mode'),
+        hash_for_cancel_rescue_host_path(:id => @host).merge(:auth_object => @host, :permission => 'rescue_hosts'),
+        :method => :put,
+        :class => 'btn btn-primary btn-lg')
+      %>
+    <% elsif !@host.can_be_rescued? %>
+      <div class="alert alert-info" style="text-align: left; font-size: 0.8em;">
+        <%= alert_header(_('The following reasons prevent a boot into rescue mode:'), 'alert-info') %>
+      <ul>
+        <% unless @host.managed? %>
+          <li><%= _('%s is not managed.') % @host %></li>
+        <% end %>
+        <% unless SETTINGS[:unattended] %>
+          <li><%= _('Unattended mode is not activated.') %></li>
+        <% end %>
+        <% unless @host.pxe_build? %>
+          <li><%= _('%s does not support PXE booting.') % @host %></li>
+        <% end %>
+        <% if @host.build? %>
+          <li><%= _('%s is in build mode.') % @host %></li>
+        <% end %>
+      </ul>
+      </div>
+      <%= link_to_if_authorized(_("Back to host"), hash_for_host_path(:id => @host), :title => _("Back to host"), :class => 'btn btn-default btn-lg') %>
+    <% else %>
+      <div class="panel panel-default">
+        <div class="panel-heading">
+        <h3 class="panel-title"><%= _('Activate rescue mode') %></h3>
+      </div>
+      <div class="panel-body">
+        <%= form_for :host,
+          :method => :put,
+          :html => {:class => 'form-horizontal'},
+          :url    => hash_for_set_rescue_host_path(:id => @host).merge(:auth_object => @host, :permission => 'rescue_hosts') do |f|
+        %>
+          <div class="alert alert-warning" style="text-align: left; font-size: 0.8em;">
+            <span class="pficon pficon-warning-triangle-o"></span>
+            <%= _("Activating rescue mode can disrupt running services on %s.") % @host %>
+          </div>
+
+          <%= checkbox_f(f, :rescue_mode, :help_text => _('Reboot %s') % @host, :size => '') if @host.supports_power_and_running? %>
+         <%= link_to_if_authorized(_("Back to host"), hash_for_host_path(:id => @host), :title => _("Back to host"), :class => 'btn btn-default btn-lg') %>
+         <%= f.submit _("Activate rescue mode"), :class => "btn btn-danger btn-lg submit" %>
+        <% end %>
+      <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  constraints(:id => /[^\/]+/) do
+    resources :hosts, controller: 'foreman_rescue/hosts', :only => [] do
+      member do
+        get 'rescue'
+        put 'set_rescue'
+        put 'cancel_rescue'
+      end
+    end
+  end
+end

data/db/migrate/20170901131321_add_rescue_mode_to_host.foreman_rescue.rb

@@ -0,0 +1,5 @@
+class AddRescueModeToHost < ActiveRecord::Migration
+  def change
+    add_column :hosts, :rescue_mode, :boolean, default: false, index: true
+  end
+end

data/lib/foreman_rescue.rb

@@ -0,0 +1,4 @@
+require 'foreman_rescue/engine'
+
+module ForemanRescue
+end

data/lib/foreman_rescue/engine.rb

@@ -0,0 +1,53 @@
+module ForemanRescue
+  class Engine < ::Rails::Engine
+    engine_name 'foreman_rescue'
+
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+
+    # Add any db migrations
+    initializer 'foreman_rescue.load_app_instance_data' do |app|
+      ForemanRescue::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_monitoring.load_default_settings',
+                :before => :load_config_initializers do |_app|
+      if begin
+        Setting.table_exists?
+      rescue
+        false
+      end
+        require_dependency File.expand_path('../../../app/models/setting/rescue.rb', __FILE__)
+      end
+    end
+
+    initializer 'foreman_rescue.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_rescue do
+        requires_foreman '>= 1.15'
+
+        # Add permissions
+        security_block :foreman_rescue do
+          permission :rescue_hosts, :'foreman_rescue/hosts' => [:rescue, :set_rescue, :cancel_rescue]
+        end
+      end
+    end
+
+    config.to_prepare do
+      begin
+        Host::Managed.send(:prepend, ForemanRescue::HostExtensions)
+        HostsHelper.send(:prepend, ForemanRescue::HostsHelperExtensions)
+        Nic::Managed.send(:prepend, ForemanRescue::Orchestration::TFTP)
+      rescue => e
+        Rails.logger.warn "ForemanRescue: skipping engine hook (#{e})"
+      end
+    end
+
+    initializer 'foreman_rescue.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_domain = 'foreman_rescue'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_rescue/version.rb

@@ -0,0 +1,3 @@
+module ForemanRescue
+  VERSION = '0.1.0'.freeze
+end

data/lib/tasks/foreman_rescue_tasks.rake

@@ -0,0 +1,37 @@
+require 'rake/testtask'
+
+# Tests
+namespace :test do
+  desc 'Test ForemanRescue'
+  Rake::TestTask.new(:foreman_rescue) 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_rescue do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_rescue) do |task|
+        task.patterns = ["#{ForemanRescue::Engine.root}/app/**/*.rb",
+                         "#{ForemanRescue::Engine.root}/lib/**/*.rb",
+                         "#{ForemanRescue::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_rescue'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_rescue']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_rescue', 'foreman_rescue:rubocop']
+end