foreman-tasks 0.11.3 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5215b1de3a75cefb5abd6ee4cddab099336f5982
-  data.tar.gz: d4a4c997bc7a1527fb022d2e058f8e0b6c47379d
+  metadata.gz: c7c6574c1c5525bc889cdc026a5604229f0807b9
+  data.tar.gz: 4c79cb7a232ea3115f09c06e619667b7a203d821
 SHA512:
-  metadata.gz: d4a03380fa48d6f4c61f0b3b87ab9ef0b81e7938ee1090a50e205ec9e2a60b4e11a1a18ccd3bbb7c5d69880b8bf76e913a403233f5df7df9b4839f6cc5310396
-  data.tar.gz: dfd5566f78c22ab02632dc33edca0a9a9e9ef25a00e297399d09440be29c2d79fd3bb87371766fef052e5ae8aefac914dc7407b8093071a21d9218eef8588a34
+  metadata.gz: 0a4b956c2dd74d1cd3c20499636bcaf794accdd6442a21565bc2912c8c112827f5c1fdc709334393631e4e1d1d8460e090c6a9ea9a6904c072657a1743d21de0
+  data.tar.gz: 1b31d911db9af5260d56754779c068f53d66a9936e90a73b2b5889cdd2321d6aefdde41bfc6a3e68152d908312e2101c7e1fe971fd4851969bb4d51b11e05e08

data/.rubocop.yml

@@ -98,3 +98,6 @@ Rails/InverseOf:
 
 Style/FormatStringToken:
   Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/app/controllers/foreman_tasks/concerns/hosts_controller_extension.rb

@@ -1,7 +1,13 @@
 module ForemanTasks
   module Concerns
     module HostsControllerExtension
-      def facts
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :facts, :dynflow
+      end
+
+      def facts_with_dynflow
         task = ForemanTasks.async_task(::Actions::Foreman::Host::ImportFacts,
                                        detect_host_type,
                                        params[:name],

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -17,7 +17,7 @@ module ForemanTasks
           render :index
         end
         format.csv do
-          csv_response(@tasks, [:to_label, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :username], ['Action', 'State', 'Result', 'Started At', 'Ended At', 'User'])
+          csv_response(@tasks, [:action_label, :state, :result, 'started_at.in_time_zone', 'ended_at.in_time_zone', :username], ['Action', 'State', 'Result', 'Started At', 'Ended At', 'User'])
         end
       end
     end

data/app/helpers/foreman_tasks/tasks_helper.rb

@@ -1,7 +1,8 @@
 module ForemanTasks
   module TasksHelper
     def format_task_input(task)
-      task ? task.to_label : '-'
+      return '-' unless task
+      task.action
     end
 
     def format_recurring_logic_limit(thing)

data/app/models/foreman_tasks/task.rb

@@ -36,6 +36,7 @@ module ForemanTasks
     end
 
     scoped_search :on => :id, :complete_value => false
+    scoped_search :on => :action, :complete_value => false
     scoped_search :on => :label, :complete_value => true
     scoped_search :on => :state, :complete_value => true
     scoped_search :on => :result, :complete_value => true
@@ -202,6 +203,10 @@ module ForemanTasks
       result.symbolize_keys
     end
 
+    def action
+      super || to_label
+    end
+
     def to_label
       parts = []
       parts << get_humanized(:name)

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

@@ -3,6 +3,7 @@ module ForemanTasks
     include Algebrick::TypeCheck
 
     scope :for_action, ->(action_class) { where(label: action_class.name) }
+    after_validation :set_action_field
 
     def update_from_dynflow(data)
       utc_zone = ActiveSupport::TimeZone.new('UTC')
@@ -152,6 +153,10 @@ module ForemanTasks
 
     private
 
+    def set_action_field
+      self.action = to_label
+    end
+
     def map_result(data)
       if state_result_transitioned?(%w[planned pending], %w[stopped error], data) ||
          (data[:result] == :error && cancelled?)

data/app/views/foreman_tasks/recurring_logics/index.html.erb

@@ -1,7 +1,7 @@
 <% title _("Recurring logics") %>
 <% title_actions SETTINGS[:version].short <= '1.13' ? help_path : help_button %>
 
-<table class="table table-fixed table-bordered table-striped table-condensed">
+<table class="<%= table_css_classes('table-condensed table-fixed') %>">
   <thead>
     <th><%= N_("Cron line") %></th>
     <th><%= N_("Task count") %></th>

data/app/views/foreman_tasks/task_groups/_common.html.erb

@@ -1,5 +1,5 @@
 <div>
-  <table class='table table-condensed'>
+  <table class='<%= table_css_classes('table-condensed') %>'>
     <tr>
       <th><%= N_('ID') %></th>
       <td><%= link_to(task_group.id, foreman_tasks_task_group_url(task_group)) %></td>

data/app/views/foreman_tasks/task_groups/recurring_logic_task_groups/_recurring_logic_task_group.html.erb

@@ -1,5 +1,5 @@
 <% recurring_logic = task_group.recurring_logic -%>
-<table class='table table-condensed'>
+<table class='<%= table_css_classes('table-condensed') %>'>
   <tr>
     <th>ID</th>
     <td><%= link_to(recurring_logic.id, recurring_logic) %></td>

data/app/views/foreman_tasks/tasks/_details.html.erb

@@ -89,7 +89,8 @@
   <div class="col-md-6">
     <div>
       <span class="param-name list-group-item-heading"><%= _("Name") %>:</span>
-      <span class="param-value" data-original-title="<%= @task.to_label %>" rel="twipsy"> <%= truncate(@task.to_label, :length => 50) %></span>
+      <% task_label = format_task_input(@task) %>
+      <span class="param-value" data-original-title="<%= task_label %>" rel="twipsy"> <%= truncate(task_label, :length => 50) %></span>
     </div>
     <div>
       <span class="param-name list-group-item-heading"><%= _("Result") %>:</span>

data/app/views/foreman_tasks/tasks/dashboard/_latest_tasks_in_error_warning.html.erb

@@ -1,5 +1,5 @@
 <h4><%= link_to _("Latest Warning/Error Tasks"), foreman_tasks_tasks_path(:order=>'started_at DESC') %></h4>
-<table class="table table-striped table-fixed">
+<table class="<%= table_css_classes('table-fixed') %>">
   <tr>
     <th class="col-md-5"><%= _("Name") %></th>
     <th class="col-md-2"><%= _("State") %></th>

data/app/views/foreman_tasks/tasks/dashboard/_tasks_status.html.erb

@@ -1,5 +1,5 @@
 <h4 class="header"><%=_("Task Status")%></h4>
-<table class="table table-striped">
+<table class="<%= table_css_classes('table-condensed') %>">
   <tr>
     <th><%= _("State") %></th>
     <th><%= _("Result") %></th>

data/app/views/foreman_tasks/tasks/index.html.erb

@@ -27,8 +27,8 @@ $(document).on('click', ".table-two-pane td.two-pane-link", function(e) {
   <% for task in @tasks %>
     <tr>
       <td class="task-id two-pane-link ellipsis">
-        <%= link_to_if_authorized(task.to_label,
-        hash_for_foreman_tasks_task_path(:id => task)) %>
+        <%= link_to_if_authorized(format_task_input(task),
+                                  hash_for_foreman_tasks_task_path(:id => task)) %>
       </td>
       <td class="ellipsis"><%= task.state %></td>
       <td class="ellipsis"><%= task.result %></td>

data/db/migrate/20171026082635_add_task_action.foreman_tasks.rb

@@ -0,0 +1,9 @@
+class AddTaskAction < ActiveRecord::Migration[4.2]
+  def up
+    add_column :foreman_tasks_tasks, :action, :string
+  end
+
+  def down
+    remove_column :foreman_tasks_tasks, :action
+  end
+end

data/db/migrate/20180216092715_use_uuid.rb

@@ -0,0 +1,44 @@
+class UseUuid < ActiveRecord::Migration[5.0]
+  # PostgreSQL has a special column type for storing UUIDs.
+  # Using this type instead of generic string should lead to having
+  #  smaller DB and possibly better overall performance.
+  def up
+    if on_postgresql?
+      change_table :foreman_tasks_tasks do |t|
+        t.change :id, :uuid, :using => 'id::uuid'
+        t.change :parent_task_id, :uuid, :using => 'parent_task_id::uuid'
+      end
+
+      change_table :foreman_tasks_task_group_members do |t|
+        t.change :task_id, :uuid, :using => 'task_id::uuid'
+      end
+
+      change_table :foreman_tasks_locks do |t|
+        t.change :task_id, :uuid, :using => 'task_id::uuid'
+      end
+    end
+  end
+
+  def down
+    if on_postgresql?
+      change_table :foreman_tasks_tasks do |t|
+        t.change :id, :string
+        t.change :parent_task_id, :string
+      end
+
+      change_table :foreman_tasks_task_group_members do |t|
+        t.change :task_id, :string
+      end
+
+      change_table :foreman_tasks_locks do |t|
+        t.change :task_id, :string
+      end
+    end
+  end
+
+  private
+
+  def on_postgresql?
+    ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+  end
+end

data/lib/foreman_tasks/engine.rb

@@ -133,7 +133,7 @@ module ForemanTasks
     # to enable async Foreman operations using Dynflow
     if ENV['FOREMAN_TASKS_MONKEYS'] == 'true'
       config.to_prepare do
-        ::Api::V2::HostsController.send :prepend, ForemanTasks::Concerns::HostsControllerExtension
+        ::Api::V2::HostsController.send :include, ForemanTasks::Concerns::HostsControllerExtension
         ::Host::Base.send :include, ForemanTasks::Concerns::HostActionSubject
       end
     end
@@ -144,8 +144,23 @@ module ForemanTasks
       Authorizer.send(:prepend, AuthorizerExt)
     end
 
+    config.after_initialize do
+      ForemanTasks.dynflow.eager_load_actions!
+      ForemanTasks.dynflow.config.increase_db_pool_size
+
+      unless ForemanTasks.dynflow.config.lazy_initialization
+        if defined?(PhusionPassenger)
+          PhusionPassenger.on_event(:starting_worker_process) do |forked|
+            ForemanTasks.dynflow.initialize! if forked
+          end
+        else
+          ForemanTasks.dynflow.initialize!
+        end
+      end
+    end
+
     rake_tasks do
-      %w[dynflow.rake test.rake export_tasks.rake cleanup.rake].each do |rake_file|
+      %w[dynflow.rake test.rake export_tasks.rake cleanup.rake generate_task_actions.rake].each do |rake_file|
         full_path = File.expand_path("../tasks/#{rake_file}", __FILE__)
         load full_path if File.exist?(full_path)
       end

data/lib/foreman_tasks/tasks/generate_task_actions.rake

@@ -0,0 +1,41 @@
+#
+# generate_task_actions.rake is a data migration task to properly fill the missing
+# values into the foreman_tasks_tasks table.
+#
+# Run "foreman-rake foreman_tasks:generate_task_actions" to generate missing values.
+
+namespace :foreman_tasks do
+  desc 'Generate missing values for action column in foreman_tasks_tasks table.'
+
+  BATCH_SIZE = 100
+
+  task :generate_task_actions => :environment do
+    class ProgressReporter
+      def initialize(count, message = nil)
+        @count = count
+        @processed = 0
+        puts message % { :count => count } unless message.nil?
+      end
+
+      def progress(count)
+        @processed += count
+      end
+
+      def report
+        puts _('Processed %{processed}/%{count} tasks') % { :processed => @processed, :count => @count }
+      end
+    end
+
+    scope = ::ForemanTasks::Task.where(:action => nil).order(:started_at => :desc)
+    count = scope.count
+    reporter = ProgressReporter.new count, _('Generating action for %{count} tasks.')
+    scope.find_in_batches(:batch_size => BATCH_SIZE) do |group|
+      group.each do |task|
+        task.action = task.to_label
+        task.save!
+      end
+      reporter.progress group.size
+      reporter.report
+    end
+  end
+end

data/lib/foreman_tasks/version.rb

@@ -1,3 +1,3 @@
 module ForemanTasks
-  VERSION = '0.11.3'.freeze
+  VERSION = '0.12.0'.freeze
 end

data/test/controllers/api/tasks_controller_test.rb

@@ -41,7 +41,7 @@ module ForemanTasks
           task.reload
           task.state.must_equal 'stopped'
           task.result.must_equal 'success'
-          task.main_action.output['proxy_task_id'].must_equal '123'
+          task.main_action.output['proxy_task_id'].must_equal Support::DummyProxyAction.proxy.uuid
           task.main_action.output['proxy_output'].must_equal('result' => 'success')
         end
       end

data/test/helpers/foreman_tasks/tasks_helper_test.rb

@@ -8,6 +8,7 @@ module ForemanTasks
         humanized = { :humanized_name => 'Create', :humanized_input => [[:user, { :text => "user 'Anonymous Admin'", :link => nil }]] }
         @task.instance_variable_set('@humanized_cache', humanized)
         @task.stubs(:input).returns('user' => { 'id' => 1, 'name' => 'Anonymous Admin' }, 'locale' => 'en')
+        @task.stubs(:action).returns(@task.to_label)
       end
 
       it 'formats the task input properly' do
@@ -31,6 +32,7 @@ module ForemanTasks
                   'cp_id' => '1412251033866',
                   'locale' => 'en' }
         @task.stubs(:input).returns(input)
+        @task.stubs(:action).returns(@task.to_label)
       end
 
       it 'formats the task input properly' do

data/test/support/dummy_proxy_action.rb

@@ -1,17 +1,20 @@
+require 'securerandom'
+
 module Support
   class DummyProxyAction < Actions::ProxyAction
     class DummyProxy
-      attr_reader :log, :task_triggered
+      attr_reader :log, :task_triggered, :uuid
 
       def initialize
         @log = Hash.new { |h, k| h[k] = [] }
         @task_triggered = Concurrent.future
+        @uuid = SecureRandom.uuid
       end
 
       def trigger_task(*args)
         @log[:trigger_task] << args
         @task_triggered.success(true)
-        { 'task_id' => '123' }
+        { 'task_id' => @uuid }
       end
 
       def cancel_task(*args)
@@ -36,7 +39,7 @@ module Support
     def task
       super
     rescue ActiveRecord::RecordNotFound
-      ForemanTasks::Task::DynflowTask.new.tap { |task| task.id = '123' }
+      ForemanTasks::Task::DynflowTask.new.tap { |task| task.id = proxy.uuid }
     end
 
     class << self

data/test/tasks/generate_task_actions_test.rb

@@ -0,0 +1,43 @@
+require 'rake'
+require 'foreman_tasks_test_helper'
+
+class GenerateTaskActionsTest < ActiveSupport::TestCase
+  TASK_NAME = 'foreman_tasks:generate_task_actions'.freeze
+
+  setup do
+    Rake.application.rake_require 'foreman_tasks/tasks/generate_task_actions'
+
+    Rake::Task.define_task(:environment)
+    Rake::Task[TASK_NAME].reenable
+  end
+
+  let(:tasks) do
+    (1..5).map { FactoryBot.build(:dynflow_task) }
+  end
+
+  it 'fixes the tasks' do
+    label = 'a label'
+    tasks
+    ForemanTasks::Task.update_all(:action => nil)
+    ForemanTasks::Task.any_instance.stubs(:to_label).returns(label)
+
+    stdout, _stderr = capture_io do
+      Rake.application.invoke_task TASK_NAME
+    end
+
+    assert_match(%r{Generating action for #{tasks.count} tasks}, stdout)
+    ForemanTasks::Task.where(:action => label).count.must_equal tasks.count
+    assert_match(%r{Processed #{tasks.count}/#{tasks.count} tasks}, stdout)
+  end
+
+  it 'fixes only tasks with missing action' do
+    tasks
+    ForemanTasks::Task.any_instance.expects(:save!).never
+
+    stdout, _stderr = capture_io do
+      Rake.application.invoke_task TASK_NAME
+    end
+
+    assert_match(%r{Generating action for 0 tasks}, stdout)
+  end
+end

data/test/unit/actions/proxy_action_test.rb

@@ -29,7 +29,7 @@ module ForemanTasks
                                  { 'retry_interval' => 15, 'retry_count' => 4, 'timeout' => 60 },
                              'proxy_url' => 'proxy.example.com',
                              'proxy_action_name' => 'Proxy::DummyAction',
-                             'callback' => { 'task_id' => '123', 'step_id' => @action.run_step_id } }]
+                             'callback' => { 'task_id' => Support::DummyProxyAction.proxy.uuid, 'step_id' => @action.run_step_id } }]
           proxy_call.must_equal(expected_call)
         end
       end
@@ -52,7 +52,7 @@ module ForemanTasks
       describe 'cancel' do
         it 'sends the cancel event to the proxy when the cancel event is sent for the first time' do
           action = run_action(@action, ::Dynflow::Action::Cancellable::Cancel)
-          Support::DummyProxyAction.proxy.log[:cancel_task].first.must_equal ['123']
+          Support::DummyProxyAction.proxy.log[:cancel_task].first.must_equal [Support::DummyProxyAction.proxy.uuid]
           action.state.must_equal :suspended
         end
 

data/test/unit/task_test.rb

@@ -58,9 +58,11 @@ class TasksTest < ActiveSupport::TestCase
 
   describe 'task without valid execution plan' do
     let(:task) do
-      FactoryBot.create(:dynflow_task).tap do |task|
+      task = FactoryBot.create(:dynflow_task).tap do |task|
         task.external_id = 'missing-task'
+        task.save
       end
+      ForemanTasks::Task.find(task.id)
     end
 
     it 'handles the error while loading the task and does not propagate errors unless necessary' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman-tasks
 version: !ruby/object:Gem::Version
-  version: 0.11.3
+  version: 0.12.0
 platform: ruby
 authors:
 - Ivan Nečas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foreman-tasks-core
@@ -200,6 +200,8 @@ files:
 - db/migrate/20160920151810_add_more_lock_indexes.rb
 - db/migrate/20160924213030_change_tasks_widget_names.rb
 - db/migrate/20161003091412_add_missing_indexes.rb
+- db/migrate/20171026082635_add_task_action.foreman_tasks.rb
+- db/migrate/20180216092715_use_uuid.rb
 - db/seeds.d/20-foreman_tasks_permissions.rb
 - db/seeds.d/60-dynflow_proxy_feature.rb
 - db/seeds.d/61-foreman_tasks_bookmarks.rb
@@ -220,6 +222,7 @@ files:
 - lib/foreman_tasks/task_error.rb
 - lib/foreman_tasks/tasks/cleanup.rake
 - lib/foreman_tasks/tasks/export_tasks.rake
+- lib/foreman_tasks/tasks/generate_task_actions.rake
 - lib/foreman_tasks/test_extensions.rb
 - lib/foreman_tasks/test_helpers.rb
 - lib/foreman_tasks/triggers.rb
@@ -243,6 +246,7 @@ files:
 - test/support/dummy_dynflow_action.rb
 - test/support/dummy_proxy_action.rb
 - test/support/dummy_task_group.rb
+- test/tasks/generate_task_actions_test.rb
 - test/unit/actions/action_with_sub_plans_test.rb
 - test/unit/actions/proxy_action_test.rb
 - test/unit/cleaner_test.rb
@@ -291,6 +295,7 @@ test_files:
 - test/support/dummy_dynflow_action.rb
 - test/support/dummy_proxy_action.rb
 - test/support/dummy_task_group.rb
+- test/tasks/generate_task_actions_test.rb
 - test/unit/actions/action_with_sub_plans_test.rb
 - test/unit/actions/proxy_action_test.rb
 - test/unit/cleaner_test.rb