foreman_wreckingball 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc7a11036e0646a12bade27dd0103e62ded2dfebf765635f25d4183b1ef526ec
-  data.tar.gz: 6f699717b502e437359a62a220c54ae6ed9caaf2d8cc967dea5ba09646ecdd05
+  metadata.gz: 91f8e9b4e8ec69fe49517364365ff0ea5e46435998461cd967718539c9e69546
+  data.tar.gz: 444176c10728b0457d50ab41adf8a923d66d30f383bb0564e9b172973bace129
 SHA512:
-  metadata.gz: 9fd15f5abf4995dc3818c4f27d6b8e4a7de4a0a23873c705f82b8b194464fa1fb7619220533bf408d1f4c9cf1e64c71b9e523965a245cd7545d650f131707f2b
-  data.tar.gz: c836945e900b536003732099503b532504d1f298a1c59d295a73db0cc4d00d9026c4a36ab1d2f10e222f93b5f6abda2f81965aebbae6b1e2bf0a08a7c83a6cb3
+  metadata.gz: 21d17ab1949782bf8a6b0f2c0f2e5d7d4fa43d8c25d93112b3ac3e1412f16b5418357b82c05643248fff7c57671bbbe31bdfc04c11559b34db5d7351f90e6514
+  data.tar.gz: 489a9097ef263bc2e1eb4cff7d0ae695e1e53fd7462066ad8f06be48efc7aedadc5b013287198a4350f9c22908c1d99f9abe78ba46dd11bd254b8d3b9b545bd0

data/README.md

@@ -9,6 +9,7 @@ This is a plugin for Foreman that adds several VMware related status checks to y
 | >= 1.15         | ~> 0.1         |
 | >= 1.16         | ~> 1.0         |
 | >= 1.17         | ~> 2.0         |
+| >= 1.18         | ~> 3.0         |
 
 ## Installation
 

data/app/assets/javascripts/foreman_wreckingball/modal.js

@@ -0,0 +1,42 @@
+$(function() {
+  $('#confirmation-modal .secondary').click(function(){
+    $('#confirmation-modal').modal('hide');
+  });
+});
+
+function submit_modal_form() {
+  $('#confirmation-modal form').submit();
+  $('#confirmation-modal').modal('hide');
+}
+
+function show_modal(element, url) {
+  if (!url) {
+    url = $(element).attr('href');    
+  }
+  var title = $(element).attr('data-title');
+  if (title) {
+    $('#confirmation-modal .modal-title').text(title);
+  }
+  $('#confirmation-modal .modal-body')
+    .empty()
+    .append('<div class="modal-spinner spinner spinner-lg"></div>');
+  $('#confirmation-modal').modal();
+  $('#confirmation-modal .modal-body').load(url + ' #content',
+    function(response, status, xhr) {
+      $('#confirmation-modal .form-actions').remove();
+
+      var submit_button = $('#confirmation-modal button[data-action="submit"]');
+      if ($(element).attr('data-submit-class')) {
+        submit_button.attr('class', 'btn ' + $(element).attr('data-submit-class'));
+      } else {
+        submit_button.attr('class', 'btn btn-primary');
+      }
+
+      $('#confirmation-modal a[rel="popover"]').popover();
+
+      trigger_form_selector_binds('schedule_remediate_form', url);
+      $('#loading').hide();
+    });
+  return false;
+}
+

data/app/controllers/foreman_wreckingball/hosts_controller.rb

@@ -2,8 +2,9 @@
 
 module ForemanWreckingball
   class HostsController < ::HostsController
-    before_action :find_resource, :only => [:remediate]
-    before_action :find_status, :only => [:remediate]
+    include ::ForemanTasks::Concerns::Parameters::Triggering
+    before_action :find_resource, :only => [:submit_remediate, :schedule_remediate]
+    before_action :find_status, :only => [:submit_remediate, :schedule_remediate]
 
     def status_dashboard
       statuses = [
@@ -42,17 +43,35 @@ module ForemanWreckingball
       redirect_to(foreman_tasks_task_path(task.id))
     end
 
-    def remediate
+    def schedule_remediate
+      @triggering = ForemanTasks::Triggering.new(mode: :immediate)
+    end
+
+    def submit_remediate
       raise Foreman::Exception, 'VMware Status can not be remediated.' unless @status.class.respond_to?(:supports_remediate?) && @status.class.supports_remediate?
-      flash[:success] = _('Remediate VM task for %s was successfully scheduled.') % @host
       task = User.as_anonymous_admin do
-        ::ForemanTasks.async_task(@status.class.remediate_action, @host)
+        triggering = ::ForemanTasks::Triggering.new_from_params(triggering_params)
+        if triggering.future?
+          triggering.parse_start_at!
+          triggering.parse_start_before!
+        else
+          triggering.start_at ||= Time.zone.now
+        end
+
+        triggering.trigger(@status.class.remediate_action, @host)
       end
+      flash[:success] = _('Remediate VM task for %s was successfully scheduled.') % @host
       redirect_to(foreman_tasks_task_path(task.id))
     end
 
     private
 
+    def triggering_params
+      %i[triggering foreman_tasks_triggering].inject({}) do |result, param_name|
+        result.merge(self.class.triggering_params_filter.filter_params(params, parameter_filter_context, param_name))
+      end
+    end
+
     def find_status
       @status = HostStatus::Status.find_by!(:id => params[:status_id], :host_id => @host.id)
     end
@@ -63,7 +82,7 @@ module ForemanWreckingball
         'view'
       when 'refresh_status_dashboard'
         'refresh_vmware_status'
-      when 'remediate'
+      when 'schedule_remediate', 'submit_remediate'
         'remediate_vmware_status'
       else
         super

data/app/lib/actions/foreman_wreckingball/host/remediate_vmware_operatingsystem.rb

@@ -6,6 +6,11 @@ module Actions
       class RemediateVmwareOperatingsystem < Actions::EntryAction
         middleware.use Actions::Middleware::KeepCurrentUser
 
+        def delay(delay_options, host)
+          action_subject(host)
+          super(delay_options, host)
+        end
+
         def plan(host)
           action_subject(host)
           plan_self

data/app/models/foreman_wreckingball/operatingsystem_status.rb

@@ -21,6 +21,10 @@ module ForemanWreckingball
       true
     end
 
+    def self.dangerous_remediate?
+      true
+    end
+
     def self.remediate_action
       ::Actions::ForemanWreckingball::Host::RemediateVmwareOperatingsystem
     end

data/app/views/foreman_wreckingball/hosts/_status_row.html.erb

@@ -85,10 +85,9 @@
                         action_buttons(
                           display_link_if_authorized(
                             _('Remediate'),
-                            hash_for_remediate_host_path(:id => host, :status_id => host.public_send(status).id).merge(:auth_object => host, :permission => 'remediate_vmware_status_hosts'),
-                            :data => { :confirm => _('Are you sure? This might cause a service interruption.') },
-                            :method => :put,
-                            :target => :blank
+                            hash_for_schedule_remediate_host_path(:id => host, :status_id => host.public_send(status).id).merge(:auth_object => host, :permission => 'remediate_vmware_status_hosts'),
+                            :data => { :title => _('Remediate Host OS'), :submit_class => 'btn-danger' },
+                            :onclick => 'show_modal(this); return false;'
                           )
                         )
                       %>

data/app/views/foreman_wreckingball/hosts/schedule_remediate.html.erb

@@ -0,0 +1,35 @@
+<% title _('Remediate %s') % @host %>
+<% javascript 'foreman_tasks/trigger_form' %>
+<% stylesheet 'foreman_tasks/trigger_form' %>
+
+
+<% if @status.class.respond_to?(:dangerous_remediate?) && @status.class.dangerous_remediate? -%>
+<%= alert(:text => _('This will cause a service interruption.'), :class => 'alert-warning', :close => false) %>
+<% end -%>
+
+<%= form_for @triggering, :url => submit_remediate_host_path(:id => @host.id, :status_id => @status), :html => { :class => 'form-horizontal', :id => 'schedule_remediate_form' } do |f| %>
+  <%= javascript_tag do %>
+    $(function() { trigger_form_selector_binds('<%= f.options[:html][:id] %>','<%= f.object_name %>') });
+  <% end %>
+  <div class="form-group">
+    <label class="col-md-2 control-label"><%= _('Schedule') %></label>
+    <div class="col-md-8">
+      <%= fields_for :triggering, @triggering do |trigger_fields| %>
+        <%= radio_button_f trigger_fields, :mode, :class => 'trigger_mode_selector', :value => 'immediate', :text => _("Execute now") %>
+        <%= radio_button_f trigger_fields, :mode, :class => 'trigger_mode_selector', :value => 'future',    :text => _("Schedule future execution") %>
+    </div>
+  </div>
+
+  <div class="trigger_fields">
+    <%= content_tag(:fieldset, nil, :id => 'trigger_mode_future', :class => "trigger_mode_form #{'hidden' unless @triggering.future?}") do
+      safe_join([
+        text_f(f, :start_at_raw, :label => _('Start at'), :placeholder => 'YYYY-mm-dd HH:MM'),
+        text_f(f, :start_before_raw, :label => _('Start before'), :placeholder => 'YYYY-mm-dd HH:MM',
+                                     :label_help => _('Indicates that the action should be cancelled if it cannot be started before this time.'))
+      ])
+    end %>
+  </div>
+  <% end %>
+
+  <%= submit_or_cancel f, false, :cancel_path => { :controller => :'foreman_wreckingball/hosts', :action => :status_dashboard } %>
+<% end %>

data/app/views/foreman_wreckingball/hosts/status_dashboard.html.erb

@@ -1,4 +1,7 @@
 <% title _('VMware Status Overview') %>
+<% javascript 'foreman_wreckingball/modal' %>
+<% javascript 'foreman_tasks/trigger_form' %>
+<% stylesheet 'foreman_tasks/trigger_form' %>
 
 <%=
   if @newest_data
@@ -7,3 +10,11 @@
     render 'status_dashboard_empty'
   end
 %>
+<%= render :partial => 'common/modal', :locals => {
+  :id => 'confirmation-modal',
+  :title => _('Please Confirm'),
+  :buttons => [
+    button_tag(_('Cancel'), :class => 'btn btn-default', :data => { :dismiss => 'modal' }, :type => 'button'),
+    button_tag(_('Submit'), :class => 'btn btn-primary', :data => { :action => 'submit' }, :onclick => 'submit_modal_form()')
+  ]
+} %>

data/config/routes.rb

@@ -5,7 +5,8 @@ Rails.application.routes.draw do
     constraints(:id => /[^\/]+/) do
       resources :hosts, controller: 'foreman_wreckingball/hosts', only: [] do
         member do
-          put :remediate
+          get :schedule_remediate
+          post :submit_remediate
         end
         collection do
           get :status_dashboard

data/lib/foreman_wreckingball/engine.rb

@@ -25,14 +25,14 @@ module ForemanWreckingball
 
     initializer 'foreman_wreckingball.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_wreckingball do
-        requires_foreman '>= 1.17'
+        requires_foreman '>= 1.18'
 
         security_block :foreman_wreckingball do
           permission :refresh_vmware_status_hosts, {
             :'foreman_wreckingball/hosts' => [:refresh_status_dashboard]
           }, :resource_type => 'Host'
           permission :remediate_vmware_status_hosts, {
-            :'foreman_wreckingball/hosts' => [:remediate]
+            :'foreman_wreckingball/hosts' => [:schedule_remediate, :submit_remediate]
           }, :resource_type => 'Host'
         end
 

data/lib/foreman_wreckingball/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanWreckingball
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.0.0'
 end

data/test/controllers/foreman_wreckingball/hosts_controller_test.rb

@@ -34,14 +34,36 @@ module ForemanWreckingball
       end
     end
 
-    describe '#remediate' do
+    describe '#schedule_remediate' do
+      let(:host) do
+        FactoryBot.create(:host, :with_wreckingball_statuses)
+      end
+
+      test 'shows a remediation schedule page' do
+        get :schedule_remediate, params: { status_id: host.vmware_operatingsystem_status_object.id, id: host.id }, session: set_session_user
+        assert_response :success
+      end
+
+      test 'returns not found when host id is invalid' do
+        get :schedule_remediate, params: { status_id: nil, id: 'invalid' }, session: set_session_user
+        assert_response :not_found
+      end
+
+      test 'returns not found when status id is invalid' do
+        FactoryBot.create(:host, :with_wreckingball_statuses)
+        get :schedule_remediate, params: { status_id: 'invalid', id: host.id }, session: set_session_user
+        assert_response :not_found
+      end
+    end
+
+    describe '#submit_remediate' do
       let(:host) do
         FactoryBot.create(:host, :with_wreckingball_statuses)
       end
 
       test 'redirects to scheduled task' do
         ForemanTasks.expects(:async_task).returns(fake_task)
-        put :remediate, params: { status_id: host.vmware_operatingsystem_status_object.id, id: host.id }, session: set_session_user
+        post :submit_remediate, params: { status_id: host.vmware_operatingsystem_status_object.id, id: host.id }, session: set_session_user
         assert_response :redirect
         assert_includes flash[:success], 'successfully scheduled'
         assert_redirected_to foreman_tasks_task_path(123)
@@ -50,18 +72,18 @@ module ForemanWreckingball
       test 'raises error when status can not be remediated' do
         FactoryBot.create(:host, :with_wreckingball_statuses)
         assert_raises Foreman::Exception do
-          put :remediate, params: { status_id: host.vmware_tools_status_object.id, id: host.id }, session: set_session_user
+          post :submit_remediate, params: { status_id: host.vmware_tools_status_object.id, id: host.id }, session: set_session_user
         end
       end
 
       test 'returns not found when host id is invalid' do
-        put :remediate, params: { status_id: nil, id: 'invalid' }, session: set_session_user
+        post :submit_remediate, params: { status_id: nil, id: 'invalid' }, session: set_session_user
         assert_response :not_found
       end
 
       test 'returns not found when status id is invalid' do
         FactoryBot.create(:host, :with_wreckingball_statuses)
-        put :remediate, params: { status_id: 'invalid', id: host.id }, session: set_session_user
+        post :submit_remediate, params: { status_id: 'invalid', id: host.id }, session: set_session_user
         assert_response :not_found
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_wreckingball
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Timo Goebel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +62,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/javascripts/foreman_wreckingball/modal.js
 - app/controllers/foreman_wreckingball/hosts_controller.rb
 - app/helpers/concerns/foreman_wreckingball/hosts_helper_extensions.rb
 - app/jobs/update_hosts_vmware_facets.rb
@@ -90,6 +91,7 @@ files:
 - app/views/foreman_wreckingball/hosts/_status_dashboard_content.erb
 - app/views/foreman_wreckingball/hosts/_status_dashboard_empty.erb
 - app/views/foreman_wreckingball/hosts/_status_row.html.erb
+- app/views/foreman_wreckingball/hosts/schedule_remediate.html.erb
 - app/views/foreman_wreckingball/hosts/status_dashboard.html.erb
 - config/routes.rb
 - db/migrate/20171106155000_create_vmware_facets.rb