foreman_remote_execution 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4120a1934a7887f21bd50779f5d6f9f76b3046c4
-  data.tar.gz: 1e4c6270f33ef933afe21173fb9e3e0e1a6478b2
+  metadata.gz: a436dbf82dcf2ef9b040cdc5dfecf517dd25cc9e
+  data.tar.gz: 8f8d044eba9abcbb997d4299ba828700d29e71f4
 SHA512:
-  metadata.gz: d986544207cce24d406123b2567df7216755234528151da383d6bce25e22612e80a99a920fcfd2188435a2706ff991bf98096d27e46d2f30dd2a8e8528be3929
-  data.tar.gz: d8fb4cfa5e43be5144895a706806348dc358c832946a0bd983744cb7ac4b3ea77a6c174846e6e85e2152574cbd5232f9f89c605f50b2717cc67d44d48d6217a3
+  metadata.gz: f27bc513effd681f1d186a264e1a1d289c3c164aabedf7fad48c90d3891eac9ce1a7f319e13196d532fe061f7b679e0d3f0da475688f72cf82d53f1c270826a1
+  data.tar.gz: b3f489e09fbad3cc4f69c8197f939bc7e3ed6a013f93b46989cf4f9f863509d73a87213715bd7f038d82a13a3a14a755da8321f096f890acaf8a99085a38bf52

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

@@ -112,8 +112,8 @@ module Api
         process_response @job_template.save
       end
 
-      def resource_name
-        'job_template'
+      def resource_name(nested_resource = nil)
+        nested_resource || 'job_template'
       end
 
       private

data/app/helpers/remote_execution_helper.rb

@@ -167,6 +167,11 @@ module RemoteExecutionHelper
     end
   end
 
+  def invocation_description(invocation)
+    description = invocation.description.try(:capitalize) || invocation.job_category
+    trunc_with_tooltip(description, 80)
+  end
+
   def invocation_result(invocation, key)
     unknown = '—'
     result = invocation_count(invocation, :output_key => key, :unknown_string => unknown.html_safe)

data/app/models/job_template_importer.rb

@@ -0,0 +1,24 @@
+# This class is a shim to handle the importing of templates via the
+# foreman_templates plugin. It expects a method like
+#     def import(name, text, metadata)
+# but REx already has an import! method, so this class provides the
+# translation layer.
+
+class JobTemplateImporter
+  def self.import!(name, text, _metadata)
+    template = JobTemplate.import(
+      text.sub(/^name: .*$/, "name: #{name}").sub(/^model: .*$/, ''),
+      :update => true
+    )
+
+    c_or_u = template.new_record? ? 'Created' : 'Updated'
+    id_string = ('id' + template.id) rescue ''
+
+    result = "  #{c_or_u} Template #{id_string}:#{name}"
+    { :old => template.template_was,
+      :new => template.template,
+      :status => template.save,
+      :result => result
+    }
+  end
+end

data/app/models/setting/remote_execution.rb

@@ -32,7 +32,10 @@ class Setting::RemoteExecution < Setting
                  { :collection => Proc.new {Hash[SSHExecutionProvider::EFFECTIVE_USER_METHODS.map{|method| [method, method]}]} }),
         self.set('remote_execution_sync_templates',
                  N_('Whether we should sync templates from disk when running db:seed.'),
-                 true)
+                 true),
+        self.set('remote_execution_ssh_port',
+                N_('Port to use for SSH communication. Default port 22. You may override per host by setting a parameter called remote_execution_ssh_port.'),
+                '22')
       ].each { |s| self.create! s.update(:category => 'Setting::RemoteExecution') }
     end
 

data/app/models/ssh_execution_provider.rb

@@ -6,7 +6,8 @@ class SSHExecutionProvider < RemoteExecutionProvider
     def proxy_command_options(template_invocation, host)
       super.merge(:ssh_user => ssh_user(host),
                   :effective_user => effective_user(template_invocation),
-                  :effective_user_method => effective_user_method(host))
+                  :effective_user_method => effective_user_method(host),
+                  :ssh_port => ssh_port(host))
     end
 
     def humanized_name
@@ -23,6 +24,10 @@ class SSHExecutionProvider < RemoteExecutionProvider
       host.params['remote_execution_ssh_user']
     end
 
+    def ssh_port(host)
+      Integer(host.params['remote_execution_ssh_port'] || Setting[:remote_execution_ssh_port])
+    end
+
     def effective_user(template_invocation)
       template_invocation.effective_user
     end

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

@@ -36,7 +36,7 @@
       <%= _('following user inputs were provided') %>
       <ul>
         <% template_invocation.input_values.joins(:template_input).each do |input_value| %>
-          <li><b><%= input_value.template_input.name %></b>: <%= input_value.value %></li>
+          <li><b><%= input_value.template_input.name %></b>: <%= trunc_with_tooltip(input_value.value, 255) %></li>
         <% end %>
       </ul>
     <% end %>

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

@@ -18,7 +18,7 @@
   <tbody>
     <% @job_invocations.each do |invocation| %>
       <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_if_authorized invocation_description(invocation), 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_result(invocation, :success_count) %></td>
         <td><%= invocation_result(invocation, :failed_count) %></td>

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

@@ -1,4 +1,4 @@
-<% title @job_invocation.description %>
+<% title @job_invocation.description, trunc_with_tooltip(@job_invocation.description, 120) %>
 <% stylesheet 'job_invocations' %>
 <% javascript 'template_invocation' %>
 

data/app/views/template_invocations/_output_line_set.html.erb

@@ -2,6 +2,6 @@
   <%= content_tag :div, :class => 'line ' + output_line_set['output_type'], :data => { :timestamp => output_line_set['timestamp'] } do %>
 
     <%= content_tag(:span, (@line_counter += 1).to_s.rjust(4).gsub(' ', '&nbsp;').html_safe + ':', :class => 'counter', :title => (output_line_set['timestamp'] && Time.at(output_line_set['timestamp']))) %>
-    <%= content_tag(:div, (line.empty? ? '&nbsp;' : line).html_safe, :class => 'content') %>
+    <%= content_tag(:div, (line.empty? ? '&nbsp;' : h(line)).html_safe, :class => 'content') %>
   <% end %>
 <% end %>

data/config/routes.rb

@@ -55,6 +55,18 @@ Rails.application.routes.draw do
         end
       end
 
+      if SETTINGS[:organizations_enabled]
+        resources :organizations, :only => [:index] do
+          resources :job_templates, :only =>[:index, :show]
+        end
+      end
+
+      if SETTINGS[:locations_enabled]
+        resources :locations, :only => [:index] do
+          resources :job_templates, :only =>[:index, :show]
+        end
+      end
+
       resources :templates, :only => :none do
         resources :template_inputs, :only => [:index, :show, :create, :destroy, :update]
         resources :foreign_input_sets, :only => [:index, :show, :create, :destroy, :update]

data/db/migrate/20160926225841_update_template_input_value.rb

@@ -0,0 +1,5 @@
+class UpdateTemplateInputValue < ActiveRecord::Migration
+  def change
+    change_column :template_invocation_input_values, :value, :text, :limit => 16.megabytes - 1
+  end
+end

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/test/functional/api/v2/job_templates_controller_test.rb

@@ -14,6 +14,16 @@ module Api
         assert_response :success
       end
 
+      test 'should get templates of give organization' do
+        @organization = FactoryGirl.create(:organization)
+        @template.organizations << @organization
+        @template.save!
+        get :index, :organization_id => @organization.id
+        templates = ActiveSupport::JSON.decode(@response.body)
+        assert !templates.empty?, 'Should respond with template'
+        assert_response :success
+      end
+
       test 'should get template detail' do
         get :show, :id => @template.to_param
         assert_response :success

data/test/unit/job_invocation_composer_test.rb

@@ -4,7 +4,7 @@ RemoteExecutionProvider.register(:Mcollective, OpenStruct)
 
 describe JobInvocationComposer do
   before do
-    permission1 = FactoryGirl.create(:permission, :name => 'view_job_templates', :resource_type => 'JobTemplate')
+    permission1 = Permission.find_by_name('view_job_templates')
     permission2 = Permission.find_by_name('view_bookmarks')
     permission3 = Permission.find_by_name('view_hosts')
     filter1 = FactoryGirl.build(:filter, :permissions => [permission1], :search => 'name ~ trying*')
@@ -17,7 +17,8 @@ describe JobInvocationComposer do
     role.filters = filter1, filter2, filter3
     role.save
     User.current = FactoryGirl.build(:user)
-    User.current.roles<< role
+    User.current.current_password = User.current.password
+    User.current.roles << role
     User.current.save
   end
 

data/test/unit/job_template_importer_test.rb

@@ -0,0 +1,48 @@
+require 'test_plugin_helper'
+
+describe JobTemplateImporter do
+  context 'importing a new template' do
+    # JobTemplate tests handle most of this, we just check that the shim
+    # correctly loads a template returns a hash
+    let(:remote_execution_feature) do
+      FactoryGirl.create(:remote_execution_feature)
+    end
+
+    let(:result) do
+      name = "Community Service Restart"
+      text = <<-END_TEMPLATE
+<%#
+model: JobTemplateImporter
+kind: job_template
+name: Service Restart
+job_category: Service Restart
+provider_type: SSH
+feature: #{remote_execution_feature.label}
+template_inputs:
+- name: service_name
+  input_type: user
+  required: true
+- name: verbose
+  input_type: user
+%>
+
+service <%= input("service_name") %> restart
+END_TEMPLATE
+
+      # This parameter is unused but foreman_templates will supply it
+      # so we test it's accepted
+      metadata = "unused"
+
+      JobTemplateImporter.import!(name, text, metadata)
+    end
+
+    let(:template) { JobTemplate.find_by_name 'Community Service Restart' }
+
+    it 'returns a valid foreman_templates hash' do
+      result[:status].must_equal true
+      result[:result].must_equal '  Created Template :Community Service Restart'
+      result[:old].must_equal nil
+      result[:new].must_equal template.template.squish
+    end
+  end
+end

data/test/unit/remote_execution_provider_test.rb

@@ -89,5 +89,28 @@ describe RemoteExecutionProvider do
         proxy_options[:effective_user_method].must_equal 'su'
       end
     end
+
+
+    describe 'ssh port from settings' do
+      before do
+        Setting[:remote_execution_ssh_port] = '66'
+      end
+
+      it 'has ssh port changed in settings and check return type' do
+        proxy_options[:ssh_port].must_be_kind_of Integer
+        proxy_options[:ssh_port].must_equal 66
+      end
+    end
+
+    describe 'ssh port from params' do
+      it 'takes ssh port number from params and check return type' do
+        host.params['remote_execution_ssh_port'] = '30'
+        host.host_parameters << FactoryGirl.build(:host_parameter, :name => 'remote_execution_ssh_port', :value => '30')
+        host.clear_host_parameters_cache!
+        proxy_options[:ssh_port].must_be_kind_of Integer
+        proxy_options[:ssh_port].must_equal 30
+      end
+    end
+
   end
 end

data/test/unit/template_invocation_input_value_test.rb

@@ -26,4 +26,13 @@ describe TemplateInvocationInputValue do
                                                                        :value => 'foreman')
     end
   end
+
+  it 'supports large inputs' do
+    template.template_inputs << FactoryGirl.build(:template_input, :name => 'service_name',
+                                                  :input_type => 'user', :required => true)
+    assert_valid FactoryGirl.create(:template_invocation_input_value,
+                                    :template_invocation => template_invocation,
+                                    :template_input => template.template_inputs.first,
+                                    :value => 'foreman' * 1000000)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -198,6 +198,7 @@ files:
 - app/models/job_invocation_task_group.rb
 - app/models/job_template.rb
 - app/models/job_template_effective_user.rb
+- app/models/job_template_importer.rb
 - app/models/remote_execution_feature.rb
 - app/models/remote_execution_provider.rb
 - app/models/setting/remote_execution.rb
@@ -310,6 +311,7 @@ files:
 - db/migrate/20160127134031_add_advanced_to_template_input.rb
 - db/migrate/20160127162711_reword_puppet_template_description.rb
 - db/migrate/20160203104056_add_concurrency_options_to_job_invocation.rb
+- db/migrate/20160926225841_update_template_input_value.rb
 - db/seeds.d/60-ssh_proxy_feature.rb
 - db/seeds.d/70-job_templates.rb
 - db/seeds.d/90-bookmarks.rb
@@ -398,6 +400,7 @@ files:
 - test/unit/job_invocation_composer_test.rb
 - test/unit/job_invocation_test.rb
 - test/unit/job_template_effective_user_test.rb
+- test/unit/job_template_importer_test.rb
 - test/unit/job_template_test.rb
 - test/unit/remote_execution_feature_test.rb
 - test/unit/remote_execution_provider_test.rb
@@ -446,6 +449,7 @@ test_files:
 - test/unit/job_invocation_composer_test.rb
 - test/unit/job_invocation_test.rb
 - test/unit/job_template_effective_user_test.rb
+- test/unit/job_template_importer_test.rb
 - test/unit/job_template_test.rb
 - test/unit/remote_execution_feature_test.rb
 - test/unit/remote_execution_provider_test.rb