foreman-tasks 0.17.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 289b729c99fef5c4047a025dd9deabfe4421ea2f5c457922f22ebababf0bf4e9
-  data.tar.gz: 4c571c09518c2b3ce576b4cf31be1b62e5cae4c15bc8d8401a4ce8886bd60e4f
+  metadata.gz: bfc833d42aeafa9f146457f33ffe29db5f4ddc374a372511a384f05d6932754e
+  data.tar.gz: eda50a6c4a0e2c1257fd72c5764c5eed7df097beb230579304ccf1943a472477
 SHA512:
-  metadata.gz: 5b751006f3adf4e24870a916e4ba5e13a67234d10bb977e1d66df84c626059c544179b4042d631acd50481b831eb38bfe20c6739cb3c9e1efda83e35805e2b34
-  data.tar.gz: cb353429cb48a625176818a3625be9da6e0c7f4deede573c2e614364d4b20d263b2476f614fa2b45813131b1cfbf113e5d736ceb7522dbd2b8dd889f02ff920b
+  metadata.gz: cbbb4c98796edf5e91c2f7b3fd731a40162c6865b94e5c262f61865a5f4b18f939e38a76920756b9f6919501a72ba47b02653ba27fec54ad035e461d33df60bd
+  data.tar.gz: 868cbea935b39e9dd74ff7a616983e1e68d89355716134f493fd29485280c0cc2e4f01ea015358c1285ac82f3ece89c9234c5cac5a73add22edb6213cfbacd43

data/app/assets/stylesheets/foreman_tasks/tasks.css.scss

@@ -1,7 +1,7 @@
 .param-name {
-    display: inline-block;
-    width: 10em;
-  }
+  display: inline-block;
+  width: 10em;
+}
 
 .task-details pre {
   white-space: pre;

data/app/controllers/foreman_tasks/api/tasks_controller.rb

@@ -31,6 +31,15 @@ module ForemanTasks
       param :id, :identifier, desc: 'UUID of the task'
       def details; end
 
+      api :GET, '/tasks/:id/sub_tasks', 'Show sub_tasks details'
+      param :id, :identifier, desc: 'UUID of the task'
+      def sub_tasks
+        parent_task = resource_scope.find(params[:id])
+        filtered_scope = parent_task.sub_tasks
+        action_name = { "action_name" => parent_task.action }
+        render :json => action_name.merge(tasks_list(filtered_scope))
+      end
+
       api :POST, '/tasks/bulk_search', 'List dynflow tasks for uuids'
       param :searches, Array, :desc => 'List of uuids to fetch info about' do
         param :search_id, String, :desc => <<-DESC
@@ -121,35 +130,8 @@ module ForemanTasks
         param :order, String, :desc => N_('How to order the sorted results (e.g. ASC for ascending)')
       end
       def index
-        total = resource_scope.count
-        subtotal = resource_scope.search_for(params[:search]).select('DISTINCT foreman_tasks_tasks.id').count
-
-        scope = resource_scope.search_for(params[:search]).select('DISTINCT foreman_tasks_tasks.*')
-
-        ordering_params = {
-          sort_by: params[:sort_by] || 'started_at',
-          sort_order: params[:sort_order] || 'DESC'
-        }
-        scope = ordering_scope(scope, ordering_params)
-
-        pagination_params = {
-          page: params[:page] || 1,
-          per_page: params[:per_page] || Setting[:entries_per_page] || 20
-        }
-        scope = pagination_scope(scope, pagination_params)
-        results = scope.map { |task| task_hash(task) }
-
-        render :json => {
-          total: total,
-          subtotal: subtotal,
-          page: pagination_params[:page],
-          per_page: pagination_params[:per_page],
-          sort: {
-            by: ordering_params[:sort_by],
-            order: ordering_params[:sort_order]
-          },
-          results: results
-        }
+        filtered_scope = DashboardTableFilter.new(resource_scope, params).scope
+        render :json => tasks_list(filtered_scope)
       end
 
       def_param_group :callback_target do
@@ -255,6 +237,7 @@ module ForemanTasks
       def ordering_scope(scope, ordering_params)
         sort_by = ordering_params[:sort_by] || 'started_at'
         sort_order = ordering_params[:sort_order] || 'DESC'
+        scope = scope.select("*, coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) as duration")
         scope.order("#{sort_by} #{sort_order}")
       end
 
@@ -278,9 +261,13 @@ module ForemanTasks
         @resource_scope ||= ForemanTasks::Task.authorized("#{action_permission}_foreman_tasks")
       end
 
+      def resource_class
+        @resource_class ||= ForemanTasks::Task
+      end
+
       def action_permission
         case params[:action]
-        when 'bulk_search', 'summary', 'details'
+        when 'bulk_search', 'summary', 'details', 'sub_tasks'
           :view
         when 'bulk_resume'
           :edit
@@ -288,6 +275,39 @@ module ForemanTasks
           super
         end
       end
+
+      def tasks_list(filtered_scope)
+        total = resource_scope.count
+
+        search_scope = filtered_scope.search_for(params[:search])
+        subtotal = search_scope.select('DISTINCT foreman_tasks_tasks.id').count
+        filtered_scope = search_scope.select('DISTINCT foreman_tasks_tasks.*')
+
+        ordering_params = {
+          sort_by: params[:sort_by] || 'started_at',
+          sort_order: params[:sort_order] || 'DESC'
+        }
+        filtered_scope = ordering_scope(filtered_scope, ordering_params)
+
+        pagination_params = {
+          page: params[:page] || 1,
+          per_page: params[:per_page] || Setting[:entries_per_page] || 20
+        }
+        filtered_scope = pagination_scope(filtered_scope, pagination_params)
+        results = filtered_scope.map { |task| task_hash(task) }
+
+        {
+          total: total,
+          subtotal: subtotal,
+          page: pagination_params[:page],
+          per_page: pagination_params[:per_page],
+          sort: {
+            by: ordering_params[:sort_by],
+            order: ordering_params[:sort_order]
+          },
+          results: results
+        }
+      end
     end
   end
 end

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -16,7 +16,8 @@ module ForemanTasks
     end
 
     def summary
-      render json: Task::Summarizer.new(resource_base, params[:recent_timeframe].to_i).summary
+      scope = resource_base.search_for(current_taxonomy_search).select(:id)
+      render json: Task::Summarizer.new(Task.where(:id => scope), params[:recent_timeframe].to_i).summary
     end
 
     def sub_tasks
@@ -35,11 +36,10 @@ module ForemanTasks
     def cancel
       task = find_dynflow_task
       if task.cancel
-        flash[:info] = _('Trying to cancel the task')
+        render json: { statusText: 'OK' }
       else
-        flash[:warning] = _('The task cannot be cancelled at the moment.')
+        render json: {}, status: :bad_request
       end
-      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     def abort
@@ -56,11 +56,10 @@ module ForemanTasks
       task = find_dynflow_task
       if task.resumable?
         ForemanTasks.dynflow.world.execute(task.execution_plan.id)
-        flash[:info] = _('The execution was resumed.')
+        render json: { statusText: 'OK' }
       else
-        flash[:warning] = _('The execution has to be resumable.')
+        render json: {}, status: :bad_request
       end
-      redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
     def unlock
@@ -95,16 +94,8 @@ module ForemanTasks
     private
 
     def respond_with_tasks(scope)
-      respond_to do |format|
-        format.html do
-          @tasks = filter(scope)
-          render :index, layout: !request.xhr?
-        end
-        format.csv do
-          @tasks = filter(scope, paginate: false)
-          csv_response(@tasks, [:id, :action, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :username], ['Id', 'Action', 'State', 'Result', 'Started At', 'Ended At', 'User'])
-        end
-      end
+      @tasks = filter(scope, paginate: false)
+      csv_response(@tasks, [:id, :action, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :username], ['Id', 'Action', 'State', 'Result', 'Started At', 'Ended At', 'User'])
     end
 
     def restrict_dangerous_actions

data/app/models/foreman_tasks/task.rb

@@ -49,10 +49,12 @@ module ForemanTasks
     scoped_search :on => :user_id,
                   :complete_value => true,
                   :rename => 'user.id',
-                  :validator => ->(value) { ScopedSearch::Validators::INTEGER.call(value) || value == 'current_user' },
-                  :aliases => ['owner.id'], :ext_method => :search_by_owner, :only_explicit => true
-    scoped_search :relation => :user, :on => :login, :rename => 'user.login', :complete_value => true, :aliases => ['owner.login', 'user'], :ext_method => :search_by_owner, :only_explicit => true
-    scoped_search :relation => :user, :on => :firstname, :rename => 'user.firstname', :complete_value => true, :aliases => ['owner.firstname'], :ext_method => :search_by_owner, :only_explicit => true
+                  :validator => ->(value) { ScopedSearch::Validators::INTEGER.call(value) },
+                  :value_translation => ->(value) { value == 'current_user' ? User.current.id : value },
+                  :special_values => %w[current_user],
+                  :aliases => ['owner.id'], :only_explicit => true
+    scoped_search :relation => :user, :on => :login, :complete_value => true, :aliases => ['owner.login', 'user'], :only_explicit => true
+    scoped_search :relation => :user, :on => :firstname, :rename => 'user.firstname', :complete_value => true, :aliases => ['owner.firstname'], :only_explicit => true
     scoped_search :relation => :task_groups, :on => :id, :complete_value => true, :rename => 'task_group.id', :validator => ScopedSearch::Validators::INTEGER
 
     scope :active, -> {  where('foreman_tasks_tasks.state != ?', :stopped) }

data/app/models/foreman_tasks/task/search.rb

@@ -22,31 +22,6 @@ module ForemanTasks
         sql = "foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id #{operator} ? OR foreman_tasks_locks_taxonomy#{uniq_suffix}.resource_id IS NULL"
         { :conditions => sanitize_sql_for_conditions([sql, value]), :joins => joins }
       end
-
-      def search_by_owner(key, operator, value)
-        return { :conditions => '0 = 1' } if value == 'current_user' && User.current.nil?
-
-        key = 'owners.login' if key == 'user'
-        # using uniq suffix to avoid colisions when searching by two different owners via ScopedSearch
-        uniq_suffix = SecureRandom.hex(3)
-        key_name = connection.quote_column_name(key.sub(/^.*\./, ''))
-        value.sub!('*', '%%')
-        condition = if key.blank?
-                      sanitize_sql_for_conditions(["users_#{uniq_suffix}.login #{operator} ? or users_#{uniq_suffix}.firstname #{operator} ? ", value, value])
-                    elsif key =~ /\.id\Z/
-                      value = User.current.id if value == 'current_user'
-                      sanitize_sql_for_conditions(["foreman_tasks_tasks.user_id #{operator} ?", value])
-                    else
-                      placeholder, value = operator == 'IN' ? ['(?)', value.split(',').map(&:strip)] : ['?', value]
-                      sanitize_sql_for_conditions(["users_#{uniq_suffix}.#{key_name} #{operator} #{placeholder}", value])
-                    end
-        { :conditions => condition, :joins => joins_for_user_search(key, uniq_suffix) }
-      end
-
-      def joins_for_user_search(key, uniq_suffix)
-        return '' if key =~ /\.id\Z/
-        "INNER JOIN users AS users_#{uniq_suffix} ON users_#{uniq_suffix}.id = foreman_tasks_tasks.user_id"
-      end
     end
   end
 end

data/app/models/setting/foreman_tasks.rb

@@ -1,28 +1,24 @@
 class Setting::ForemanTasks < Setting
-  def self.load_defaults
-    # Check the table exists
-    return unless super
+  def self.default_settings
+    [
+      set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120),
+      set('dynflow_allow_dangerous_actions', N_('Allow unlocking actions which can have dangerous consequences.'), false),
+      set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true),
+      set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true),
+      set('foreman_tasks_proxy_action_retry_count', N_('Number of attempts to start a task on the smart proxy before failing'), 4),
+      set('foreman_tasks_proxy_action_retry_interval', N_('Time in seconds between retries'), 15),
+      set('foreman_tasks_proxy_batch_trigger', N_('Allow triggering tasks on the smart proxy in batches'), true),
+      set('foreman_tasks_proxy_batch_size', N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'), 100),
+      set('foreman_tasks_troubleshooting_url',
+          N_('Url pointing to the task troubleshooting documentation. '\
+             'It should contain %{label} placeholder, that will be replaced with normalized task label '\
+             '(restricted to only alphanumeric characters)). %{version} placeholder is also available.'),
+          nil)
+    ]
+  end
 
+  def self.load_defaults
     Setting::BLANK_ATTRS.push('foreman_tasks_troubleshooting_url')
-
-    transaction do
-      [
-        set('foreman_tasks_sync_task_timeout', N_('Number of seconds to wait for synchronous task to finish.'), 120),
-        set('dynflow_allow_dangerous_actions', N_('Allow unlocking actions which can have dangerous consequences.'), false),
-        set('dynflow_enable_console', N_('Enable the dynflow console (/foreman_tasks/dynflow) for debugging'), true),
-        set('dynflow_console_require_auth', N_('Require user to be authenticated as user with admin rights when accessing dynflow console'), true),
-        set('foreman_tasks_proxy_action_retry_count', N_('Number of attempts to start a task on the smart proxy before failing'), 4),
-        set('foreman_tasks_proxy_action_retry_interval', N_('Time in seconds between retries'), 15),
-        set('foreman_tasks_proxy_batch_trigger', N_('Allow triggering tasks on the smart proxy in batches'), true),
-        set('foreman_tasks_proxy_batch_size', N_('Number of tasks which should be sent to the smart proxy in one request, if foreman_tasks_proxy_batch_trigger is enabled'), 100),
-        set('foreman_tasks_troubleshooting_url',
-            N_('Url pointing to the task troubleshooting documentation. '\
-               'It should contain %{label} placeholder, that will be replaced with normalized task label '\
-               '(restricted to only alphanumeric characters)). %{version} placeholder is also available.'),
-            nil)
-      ].each { |s| create! s.update(:category => 'Setting::ForemanTasks') }
-    end
-
-    true
+    super
   end
 end

data/app/views/foreman_tasks/api/tasks/show.json.rabl

@@ -3,3 +3,4 @@ object @task if @task
 attributes :id, :label, :pending, :action
 attributes :username, :started_at, :ended_at, :state, :result, :progress
 attributes :input, :output, :humanized, :cli_example
+node(:available_actions) { |t| {cancellable: t.execution_plan&.cancellable?, resumable: t.resumable? }}

data/app/views/foreman_tasks/layouts/react.html.erb

@@ -1,6 +1,9 @@
 <% content_for(:javascripts) do %>
   <%= webpacked_plugins_js_for :'foreman-tasks' %>
 <% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :'foreman-tasks' %>
+<% end %>
 
 <% content_for(:content) do %>
   <%= notifications %>
@@ -9,4 +12,4 @@
   <div id="foremanTasksReactRoot"></div>
 <% end %>
 <%= render file: "layouts/base" %>
-<%= mount_react_component('ForemanTasks', '#foremanTasksReactRoot',{ :flatten_data => true }) %>
+<%= mount_react_component('ForemanTasks', '#foremanTasksReactRoot') %>

data/config/routes.rb

@@ -8,13 +8,12 @@ Foreman::Application.routes.draw do
       end
     end
 
-    resources :tasks, :only => [:index, :show] do
+    resources :tasks, :only => [:show] do
       collection do
         get 'auto_complete_search'
         get '/summary/:recent_timeframe', action: 'summary'
       end
       member do
-        get :sub_tasks
         post :abort
         post :cancel
         post :resume
@@ -23,8 +22,15 @@ Foreman::Application.routes.draw do
         post :cancel_step
       end
     end
+    resources :tasks, :only => [:show], constraints: ->(req) { req.format == :csv } do
+      member do
+        get :sub_tasks
+      end
+    end
+    resources :tasks, :only => [:index], constraints: ->(req) { req.format == :csv }
 
-    match '/ex_tasks' => 'react#index', :via => [:get]
+    match '/tasks' => 'react#index', :via => [:get]
+    match '/tasks/:id/sub_tasks' => 'react#index', :via => [:get]
     match '/ex_tasks/:id' => 'react#index', :via => [:get]
 
     namespace :api do
@@ -37,6 +43,7 @@ Foreman::Application.routes.draw do
       resources :tasks, :only => [:show, :index] do
         member do
           get :details
+          get :sub_tasks
         end
         collection do
           post :bulk_search
@@ -50,6 +57,13 @@ Foreman::Application.routes.draw do
     if ForemanTasks.dynflow.required?
       require 'dynflow/web'
       mount ForemanTasks.dynflow.web_console => '/dynflow'
+      if defined? ::Sidekiq
+        require 'sidekiq/web'
+        redis_url = SETTINGS.dig(:dynflow, :redis_url)
+        Sidekiq.redis = { url: redis_url }
+        Sidekiq::Web.set :sessions, false
+        mount Sidekiq::Web => '/sidekiq', :constraints => ForemanTasks::Dynflow::SidekiqConsoleConstraint.new
+      end
     end
   end
 end

data/db/migrate/20180927120509_add_user_id.foreman_tasks.rb

@@ -5,8 +5,10 @@ class AddUserId < ActiveRecord::Migration[5.0]
     return if User.unscoped.find_by(:login => User::ANONYMOUS_ADMIN).nil?
     User.as_anonymous_admin do
       user_locks.select(:resource_id).distinct.pluck(:resource_id).each do |owner_id|
-        tasks = ForemanTasks::Task.joins(:locks).where(:locks => user_locks.where(:resource_id => owner_id))
-        tasks.update_all(:user_id => owner_id)
+        if User.exists?(:id => owner_id)
+          tasks = ForemanTasks::Task.joins(:locks).where(:locks => user_locks.where(:resource_id => owner_id))
+          tasks.update_all(:user_id => owner_id)
+        end
         user_locks.where(:resource_id => owner_id).delete_all
       end
     end

data/lib/foreman_tasks/dynflow.rb

@@ -9,7 +9,7 @@ module ForemanTasks
       ::Dynflow::Web.setup do
         before do
           if !Setting[:dynflow_enable_console] ||
-             (Setting[:dynflow_console_require_auth] && !ConsoleAuthorizer.new(env).allow?)
+             (Setting[:dynflow_console_require_auth] && !ConsoleAuthorizer.from_env(env).allow?)
             halt 403, 'Access forbidden'
           end
         end

data/lib/foreman_tasks/dynflow/console_authorizer.rb

@@ -1,7 +1,18 @@
 module ForemanTasks
+  class Dynflow::SidekiqConsoleConstraint
+    def matches?(request)
+      Setting[:dynflow_enable_console] &&
+        (!Setting[:dynflow_console_require_auth] || Dynflow::ConsoleAuthorizer.new(request).allow?)
+    end
+  end
+
   class Dynflow::ConsoleAuthorizer
-    def initialize(env)
-      @rack_request = Rack::Request.new(env)
+    def self.from_env(env)
+      new(Rack::Request.new(env))
+    end
+
+    def initialize(request)
+      @rack_request = request
       @user_id = @rack_request.session[:user]
       @expires_at = @rack_request.session[:expires_at]
       @user = User.unscoped.where(:id => @user_id).first unless session_expired?

data/lib/foreman_tasks/engine.rb

@@ -58,7 +58,7 @@ module ForemanTasks
         security_block :foreman_tasks do |_map|
           permission :view_foreman_tasks, { :'foreman_tasks/tasks' => [:auto_complete_search, :sub_tasks, :index, :summary, :show],
                                             :'foreman_tasks/react' => [:index],
-                                            :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :details] }, :resource_type => ForemanTasks::Task.name
+                                            :'foreman_tasks/api/tasks' => [:bulk_search, :show, :index, :summary, :details, :sub_tasks] }, :resource_type => ForemanTasks::Task.name
           permission :edit_foreman_tasks, { :'foreman_tasks/tasks' => [:resume, :unlock, :force_unlock, :cancel_step, :cancel, :abort],
                                             :'foreman_tasks/api/tasks' => [:bulk_resume] }, :resource_type => ForemanTasks::Task.name
 

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.17.0'.freeze
+  VERSION = '0.17.1'.freeze
 end

data/package.json

@@ -23,6 +23,7 @@
   },
   "dependencies": {
     "@theforeman/vendor": "^1.4.0",
+    "c3": "^0.4.11",
     "humanize-duration": "^3.20.1",
     "react-intl": "^2.8.0"
   },

data/test/controllers/tasks_controller_test.rb

@@ -3,10 +3,6 @@ require 'foreman_tasks_test_helper'
 module ForemanTasks
   class TasksControllerTest < ActionController::TestCase
     describe ForemanTasks::TasksController do
-      basic_index_test('tasks')
-      basic_pagination_per_page_test
-      basic_pagination_rendered_test
-
       # rubocop:disable Naming/AccessorMethodName
       def get_factory_name
         :dynflow_task
@@ -41,6 +37,41 @@ module ForemanTasks
           response = JSON.parse(@response.body)
           assert_equal 0, response['stopped']['total']
         end
+
+        describe 'taxonomy scoping' do
+          before do
+            @organizations = [0, 0].map { FactoryBot.create(:organization) }
+            @locations = [0, 0].map { FactoryBot.create(:location) }
+            @tasks = [0, 0].map { FactoryBot.create(:some_task) }
+            @tasks.zip(@organizations, @locations).each do |task, org, loc|
+              Lock.link!(org, task.id)
+              Lock.link!(loc, task.id)
+            end
+          end
+
+          it 'does not limit if unset' do
+            get(:summary, params: { recent_timeframe: 24 }, session: set_session_user)
+            assert_response :success
+            response = JSON.parse(@response.body)
+            assert_equal 2, response['stopped']['total']
+          end
+
+          it 'finds only tasks with matching taxonomies' do
+            get(:summary, params: { recent_timeframe: 24 },
+                          session: set_session_user.merge(:organization_id => @organizations.first, :location_id => @locations.first))
+            assert_response :success
+            response = JSON.parse(@response.body)
+            assert_equal 1, response['stopped']['total']
+          end
+
+          it 'find no tasks when taxonomy combination contains no tasks' do
+            get(:summary, params: { recent_timeframe: 24 },
+                          session: set_session_user.merge(:organization_id => @organizations.first, :location_id => @locations.last))
+            assert_response :success
+            response = JSON.parse(@response.body)
+            assert_equal 0, response['stopped']['total']
+          end
+        end
       end
 
       it 'supports csv export' do