foreman-tasks 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abb4a2ffa0ff0ef6082c2ebe1a8a90d89b5b3b27
-  data.tar.gz: 35f084894f1692002cc5a76458b28f34763d9778
+  metadata.gz: 4b2dd645da0ebd3edca99e961dc24554fa56f679
+  data.tar.gz: 0e013856f470f68c6b5e0ed7f11feee290f0e4d4
 SHA512:
-  metadata.gz: da1b67abb754259dddb59013b176c38cfcb4c2f69d09640bf89a862f784b08d53ee30ca228723ab24aabb1db2770249e57b07cce9bb756df214feac2becd3393
-  data.tar.gz: 02be42c80788f710e700f8c502177c584a421517e76678299859258a08b2c1267c9134afd088b0801bce3390f9e19feafc3afb3affa0cd5c65df31c23cb0698e
+  metadata.gz: 9d8ca3871234b226b1e2d2843e6cdc59c4cbf712f8a8c942e478b304b7e07330aa5407bc55b159f90023970a55bfe0ffe9817473613dc3dc223847487eb4ba97
+  data.tar.gz: 50362b2a751157e3f8132ce4759f3262a389fa7c154bef924eecbfe9d2bf362809eb05c54c111da9188cc725b8a096f35d0b392cf4d4b66e43397a776792fbac

data/.rubocop.yml

@@ -43,10 +43,6 @@ Rails/SkipsModelValidations:
 Style/SymbolArray:
   Enabled: false
 
-# for compatibility with Foreman 1.15
-Rails/ApplicationRecord:
-  Enabled: false
-
 Style/FormatString:
   Enabled: false
 
@@ -62,6 +58,9 @@ Rails/ReversibleMigration:
 
 Metrics/BlockLength:
   Exclude:
+    - config/routes.rb
+    - lib/foreman_remote_execution/engine.rb
+    - test/**/*
     - lib/foreman_tasks/tasks/**/*
 
 Naming/FileName:

data/.rubocop_todo.yml

@@ -58,9 +58,6 @@ Rails/Exit:
   Exclude:
     - 'lib/**/*.rake'
 
-Rails/HttpPositionalArguments:
-  Enabled: false
-
 # Configuration parameters: Include.
 # Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
 Rails/Output:

data/app/controllers/foreman_tasks/concerns/parameters/triggering.rb

@@ -3,22 +3,28 @@ module ForemanTasks
     module Parameters
       module Triggering
         extend ActiveSupport::Concern
-        include Foreman::Controller::Parameters::KeepParam
 
         class_methods do
           def triggering_params_filter
             Foreman::ParameterFilter.new(::ForemanTasks::Triggering).tap do |filter|
-              filter.permit_by_context(:mode, :start_at, :start_before,
-                                       *::ForemanTasks::Triggering::PARAMS,
-                                       :nested => true)
+              filter.permit_by_context(
+                [
+                  :mode,
+                  :start_at,
+                  :start_before,
+                  *::ForemanTasks::Triggering::PARAMS,
+                  :days_of_week => {},
+                  :time => {},
+                  :end_time => {}
+                ],
+                :nested => true
+              )
             end
           end
         end
 
         def triggering_params
-          keep_param(params, :triggering, :days_of_week, :time, :end_time) do
-            self.class.triggering_params_filter.filter_params(params, parameter_filter_context, :triggering)
-          end
+          self.class.triggering_params_filter.filter_params(params, parameter_filter_context, :triggering)
         end
       end
     end

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -42,7 +42,7 @@ module ForemanTasks
       else
         flash[:warning] = _('The task cannot be cancelled at the moment.')
       end
-      redirect_to :back
+      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     def abort
@@ -52,7 +52,7 @@ module ForemanTasks
       else
         flash[:warning] = _('The task cannot be aborted at the moment.')
       end
-      redirect_to :back
+      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     def resume
@@ -63,7 +63,7 @@ module ForemanTasks
       else
         flash[:warning] = _('The execution has to be resumable.')
       end
-      redirect_to :back
+      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     def unlock
@@ -75,7 +75,7 @@ module ForemanTasks
       else
         flash[:warning] = _('The execution has to be paused.')
       end
-      redirect_to :back
+      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     def force_unlock
@@ -83,7 +83,7 @@ module ForemanTasks
       task.state = :stopped
       task.save!
       flash[:notice] = _('The task resources were unlocked with force.')
-      redirect_to :back
+      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     # we need do this to make the Foreman helpers working properly

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

@@ -0,0 +1,11 @@
+module Actions
+  module Middleware
+    class HideSecrets < ::Dynflow::Middleware
+      def present
+        action.input[:secrets]  = 'Secrets hidden' if action.input.key?(:secrets)
+        action.output[:secrets] = 'Secrets hidden' if action.output.key?(:secrets)
+        pass
+      end
+    end
+  end
+end

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

@@ -47,7 +47,7 @@ module Actions
       end
 
       def restore_curent_user
-        User.current = User.unscoped.find(action.input[:current_user_id])
+        User.current = User.unscoped.find(action.input[:current_user_id]) if action.input[:current_user_id].present?
         yield
       ensure
         User.current = nil

data/app/lib/actions/proxy_action.rb

@@ -3,6 +3,8 @@ module Actions
     include ::Dynflow::Action::Cancellable
     include ::Dynflow::Action::Timeouts
 
+    middleware.use ::Actions::Middleware::HideSecrets
+
     class CallbackData
       attr_reader :data
 
@@ -93,6 +95,12 @@ module Actions
     # @override to put custom logic on event handling
     def on_data(data)
       output[:proxy_output] = data
+      wipe_secrets!
+    end
+
+    def wipe_secrets!
+      input.delete(:secrets)
+      output.delete(:secrets)
     end
 
     # @override String name of an action to be triggered on server

data/app/models/foreman_tasks/lock.rb

@@ -1,5 +1,5 @@
 module ForemanTasks
-  class Lock < ActiveRecord::Base
+  class Lock < ApplicationRecord
     LINK_LOCK_NAME  = :link_resource
     OWNER_LOCK_NAME = :task_owner
 

data/app/models/foreman_tasks/recurring_logic.rb

@@ -1,7 +1,7 @@
 module ForemanTasks
   require 'parse-cron'
 
-  class RecurringLogic < ActiveRecord::Base
+  class RecurringLogic < ApplicationRecord
     include Authorizable
 
     belongs_to :task_group
@@ -11,7 +11,7 @@ module ForemanTasks
     if Rails::VERSION::MAJOR < 4
       has_many :task_groups, :through => :tasks, :uniq => true
     else
-      has_many :task_groups, -> { uniq }, :through => :tasks
+      has_many :task_groups, -> { distinct }, :through => :tasks
     end
 
     scoped_search :on => :id, :complete_value => false, :validator => ScopedSearch::Validators::INTEGER

data/app/models/foreman_tasks/task.rb

@@ -1,7 +1,7 @@
 require 'securerandom'
 
 module ForemanTasks
-  class Task < ActiveRecord::Base
+  class Task < ApplicationRecord
     include Authorizable
 
     def check_permissions_after_save

data/app/models/foreman_tasks/task_group.rb

@@ -1,5 +1,5 @@
 module ForemanTasks
-  class TaskGroup < ActiveRecord::Base
+  class TaskGroup < ApplicationRecord
     has_many :task_group_members, :dependent => :destroy
     has_many :tasks, :through => :task_group_members, :dependent => :nullify
 

data/app/models/foreman_tasks/task_group_member.rb

@@ -1,5 +1,5 @@
 module ForemanTasks
-  class TaskGroupMember < ActiveRecord::Base
+  class TaskGroupMember < ApplicationRecord
     belongs_to :task_group
     belongs_to :task
   end

data/app/models/foreman_tasks/triggering.rb

@@ -1,5 +1,5 @@
 module ForemanTasks
-  class Triggering < ActiveRecord::Base
+  class Triggering < ApplicationRecord
     PARAMS = [:start_at_raw, :start_before_raw, :max_iteration, :input_type,
               :cronline, :days, :days_of_week, :time, :end_time_limited,
               :end_time].freeze

data/deploy/foreman-tasks.sysconfig

@@ -1,6 +1,5 @@
 FOREMAN_USER=foreman
 BUNDLER_EXT_HOME=/usr/share/foreman
-RAILS_RELATIVE_URL_ROOT=$FOREMAN_PREFIX
 RAILS_ENV=production
 FOREMAN_LOGGING=warn
 FOREMAN_LOGGING_SQL=warn

data/lib/foreman_tasks/engine.rb

@@ -116,6 +116,7 @@ module ForemanTasks
     initializer 'foreman_tasks.require_dynflow', :before => 'foreman_tasks.initialize_dynflow' do |_app|
       ForemanTasks.dynflow.require!
       ::ForemanTasks.dynflow.config.on_init do |world|
+        world.middleware.use Actions::Middleware::KeepCurrentUser
         ForemanTasksCore.dynflow_setup(world)
       end
     end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.11.0'.freeze
+  VERSION = '0.11.1'.freeze
 end

data/test/controllers/api/recurring_logics_controller_test.rb

@@ -22,7 +22,7 @@ module ForemanRecurringLogic
 
       describe 'GET /api/recurring_logics/:id' do
         it 'searches for recurring logic' do
-          get :show, :id => @recurring_logic.id
+          get :show, params: { :id => @recurring_logic.id }
           assert_response :success
           assert_template 'api/recurring_logics/show'
         end
@@ -30,7 +30,7 @@ module ForemanRecurringLogic
 
       describe 'POST /api/recurring_logics/:id/cancel' do
         it 'cancels recurring logic' do
-          post :cancel, :id => @recurring_logic.id
+          post :cancel, params: { :id => @recurring_logic.id }
           assert_response :success
           @recurring_logic.reload
           assert @recurring_logic.state == 'cancelled'

data/test/controllers/api/tasks_controller_test.rb

@@ -14,15 +14,13 @@ module ForemanTasks
       describe 'GET /api/tasks/show' do
         it 'searches for task' do
           task = FactoryBot.create(:dynflow_task, :user_create_task)
-          get :show, :id => task.id
+          get :show, params: { :id => task.id }
           assert_response :success
           assert_template 'api/tasks/show'
         end
       end
 
       describe 'POST /tasks/callback' do
-        self.use_transactional_fixtures = false
-
         it 'passes the data to the corresponding action' do
           Support::DummyProxyAction.reset
 
@@ -37,7 +35,7 @@ module ForemanTasks
           task.result.must_equal 'pending'
 
           callback = Support::DummyProxyAction.proxy.log[:trigger_task].first[1][:callback]
-          post :callback, 'callback' => callback, 'data' => { 'result' => 'success' }
+          post :callback, params: { 'callback' => callback, 'data' => { 'result' => 'success' } }
           triggered.finished.wait(5)
 
           task.reload

data/test/foreman_tasks_test_helper.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 require_relative './support/dummy_dynflow_action'
 require_relative './support/dummy_proxy_action'
+require_relative './support/dummy_task_group'
 
 require 'dynflow/testing'
 

data/test/support/dummy_task_group.rb

@@ -0,0 +1,4 @@
+module Support
+  class DummyTaskGroup < ForemanTasks::TaskGroup
+  end
+end

data/test/unit/actions/action_with_sub_plans_test.rb

@@ -2,8 +2,6 @@ require 'foreman_tasks_test_helper'
 
 module ForemanTasks
   class ActionWithSubPlansTest < ActiveSupport::TestCase
-    self.use_transactional_fixtures = false
-
     before do
       User.current = User.where(:login => 'apiadmin').first
     end

data/test/unit/actions/proxy_action_test.rb

@@ -5,12 +5,17 @@ module ForemanTasks
     describe Actions::ProxyAction do
       include ::Dynflow::Testing
 
+      let(:secrets) do
+        { 'logins' => { 'admin' => 'changeme', 'root' => 'toor' } }
+      end
+
       before do
         Support::DummyProxyAction.reset
         @action = create_and_plan_action(Support::DummyProxyAction,
                                          Support::DummyProxyAction.proxy,
                                          'Proxy::DummyAction',
-                                         'foo' => 'bar')
+                                         'foo' => 'bar',
+                                         'secrets' => secrets)
         @action = run_action(@action)
       end
 
@@ -19,6 +24,7 @@ module ForemanTasks
           proxy_call = Support::DummyProxyAction.proxy.log[:trigger_task].first
           expected_call = ['Proxy::DummyAction',
                            { 'foo' => 'bar',
+                             'secrets' => secrets,
                              'connection_options' =>
                                  { 'retry_interval' => 15, 'retry_count' => 4, 'timeout' => 60 },
                              'proxy_url' => 'proxy.example.com',
@@ -86,6 +92,23 @@ module ForemanTasks
         proc { action = run_stubbed_action.call action }.must_raise(Errno::ECONNREFUSED)
         action.state.must_equal :error
       end
+
+      it 'hides secrets' do
+        triggered = ForemanTasks.dynflow.world.trigger(Support::DummyProxyAction,
+                                                       Support::DummyProxyAction.proxy,
+                                                       'Proxy::DummyAction',
+                                                       'foo' => 'bar',
+                                                       'secrets' => secrets)
+        task = ForemanTasks::Task.where(:external_id => triggered.id).first
+        task.input[:secrets].must_equal 'Secrets hidden'
+        triggered.future.wait # Wait for the task to get triggered before leaving the test
+      end
+
+      it 'wipes secrets' do
+        @action.input[:secrets].must_equal secrets
+        action = run_action(@action, ::Actions::ProxyAction::CallbackData.new('result' => 'success'))
+        refute action.input.key?(:secrets)
+      end
     end
   end
 end

data/test/unit/recurring_logic_test.rb

@@ -88,6 +88,17 @@ class RecurringLogicsTest < ActiveSupport::TestCase
       recurring_logic.start(::Support::DummyDynflowAction)
     end
 
+    it 'has a task group associated to all tasks that were created as part of the recurring logic' do
+      recurring_logic = ForemanTasks::RecurringLogic.new_from_cronline('* * * * *')
+      recurring_logic.save
+      recurring_logic.task_group.must_be_kind_of ForemanTasks::TaskGroups::RecurringLogicTaskGroup
+      task = FactoryBot.build(:dynflow_task, :user_create_task)
+      task.task_groups << Support::DummyTaskGroup.new
+      task.save!
+      recurring_logic.task_group.tasks << task
+      recurring_logic.task_groups.must_include(*task.task_groups)
+    end
+
     it 'can be created from triggering' do
       triggering = FactoryBot.build(:triggering, :recurring, :end_time_limited)
       logic = ForemanTasks::RecurringLogic.new_from_triggering(triggering)

data/test/unit/task_groups_test.rb

@@ -2,7 +2,6 @@ require 'foreman_tasks_test_helper'
 
 module ForemanTasks
   class TaskGroupsTest < ActiveSupport::TestCase
-    self.use_transactional_fixtures = false
     include ::Dynflow::Testing
 
     before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -137,6 +137,7 @@ files:
 - app/lib/actions/helpers/lock.rb
 - app/lib/actions/helpers/with_continuous_output.rb
 - app/lib/actions/helpers/with_delegated_action.rb
+- app/lib/actions/middleware/hide_secrets.rb
 - app/lib/actions/middleware/inherit_task_groups.rb
 - app/lib/actions/middleware/keep_current_user.rb
 - app/lib/actions/middleware/rails_executor_wrap.rb
@@ -241,6 +242,7 @@ files:
 - test/helpers/foreman_tasks/tasks_helper_test.rb
 - test/support/dummy_dynflow_action.rb
 - test/support/dummy_proxy_action.rb
+- test/support/dummy_task_group.rb
 - test/unit/actions/action_with_sub_plans_test.rb
 - test/unit/actions/proxy_action_test.rb
 - test/unit/cleaner_test.rb
@@ -288,6 +290,7 @@ test_files:
 - test/helpers/foreman_tasks/tasks_helper_test.rb
 - test/support/dummy_dynflow_action.rb
 - test/support/dummy_proxy_action.rb
+- test/support/dummy_task_group.rb
 - test/unit/actions/action_with_sub_plans_test.rb
 - test/unit/actions/proxy_action_test.rb
 - test/unit/cleaner_test.rb