foreman_patch 1.1.6.alpha5 → 1.2.0.alpha1

data/app/models/foreman_patch/round.rb

@@ -2,8 +2,6 @@ module ForemanPatch
   class Round < ::ApplicationRecord
     include ForemanTasks::Concerns::ActionSubject
 
-    STATUSES = %w(planned pending running complete).freeze
-
     belongs_to :window, class_name: 'ForemanPatch::Window'
     has_one :cycle, class_name: 'ForemanPatch::Cycle', through: :window
     belongs_to :group, class_name: 'ForemanPatch::Group'
@@ -34,8 +32,29 @@ module ForemanPatch
     scoped_search on: :name, complete_value: true
     scoped_search on: :status, complete_value: true
 
-    def progress
-      ForemanPatch::Invocation::STATUSES.product([0]).to_h.merge(invocations.unscope(:order).group(:status).count)
+    def progress(total = nil, done = nil)
+      if invocations.empty? || done == 0
+        0
+      else
+        total ||= invocations.count
+        done ||= sub_tasks.where(result: %w(success warning error)).count
+        ((done.to_f / total) * 100).round
+      end
+    end
+
+    def progress_report
+      invocations.reduce({
+        pending: 0,
+        running: 0,
+        success: 0,
+        warning: 0,
+        failed: 0,
+        cancelled: 0,
+      }) do |report, invocation|
+        status = (invocation.status == 'planned' ? 'pending' : invocation.status)
+        report[status.to_sym] += 1
+        report
+      end
     end
 
     def finished?

data/app/models/setting/patching.rb

@@ -0,0 +1,57 @@
+class Setting::Patching < ::Setting
+  def self.default_settings
+    http_proxy_select = [{
+      name: _('Http Proxies'),
+      class: 'HttpProxy',
+      scope: 'all',
+      value_method: 'name',
+      text_method: 'name_and_url',
+    }]
+
+    time_zone_select = [{
+      name: _('Time Zones'),
+      class: 'ActiveSupport::TimeZone',
+      scope: 'all',
+      value_method: 'name',
+      text_method: 'name',
+    }]
+
+    # set(name, description, default, fullname, value, { options })
+    [
+      self.set('host_max_wait_for_up', N_("Maximum seconds to wait for a host after patching restart."),
+               600, N_("Max wait for host up")),
+      self.set('host_patch_timeout', N_("Maximum seconds for a patching invocation to run before timing out"),
+               nil, N_('Patch Timeout')),
+      self.set('patch_schedule_time_zone', N_('Time zone used to base patch window scheduling off of.'),
+               'UTC', N_('Patch Schedule Time Zone'), nil,
+               collection: proc { time_zone_select }),
+      self.set('ticket_api_host', N_('Host used for change management tickets'),
+               nil, N_('Ticket API host')),
+      self.set('ticket_api_proxy', N_('HTTP Proxy to access ticket API host'),
+               nil, N_('Ticket API HTTP proxy'), nil,
+               collection: proc { http_proxy_select }, include_blank: N_('no proxy')),
+      self.set('ticket_api_user', N_('User with access to ticket API'),
+               nil, N_('Ticket API user')),
+      self.set('ticket_api_password', N_('Password for ticket API user'),
+               nil, N_('Ticket API password'), nil, { encrypted: true }),
+      self.set('ticket_api_path', N_('Ticket API path for REST/CRUD operations'),
+               '/api/now/table/change_request', N_('Ticket API path')),
+      self.set('ticket_web_ui_path', N_('Path for opening a ticket in the web UI'),
+               '/change_request.do?sys_id=:id', N_('Ticket Web UI path')),
+      self.set('ticket_label_field', N_('Name of the field used for the ticket label'),
+               'number', N_('Ticket label field')),
+      self.set('ticket_id_field', N_('Name of the field used for the ticket id'),
+               'sys_id', N_('Ticket ID field')),
+      self.set('skip_broken_patches', N_('Skip broken dependencies during patching'), true, N_('Skip broken patches'))
+    ]
+  end
+
+  def self.humanized_category
+    N_('Patching')
+  end
+
+  def self.load_defaults
+    BLANK_ATTRS.concat %w(ticket_api_host ticket_api_proxy ticket_api_user ticket_api_password, host_patch_timeout)
+    super
+  end
+end

data/app/services/foreman_patch/ticket/api.rb

@@ -57,8 +57,7 @@ module ForemanPatch
 
         @response = JSON.parse(raw)
       rescue RestClient::ExceptionWithResponse => error
-        @errors = JSON.parse(error.response)
-        Rails.logger.error(error)
+        Rails.logger.error(error.response)
       rescue => error
         Rails.logger.error(error)
       end

data/app/views/foreman_patch/api/v2/invocations/base.json.rabl

@@ -1,6 +1,6 @@
 object @invocation
 
-attributes :id, :round_id, :task_id, :host_id, :status
+attributes :id, :round_id, :task_id, :host_id, :state, :result, :status
 
 node(:name) { |inv| inv.host.name }
 

data/app/views/foreman_patch/api/v2/invocations/phase.json.rabl

@@ -0,0 +1,7 @@
+object @phase
+
+attribute :label, :humanized_name, :exit_status
+
+node do |phase|
+  { live_output: normalize_line_sets(phase.live_output) }
+end

data/app/views/foreman_patch/api/v2/invocations/show.json.rabl

@@ -2,6 +2,6 @@ object @invocation
 
 extends 'foreman_patch/api/v2/invocations/base'
 
-child events: :events do
-  extends 'foreman_patch/api/v2/invocations/event'
+child phases: :phases do
+  extends 'foreman_patch/api/v2/invocations/phase'
 end

data/app/views/foreman_patch/api/v2/rounds/base.json.rabl

@@ -1,3 +1,3 @@
 object @round
 
-attributes :id, :name, :description, :window_id, :group_id, :max_unavailable, :priority, :status
+attributes :id, :name, :description, :window_id, :group_id, :max_unavailable, :priority

data/app/views/foreman_patch/api/v2/rounds/status.json.rabl

@@ -1,5 +1,11 @@
 object @round
 
-extends 'foreman_patch/api/v2/rounds/base'
+attribute :id
 
-attribute :progress
+node :complete do
+  @round.finished?
+end
+
+node :progress do
+  @round.progress_report
+end

data/app/views/foreman_patch/groups/index.html.erb

@@ -22,7 +22,7 @@
           <%= group.label %>
         </td>
         <td class="hidden-xs ellipsis">
-          <%= group.default_window_plan.name %>
+          <%= group.default_window_plan&.name %>
         </td>
         <td class="hidden-xs">
           <%= link_to group.hosts.count, main_app.hosts_path(search: %Q[patch_group = "#{group.name}"]) %>

data/app/views/foreman_patch/invocations/show.html.erb

@@ -11,9 +11,34 @@ breadcrumbs(resource_url: api_round_invocations_path(@round.id),
             items: items)
 %>
 
+<% stylesheet 'foreman_remote_execution/foreman_remote_execution' %>
+<% javascript 'foreman_remote_execution/template_invocation' %>
+
 <%=
   title_actions(link_to(_('Back to Group'), round_path(@round), class: 'btn btn-default'),
+                button_group(link_to_function(_('Toggle STDERR'), '$("div.line.stderr").toggle()', class: 'btn btn-default'),
+                             link_to_function(_('Toggle STDOUT'), '$("div.line.stdout").toggle()', class: 'btn btn-default'),
+                             link_to_function(_('Toggle DEBUG'), '$("div.line.debug").toggle()', class: 'btn btn-default')),
                 button_group(invocation_task_buttons(@invocation.task, @invocation)))
 %>
 
-<%= react_component('Invocation', id: @round.id) %>
+<ul class="nav nav-tabs" data="tabs">
+  <li class="active"><a href="#primary" data-toggle="tab"><%= _('Primary') %></a></li>
+  <% @invocation.phases.each do |phase| %>
+    <li><a href="#<%= phase.class.name.demodulize.underscore %>" data-toggle="tab"><%= phase.humanized_name.titlecase %></a></li>
+  <% end %>
+</ul>
+
+<div class="tab-content">
+  <div class="tab-pane active" id="primary">
+    <%= render partial: 'primary' %>
+  </div>
+
+  <% @invocation.phases.each do |phase| %>
+    <%= render partial: 'phase', locals: { phase: phase } %>
+  <% end %>
+</div>
+
+<script>
+  <%= render partial: 'refresh.js' %>
+</script>

data/app/views/foreman_patch/layouts/react.html.erb

@@ -12,6 +12,6 @@
   <div id="user-id" data-id="<%= User.current.id if User.current %>"></div>
   <%= react_component('ForemanPatch') %>
 <% end %>
-<%= render template: "layouts/base" %>
+<%= render file: "layouts/base" %>
 
 

data/app/views/templates/ensure_services.erb

@@ -7,20 +7,17 @@ feature: ensure_services
 provider_type: SSH
 %>
 <% if @host.operatingsystem.family == "Redhat" && @host.operatingsystem.major.to_i > 6 %>
-while true; do
-  state=$(systemctl is-system-running)
+state=$(systemctl is-system-running)
+while [ $? -ne 0 ]; do
   case $state in
     initializing | starting)
       sleep 5
+      state=$(systemctl is-system-running)
       ;;
     maintenance | stopping | offline)
-      echo "System is $state"
+      echo $state
       exit 1
       ;;
-    running)
-      echo "All services running."
-      exit 0
-      ;;
     *)
       systemctl list-units --failed
       exit 1

data/config/api_routes.rb

@@ -1,41 +1,37 @@
 ForemanPatch::Engine.routes.draw do
-  namespace :api, defaults: { format: 'json' } do
-    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
-      resources :plans, only: [:index, :show, :create, :update, :destroy] do
-        resources :window_plans, only: [:index, :create]
-        resources :cycles, only: [:index, :create]
-      end
+  scope :foreman_patch, path: '/foreman_patch' do
+    namespace :api do
+      scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
+        resources :plans, only: [:index, :show, :create, :update, :destroy] do
+          resources :window_plans, only: [:index, :create]
+          resources :cycles, only: [:index, :create]
+        end
 
-      resources :window_plans, only: [:index, :show, :update, :destroy]
+        resources :window_plans, only: [:index, :show, :update, :destroy]
 
-      resources :cycles, only: [:index, :create, :show, :update, :destroy] do
-        resources :windows, only: [:index, :create]
-      end
-
-      resources :windows, only: [:show, :update, :destroy] do
-        resources :rounds, only: [:index]
-        member do
-          post :schedule
+        resources :cycles, only: [:index, :create, :show, :update, :destroy] do
+          resources :windows, only: [:index, :create]
         end
-      end
 
-      resources :groups, only: [:index, :show, :create, :update, :destroy]
+        resources :windows, only: [:show, :update, :destroy] do
+          resources :rounds, only: [:index]
+          member do
+            post :schedule
+          end
+        end
 
-      resources :rounds, only: [:show, :create, :update, :destroy] do
-        resources :invocations, only: [:index]
+        resources :groups, only: [:index, :show, :create, :update, :destroy]
 
-        member do
-          get :status
+        resources :rounds, only: [:show, :create, :update, :destroy] do
+          resources :invocations, only: [:index]
+          member do
+            get :status
+          end
         end
-      end
 
-      resources :invocations, only: [:show] do
-        collection do
-          put 'move'
-          put 'cancel'
-        end
-      end
+        resources :invocations, only: [:show]
 
+      end
     end
   end
 end

data/config/routes/mount_engine.rb

@@ -0,0 +1,3 @@
+Foreman::Application.routes.draw do
+  mount ForemanPatch::Engine, at: '/', as: 'foreman_patch'
+end

data/config/routes/overrides.rb

@@ -0,0 +1,10 @@
+Foreman::Application.routes.draw do
+  
+  resources :hosts, only: [] do
+    collection do
+      post 'select_multiple_patch_group'
+      post 'update_multiple_patch_group'
+    end
+  end
+
+end

data/config/routes.rb

@@ -1,58 +1,47 @@
 ForemanPatch::Engine.routes.draw do
-  resources :groups, only: [:index, :new, :create, :edit, :update, :destroy] do
-    collection do
-      get 'auto_complete_search'
+  scope :foreman_patch, path: '/foreman_patch' do
+    resources :groups, only: [:index, :new, :create, :edit, :update, :destroy] do
+      collection do
+        get 'auto_complete_search'
+      end
     end
-  end
 
-  resources :cycles, only: [:index, :show, :destroy] do
-    collection do
-      get 'auto_complete_search'
-    end
+    resources :cycles, only: [:index, :show, :destroy] do
+      collection do
+        get 'auto_complete_search'
+      end
 
-    resources :windows, only: [:new, :create]
-  end
+      resources :windows, only: [:new, :create]
+    end
 
-  resources :windows, only: [:show, :destroy]
+    resources :windows, only: [:show, :destroy]
 
-  resources :rounds, only: [:show] do
-    collection do
-      get 'auto_complete_search'
+    resources :rounds, only: [:show] do
+      collection do
+        get 'auto_complete_search'
+      end
     end
-  end
 
-  resources :invocations, only: [:show, :destroy] do
-    collection do
-      get 'auto_complete_search'
+    resources :invocations, only: [:show, :destroy] do
+      collection do
+        get 'auto_complete_search'
+      end
     end
-  end
 
-  resources :plans, only: [:index, :new, :create, :show, :edit, :update, :destroy] do
-    resources :window_plans, only: [:new, :create]
-    member do
-      post :iterate
+    resources :plans, only: [:index, :new, :create, :show, :edit, :update, :destroy] do
+      resources :window_plans, only: [:new, :create]
+      member do
+        post :iterate
+      end
     end
-  end
 
-  resources :window_plans, only: [:edit, :update, :destroy]
+    resources :window_plans, only: [:edit, :update, :destroy]
 
-  resources :ticket_fields, except: [:show] do
-    resources :lookup_values, only: [:index, :create, :update, :destroy]
-    collection do
-      get 'auto_complete_search'
-    end
-  end
-
-  constraints(id: %r{[^/]+}) do
-    resources :hosts, only: [], controller: '/hosts' do
+    resources :ticket_fields, except: [:show] do
+      resources :lookup_values, only: [:index, :create, :update, :destroy]
       collection do
-        post 'select_multiple_patch_group'
-        post 'update_multiple_patch_group'
+        get 'auto_complete_search'
       end
     end
   end
 end
-
-Foreman::Application.routes.draw do
-  mount ForemanPatch::Engine, at: '/foreman_patch'
-end

data/db/seeds.d/100-assign_features_with_templates.rb

@@ -1,10 +1,16 @@
 User.as_anonymous_admin do
-  JobTemplate.without_auditing do
-    module_template = JobTemplate.find_by(name: 'Power Action - SSH Default')
-    if module_template && !Rails.env.test? && Setting[:remote_execution_sync_templates]
-      module_template.sync_feature('power_action')
-      module_template.organizations << Organization.unscoped.all if module_template.organizations.empty?
-      module_template.locations << Location.unscoped.all if module_template.locations.empty?
+  RemoteExecutionFeature.without_auditing do
+    if Rails.env.test? || Foreman.in_rake?
+      ForemanPatch.register_rex_features
+    end
+
+    JobTemplate.without_auditing do
+      module_template = JobTemplate.find_by(name: 'Power Action - SSH Default')
+      if module_template && !Rails.env.test? && Setting[:remote_execution_sync_templates]
+        module_template.sync_feature('power_action')
+        module_template.organizations << Organization.unscoped.all if module_template.organizations.empty?
+        module_template.locations << Location.unscoped.all if module_template.locations.empty?
+      end
     end
   end
 end

data/lib/foreman_patch/engine.rb

@@ -1,9 +1,15 @@
 module ForemanPatch
   class Engine < ::Rails::Engine
-    isolate_namespace ForemanPatch
     engine_name 'foreman_patch'
+    isolate_namespace ForemanPatch
 
-    config.paths['config/routes.rb'].unshift('config/api_routes.rb')
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+
+    initializer 'foreman_patch.configure_assets', group: :assets do
+      SETTINGS[:foreman_patch] = { assets: { precompile: ['foreman_patch.css'] } }
+    end
 
     # Add any db migrations
     initializer 'foreman_patch.load_app_instance_data' do |app|
@@ -12,29 +18,40 @@ module ForemanPatch
       end
     end
 
-    initializer 'foreman_patch.register_plugin', before: :finisher_hook, after: 'katello.register_plugin' do |_app|
-      require 'foreman_patch/register'
+    initializer 'foreman_patch.mount_engine', before: :sooner_routes_load do |app|
+      app.routes_reloader.paths << "#{ForemanPatch::Engine.root}/config/routes/mount_engine.rb"
+      app.routes_reloader.paths << "#{ForemanPatch::Engine.root}/config/api_routes.rb"
+      app.routes_reloader.paths.unshift("#{ForemanPatch::Engine.root}/config/routes/overrides.rb")
+    end
+
+    initializer 'foreman_patch.load_default_settings', before: :load_config_initializers do |_app|
+      require_dependency File.expand_path('../../../app/models/setting/patching.rb', __FILE__)
+    end
+
+    initializer 'foreman_patch.require_dynflow', before: 'foreman_tasks.initialize_dynflow' do |_app|
+      ::ForemanTasks.dynflow.require!
+      ::ForemanTasks.dynflow.config.eager_load_paths << File.join(ForemanPatch::Engine.root, 'app/lib/actions/foreman_patch')
+    end
+
+    initializer 'foreman_patch.register_plugin', :before => :finisher_hook do |_app|
+      require 'foreman_patch/plugin'
       Apipie.configuration.checksum_path += ['/foreman_patch/api/']
     end
 
-    initializer 'foreman_patch.register_actions', before: :finisher_hook do |_app|
-      ForemanTasks.dynflow.require!
-      ForemanTasks.dynflow.config.eager_load_paths << File.join(ForemanPatch::Engine.root, 'app/lib/actions/foreman_patch')
-      ForemanTasks.dynflow.eager_load_actions!
+    initializer 'foreman_patch.helpers' do |_app|
+      ActionView::Base.include ForemanPatch::HostsHelper
     end
 
     # Include concerns in this config.to_prepare block
     config.to_prepare do
       # Model extensions
-      ::Host::Managed.include ForemanPatch::Concerns::HostManagedExtensions
+      ::Host::Managed.send(:include, ForemanPatch::Concerns::HostManagedExtensions)
 
       # Controller extensions      
       ::HostsController.include ForemanPatch::Concerns::HostsControllerExtensions
 
       # Api Controller extensions
       ::Api::V2::HostsController.include ForemanPatch::Concerns::Api::V2::HostsControllerExtensions
-    rescue => e
-      Rails.logger.warn "ForemanPatch: skipping engine hook (#{e})"
     end
 
     rake_tasks do
@@ -49,4 +66,22 @@ module ForemanPatch
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
   end
+
+  def self.table_name_prefix
+    'foreman_patch_'
+  end
+
+  def self.use_relative_model_naming
+    true
+  end
+
+  def self.register_rex_features
+    RemoteExecutionFeature.register(
+      :power_action,
+      N_('Power Action'),
+      description: N_('Power Action'),
+      provided_inputs: 'action',
+      host_action_button: false
+    )
+  end
 end

data/lib/foreman_patch/plugin.rb

@@ -0,0 +1,47 @@
+Foreman::Plugin.register :foreman_patch do
+  requires_foreman '>= 2.1'
+
+  apipie_documented_controllers(["#{ForemanPatch::Engine.root}/app/controllers/foreman_patch/api/v2/*.rb"])
+
+  register_facet ForemanPatch::Host::GroupFacet, :group_facet do
+    api_view list: 'foreman_patch/api/v2/group_facet/base_with_root', single: 'foreman_patch/api/v2/group_facet/show'
+    api_docs :group_facet_attributes, ::ForemanPatch::Api::V2::HostGroupsController
+    extend_model ForemanPatch::Concerns::GroupFacetHostExtensions
+    set_dependent_action :destroy
+  end
+
+  # Add permissions
+  security_block :foreman_patch do
+  end
+
+  divider :top_menu, caption: N_('Patching'), parent: :content_menu
+  menu :top_menu, :groups,
+    caption: N_('Groups'),
+    engine: ForemanPatch::Engine,
+    parent: :content_menu
+
+  menu :top_menu, :cycles,
+    caption: N_('Cycles'),
+    engine: ForemanPatch::Engine,
+    parent: :content_menu
+
+  menu :top_menu, :plans,
+    caption: N_('Plans'),
+    engine: ForemanPatch::Engine,
+    parent: :content_menu
+
+  menu :top_menu, :ticket_fields,
+    caption: N_('Ticket Fields'),
+    engine: ForemanPatch::Engine,
+    parent: :content_menu
+
+  parameter_filter ::Host::Managed, :group_facet_attributes => [:group_id]
+
+  describe_host do
+    multiple_actions_provider :patch_host_multiple_actions
+    overview_fields_provider :patch_host_overview_fields
+  end
+
+  RemoteExecutionFeature.register(:power_action, N_("Power Action"), description: N_("Power Action"), provided_inputs: ['action'])
+  RemoteExecutionFeature.register(:ensure_services, N_("Ensure Services"), description: N_("Ensure Services are running"))
+end

data/lib/foreman_patch/version.rb

@@ -1,3 +1,3 @@
 module ForemanPatch
-  VERSION = '1.1.6.alpha5'.freeze
+  VERSION = '1.2.0.alpha1'.freeze
 end

data/lib/foreman_patch.rb

@@ -1,5 +1,4 @@
-module ForemanPatch
-end
-
 require 'foreman_patch/engine'
 
+module ForemanPatch
+end

data/locale/en/foreman_patch.po

@@ -5,7 +5,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_patch 0.0.1\n"
+"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"

data/locale/foreman_patch.pot

@@ -5,7 +5,7 @@
 #, fuzzy
 msgid ""
 msgstr ""
-"Project-Id-Version: foreman_patch 0.0.1\n"
+"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"

data/locale/gemspec.rb

@@ -1,2 +1,2 @@
 # Matches foreman_patch.gemspec
-_("Foreman Plugin for Managing Patching.")
+_('TODO: Description of ForemanPatch.')