foreman_remote_execution 0.1.1 → 0.1.2

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

@@ -8,6 +8,10 @@
                              :id => 'search') %>
   <% end %>
 
+  <%= text_f f, :description_format,
+             :help_inline => popover(_('Explanation'), _('Description template determines the job name once it is submitted. Input values can become part of the name
+                         if they are specified using interpolation syntax, e.g. %{fqdn} where fqdn is the name of interpolated input.')) %>
+
   <%= select_f f, :provider_type, providers_options, :first, :last %>
 
   <div class="children_fields">
@@ -20,6 +24,18 @@
     <%= add_child_link '+ ' + _("Add Input"), :template_inputs, { :title => _('add a input for this template')} %>
   </div>
 
+  <div class="children_fields">
+    <%= field_set_tag _("Effective user") do %>
+      <%= f.fields_for :effective_user, @template.effective_user do |ff| %>
+        <div class="effective_user_form fields">
+          <%= text_f ff, :value %>
+          <%= checkbox_f ff, :current_user %>
+          <%= checkbox_f ff, :overridable %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+
 </div>
 
 

data/app/views/templates/package_action.erb

@@ -2,6 +2,7 @@
 kind: job_template
 name: Package Action - SSH Default
 job_name: Package Action
+description_format: "%{action} package(s) %{package}"
 provider_type: Ssh
 template_inputs:
 - name: pre_script

data/app/views/templates/puppet_run_once.erb

@@ -2,6 +2,7 @@
 kind: job_template
 name: Puppet Run Once - SSH Default
 job_name: Puppet Run Once
+description_format: '%{job_name} with "%{puppet_options}"'
 provider_type: Ssh
 template_inputs:
 - name: puppet_options

data/app/views/templates/run_command.erb

@@ -2,6 +2,7 @@
 kind: job_template
 name: Run Command - SSH Default
 job_name: Run Command
+description_format: "%{job_name} %{command}"
 provider_type: Ssh
 template_inputs:
 - name: command

data/app/views/templates/service_action.erb

@@ -2,6 +2,7 @@
 kind: job_template
 name: Service Action - SSH Default
 job_name: Service Action
+description_format: '%{action} service %{service}'
 provider_type: Ssh
 template_inputs:
 - name: action

data/config/routes.rb

@@ -24,11 +24,20 @@ Rails.application.routes.draw do
     end
   end
 
-  resources :template_invocations, :only => [:show]
+  # index is needed so the auto_complete_search can be constructed, otherwise autocompletion in filter does not work
+  resources :template_invocations, :only => [:show, :index] do
+    collection do
+      get 'auto_complete_search'
+    end
+  end
 
   namespace :api, :defaults => {:format => 'json'} do
     scope "(:apiv)", :module => :v2, :defaults => {:apiv => 'v2'}, :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2, :default => true) do
-      resources :job_invocations, :except => [:new, :edit, :update, :destroy]
+      resources :job_invocations, :except => [:new, :edit, :update, :destroy] do
+        resources :hosts, :only => :none do
+          get '/', :to => 'job_invocations#output'
+        end
+      end
 
       resources :job_templates, :except => [:new, :edit] do
         (resources :locations, :only => [:index, :show]) if SETTINGS[:locations_enabled]
@@ -38,6 +47,10 @@ Rails.application.routes.draw do
           get 'revision'
         end
       end
+
+      resources :templates, :only => :none do
+        resources :template_inputs, :only => [:index, :show, :create, :new, :destroy, :update]
+      end
     end
   end
 end

data/db/migrate/20150923125825_add_job_invocation_task_group.rb

@@ -0,0 +1,10 @@
+class AddJobInvocationTaskGroup < ActiveRecord::Migration
+  def up
+    add_column :job_invocations, :task_group_id, :integer, :index => true
+    add_foreign_key :job_invocations, :foreman_tasks_task_groups, :column => :task_group_id
+  end
+
+  def down
+    remove_column :job_invocations, :task_group_id
+  end
+end

data/db/migrate/20151022105508_rename_last_task_id_column.rb

@@ -0,0 +1,6 @@
+class RenameLastTaskIdColumn < ActiveRecord::Migration
+  def change
+    rename_column :job_invocations, :last_task_id, :task_id
+    rename_index :job_invocations, 'job_invocations_last_task_id', 'job_invocations_task_id'
+  end
+end

data/db/migrate/20151116105412_add_triggering_to_job_invocation.rb

@@ -0,0 +1,10 @@
+class AddTriggeringToJobInvocation < ActiveRecord::Migration
+  def up
+    add_column :job_invocations, :triggering_id, :integer, :index => true
+    add_foreign_key :job_invocations, :foreman_tasks_triggerings, :column => :triggering_id
+  end
+
+  def down
+    remove_column :job_invocations, :triggering_id
+  end
+end

data/db/migrate/20151120171100_add_effective_user_to_template_invocation.rb

@@ -0,0 +1,5 @@
+class AddEffectiveUserToTemplateInvocation < ActiveRecord::Migration
+  def change
+    add_column :template_invocations, :effective_user, :string
+  end
+end

data/db/migrate/20151124162300_create_job_template_effective_users.rb

@@ -0,0 +1,13 @@
+class CreateJobTemplateEffectiveUsers < ActiveRecord::Migration
+  def change
+    create_table :job_template_effective_users do |t|
+      t.integer :job_template_id
+      t.string :value
+      t.boolean :overridable
+      t.boolean :current_user
+    end
+
+    add_index :job_template_effective_users, :job_template_id, :name => 'effective_users_job_template_id'
+    add_foreign_key :job_template_effective_users, :templates, :column => :job_template_id
+  end
+end

data/db/migrate/20151203100824_add_description_to_job_invocation.rb

@@ -0,0 +1,11 @@
+class AddDescriptionToJobInvocation < ActiveRecord::Migration
+  def up
+    add_column :job_invocations, :description, :string
+    add_column :templates, :description_format, :string
+  end
+
+  def down
+    remove_column :job_invocations, :description
+    remove_column :templates, :description_format
+  end
+end

data/db/migrate/20151215114631_add_host_id_to_template_invocation.rb

@@ -0,0 +1,29 @@
+class AddHostIdToTemplateInvocation < ActiveRecord::Migration
+  class FakeTemplateInvocation < ActiveRecord::Base
+    set_table_name 'template_invocations'
+  end
+
+  def up
+    add_column :template_invocations, :host_id, :integer
+    add_foreign_key "template_invocations", "hosts", :name => "template_invocations_hosts_id_fk", :column => 'host_id'
+    FakeTemplateInvocation.reset_column_information
+
+    say 'Migrating existing execution locks to explicit relations, this may take a while'
+    FakeTemplateInvocation.all.each do |template_invocation|
+      task = ForemanTasks::Task.for_action_types('Actions::RemoteExecution::RunHostJob').joins(:locks).where(
+        :'foreman_tasks_locks.resource_type' => 'TemplateInvocation',
+        :'foreman_tasks_locks.resource_id' => template_invocation.id).first
+      next if task.nil? # skip invocations from very early versions of remote executions
+      host_id = task.locks.where(:'foreman_tasks_locks.resource_type' => 'Host::Managed').first.resource_id
+      next unless Host.find_by_id(host_id)
+
+      template_invocation.host_id = host_id
+      template_invocation.save!
+    end
+  end
+
+  def down
+    remove_foreign_key "template_invocations", :name => "template_invocations_hosts_id_fk"
+    remove_column :template_invocations, :host_id
+  end
+end

data/db/migrate/20151217092555_migrate_to_task_groups.rb

@@ -0,0 +1,16 @@
+class MigrateToTaskGroups < ActiveRecord::Migration
+  class FakeJobInvocation < ActiveRecord::Base
+    set_table_name 'job_invocations'
+  end
+
+  def up
+    say 'Migrating from locks to task groups'
+    FakeJobInvocation.where('task_group_id IS NULL AND task_id IS NOT NULL').each do |job_invocation|
+      task_group = JobInvocationTaskGroup.new
+      task_group.task_ids = [job_invocation.task_id]
+      task_group.save!
+      job_invocation.task_group_id = task_group.id
+      job_invocation.save!
+    end
+  end
+end

data/foreman_remote_execution.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency "deface"
   s.add_dependency "rails", "~> 3.2.8"
-  s.add_dependency "foreman-tasks", "~> 0.7.6"
+  s.add_dependency "dynflow", "~> 0.8.8"
+  s.add_dependency "foreman-tasks", "~> 0.7.8"
 
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rdoc'

data/lib/foreman_remote_execution/engine.rb

@@ -34,22 +34,46 @@ 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_name, :preview],
-                                            :'api/v2/job_templates' => [:index, :show, :revision] }, :resource_type => 'JobTemplate'
+                                            :'api/v2/job_templates' => [:index, :show, :revision],
+                                            :'api/v2/template_inputs' => [: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 :edit_job_templates, { :job_templates => [:edit, :update],
-                                            :'api/v2/job_templates' => [:update] }, :resource_type => 'JobTemplate'
+                                            :'api/v2/job_templates' => [:update],
+                                            :'api/v2/template_inputs' => [:update, :new, :create, :destroy]}, :resource_type => 'JobTemplate'
           permission :destroy_job_templates, { :job_templates => [:destroy],
                                                :'api/v2/job_templates' => [:destroy] }, :resource_type => 'JobTemplate'
           permission :lock_job_templates, { :job_templates => [:lock, :unlock] }, :resource_type => 'JobTemplate'
           permission :create_job_invocations, { :job_invocations => [:new, :create, :refresh, :rerun, :preview_hosts],
                                                 'api/v2/job_invocations' => [:create] }, :resource_type => 'JobInvocation'
           permission :view_job_invocations, { :job_invocations => [:index, :show, :auto_complete_search], :template_invocations => [:show],
-                                              'api/v2/job_invocations' => [:index, :show] }, :resource_type => 'JobInvocation'
+                                              'api/v2/job_invocations' => [:index, :show, :output] }, :resource_type => 'JobInvocation'
+          permission :execute_template_invocation, {}, :resource_type => 'TemplateInvocation'
+          # this permissions grants user to get auto completion hints when setting up filters
+          permission :filter_autocompletion_for_template_invocation, { :template_invocations => [ :auto_complete_search, :index ] },
+                     :resource_type => 'TemplateInvocation'
         end
 
-        # Add a new role called 'ForemanRemoteExecution' if it doesn't exist
-        # role 'ForemanRemoteExecution', [:view_foreman_remote_execution]
+        USER_PERMISSIONS = [
+          :view_job_templates,
+          :view_job_invocations,
+          :create_job_invocations,
+          :execute_template_invocation,
+          :view_hosts,
+          :view_smart_proxies
+        ]
+        MANAGER_PERMISSIONS = USER_PERMISSIONS + [
+          :destroy_job_templates,
+          :edit_job_templates,
+          :create_job_templates,
+          :lock_job_templates,
+          :view_audit_logs,
+          :filter_autocompletion_for_template_invocation
+        ]
+
+        # Add a new role called 'Remote Execution User ' if it doesn't exist
+        role 'Remote Execution User', USER_PERMISSIONS
+        role 'Remote Execution Manager', MANAGER_PERMISSIONS
 
         # add menu entry
         menu :top_menu, :job_templates,
@@ -122,6 +146,7 @@ module ForemanRemoteExecution
       # having issues with resolving it to Rake::Task otherwise
       require_dependency 'foreman_tasks/task'
       ForemanTasks::Task.send(:include, ForemanRemoteExecution::ForemanTasksTaskExtensions)
+      RemoteExecutionProvider.register(:Ssh, SSHExecutionProvider)
     end
 
     initializer 'foreman_remote_execution.register_gettext', after: :load_config_initializers do |_app|

data/lib/foreman_remote_execution/version.rb

@@ -1,3 +1,3 @@
 module ForemanRemoteExecution
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/factories/foreman_remote_execution_factories.rb

@@ -11,6 +11,10 @@ FactoryGirl.define do
         template.template_inputs << FactoryGirl.build(:template_input)
       end
     end
+
+    trait :with_description_format do
+      description_format "Factory-built %{job_name}"
+    end
   end
 
   factory :template_input do |f|
@@ -27,6 +31,7 @@ FactoryGirl.define do
   factory :job_invocation do |f|
     targeting
     f.sequence(:job_name) { |n| "Job name #{n}" }
+    f.description_format '%{job_name}'
     trait :with_template do
       after(:build) do |invocation, evaluator|
         invocation.template_invocations << FactoryGirl.build(:template_invocation)

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

@@ -23,7 +23,7 @@ module Api
         assert_equal template["job_name"], @invocation.job_name
       end
 
-      test "should create valid without template_id" do
+      test "should create valid without job_template_id" do
         attrs = { :job_name => @template.job_name, :name => 'RandomName', :targeting_type => 'static_query', :search_query => "foobar"}
         post :create,  :job_invocation => attrs
 
@@ -32,8 +32,8 @@ module Api
         assert_response :success
       end
 
-      test "should create valid with template_id" do
-        attrs = { :job_name => @template.job_name, :name => 'RandomName', :template_id => @template.id,:targeting_type => 'static_query', :search_query => "foobar"}
+      test "should create valid with job_template_id" do
+        attrs = { :job_name => @template.job_name, :name => 'RandomName', :job_template_id => @template.id,:targeting_type => 'static_query', :search_query => "foobar"}
         post :create,  :job_invocation => attrs
 
         invocation = ActiveSupport::JSON.decode(@response.body)

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

@@ -0,0 +1,61 @@
+require 'test_plugin_helper'
+
+module Api
+  module V2
+    class TemplateInputsControllerTest < ActionController::TestCase
+      setup do
+        @template = FactoryGirl.create(:job_template, :with_input)
+        @input = @template.template_inputs.first
+      end
+
+      test 'should get index' do
+        get :index, :template_id => @template.id
+        inputs = ActiveSupport::JSON.decode(@response.body)
+        assert !inputs.empty?, "Should respond with inputs"
+        assert_response :success
+      end
+
+      test 'should get input detail' do
+        get :show,  :template_id => @template.to_param, :id => @input.to_param
+        assert_response :success
+        input = ActiveSupport::JSON.decode(@response.body)
+        assert !input.empty?
+        assert_equal input["name"], @input.name
+      end
+
+      test 'should create valid' do
+        valid_attrs = { :name => 'is_potato', :input_type => 'user', :options => ['true', 'false'] }
+        post :create, :template_input => valid_attrs, :template_id => @template.to_param
+        input = ActiveSupport::JSON.decode(@response.body)
+        assert input['name'] == 'is_potato'
+        assert_response :success
+      end
+
+      test 'should not create invalid' do
+        post :create, :template_id => @template.to_param
+        assert_response :unprocessable_entity
+      end
+
+      test 'should update valid' do
+        put :update,  :template_id => @template.to_param,
+                      :id => @input.to_param,
+                      :template_input => { :name => "blah" }
+        assert_response :ok
+      end
+
+      test 'should not update invalid' do
+        put :update,  :template_id => @template.to_param,
+                      :id => @input.to_param,
+                      :template_input => { :name => '' }
+        assert_response :unprocessable_entity
+      end
+
+      test 'should destroy' do
+        delete :destroy,  :template_id => @template.to_param,
+                          :id => @input.to_param
+        assert_response :ok
+        refute TemplateInput.exists?(@input.id)
+      end
+    end
+  end
+end

data/test/unit/actions/run_hosts_job_test.rb

@@ -14,10 +14,17 @@ module ForemanRemoteExecution
         invocation.save
       end
     end
+
+    let(:task) do
+      OpenStruct.new(:id => '123').tap do |o|
+        o.stubs(:add_missing_task_groups)
+        o.stubs(:task_groups).returns([])
+      end
+    end
     let(:action) do
       action = create_action(Actions::RemoteExecution::RunHostsJob)
       action.expects(:action_subject).with(job_invocation)
-      ForemanTasks::Task::DynflowTask.stubs(:find_by_external_id!).returns(OpenStruct.new(:id => '123'))
+      ForemanTasks::Task::DynflowTask.stubs(:where).returns(mock.tap { |m| m.stubs(:first! => task) })
       plan_action(action, job_invocation)
     end
 
@@ -33,13 +40,13 @@ module ForemanRemoteExecution
 
     it 'triggers the RunHostJob actions on the resolved hosts in run phase' do
       template_invocation = job_invocation.template_invocation_for_host(host)
-      action.expects(:trigger).with(Actions::RemoteExecution::RunHostJob, job_invocation, host, template_invocation, proxy, {})
+      action.expects(:trigger).with(Actions::RemoteExecution::RunHostJob, job_invocation, host, template_invocation, proxy)
       action.create_sub_plans
     end
 
     it 'uses the BindJobInvocation middleware' do
       action
-      job_invocation.last_task_id.must_equal '123'
+      job_invocation.task_id.must_equal '123'
     end
   end
 end

data/test/unit/concerns/host_extensions_test.rb

@@ -9,13 +9,14 @@ describe ForemanRemoteExecution::HostExtensions do
 
   after { User.current = nil }
 
-  context 'ssh user' do
+  describe 'ssh specific params' do
     let(:host) { FactoryGirl.build(:host, :with_execution) }
     let(:sshkey) { 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQ foo@example.com' }
 
     before do
       SmartProxy.any_instance.stubs(:pubkey).returns(sshkey)
       Setting[:remote_execution_ssh_user] = 'root'
+      Setting[:remote_execution_effective_user_method] = 'sudo'
     end
 
     it 'has ssh user in the parameters' do
@@ -26,14 +27,17 @@ describe ForemanRemoteExecution::HostExtensions do
       host.host_parameters << FactoryGirl.build(:host_parameter, :name => 'remote_execution_ssh_user', :value => 'amy')
       host.params['remote_execution_ssh_user'].must_equal 'amy'
     end
-  end
 
-  context 'ssh keys' do
-    let(:host) { FactoryGirl.build(:host, :with_execution) }
-    let(:sshkey) { 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQ foo@example.com' }
+    it 'has effective user method in the parameters' do
+      host.params['remote_execution_effective_user_method'].must_equal Setting[:remote_execution_effective_user_method]
+    end
+
+    it 'can override effective user method' do
+      host.host_parameters << FactoryGirl.build(:host_parameter, :name => 'remote_execution_effective_user_method', :value => 'su')
+      host.params['remote_execution_effective_user_method'].must_equal 'su'
+    end
 
     it 'has ssh keys in the parameters' do
-      SmartProxy.any_instance.stubs(:pubkey).returns(sshkey)
       host.remote_execution_ssh_keys.must_include sshkey
     end
   end