foreman_remote_execution 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85fa812b15aa151cf2a16622d6f8a948fa112042
-  data.tar.gz: 530bbbd4c60e53d39fa6d6610f613e95a4d6f84c
+  metadata.gz: 42b3d239b3161263e650d3d6d6dba548e732145b
+  data.tar.gz: aeadb8c264c040867f45d224fc87724f056976db
 SHA512:
-  metadata.gz: fe774b17034cecef1ccb880aaa46f1874ac81b0fca7c955a5f6c3e0ecf80782d56e2b5583a67d7df873f3420e679af6a3577243e9aa28d8868efcb8a9f57b0a3
-  data.tar.gz: d9cdabe2fe9e1ab6c8780b80131b3eed503fcc80994c0c8b1a40e2a342587af9542942718ac892d7c88d881495a2759e1933b7394df7845f3b4b4ea83a46db6d
+  metadata.gz: 4b507b186ef9ba52d7612e2843fed86c268bb9dda737e6c8e029a7c9a1046b45caf5495d7e65ed35ce4f9e4a1b8fc2fc9c33ae9763684b5a77e60b61fb69a9ae
+  data.tar.gz: 0b7dbd1acb92629cf67f3a4a80f87ba7280f832196efaf471f60d50b278d9823e6da9907991b25552304bf78608305c84c048162d9ae56df8bbb68da9caa2078

data/.gitignore

@@ -9,4 +9,6 @@ test/dummy/tmp/
 test/dummy/.sass-cache
 locale/*.mo
 locale/*/*.pox
+locale/*/*.edit.po
+locale/*/*.po.time_stamp
 Gemfile.lock

data/.rubocop.yml

@@ -3,6 +3,13 @@ inherit_from:
 
 AllCops:
   RunRailsCops: true # always run the rails cops
+  Exclude:
+    - 'doc/plugins/**'
+
+# TODO: uncomment when on rubocop 0.35.1
+#Rails/Date:
+  #Exclude:
+    #- foreman_remote_execution.gemspec
 
 # Don't enforce documentation
 Style/Documentation:

data/.rubocop_todo.yml

@@ -54,11 +54,6 @@ Style/AndOr:
 Style/BarePercentLiterals:
   Enabled: false
 
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/Blocks:
-  Enabled: false
-
 # Offense count: 1
 # Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
 Style/CaseIndentation:
@@ -200,3 +195,19 @@ Style/SpaceInsideHashLiteralBraces:
 # Configuration parameters: IgnoredMethods.
 Style/SymbolProc:
   Enabled: false
+
+# TODO: uncomment when on rubocop 0.35.1
+#Rails/FindBy:
+  #Enabled: false # rails 4
+
+# TODO: uncomment when on rubocop 0.35.1
+#Style/UnneededPercentQ:
+  #Enabled: false
+
+# TODO: uncomment when on rubocop 0.35.1
+#Lint/EndAlignment:
+  #Enabled: false
+
+# TODO: uncomment when on rubocop 0.35.1
+#Metrics/ModuleLength:
+  #Enabled: false

data/.tx/config

@@ -2,7 +2,7 @@
 host = https://www.transifex.com
 
 [foreman.foreman_remote_execution]
-file_filter = locale/<lang>/foreman_remote_execution.po
+file_filter = locale/<lang>/foreman_remote_execution.edit.po
 source_file = locale/foreman_remote_execution.pot
 source_lang = en
 type = PO

data/app/assets/javascripts/template_invocation.js

@@ -74,6 +74,19 @@ function job_invocation_form_binds() {
   $('textarea#targeting_search_query').on('change', refresh_execution_form);
 
   $('select#targeting_bookmark_id').on('change', refresh_search_query);
+
+  $('a.advanced_fields_switch').on('click', toggle_advanced_fields )
+}
+
+function toggle_advanced_fields() {
+  switcher = $('a.advanced_fields_switch');
+  original = switcher.html();
+  switcher.html(switcher.data('alternativeLabel'));
+  switcher.data('alternativeLabel', original);
+
+  switcher.siblings('i').toggleClass('fa-angle-right').toggleClass('fa-angle-down');
+
+  $('div.advanced').toggle()
 }
 
 function delayed_refresh(url, data){
@@ -83,7 +96,7 @@ function delayed_refresh(url, data){
         url: url,
         data: data,
         dataType: "script",
-        error: function() { $("div.terminal div.printable").append(__('<div class="line error">There was an error while updating the status, try <a href="javascript:window.location.href=window.location.href">refreshing</a> the page</div>')) }
+        error: function() { $("div.terminal div.printable").append('<div class="line error">' + __('There was an error while updating the status, try refreshing the page.') + '</div>'); }
       }
     )
   }, 1000);

data/app/assets/stylesheets/job_invocations.css.scss

@@ -20,16 +20,3 @@ div.infoblock {
     }
   }
 }
-
-// chances are that these will be present in Foreman 1.10
-.status-ok {
-  color: #5CB85C;
-}
-
-.status-error {
-  color: #D9534F
-}
-
-.status-warn, .status-question {
-  color: #DB843D;
-}

data/app/assets/stylesheets/template_invocation.css.scss

@@ -19,27 +19,21 @@ div.terminal {
   display: block;
   padding: 9.5px;
   margin: 0 0 10px;
-  font-size: 13px;
-  line-height: 1.428571429;
+  font-size: 12px;
   word-break: break-all;
   word-wrap: break-word;
-  color: #B2B2B2;
-  background-color: #000000;
+  color: rgba(255, 255, 255, 1);
+  background-color: rgba(47, 47, 47, 1);
   border: 1px solid #000000;
-  border-radius: 4px;
-  font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
+  border-radius: 0px;
+  font-family: Menlo, Monaco, Consolas, monospace;
 
   div.printable {
     min-height: 50px;
   }
 
-  div.line.error, div.line.debug {
-    color: #a9302a;
-  }
-
-  div.line.stderr {
-    background-color: rgba(205, 209, 207, 0.21);
-    color: #FFFFFF;
+  div.line.stderr, div.line.error, div.line.debug {
+    color: red;
   }
 
   div.line span.counter {

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

@@ -22,7 +22,7 @@ module Api
 
       def_param_group :foreign_input_set do
         param :foreign_input_set, Hash, :required => true, :action_aware => true do
-          param :target_template_id, :identifier, :required => true, :desc => N_('Target template id')
+          param :target_template_id, :identifier, :required => true, :desc => N_('Target template ID')
           param :include_all, :bool, :desc => N_('Include all inputs form the foreign template')
           param :include, String, :desc => N_('A comma separated list of input names to be included from the foreign template.')
           param :exclude, String, :desc => N_('A comma separated list of input names to be included from the foreign template.')

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

@@ -8,7 +8,7 @@ module Api
       before_filter :find_optional_nested_object
       before_filter :find_host, :only => %w{output}
       before_filter :find_resource, :only => %w{show update destroy clone}
-      before_filter :validate_templates, :only => :create
+      before_filter :validate_template, :only => :create
 
       wrap_parameters JobInvocation, :include => (JobInvocation.attribute_names + [:ssh])
 
@@ -25,8 +25,7 @@ module Api
 
       def_param_group :job_invocation do
         param :job_invocation, Hash, :required => true, :action_aware => true do
-          param :job_category, String, :required => true, :desc => N_('Job category')
-          param :job_template_id, String, :required => false, :desc => N_('If using a specific template, the id of that template.')
+          param :job_template_id, String, :required => true, :desc => N_('The job template to use')
           param :targeting_type, String, :required => true, :desc => N_('Invocation type, one of %s') % Targeting::TYPES
           param :inputs, Hash, :required => false, :desc => N_('Inputs to use')
           param :ssh, Hash, :desc => N_('SSH provider specific options') do
@@ -46,6 +45,11 @@ module Api
             param :start_before, DateTime, :required => false, :desc => N_('Indicates that the action should be cancelled if it cannot be started before this time.')
           end
 
+          param :concurrency_control, Hash, :desc => N_('Control concurrency level and distribution over time') do
+            param :time_span, Integer, :desc => N_('Distribute tasks over N seconds')
+            param :concurrency_level, Integer, :desc => N_('Run at most N tasks at a time')
+          end
+
           param :bookmark_id, Integer, :required => false
           param :search_query, Integer, :required => false
           param :description_format, String, :required => false, :desc => N_('Override the description format from the template for this invocation only')
@@ -56,10 +60,8 @@ module Api
       param_group :job_invocation, :as => :create
       def create
         composer = JobInvocationComposer.from_api_params(job_invocation_params)
-        composer.save!
+        composer.trigger!
         @job_invocation = composer.job_invocation
-        @job_invocation.generate_description! if @job_invocation.description.blank?
-        composer.triggering.trigger(::Actions::RemoteExecution::RunHostsJob, @job_invocation)
         process_response @job_invocation
       end
 
@@ -99,18 +101,10 @@ module Api
         not_found({ :error => { :message => (_("Host with id '%{id}' was not found") % { :id => params['host_id'] }) } })
       end
 
-      def validate_templates
-        templates = []
-        if job_invocation_params[:job_template_id]
-          templates << JobTemplate.find(job_invocation_params[:job_template_id])
-        else
-          templates = JobTemplate.where(:job_category => job_invocation_params[:job_category])
-          if templates.pluck(:provider_type).uniq.length != templates.length
-            raise Foreman::Exception, _('Duplicate remote execution providers found for specified Job, please specify a single job_template_id.')
-          end
-        end
-
-        raise Foreman::Exception, _('No templates associated with specified Job Name') if templates.empty?
+      def validate_template
+        JobTemplate.authorized(:view_job_templates).find(job_invocation_params['job_template_id'])
+      rescue ActiveRecord::RecordNotFound
+        not_found({ :error => { :message => (_("Template with id '%{id}' was not found") % { :id => job_invocation_params['job_template_id'] }) } })
       end
 
       def job_invocation_params

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

@@ -0,0 +1,38 @@
+module Api
+  module V2
+    class RemoteExecutionFeaturesController < ::Api::V2::BaseController
+      include ::Api::Version2
+
+      before_filter :find_resource, :only => %w{show update}
+
+      api :GET, '/remote_execution_features/', N_('List remote execution features')
+      def index
+        @remote_execution_features = resource_scope
+      end
+
+      api :GET, '/remote_execution_features/:id', N_('Show remote execution feature')
+      param :id, :identifier, :required => true
+      def show
+      end
+
+      def_param_group :remote_execution_feature do
+        param :remote_execution_feature, Hash, :required => true, :action_aware => true do
+          param :job_template_id, :identifier, :required => true, :desc => N_('Job template ID to be used for the feature')
+        end
+      end
+
+      api :PUT, '/remote_execution_features/:id', N_('Update a job template')
+      param :id, :identifier, :required => true
+      param_group :remote_execution_feature
+      def update
+        process_response @remote_execution_feature.update_attributes(params[:remote_execution_feature])
+      end
+
+      private
+
+      def parent_scope
+        resource_class.where(nil)
+      end
+    end
+  end
+end

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

@@ -26,6 +26,7 @@ module Api
           param :name, String, :required => true, :desc => N_('Input name')
           param :description, String, :required => false, :desc => N_('Input description')
           param :required, :bool, :allow_nil => true, :desc => N_('Input is required')
+          param :advanced, :bool, :allow_nil => true, :desc => N_('Input is advanced')
           param :input_type, TemplateInput::TYPES.keys.map(&:to_s), :required => true, :desc => N_('Input type')
           param :fact_name, String, :required => false, :desc => N_('Fact name, used when input type is fact')
           param :variable_name, String, :required => false, :desc => N_('Variable name, used when input type is variable')

data/app/controllers/job_invocations_controller.rb

@@ -1,8 +1,6 @@
 class JobInvocationsController < ApplicationController
   include Foreman::Controller::AutoCompleteSearch
 
-  before_filter :find_or_create_triggering, :only => [:create, :refresh]
-
   def new
     ui_params = {
       :host_ids => params[:host_ids],
@@ -27,10 +25,9 @@ class JobInvocationsController < ApplicationController
   def rerun
     job_invocation = resource_base.find(params[:id])
     @composer = JobInvocationComposer.from_job_invocation(job_invocation)
-
     if params[:failed_only]
       host_ids = job_invocation.failed_host_ids
-      @composer.search_query = @composer.targeting.build_query_from_hosts(host_ids)
+      @composer.search_query = Targeting.build_query_from_hosts(host_ids)
     end
 
     render :action => 'new'
@@ -38,11 +35,8 @@ class JobInvocationsController < ApplicationController
 
   def create
     @composer = JobInvocationComposer.from_ui_params(params)
-    if @composer.save
-      job_invocation = @composer.job_invocation
-      job_invocation.generate_description! if job_invocation.description.blank?
-      @composer.triggering.trigger(::Actions::RemoteExecution::RunHostsJob, job_invocation)
-      redirect_to job_invocation_path(job_invocation)
+    if @composer.trigger
+      redirect_to job_invocation_path(@composer.job_invocation)
     else
       @composer.job_invocation.description_format = nil if params[:job_invocation].key?(:description_override)
       render :action => 'new'
@@ -79,10 +73,6 @@ class JobInvocationsController < ApplicationController
 
   private
 
-  def find_or_create_triggering
-    @triggering ||= ::ForemanTasks::Triggering.new_from_params(params[:triggering])
-  end
-
   def action_permission
     case params[:action]
       when 'rerun'

data/app/controllers/job_templates_controller.rb

@@ -20,7 +20,7 @@ class JobTemplatesController < ::TemplatesController
     if (output = renderer.preview)
       render :text => output
     else
-      render :status => 406, :text => renderer.error_message + _(', note that you must save template input changes before you try to preview it.')
+      render :status => 406, :text => _('Problem with previewing the template: %{error}. Note that you must save template input changes before you try to preview it.' % {:error => renderer.error_message})
     end
   end
 

data/app/controllers/remote_execution_features_controller.rb

@@ -0,0 +1,19 @@
+class RemoteExecutionFeaturesController < ::ApplicationController
+  before_filter :find_resource, :only => [:show, :update]
+
+  def index
+    @remote_execution_features = resource_base.all
+  end
+
+  def show
+  end
+
+  def update
+    if @remote_execution_feature.update_attributes(params[:remote_execution_feature])
+      process_success :object => @remote_execution_feature
+    else
+      process_error :object => @remote_execution_feature
+    end
+  end
+
+end

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

@@ -5,36 +5,15 @@ module ForemanRemoteExecution
     included do
       alias_method_chain(:host_title_actions, :run_button)
       alias_method_chain :multiple_actions, :remote_execution
-      alias_method_chain :multiple_actions_select, :remote_execution
     end
 
     def multiple_actions_with_remote_execution
-      # The modal window loads empty page, we hook the custom function
-      # to the link later. The ?run_job=true is there just to be able to identify the link
-      multiple_actions_without_remote_execution + [[_('Run Job'), 'blank.html?run_job=true']]
+      multiple_actions_without_remote_execution + [[_('Run Job'), new_job_invocation_path, false]]
     end
 
     def host_title_actions_with_run_button(*args)
       title_actions(button_group(link_to(_('Run Job'), new_job_invocation_path(:host_ids => [args.first.id]), :id => :run_button)))
       host_title_actions_without_run_button(*args)
     end
-
-    def multiple_actions_select_with_remote_execution(*args)
-      # TODO: awful hack to open the job invocation form as a new
-      # page rather than using the AJAX inside a modal window.
-      # Since we want for this plugin to be compatible with 1.9, we
-      # need to monkey patch/js hack for now, but it should be removed
-      # after we fix and release http://projects.theforeman.org/issues/11309
-      multiple_actions_select_without_remote_execution(*args) +
-          <<-JAVASCRIPT.html_safe
-      <script>
-      $(function () {
-        $("#submit_multiple a[onclick*='blank.html?run_job=true']").click(function (e) {
-          document.location = "#{new_job_invocation_path}?" + $.param({host_ids: $.foremanSelectedHosts});
-        })
-      })
-      </script>
-      JAVASCRIPT
-    end
   end
 end

data/app/helpers/remote_execution_helper.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Metrics/ModuleLength
 module RemoteExecutionHelper
   def providers_options
     RemoteExecutionProvider.providers.map { |key, provider| [ key, _(provider) ] }
@@ -34,7 +35,7 @@ module RemoteExecutionHelper
       when HostStatus::ExecutionStatus::QUEUED
         _('queued')
       when HostStatus::ExecutionStatus::RUNNING
-        _('running %s%') % invocation.progress
+        _('running %{percent}%') % {:percent => invocation.progress}
       when HostStatus::ExecutionStatus::OK
         _('succeeded')
       when HostStatus::ExecutionStatus::ERROR
@@ -60,19 +61,19 @@ module RemoteExecutionHelper
 
   def template_invocation_status(task)
     if task.nil?
-      content_tag(:i, '&nbsp'.html_safe, :class => 'glyphicon glyphicon-question-sign') + content_tag(:span, _('N/A'))
+      icon_text('question', 'N/A', :kind => 'fa')
     else
       case task.result
         when 'warning', 'error'
           if task_cancelled?(task)
-            content_tag(:i, '&nbsp'.html_safe, :class => 'glyphicon glyphicon-warning-sign') + content_tag(:span, _('cancelled'), :class => 'status-error')
+            icon_text('warning-triangle-o', _('cancelled'), :kind => 'pficon')
           else
-            content_tag(:i, '&nbsp'.html_safe, :class => 'glyphicon glyphicon-exclamation-sign') + content_tag(:span, _('failed'), :class => 'status-error')
+            icon_text('error-circle-o', _('failed'), :kind => 'pficon')
           end
         when 'success'
-          content_tag(:i, '&nbsp'.html_safe, :class => 'glyphicon glyphicon-ok-sign') + content_tag(:span, _('success'), :class => 'status-ok')
+          icon_text('ok', _('success'), :kind => 'pficon')
         when 'pending'
-          content_tag(:i, '&nbsp'.html_safe, :class => 'glyphicon glyphicon-question-sign') + content_tag(:span, _('pending'))
+          icon_text('question', _('pending'), :kind => 'fa')
         else
           task.result
       end
@@ -164,6 +165,13 @@ module RemoteExecutionHelper
     end
   end
 
+  def invocation_result(invocation, key)
+    unknown = '—'
+    result = invocation_count(invocation, :output_key => key, :unknown_string => unknown.html_safe)
+    label = key == :failed_count ? 'danger' : 'info'
+    result == unknown ? result : report_event_column(result, "label-#{label}")
+  end
+
   def preview_box(template_invocation, target)
     renderer = InputTemplateRenderer.new(template_invocation.template, target, template_invocation)
     if (preview = renderer.preview)
@@ -189,7 +197,7 @@ module RemoteExecutionHelper
     if time.nil?
       _('N/A')
     else
-      content_tag :span, (time > Time.now ? _('in %s') : _('%s ago')) % time_ago_in_words(time),
+      content_tag :span, (time > Time.now.utc ? _('in %s') : _('%s ago')) % time_ago_in_words(time),
                   { :'data-original-title' => time.try(:in_time_zone), :rel => 'twipsy' }
     end
   end
@@ -228,12 +236,22 @@ module RemoteExecutionHelper
                :value => f.object.description_format || job_template.generate_description_format,
                :rows => 2,
                :onchange => 'regenerate_description(this);',
-               :class => 'description_format',
+               :class => 'description_format advanced',
                :disabled => disabled,
                :help_inline => popover(_('Explanation'),
-                                       _('This template is used to generate the description.
-                                          Input values can be used using the syntax %{package}.
-                                          You may also include the job category and template
-                                          name using %{job_category} and %{template_name}.'))
+                                       _('This template is used to generate the description ' +
+                                         'Input values can be used using the syntax %{package}. ' +
+                                         'You may also include the job category and template ' +
+                                         'name using %{job_category} and %{template_name}.'))
+  end
+
+  def advanced_switch_f(default_text, switch_text)
+    content_tag :div, :class => 'form-group' do
+      content_tag(:div, '', :class => 'col-md-2 control-label') +
+      content_tag(:div, :class => 'col-md-4') do
+        content_tag(:i, '', :class => 'fa fa-angle-right') + ' ' +
+        link_to(default_text, '#', :class => 'advanced_fields_switch', :'data-alternative-label' => switch_text)
+      end
+    end
   end
 end