foreman_remote_execution 0.3.0 → 0.3.1

data/app/lib/actions/middleware/bind_job_invocation.rb

@@ -6,7 +6,7 @@ module Actions
       def delay(*args)
         schedule_options, job_invocation = args
         if !job_invocation.task_id.nil? && job_invocation.task_id != task.id
-          job_invocation = job_invocation.deep_clone
+          job_invocation = job_invocation.deep_clone!
           args = [schedule_options, job_invocation]
         end
         pass(*args).tap { bind(job_invocation) }

data/app/lib/actions/remote_execution/run_host_job.rb

@@ -9,7 +9,7 @@ module Actions
         :link
       end
 
-      def plan(job_invocation, host, template_invocation, proxy)
+      def plan(job_invocation, host, template_invocation, proxy, options = {})
         action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description)
 
         template_invocation.host_id = host.id
@@ -24,11 +24,19 @@ module Actions
 
         raise _('Could not use any template used in the job invocation') if template_invocation.blank?
 
-        settings = { :global_proxy   => 'remote_execution_global_proxy',
-                     :fallback_proxy => 'remote_execution_fallback_proxy' }
+        if proxy.blank?
+          offline_proxies = options.fetch(:offline_proxies, [])
+          settings = { :count => offline_proxies.count, :proxy_names => offline_proxies.map(&:name).join(', ') }
+          raise n_('The only applicable proxy %{proxy_names} is down',
+                   'All %{count} applicable proxies are down. Tried %{proxy_names}',
+                   offline_proxies.count) % settings unless offline_proxies.empty?
 
-        raise _('Could not use any proxy. Consider configuring %{global_proxy} ' +
-                'or %{fallback_proxy} in settings') % settings if proxy.blank?
+          settings = { :global_proxy   => 'remote_execution_global_proxy',
+                       :fallback_proxy => 'remote_execution_fallback_proxy' }
+
+          raise _('Could not use any proxy. Consider configuring %{global_proxy} ' +
+                  'or %{fallback_proxy} in settings') % settings
+        end
 
         renderer = InputTemplateRenderer.new(template_invocation.template, host, template_invocation)
         script = renderer.render
@@ -70,9 +78,8 @@ module Actions
 
       def find_ip_or_hostname(host)
         %w(execution primary provision).each do |flag|
-          if host.send("#{flag}_interface") && host.send("#{flag}_interface").ip.present?
-            return host.execution_interface.ip
-          end
+          interface = host.send(flag + '_interface')
+          return interface.ip if interface && interface.ip.present?
         end
 
         host.interfaces.each do |interface|

data/app/lib/actions/remote_execution/run_hosts_job.rb

@@ -31,7 +31,8 @@ module Actions
           template_invocation = job_invocation.pattern_template_invocation_for_host(host).deep_clone
           template_invocation.host_id = host.id
           proxy = determine_proxy(template_invocation, host, load_balancer)
-          trigger(RunHostJob, job_invocation, host, template_invocation, proxy)
+          trigger(RunHostJob, job_invocation, host, template_invocation, proxy,
+                  :offline_proxies => load_balancer.offline)
         end
       end
 

data/app/models/concerns/foreman_remote_execution/exportable.rb

@@ -0,0 +1,71 @@
+# This concern makes it easy to export an ActiveRecord object with specified
+# attributes and associations in a particular format.  If a specified
+# assocation also includes this concern, then it will likewise be exported.
+#
+# Custom attributes can be specified with a custom export lambda in an options
+# hash.
+#
+# Example:
+#   attr_exportable :name, :address, :company => ->(user) { user.company.name }
+#
+module ForemanRemoteExecution
+  module Exportable
+    extend ActiveSupport::Concern
+
+    def to_export(include_blank = true)
+      self.class.exportable_attributes.keys.inject({}) do |hash, attribute|
+        value = export_attr(attribute, self.class.exportable_attributes[attribute], include_blank)
+
+        # Rails considers false blank, but if a boolean value is explicitly set false, we want to ensure we export it.
+        if include_blank || value.present? || value == false
+          hash.update(attribute => value)
+        else
+          hash
+        end
+      end.stringify_keys
+    end
+
+    # Export a particular attribute or association.
+    #   - If our exportable_attributes value is callable, we call it with self as an argument
+    #   - If our object is iterable, then we export each item
+    #   - If the attribute or association also includes this concern, call to_export on it
+    def export_attr(attribute, exporter, include_blank)
+      value = if exporter.respond_to?(:call)
+                exporter.call(self)
+              elsif self.respond_to?(exporter)
+                self.send(exporter)
+              end
+
+      value = value.respond_to?(:map) ? export_iterable(value, include_blank) : value
+      value.respond_to?(:to_export) ? value.to_export(include_blank) : value
+    end
+
+    # Exports each item in an iterable.  If it's a hash, then export each value.
+    def export_iterable(items, include_blank)
+      if items.is_a?(Hash)
+        items.each { |key, value| items[key] = value.respond_to?(:to_export) ? value.to_export(include_blank) : value }
+        items.to_hash.stringify_keys
+      else
+        items.map { |item| item.respond_to?(:to_export) ? item.to_export(include_blank) : item }
+      end
+    end
+
+    module ClassMethods
+      attr_reader :exportable_attributes
+
+      # Takes an array of exportable attributes, and a custom exports hash.  The
+      # custom exports hash should be a key/lambda pair used to export the
+      # particular attribute.
+      def attr_exportable(*args)
+        @exportable_attributes ||= {}
+        args.each do |arg|
+          if arg.is_a?(Hash)
+            @exportable_attributes.merge!(arg)
+          else
+            @exportable_attributes.merge!(arg => arg)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/foreign_input_set.rb

@@ -1,8 +1,11 @@
 class ForeignInputSet < ActiveRecord::Base
+  include ForemanRemoteExecution::Exportable
+
   class CircularDependencyError < Foreman::Exception
   end
 
   attr_accessible :template_id, :target_template_id, :include_all, :include, :exclude
+  attr_exportable :exclude, :include, :include_all, :template => ->(input_set) { input_set.template.name }
 
   belongs_to :template
   belongs_to :target_template, :class_name => 'Template'

data/app/models/job_invocation.rb

@@ -93,15 +93,18 @@ class JobInvocation < ActiveRecord::Base
 
   def deep_clone
     JobInvocationComposer.from_job_invocation(self).job_invocation.tap do |invocation|
-      invocation.task_group = JobInvocationTaskGroup.new.tap(&:save!)
+      invocation.task_group = JobInvocationTaskGroup.new
       invocation.triggering = self.triggering
       invocation.description_format = self.description_format
       invocation.description = self.description
       invocation.pattern_template_invocations = self.pattern_template_invocations.map(&:deep_clone)
-      invocation.save!
     end
   end
 
+  def deep_clone!
+    deep_clone.tap(&:save!)
+  end
+
   def to_action_input
     { :id => id, :name => job_category, :description => description }
   end
@@ -151,7 +154,7 @@ class JobInvocation < ActiveRecord::Base
     task.main_action.live_output.first['output']
   end
 
-  def generate_description!
+  def generate_description
     key_re = /%\{([^\}]+)\}/
     template_invocation = pattern_template_invocations.first
     input_names = template_invocation.template.template_inputs_with_foreign(&:name)
@@ -165,7 +168,6 @@ class JobInvocation < ActiveRecord::Base
       self.description.gsub!(Regexp.new("%\{#{k}\}"), v || '')
     end
     self.description = self.description[0..(JobInvocation.columns_hash['description'].limit - 1)]
-    save!
   end
 
   private

data/app/models/job_invocation_composer.rb

@@ -468,7 +468,7 @@ class JobInvocationComposer
       template = job_invocation.pattern_template_invocations.first.try(:template)
       job_invocation.description_format = template.generate_description_format if template
     end
-    job_invocation.generate_description! if job_invocation.description.blank?
+    job_invocation.generate_description if job_invocation.description.blank?
   end
 
   def build_effective_user(template_invocation_params)

data/app/models/job_template.rb

@@ -1,9 +1,12 @@
 class JobTemplate < ::Template
+  include ForemanRemoteExecution::Exportable
 
   class NonUniqueInputsError < Foreman::Exception
   end
 
   attr_accessible :job_category, :provider_type, :description_format, :effective_user_attributes
+  attr_exportable :name, :job_category, :description_format, :snippet, :template_inputs,
+                  :foreign_input_sets, :provider_type, :kind => ->(template) { template.class.name.underscore }
 
   include Authorizable
   extend FriendlyId
@@ -67,16 +70,17 @@ class JobTemplate < ::Template
       metadata = parse_metadata(contents)
       return if metadata.blank? || metadata.delete('kind') != 'job_template'
 
+      # Don't look for existing if we should always create a new template
+      existing = self.find_by_name(metadata['name']) unless options.delete(:build_new)
       # 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.assign_attributes(metadata.merge(:template => contents.gsub(/<%\#.+?.-?%>\n?/m, '').strip).merge(options))
+      template.assign_taxonomies if template.new_record?
 
       template
     end
@@ -88,6 +92,19 @@ class JobTemplate < ::Template
     template
   end
 
+  def metadata
+    "<%#\n#{to_export(false).to_yaml.sub(/\A---$/, '').strip}\n%>\n\n"
+  end
+
+  # 'Package Action - SSH Default' => 'package_action_ssh_default.erb'
+  def filename
+    name.downcase.delete('-').gsub(/\s+/, '_') + '.erb'
+  end
+
+  def to_erb
+    metadata + template
+  end
+
   # Override method in Taxonomix as Template is not used attached to a Host,
   # and matching a Host does not prevent removing a template from its taxonomy.
   def used_taxonomy_ids(type)
@@ -140,7 +157,7 @@ class JobTemplate < ::Template
   def sync_inputs(inputs)
     inputs ||= []
     # Build a hash where keys are input names
-    inputs = inputs.inject({}) { |h, input| h.update(input['name'] => input ) }
+    inputs = inputs.inject({}) { |h, input| h.update(input['name'] => input) }
 
     # Sync existing inputs
     template_inputs.each do |existing_input|
@@ -180,7 +197,6 @@ class JobTemplate < ::Template
   def sync_feature(feature_name)
     if feature_name && (feature = RemoteExecutionFeature.feature(feature_name))
       feature.job_template ||= self
-      feature.save!
     end
   end
 
@@ -203,4 +219,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/template_input.rb

@@ -1,4 +1,6 @@
 class TemplateInput < ActiveRecord::Base
+  include ForemanRemoteExecution::Exportable
+
   class ValueNotReady < ::Foreman::Exception
   end
   class UnsatisfiedRequiredInput < ::Foreman::Exception
@@ -11,6 +13,8 @@ class TemplateInput < ActiveRecord::Base
                   :puppet_class_name, :puppet_parameter_name, :description, :template_id,
                   :options, :advanced
 
+  attr_exportable(*self.accessible_attributes - %w(template_id))
+
   belongs_to :template
   has_many :template_invocation_input_values, :dependent => :destroy
 

data/app/models/template_invocation.rb

@@ -36,7 +36,7 @@ class TemplateInvocation < ActiveRecord::Base
   end
 
   def deep_clone!
-    deep_clone.tap { |clone| clone.input_values.each(&:save!) }
+    deep_clone.tap(&:save!)
   end
 
   private

data/app/services/proxy_load_balancer.rb

@@ -1,4 +1,7 @@
 class ProxyLoadBalancer
+
+  attr_reader :offline
+
   def initialize
     @tasks   = {}
     @offline = []

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

@@ -1,3 +1,5 @@
+<% stylesheet 'modal_window' %>
+
 <!-- modal window -->
 <div class="modal fade" id="previewHostsModal" role="dialog" aria-hidden="true" data-url="<%= preview_hosts_job_invocations_path %>">
   <div class="modal-dialog">
@@ -6,7 +8,7 @@
         <button type="button" class="close" onclick="close_preview_hosts_modal(); return false;"><span aria-hidden="true">&times;</span><span class="sr-only"><%= _('Close') %></span></button>
         <h4 class="modal-title">Preview Hosts</h4>
       </div>
-      <div class="modal-body" style="overflow-y: auto; max-height: 500px;">
+      <div class="modal-body">
       </div>
     </div>
   </div>

data/app/views/job_templates/_import_job_template_modal.html.erb

@@ -0,0 +1,20 @@
+<% stylesheet 'modal_window' %>
+
+<!-- modal window -->
+<div class="modal fade" id="importJobTemplateModal" role="dialog" aria-hidden="true">
+  <div class="modal-dialog">
+    <div class="modal-content">
+      <div class="modal-header">
+        <button type="button" class="close" onclick="close_import_job_template_modal(); return false;"><span aria-hidden="true">&times;</span><span class="sr-only"><%= _('Close') %></span></button>
+        <h4 class="modal-title">Import Job Template</h4>
+      </div>
+      <div class="modal-body">
+        <%= form_for :imported_template, :url => import_job_templates_path do |f| %>
+          <%= file_field_f f, :template, :size => "col-md-10", :help_block  => _("Select an ERB file to upload in order to import a job template.  The template must contain metadata in the first ERB comment.") %>
+          <%= checkbox_f(f, :overwrite, :label => _('Overwrite'), :help_block => _("Whether to overwrite the template if it already exists")) %>
+          <%= submit_or_cancel f, false, :cancel_path => 'javascript:close_import_job_template_modal();' %>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -1,9 +1,11 @@
 <%= include_javascript if SETTINGS[:version].short == '1.9' %>
+<%= javascript 'job_templates' %>
 <%= javascript 'lookup_keys' %>
 <%= javascript 'template_input' %>
 
 <% title _("Job Templates") %>
 <% title_actions(documentation_button_rex('3.1JobTemplates'),
+                 link_to_function(_('Import'), 'show_import_job_template_modal();', :class => 'btn btn-default'),
                  display_link_if_authorized(_("New Job Template"),
                                             hash_for_new_job_template_path)) %>
 
@@ -19,7 +21,7 @@
   <tbody>
     <% for job_template in @templates %>
       <tr>
-        <td class="display-two-pane"><%= link_to_if_authorized trunc_with_tooltip(job_template),
+        <td class="display-two-pane ellipsis"><%= link_to_if_authorized job_template,
                                                                hash_for_edit_job_template_path(:id => job_template).merge(:auth_object => job_template, :authorizer => authorizer) %></td>
         <td align='center'><%= checked_icon job_template.snippet %></td>
         <td align='center'>
@@ -33,3 +35,5 @@
   </tbody>
 </table>
 <%= will_paginate_with_info @templates %>
+
+<%= render :partial => 'import_job_template_modal' %>

data/config/routes.rb

@@ -3,11 +3,13 @@ Rails.application.routes.draw do
     member do
       get 'clone_template'
       get 'lock'
+      get 'export'
       get 'unlock'
       post 'preview'
     end
     collection do
       post 'preview'
+      post 'import'
       get 'revision'
       get 'auto_complete_search'
       get 'auto_complete_job_category'
@@ -45,9 +47,11 @@ Rails.application.routes.draw do
       resources :job_templates, :except => [:new, :edit] do
         (resources :locations, :only => [:index, :show]) if SETTINGS[:locations_enabled]
         (resources :organizations, :only => [:index, :show]) if SETTINGS[:organizations_enabled]
+        get :export, :on => :member
         post :clone, :on => :member
         collection do
           get 'revision'
+          post 'import'
         end
       end
 

data/lib/foreman_remote_execution/engine.rb

@@ -35,12 +35,12 @@ module ForemanRemoteExecution
 
         # Add permissions
         security_block :foreman_remote_execution do
-          permission :view_job_templates, { :job_templates => [:index, :show, :revision, :auto_complete_search, :auto_complete_job_category, :preview],
-                                            :'api/v2/job_templates' => [:index, :show, :revision],
+          permission :view_job_templates, { :job_templates => [:index, :show, :revision, :auto_complete_search, :auto_complete_job_category, :preview, :export],
+                                            :'api/v2/job_templates' => [:index, :show, :revision, :export],
                                             :'api/v2/template_inputs' => [:index, :show],
                                             :'api/v2/foreign_input_sets' => [:index, :show]}, :resource_type => 'JobTemplate'
-          permission :create_job_templates, { :job_templates => [:new, :create, :clone_template],
-                                              :'api/v2/job_templates' => [:create, :clone] }, :resource_type => 'JobTemplate'
+          permission :create_job_templates, { :job_templates => [:new, :create, :clone_template, :import],
+                                              :'api/v2/job_templates' => [:create, :clone, :import] }, :resource_type => 'JobTemplate'
           permission :edit_job_templates, { :job_templates => [:edit, :update],
                                             :'api/v2/job_templates' => [:update],
                                             :'api/v2/template_inputs' => [:create, :update, :destroy],

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/locale/Makefile

@@ -10,9 +10,10 @@ DOMAIN = foreman_remote_execution
 VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
 POTFILE = $(DOMAIN).pot
 MOFILE = $(DOMAIN).mo
-POFILES = $(shell find . -name '*.po')
+POFILES = $(shell find . -name '$(DOMAIN).po')
 MOFILES = $(patsubst %.po,%.mo,$(POFILES))
 POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
 
 %.mo: %.po
 	mkdir -p $(shell dirname $@)/LC_MESSAGES
@@ -29,14 +30,10 @@ all-mo: $(MOFILES)
 	cat $@
 	! grep -q msgid $@
 
-check: $(POXFILES)
-	msgfmt -c ${POTFILE}
+%.edit.po:
+	touch $@
 
-# Merge PO files
-update-po:
-	for f in $(shell find ./ -name "*.po") ; do \
-		msgmerge -N --backup=none -U $$f ${POTFILE} ; \
-	done
+check: $(POXFILES)
 
 # Unify duplicate translations
 uniq-po:
@@ -44,19 +41,21 @@ uniq-po:
 		msguniq $$f -o $$f ; \
 	done
 
-tx-pull:
+tx-pull: $(EDITFILES)
 	tx pull -f
-	for f in $(POFILES) ; do \
+	for f in $(EDITFILES) ; do \
 		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
 	done
-	-git commit -a -m "i18n - pulling from tx"
 
-reset-po:
-	# merging po files is unnecessary when using transifex.com
-	git checkout -- ../locale/*/*po
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo
 
-tx-update: tx-pull reset-po $(MOFILES)
-	# amend mo files
-	git add ../locale/*/LC_MESSAGES
-	git commit -a --amend -m "i18n - pulling from tx"
-	-echo Changes commited!