foreman_remote_execution 0.2.3 → 0.3.0

data/app/models/job_template.rb

@@ -13,13 +13,9 @@ class JobTemplate < ::Template
   audited :allow_mass_assignment => true
   has_many :audits, :as => :auditable, :class_name => Audited.audit_class.name
   has_many :all_template_invocations, :dependent => :destroy, :foreign_key => 'template_id', :class_name => 'TemplateInvocation'
-  if Rails::VERSION::MAJOR >= 4
-    has_many :template_invocations, -> { where('host_id IS NOT NULL') }, :foreign_key => 'template_id'
-    has_many :pattern_template_invocations, -> { where('host_id IS NULL') }, :foreign_key => 'template_id', :class_name => 'TemplateInvocation'
-  else
-    has_many :template_invocations, :conditions => 'host_id IS NOT NULL', :foreign_key => 'template_id'
-    has_many :pattern_template_invocations, :conditions => 'host_id IS NULL', :foreign_key => 'template_id', :class_name => 'TemplateInvocation'
-  end
+  has_many :template_invocations, -> { where('host_id IS NOT NULL') }, :foreign_key => 'template_id'
+  has_many :pattern_template_invocations, -> { where('host_id IS NULL') }, :foreign_key => 'template_id', :class_name => 'TemplateInvocation'
+  has_many :remote_execution_features, :dependent => :nullify
 
   # these can't be shared in parent class, scoped search can't handle STI properly
   # tested with scoped_search 3.2.0
@@ -41,6 +37,7 @@ class JobTemplate < ::Template
 
   validates :job_category, :presence => true, :unless => ->(job_template) { job_template.snippet }
   validates :provider_type, :presence => true
+  validates :name, :uniqueness => true
   validate :provider_type_whitelist
   validate :inputs_unchanged_when_locked, :if => ->(template) { (template.locked? || template.locked_changed?) && template.persisted? && !Foreman.in_rake? }
 
@@ -63,20 +60,31 @@ class JobTemplate < ::Template
   end
   self.table_name = 'templates'
 
-  # Import a template from ERB, with YAML metadata in the first comment
-  def self.import(template, options = {})
-    metadata = parse_metadata(template)
-    return if metadata.blank? || metadata.delete('kind') != 'job_template' || self.find_by_name(metadata['name'])
-
-    inputs = metadata.delete('template_inputs')
-
-    template = self.create(metadata.merge(:template => template.gsub(/<%\#.+?.-?%>\n?/m, '')).merge(options))
-    template.assign_taxonomies
-
-    inputs.each do |input|
-      template.template_inputs << TemplateInput.create(input)
+  # Import a template from ERB, with YAML metadata in the first comment.  It
+  # will overwrite (sync) an existing template if options[:update] is true.
+  def self.import(contents, options = {})
+    transaction do
+      metadata = parse_metadata(contents)
+      return if metadata.blank? || metadata.delete('kind') != 'job_template'
+
+      # Don't update if the template already exists, unless we're told to
+      existing = self.find_by_name(metadata['name'])
+      return if !options.delete(:update) && existing
+
+      template = existing || self.new
+      template.sync_inputs(metadata.delete('template_inputs'))
+      template.sync_foreign_input_sets(metadata.delete('foreign_input_sets'))
+      template.assign_attributes(metadata.merge(:template => contents.gsub(/<%\#.+?.-?%>\n?/m, '')).merge(options).except('feature'))
+      template.assign_taxonomies if template.new_record?
+      template.sync_feature(metadata.delete('feature'))
+
+      template
     end
+  end
 
+  def self.import!(template, options = {})
+    template = import(template, options)
+    template.save! if template
     template
   end
 
@@ -113,7 +121,7 @@ class JobTemplate < ::Template
     if description_format.blank?
       generated_description = '%{job_category}'
       unless template_inputs_with_foreign.empty?
-        inputs = template_inputs_with_foreign.map(&:name).map { |name| %Q(#{name}="%{#{name}}") }.join(' ')
+        inputs = template_inputs_with_foreign.map(&:name).map { |name| %{#{name}="%{#{name}}"} }.join(' ')
         generated_description << " with inputs #{inputs}"
       end
       generated_description
@@ -129,13 +137,60 @@ class JobTemplate < ::Template
     end
   end
 
-  private
+  def sync_inputs(inputs)
+    inputs ||= []
+    # Build a hash where keys are input names
+    inputs = inputs.inject({}) { |h, input| h.update(input['name'] => input ) }
+
+    # Sync existing inputs
+    template_inputs.each do |existing_input|
+      if inputs.include?(existing_input.name)
+        existing_input.assign_attributes(inputs.delete(existing_input.name))
+      else
+        existing_input.mark_for_destruction
+      end
+    end
+
+    # Create new inputs
+    inputs.values.each { |new_input| template_inputs.build(new_input) }
+  end
+
+  def sync_foreign_input_sets(input_sets)
+    input_sets ||= []
+
+    input_sets = input_sets.inject({}) do |h, input_set|
+      target_template = JobTemplate.find_by!(:name => input_set.delete('template'))
+      input_set['target_template_id'] = target_template.id
+      h.update(target_template.id => input_set)
+    end
+
+    # Sync existing input sets
+    foreign_input_sets.each do |existing_input_set|
+      if input_sets.include?(existing_input_set.target_template_id)
+        existing_input_set.assign_attributes(input_sets.delete(existing_input_set.target_template_id))
+      else
+        existing_input_set.mark_for_destruction
+      end
+    end
+
+    # Create new input_sets
+    input_sets.values.each { |input_set| self.foreign_input_sets.build(input_set) }
+  end
+
+  def sync_feature(feature_name)
+    if feature_name && (feature = RemoteExecutionFeature.feature(feature_name))
+      feature.job_template ||= self
+      feature.save!
+    end
+  end
 
   def self.parse_metadata(template)
     match = template.match(/<%\#(.+?).-?%>/m)
     match.nil? ? {} : YAML.load(match[1])
   end
 
+  private
+
   # we can't use standard validator, .provider_names output can change but the validator does not reflect it
   def provider_type_whitelist
     errors.add :provider_type, :uniq unless RemoteExecutionProvider.provider_names.include?(self.provider_type)
@@ -148,4 +203,4 @@ class JobTemplate < ::Template
       errors.add(:base, _('This template is locked. Please clone it to a new template to customize.'))
     end
   end
-end
+end

data/app/models/job_template_effective_user.rb

@@ -4,8 +4,6 @@ class JobTemplateEffectiveUser < ActiveRecord::Base
 
   before_validation :set_defaults
 
-  belongs_to :job_template
-
   def set_defaults
     self.overridable = true if self.overridable.nil?
     self.current_user = false if self.current_user.nil?

data/app/models/remote_execution_feature.rb

@@ -0,0 +1,34 @@
+class RemoteExecutionFeature < ActiveRecord::Base
+  attr_accessible :label, :name, :provided_input_names, :description, :job_template_id
+
+  validate :label, :name, :presence => true, :unique => true
+
+  belongs_to :job_template
+
+  extend FriendlyId
+  friendly_id :label
+
+  def provided_input_names
+    self.provided_inputs.to_s.split(',').map(&:strip)
+  end
+
+  def provided_input_names=(values)
+    self.provided_inputs = Array(values).join(',')
+  end
+
+  def self.feature(label)
+    self.find_by_label(label) || raise(::Foreman::Exception.new(N_('Unknown remote execution feature %s'), label))
+  end
+
+  def self.register(label, name, options = {})
+    return false unless RemoteExecutionFeature.table_exists?
+    options.assert_valid_keys(:provided_inputs, :description)
+    feature = self.find_by_label(label)
+    if feature.nil?
+      feature = self.create!(:label => label, :name => name, :provided_input_names => options[:provided_inputs], :description => options[:description])
+    else
+      feature.update_attributes!(:name => name, :provided_input_names => options[:provided_inputs], :description => options[:description])
+    end
+    return feature
+  end
+end

data/app/models/setting/remote_execution.rb

@@ -22,7 +22,10 @@ class Setting::RemoteExecution < Setting
                  'root'),
         self.set('remote_execution_effective_user_method',
                  N_('What command should be used to switch to the effective user. One of %s') % SSHExecutionProvider::EFFECTIVE_USER_METHODS.inspect,
-                 'sudo')
+                 'sudo'),
+        self.set('remote_execution_sync_templates',
+                 N_('Whether we should sync templates from disk when running db:seed.'),
+                 true)
       ].each { |s| self.create! s.update(:category => 'Setting::RemoteExecution') }
     end
 

data/app/models/targeting.rb

@@ -51,9 +51,9 @@ class Targeting < ActiveRecord::Base
     targeting_type == STATIC_TYPE
   end
 
-  def build_query_from_hosts(ids)
+  def self.build_query_from_hosts(ids)
     hosts = Host.where(:id => ids).all.group_by(&:id)
-    ids.map { |id| "name = #{hosts[id].first.name}" }.join(' or ')
+    hosts.map { |id, h| "name = #{h.first.name}" }.join(' or ')
   end
 
   def resolved?

data/app/models/template_input.rb

@@ -9,7 +9,7 @@ class TemplateInput < ActiveRecord::Base
 
   attr_accessible :name, :required, :input_type, :fact_name, :variable_name,
                   :puppet_class_name, :puppet_parameter_name, :description, :template_id,
-                  :options
+                  :options, :advanced
 
   belongs_to :template
   has_many :template_invocation_input_values, :dependent => :destroy
@@ -52,21 +52,25 @@ class TemplateInput < ActiveRecord::Base
     self.options.blank? ? [] : self.options.split(/\r?\n/).map(&:strip)
   end
 
+  def basic?
+    !advanced
+  end
+
   private
 
   def get_resolver(renderer)
     resolver_class = case input_type
-      when 'user'
-        UserInputResolver
-      when 'fact'
-        FactInputResolver
-      when 'variable'
-        VariableInputResolver
-      when 'puppet_parameter'
-        PuppetParameterInputResolver
-      else
-        raise "unknown template input type #{input_type.inspect}"
-      end
+                     when 'user'
+                       UserInputResolver
+                     when 'fact'
+                       FactInputResolver
+                     when 'variable'
+                       VariableInputResolver
+                     when 'puppet_parameter'
+                       PuppetParameterInputResolver
+                     else
+                       raise "unknown template input type #{input_type.inspect}"
+                     end
     resolver_class.new(self, renderer)
   end
 
@@ -139,7 +143,7 @@ class TemplateInput < ActiveRecord::Base
     private
 
     def get_fact
-      @fact ||= @renderer.host.fact_values.includes(:fact_name).where(:'fact_names.name' => @input.fact_name).first
+      @fact ||= @renderer.host.fact_values.includes(:fact_name).find_by(:'fact_names.name' => @input.fact_name)
     end
   end
 

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

@@ -0,0 +1,3 @@
+object @remote_execution_feature
+
+attributes :id, :label, :name, :description, :job_template_id, :job_template_name

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

@@ -0,0 +1,3 @@
+collection @remote_execution_features
+
+extends "api/v2/remote_execution_features/main"

data/app/views/api/v2/remote_execution_features/main.json.rabl

@@ -0,0 +1,3 @@
+object @remote_execution_feature
+
+extends "api/v2/remote_execution_features/base"

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

@@ -0,0 +1,3 @@
+object @remote_execution_feature
+
+extends "api/v2/remote_execution_features/main"

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

@@ -1,6 +1,6 @@
 <script type="text/javascript">
   $(function () {
-    regenerate_description($('.description'))
+    template_change($('select.job_template_selector'));
   });
 </script>
 
@@ -38,15 +38,59 @@
       <div class="col-md-4">
         <%= @composer.targeted_hosts_count %> <%= _('hosts') %>
         <%= button_tag(:type => 'button', :class => 'btn btn-default btn-sm', :title => _("Refresh"), :id => 'refresh_execution_form') do %>
-          <%= icon_text('refresh') %>
+          <%= icon_text('refresh', '', :kind => 'fa') %>
         <% end %>
         <%= button_tag(:type => 'button', :class => 'btn btn-default btn-sm', :title => _("Preview"), :id => 'preview_hosts') do %>
-          <%= icon_text('eye-open') %>
+          <%= icon_text('eye', '', :kind => 'fa') %>
         <% end %>
       </div>
     </div>
 
-    <div class="form-group ">
+    <% @composer.displayed_provider_types.each do |provider_type| %>
+      <fieldset id="provider_<%= provider_type %>" class="provider_form">
+        <%= f.fields_for 'providers' do |providers_fields| %>
+          <%= providers_fields.fields_for provider_type do |provider_type_fields| %>
+            <%= provider_type_fields.fields_for :job_templates do |job_templates_fields| %>
+              <% @composer.templates_for_provider(provider_type).each do |job_template| %>
+                <fieldset id="job_template_<%= job_template.id %>" class="job_template_form <%= 'hidden' if job_template != selected_templates_per_provider[provider_type] %>">
+                  <%= job_templates_fields.fields_for job_template.id.to_s do |job_template_fields| %>
+
+                    <%= job_template_fields.fields_for :input_values do |input_values_fields| %>
+                      <% inputs = job_template.template_inputs_with_foreign.select { |input| input.input_type == 'user' } %>
+                      <% inputs.select { |i| i.basic? }.each do |input| %>
+                        <%= render :partial => 'template_inputs/invocation_form', :locals => { :input_values_fields => input_values_fields, :composer => @composer, :job_template => job_template, :input => input } %>
+                      <% end %>
+
+                      <%= advanced_switch_f _('Display advanced fields'), _('Hide advanced fields') %>
+
+                      <div class="advanced hidden">
+                        <% inputs.select { |i| i.advanced? }.each do |input| %>
+                          <%= render :partial => 'template_inputs/invocation_form', :locals => { :input_values_fields => input_values_fields, :composer => @composer, :job_template => job_template, :input => input } %>
+                        <% end %>
+                      </div>
+                    <% end %>
+
+                    <div class="advanced hidden">
+                      <% if job_template.effective_user.overridable? %>
+                        <%= text_f job_template_fields, :effective_user, :label => _('Effective user'), :help_inline => N_("A user to be used for executing the script. If it differs from the SSH user, su or sudo is used to switch the accounts.") %>
+                      <% end %>
+                      <%= render :partial => 'description_fields', :locals => { :f => f, :job_template => job_template, :disabled => job_template != selected_templates_per_provider[provider_type] } %>
+                    </div>
+                  <% end %>
+                </fieldset>
+              <% end %>
+            <% end %>
+          <% end %>
+        <% end %>
+      </fieldset>
+    <% end %>
+
+    <div class="advanced hidden">
+      <%= number_f f, :concurrency_level, :label => _('Concurrency level'), :placeholder => 'N', :min => 1, :help_inline => N_("Run at most N tasks at a time") %>
+      <%= number_f f, :time_span, :label => _('Time span'), :placeholder => 'N', :min => 1, :help_inline => N_("Distribute execution over N seconds")  %>
+    </div>
+
+    <div class="form-group advanced hidden">
       <label class="col-md-2 control-label"><%= _('Type of query') %></label>
 
       <div class="col-md-4">
@@ -55,47 +99,14 @@
       </div>
 
       <span class="help-inline"><%= popover(_('Explanation'),
-                                    _("Type has impact on when is the query evaulated to hosts.<br><ul><li><b>Static</b> - evaluates just after you submit this form</li><li><b>Dynamic</b> - evaluates just before the execution is started, so if it's planed in future, targeted hosts set may change before it</li></ul>")) %>
+                                            _("Type has impact on when is the query evaulated to hosts.<br><ul><li><b>Static</b> - evaluates just after you submit this form</li><li><b>Dynamic</b> - evaluates just before the execution is started, so if it's planed in future, targeted hosts set may change before it</li></ul>")) %>
       </span>
     </div>
   <% end %>
 
-  <% @composer.displayed_provider_types.each do |provider_type| %>
-    <fieldset id="provider_<%= provider_type %>" class="provider_form">
-      <%= f.fields_for 'providers' do |providers_fields| %>
-        <%= providers_fields.fields_for provider_type do |provider_type_fields| %>
-          <%= provider_type_fields.fields_for :job_templates do |job_templates_fields| %>
-            <% @composer.templates_for_provider(provider_type).each do |job_template| %>
-              <fieldset id="job_template_<%= job_template.id %>" class="job_template_form <%= 'hidden' if job_template != selected_templates_per_provider[provider_type] %>">
-                <%= job_templates_fields.fields_for job_template.id.to_s do |job_template_fields| %>
-
-                  <%= job_template_fields.fields_for :input_values do |input_values_fields| %>
-                    <% job_template.template_inputs_with_foreign.select { |input| input.input_type == 'user' }.each do |input| %>
-                      <%= input_values_fields.fields_for input.id.to_s, @composer.template_invocation_input_value_for(job_template, input) do |input_fields| %>
-                        <% unless input.options.blank? %>
-                          <%= selectable_f input_fields, :value, input.options_array, {:include_blank => !input.required}, :require => input.required, :label => input.name, :help_inline => input.description, :id => input.name, :onchange => "regenerate_description(this);" %>
-                        <% else %>
-                          <%= textarea_f input_fields, :value, :label => input.name, :help_inline => input.description, :required => input.required, :rows => 2, :onchange => "regenerate_description(this);", :id => input.name %>
-                        <% end %>
-                      <% end %>
-                    <% end %>
-                  <% end %>
-                  <% if job_template.effective_user.overridable? %>
-                    <%= text_f job_template_fields, :effective_user, :label => _('Effective user'), :help_inline => N_("A user to be used for executing the script. If it differs from the SSH user, su or sudo is used to switch the accounts.") %>
-                  <% end %>
-                  <%= render :partial => 'description_fields', :locals => { :f => f, :job_template => job_template, :disabled => job_template != selected_templates_per_provider[provider_type] } %>
-                <% end %>
-              </fieldset>
-            <% end %>
-          <% end %>
-        <% end %>
-      <% end %>
-    </fieldset>
-  <% end %>
-
   <%= trigger_selector f, @composer.triggering %>
-  <%= render :partial => 'preview_hosts_modal' %>
 
+  <%= render :partial => 'preview_hosts_modal' %>
 
-  <%= submit_or_cancel f %>
+  <%= submit_or_cancel f, false, :cancel_path => job_invocations_path %>
 <% end %>

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

@@ -11,7 +11,7 @@
     <% end -%>
 
     <% if @additional > 0 -%>
-        <li><%= link_to(_("...and %{count} more" % {:count => @additional}), hosts_path(:search => @query, :page => 2), :target => '_blank') %></li>
+        <li><%= link_to(n_('...and %{count} more', '...and %{count} more', @additional) % {:count => @additional}, hosts_path(:search => @query, :page => 2), :target => '_blank') %></li>
     <% end -%>
   </ul>
 <% else -%>

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

@@ -6,7 +6,7 @@
             <%= auto_complete_search(:search, params[:search].try(:squeeze, " "), :placeholder => _("Filter") + ' ...', :path => hosts_path) %>
             <span class="input-group-btn">
               <button class="btn btn-default" type="submit">
-                <%= icon_text("search", content_tag(:span, _("Search"), :class => "hidden-xs")) %>
+                <%= icon_text('search', content_tag(:span, _('Search'), :class => 'hidden-xs', :kind => 'fa')) %>
               </button>
             </span>
         </div>
@@ -41,7 +41,10 @@
   <%= will_paginate_with_info @hosts %>
 <% else %>
   <div class="alert alert-warning">
-    <%= _("The dynamic query '#{job_invocation.targeting.search_query}' was not resolved yet. The list of hosts to which it would resolve now can be seen") %>
-    <%= link_to('here.', hosts_url(:search => job_invocation.targeting.search_query)) %>
+    <%=
+        _("The dynamic query '%{query}' was not resolved yet. The list of hosts to which it would resolve now can be seen %{here}." %
+            { :query => job_invocation.targeting.search_query,
+              :here => link_to(_('here'), hosts_url(:search => job_invocation.targeting.search_query))})
+     %>
   </div>
 <% end %>

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

@@ -2,16 +2,16 @@
 
 <% title_actions(job_invocations_buttons) %>
 
-<table class="table table-bordered table-striped table-condensed">
+<table class="table table-bordered table-striped table-condensed table-fixed">
   <thead>
     <tr>
       <th><%= sort :description, :as => _('Description') %></th>
-      <th><%= _('Status') %></th>
-      <th><%= _('Succeeded') %></th>
-      <th><%= _('Failed') %></th>
-      <th><%= _('Pending') %></th>
-      <th><%= _('Total hosts') %></th>
-      <th><%= sort :start_at, :as => _('Start') %></th>
+      <th class="col-md-1"><%= _('Status') %></th>
+      <th class="col-md-1"><%= _('Succeeded') %></th>
+      <th class="col-md-1"><%= _('Failed') %></th>
+      <th class="col-md-1"><%= _('Pending') %></th>
+      <th class="col-md-1"><%= _('Total hosts') %></th>
+      <th class="col-md-2"><%= sort :start_at, :as => _('Start') %></th>
     </tr>
   </thead>
 
@@ -20,10 +20,10 @@
       <tr>
         <td><%= link_to_if_authorized "#{invocation.description.try(:capitalize) || invocation.job_category}", hash_for_job_invocation_path(invocation).merge(:auth_object => invocation, :permission => :view_job_invocations) %></td>
         <td><%= link_to_invocation_task_if_authorized(invocation) %></td>
-        <td><%= invocation_count(invocation, :output_key => :success_count) %></td>
-        <td><%= invocation_count(invocation, :output_key => :failed_count) %></td>
-        <td><%= invocation_count(invocation, :output_key => :pending_count) %></td>
-        <td><%= invocation_count(invocation, :output_key => :total_count) %></td>
+        <td><%= invocation_result(invocation, :success_count) %></td>
+        <td><%= invocation_result(invocation, :failed_count) %></td>
+        <td><%= invocation_result(invocation, :pending_count) %></td>
+        <td><%= invocation_result(invocation, :total_count) %></td>
         <td><%= time_in_words_span(invocation.start_at) %></td>
       </tr>
     <% end %>