foreman_remote_execution 1.4.5 → 1.4.6

data/test/functional/job_invocations_controller_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class JobInvocationsControllerTest < ActionController::TestCase
+  test 'should parse inputs coming from the URL params' do
+    template = FactoryBot.create(:job_template, :with_input)
+    feature = FactoryBot.create(:remote_execution_feature,
+                                :job_template => template)
+    params = {
+      feature: feature.label,
+      inputs: { template.template_inputs.first.name => 'foobar' }
+    }
+
+    get :new, params: params, session: set_session_user
+    template_invocation_params = [
+      {
+        'input_values' =>
+        [
+          {
+            'value' => 'foobar',
+            'template_input_id' => template.template_inputs.first.id
+          }
+        ],
+        'template_id' => template.id
+      }
+    ]
+    assert_equal(template_invocation_params,
+                 assigns(:composer).params['template_invocations'])
+  end
+
+  test 'should allow no inputs' do
+    template = FactoryBot.create(:job_template)
+    feature = FactoryBot.create(:remote_execution_feature,
+                                :job_template => template)
+    params = {
+      feature: feature.label,
+    }
+    get :new, params: params, session: set_session_user
+    template_invocation_params = [
+      {
+        'template_id' => template.id,
+        'input_values' => {}
+      }
+    ]
+    assert_equal(template_invocation_params,
+                 assigns(:composer).params['template_invocations'])
+  end
+end

data/test/unit/actions/run_hosts_job_test.rb

@@ -1,5 +1,5 @@
-
 require 'test_plugin_helper'
+require 'securerandom'
 
 module ForemanRemoteExecution
   class RunHostsJobTest < ActiveSupport::TestCase
@@ -12,12 +12,15 @@ module ForemanRemoteExecution
       FactoryBot.build(:job_invocation, :with_template).tap do |invocation|
         invocation.targeting = targeting
         invocation.description = 'Some short description'
+        invocation.password = 'changeme'
+        invocation.key_passphrase = 'changemetoo'
         invocation.save
       end
     end
 
+    let(:uuid) { SecureRandom.uuid }
     let(:task) do
-      OpenStruct.new(:id => '123').tap do |o|
+      OpenStruct.new(:id => uuid).tap do |o|
         o.stubs(:add_missing_task_groups)
         o.stubs(:task_groups).returns([])
       end
@@ -76,15 +79,16 @@ module ForemanRemoteExecution
 
     it 'uses the BindJobInvocation middleware' do
       planned
-      job_invocation.task_id.must_equal '123'
+      job_invocation.task_id.must_equal uuid
     end
 
     # In plan phase this is handled by #action_subject
     #   which is expected in tests
     it 'sets input in delay phase when delayed' do
-      delayed.input[:job_invocation]['id'].must_equal job_invocation.id
-      delayed.input[:job_invocation]['name'].must_equal job_invocation.job_category
-      delayed.input[:job_invocation]['description'].must_equal job_invocation.description
+      job_invocation_hash = delayed.input[:job_invocation]
+      job_invocation_hash['id'].must_equal job_invocation.id
+      job_invocation_hash['name'].must_equal job_invocation.job_category
+      job_invocation_hash['description'].must_equal job_invocation.description
       planned # To make the expectations happy
     end
 

data/test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb

@@ -14,7 +14,7 @@ class ForemanRemoteExecutionForemanTasksCleanerExtensionsTest < ActiveSupport::T
     job.reload
     job.task.must_be :nil?
     job.task_id.wont_be :nil?
-    ForemanTasks::Cleaner.new(:filter => 'id = 1').delete
+    ForemanTasks::Cleaner.new(:filter => '').delete
     JobInvocation.where(:id => job.id).must_be :empty?
   end
 end

data/test/unit/job_invocation_composer_test.rb

@@ -412,6 +412,7 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
               }
             } }
         end
+
         let(:params) do
           { :job_invocation => { :providers => { :ssh => ssh_params } }, :targeting => { :search_query => "name = #{host.name}" } }.with_indifferent_access
         end
@@ -476,6 +477,30 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
         end
       end
 
+      describe '#password' do
+        let(:password) { 'changeme' }
+        let(:params) do
+          { :job_invocation => { :password => password }}.with_indifferent_access
+        end
+
+        it 'sets the password properly' do
+          composer
+          composer.job_invocation.password.must_equal password
+        end
+      end
+
+      describe '#key_passphrase' do
+        let(:key_passphrase) { 'changeme' }
+        let(:params) do
+          { :job_invocation => { :key_passphrase => key_passphrase }}
+        end
+
+        it 'sets the key passphrase properly' do
+          composer
+          composer.job_invocation.key_passphrase.must_equal key_passphrase
+        end
+      end
+
       describe '#targeting' do
         it 'triggers targeting on job_invocation' do
           composer
@@ -630,7 +655,7 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
           },
           :targeting_type => 'static_query',
           :search_query => 'some hosts',
-          :inputs => {input1.name => 'some_value'}}
+          :inputs => { input1.name => 'some_value' } }
       end
 
       it 'sets the concurrency level and time span based on the input' do
@@ -640,6 +665,23 @@ class JobInvocationComposerTest < ActiveSupport::TestCase
       end
     end
 
+    context 'with rex feature defined' do
+      let(:feature) { FactoryBot.create(:remote_execution_feature) }
+      let(:params) do
+        { :job_category => trying_job_template_1.job_category,
+          :job_template_id => trying_job_template_1.id,
+          :remote_execution_feature_id => feature.id,
+          :targeting_type => 'static_query',
+          :search_query => 'some hosts',
+          :inputs => { input1.name => 'some_value' } }
+      end
+
+      it 'sets the remote execution feature based on the input' do
+        assert composer.save!
+        composer.job_invocation.remote_execution_feature.must_equal feature
+      end
+    end
+
     context 'with invalid targeting' do
       let(:params) do
         { :job_category => trying_job_template_1.job_category,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_remote_execution
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - Foreman Remote Execution team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -56,16 +56,16 @@ dependencies:
   name: foreman-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".tx/config"
@@ -158,7 +159,6 @@ files:
 - app/mailers/.gitkeep
 - app/models/concerns/foreman_remote_execution/bookmark_extensions.rb
 - app/models/concerns/foreman_remote_execution/errors_flattener.rb
-- app/models/concerns/foreman_remote_execution/exportable.rb
 - app/models/concerns/foreman_remote_execution/foreman_tasks_cleaner_extensions.rb
 - app/models/concerns/foreman_remote_execution/foreman_tasks_task_extensions.rb
 - app/models/concerns/foreman_remote_execution/foreman_tasks_triggering_extensions.rb
@@ -294,8 +294,12 @@ files:
 - db/migrate/20160926225841_update_template_input_value.rb
 - db/migrate/20170110145641_add_host_action_button_to_remote_execution_feature.rb
 - db/migrate/20170613101039_add_timeout_to_job_templates_and_job_invocations.rb
+- db/migrate/20171129103615_add_secrets_to_job_invocations.rb
 - db/migrate/20180110104432_rename_template_invocation_permission.rb
 - db/migrate/20180112125015_fix_taxable_taxonomies_job_template.rb
+- db/migrate/20180202072115_add_notification_builder_to_remote_execution_feature.rb
+- db/migrate/20180202123215_add_feature_id_to_job_invocation.rb
+- db/migrate/20180226095631_change_task_id_to_uuid.rb
 - db/seeds.d/50-notification_blueprints.rb
 - db/seeds.d/60-ssh_proxy_feature.rb
 - db/seeds.d/70-job_templates.rb
@@ -339,9 +343,9 @@ files:
 - test/functional/api/v2/job_templates_controller_test.rb
 - test/functional/api/v2/remote_execution_features_controller_test.rb
 - test/functional/api/v2/template_inputs_controller_test.rb
+- test/functional/job_invocations_controller_test.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_hosts_job_test.rb
-- test/unit/concerns/exportable_test.rb
 - test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb
 - test/unit/concerns/host_extensions_test.rb
 - test/unit/concerns/nic_extensions_test.rb
@@ -376,7 +380,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A plugin bringing remote execution to the Foreman, completing the config
@@ -390,9 +394,9 @@ test_files:
 - test/functional/api/v2/job_templates_controller_test.rb
 - test/functional/api/v2/remote_execution_features_controller_test.rb
 - test/functional/api/v2/template_inputs_controller_test.rb
+- test/functional/job_invocations_controller_test.rb
 - test/test_plugin_helper.rb
 - test/unit/actions/run_hosts_job_test.rb
-- test/unit/concerns/exportable_test.rb
 - test/unit/concerns/foreman_tasks_cleaner_extensions_test.rb
 - test/unit/concerns/host_extensions_test.rb
 - test/unit/concerns/nic_extensions_test.rb

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

@@ -1,71 +0,0 @@
-# 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/test/unit/concerns/exportable_test.rb

@@ -1,88 +0,0 @@
-require 'test_plugin_helper'
-
-module ForemanRemoteExecution
-  class ExportableTest < ActiveSupport::TestCase
-    class SampleModel
-      include ::ForemanRemoteExecution::Exportable
-
-      attr_accessor :name, :attrs, :subnet, :mac, :password
-      attr_exportable :name, :attrs, :mac, :subnet, :mac => ->(m) { m.mac.upcase if m.mac },
-                                                    :custom_attr => ->(m) { 'hello world' }
-
-      def attributes
-        {
-          'name' => name,
-          'attrs' => attrs,
-          'mac' => mac,
-          'password' => password,
-          'subnet' => subnet
-        }
-      end
-    end
-
-    class SampleSubnet
-      include ::ForemanRemoteExecution::Exportable
-
-      attr_accessor :name, :network
-      attr_exportable :name, :network
-
-      def attributes
-        {
-          'name' => name,
-          'network' => network
-        }
-      end
-    end
-
-    def setup
-      @subnet = SampleSubnet.new
-      @subnet.name = 'pxe'
-      @subnet.network = '192.168.122.0'
-
-      @sample = SampleModel.new
-      @sample.name = 'name'
-      @sample.attrs = {'nested' => 'hash'}
-      @sample.subnet = @subnet
-      @sample.mac = 'aa:bb:cc:dd:ee:ff'
-      @sample.password = 'password'
-    end
-
-    test '#to_export includes all specified attributes' do
-      assert_equal %w(name attrs mac subnet custom_attr), @sample.to_export.keys
-    end
-
-    test '#to_export does not include all attributes' do
-      assert_not_include @sample.to_export.keys, 'password'
-    end
-
-    test '#to_export calls the lambda' do
-      export = @sample.to_export
-      assert_equal('AA:BB:CC:DD:EE:FF', export['mac'])
-      assert_equal(export['custom_attr'], 'hello world')
-    end
-
-    test '#to_export values are exported recursively' do
-      export = @sample.to_export
-      assert_equal('pxe', export['subnet']['name'])
-      assert_equal('192.168.122.0', export['subnet']['network'])
-    end
-
-    test '#to_export nested hashes are primitive' do
-      @sample.attrs = {:foo => 'bar', :baz => 'qux'}.with_indifferent_access
-      export = @sample.to_export
-      assert_instance_of Hash, export['attrs']
-    end
-
-    test '#to_export includes blank values' do
-      @sample.attrs = {}
-      export = @sample.to_export
-      assert_instance_of Hash, export['attrs']
-    end
-
-    test '#to_export(false) does not include blank values' do
-      @sample.attrs = {}
-      export = @sample.to_export(false)
-      assert_nil export['attrs']
-    end
-  end
-end