foreman-tasks 0.16.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a562e9a32057e45cbf20bcc2d511ee03580cee1181af686965683bccfc1d6f8e
-  data.tar.gz: bcffaac1d9efb02ef8677394c7af554058aad577d5e1a7ce9b32c66ac21206f1
+  metadata.gz: 75231de648b74702c80ca64886f1d6c19caf3a7920d547807f892e130194cedb
+  data.tar.gz: bf5f7331818981dbf841c3a696e0e768bec3328b9e349df13532d1757bbe86a9
 SHA512:
-  metadata.gz: e7acf7b281043c1ad3a3c0fcb45436258caf1f11a06295c5e4b69b43f8bbe5ea450d61e25346d638198c72596e1ac3e86fdad1eff2f092d4fc3254cb8e551d5f
-  data.tar.gz: e5c9234ef7ccd241c17ef37892a79d04b6de918034d1e305093bea7b54ce125dce88cb1c9360f4a7dab1674eefbd00db20b3848a445ea297eeaab37c271cd855
+  metadata.gz: 8699acec8437f71f4fb52fb89a79dc96857cb08cd09375c7d33d9d4e72d67de8e95ee53352b14f1f80f1a62b880943df996d6fca16a666022ca030dcfdb4cd7d
+  data.tar.gz: fc3e36ab57cadf68fa033a4224890c2fdc71a76e18d782b0758cac2bef7748a2cc5e3f30b3f7a37641cb2b9f3ff8d1c79f3b2d2e90cfb0e2050381f04e2a7794

data/.babelrc

@@ -13,11 +13,11 @@
     "transform-class-properties",
     "transform-object-rest-spread",
     "transform-object-assign",
-    "lodash",
     "syntax-dynamic-import"
   ],
   "env": {
     "test": {
+      "presets": ["@theforeman/vendor-dev/babel.preset.js"],
       "plugins": [
         ["module-resolver", {
           "alias": {
@@ -27,6 +27,9 @@
         }],
         "dynamic-import-node"
       ]
+    },
+    "storybook": {
+      "presets": ["@theforeman/vendor-dev/babel.preset.js"]
     }
   }
 }

data/.eslintrc

@@ -1,6 +1,9 @@
 {
   "plugins": ["patternfly-react"],
-  "extends": ["plugin:patternfly-react/recommended"],
+  "extends": [
+    "plugin:patternfly-react/recommended",
+    "./node_modules/@theforeman/vendor-dev/eslint.extends.js"
+  ],
   "rules": {
     "prettier/prettier": ["error", {
       "singleQuote": true,
@@ -17,17 +20,5 @@
     "import/resolver": {
       "babel-module": {}
     }
-  },
-  "globals": {
-    "document": false,
-    "escape": false,
-    "navigator": false,
-    "unescape": false,
-    "window": false,
-    "$": true,
-    "_": true,
-    "__": true,
-    "n__": true,
-    "d3": true
   }
 }

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

@@ -12,43 +12,6 @@
  *= require_tree .
  */
 
-.spin {
-  -webkit-animation: spin 1s infinite linear;
-  -moz-animation: spin 1s infinite linear;
-  -o-animation: spin 1s infinite linear;
-  animation: spin 1s infinite linear;
-  -webkit-transform-origin: 50% 50%;
-  transform-origin: 50% 50%;
-  -ms-transform-origin: 50% 50%; /* IE 9 */
-}
-
-@-moz-keyframes spin {
-  from {
-    -moz-transform: rotate(0deg);
-  }
-  to {
-    -moz-transform: rotate(360deg);
-  }
-}
-
-@-webkit-keyframes spin {
-  from {
-    -webkit-transform: rotate(0deg);
-  }
-  to {
-    -webkit-transform: rotate(360deg);
-  }
-}
-
-@keyframes spin {
-  from {
-    transform: rotate(0deg);
-  }
-  to {
-    transform: rotate(360deg);
-  }
-}
-
 div.form-group div.trigger_fields {
   margin-top: 15px;
 }

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

@@ -16,7 +16,7 @@ module ForemanTasks
       class BadRequest < Apipie::ParamError
       end
 
-      before_action :find_task, :only => [:show]
+      before_action :find_task, :only => [:show, :details]
 
       api :GET, '/tasks/summary', 'Show task summary'
       def summary
@@ -27,6 +27,10 @@ module ForemanTasks
       param :id, :identifier, desc: 'UUID of the task'
       def show; end
 
+      api :GET, '/tasks/:id/details', 'Show task extended details'
+      param :id, :identifier, desc: 'UUID of the task'
+      def details; 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
@@ -117,10 +121,10 @@ module ForemanTasks
         param :order, String, :desc => N_('How to order the sorted results (e.g. ASC for ascending)')
       end
       def index
-        scope = resource_scope.search_for(params[:search]).select('DISTINCT foreman_tasks_tasks.*')
-
         total = resource_scope.count
-        subtotal = 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',
@@ -276,7 +280,7 @@ module ForemanTasks
 
       def action_permission
         case params[:action]
-        when 'bulk_search', 'summary'
+        when 'bulk_search', 'summary', 'details'
           :view
         when 'bulk_resume'
           :edit

data/app/controllers/foreman_tasks/tasks_controller.rb

@@ -12,16 +12,7 @@ module ForemanTasks
 
     def index
       params[:order] ||= 'started_at DESC'
-      respond_to do |format|
-        format.html do
-          @tasks = filter(resource_base)
-          render :index, layout: !request.xhr?
-        end
-        format.csv do
-          @tasks = filter(resource_base, 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
+      respond_with_tasks resource_base
     end
 
     def summary
@@ -29,14 +20,14 @@ module ForemanTasks
     end
 
     def sub_tasks
-      task   = resource_base.find(params[:id])
-      @tasks = filter(task.sub_tasks)
-      render :index
+      # @task is used when rendering breadcrumbs
+      @task = resource_base.find(params[:id])
+      respond_with_tasks @task.sub_tasks
     end
 
     def cancel_step
       task = find_dynflow_task
-      flash[:notice] = _('Trying to cancel step %s') % params[:step_id]
+      flash[:info] = _('Trying to cancel step %s') % params[:step_id]
       ForemanTasks.dynflow.world.event(task.external_id, params[:step_id].to_i, ::Dynflow::Action::Cancellable::Cancel).wait
       redirect_to foreman_tasks_task_path(task)
     end
@@ -44,7 +35,7 @@ module ForemanTasks
     def cancel
       task = find_dynflow_task
       if task.cancel
-        flash[:notice] = _('Trying to cancel the task')
+        flash[:info] = _('Trying to cancel the task')
       else
         flash[:warning] = _('The task cannot be cancelled at the moment.')
       end
@@ -54,7 +45,7 @@ module ForemanTasks
     def abort
       task = find_dynflow_task
       if task.abort
-        flash[:notice] = _('Trying to abort the task')
+        flash[:info] = _('Trying to abort the task')
       else
         flash[:warning] = _('The task cannot be aborted at the moment.')
       end
@@ -65,7 +56,7 @@ module ForemanTasks
       task = find_dynflow_task
       if task.resumable?
         ForemanTasks.dynflow.world.execute(task.execution_plan.id)
-        flash[:notice] = _('The execution was resumed.')
+        flash[:info] = _('The execution was resumed.')
       else
         flash[:warning] = _('The execution has to be resumable.')
       end
@@ -77,7 +68,7 @@ module ForemanTasks
       if task.paused?
         task.state = :stopped
         task.save!
-        flash[:notice] = _('The task resources were unlocked.')
+        flash[:info] = _('The task resources were unlocked.')
       else
         flash[:warning] = _('The execution has to be paused.')
       end
@@ -88,7 +79,7 @@ module ForemanTasks
       task       = find_dynflow_task
       task.state = :stopped
       task.save!
-      flash[:notice] = _('The task resources were unlocked with force.')
+      flash[:info] = _('The task resources were unlocked with force.')
       redirect_back(:fallback_location => foreman_tasks_task_path(task))
     end
 
@@ -103,6 +94,19 @@ 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
+    end
+
     def restrict_dangerous_actions
       render_403 unless Setting['dynflow_allow_dangerous_actions']
     end

data/app/helpers/foreman_tasks/foreman_tasks_helper.rb

@@ -25,38 +25,17 @@ module ForemanTasks
       ret.html_safe
     end
 
-    def task_result_icon_class(task)
-      return 'task-status pficon-help' if task.state != 'stopped'
-
-      icon_class = case task.result
-                   when 'success'
-                     'pficon-ok'
-                   when 'error'
-                     'pficon-error-circle-o'
-                   when 'warning'
-                     'pficon-ok status-warn'
-                   else
-                     'pficon-help'
-                   end
-
-      "task-status #{icon_class}"
-    end
-
-    def time_in_words_span(time)
-      if time.nil?
-        _('N/A')
-      else
-        content_tag :span, (time > Time.now.utc ? _('in %s') : _('%s ago')) % time_ago_in_words(time),
-                    :'data-original-title' => time.try(:in_time_zone), :rel => 'twipsy'
-      end
+    def troubleshooting_info_text
+      return if @task.state != 'paused' || @task.main_action.nil?
+      helper = TroubleshootingHelpGenerator.new(@task.main_action)
+      helper.generate_text
     end
 
-    def duration_in_words_span(start, finish)
-      if start.nil?
-        _('N/A')
+    def username_link_task(owner, username)
+      if owner.present? && username != User::ANONYMOUS_API_ADMIN && username != User::ANONYMOUS_ADMIN
+        link_to_if_authorized(username, hash_for_edit_user_path(owner))
       else
-        content_tag :span, distance_of_time_in_words(start, finish),
-                    :'data-original-title' => number_with_delimiter((finish - start).to_i) + _(' seconds'), :rel => 'twipsy'
+        username
       end
     end
 
@@ -122,6 +101,26 @@ module ForemanTasks
       render :partial => 'common/trigger_form', :locals => { :f => f, :triggering => triggering }
     end
 
+    def task_breadcrumb_item(task, active = false)
+      item = { :caption => format_task_input(task) }
+      item[:url] = url_for(foreman_tasks_task_path(task.id)) unless active
+      item
+    end
+
+    def index_breadcrumb_item
+      item = { :caption => _('Tasks') }
+      item[:url] = foreman_tasks_tasks_url if action_name != 'index'
+      item
+    end
+
+    def breadcrumb_items
+      items = [index_breadcrumb_item]
+      return items if action_name == 'index'
+      items << task_breadcrumb_item(@task, action_name == 'show')
+      items << { :caption => _('Sub tasks') } if action_name == 'sub_tasks'
+      items
+    end
+
     private
 
     def future_mode_fieldset(f, triggering)

data/app/lib/actions/bulk_action.rb

@@ -46,7 +46,7 @@ module Actions
     def create_sub_plans
       action_class = input[:action_class].constantize
       target_class = input[:target_class].constantize
-      targets = target_class.where(:id => current_batch)
+      targets = target_class.unscoped.where(:id => current_batch)
 
       missing = Array.new((current_batch - targets.map(&:id)).count) { nil }
 

data/app/models/foreman_tasks/task.rb

@@ -77,7 +77,7 @@ module ForemanTasks
     end
 
     def username
-      owner
+      owner.try(:login)
     end
 
     def execution_type

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

@@ -99,6 +99,36 @@ module ForemanTasks
       execution_plan.try(:steps_in_state, :running, :suspended) || []
     end
 
+    def input_output_failed_steps
+      failed_steps.map do |f|
+        begin
+          f_action = f.action(execution_plan)
+          {
+            error: ({ exception_class: f.error.exception_class, message: f.error.message, backtrace: f.error.backtrace } if f.error),
+            action_class: f.action_class.name,
+            state: f.state,
+            input: f_action.input.pretty_inspect,
+            output: f_action.output.pretty_inspect
+          }
+        end
+      end
+    end
+
+    def input_output_running_steps
+      running_steps.map do |f|
+        begin
+          f_action = f.action(execution_plan)
+          {
+            action_class: f.action_class.name,
+            state: f.state,
+            input: f_action.input.pretty_inspect,
+            output: f_action.output.pretty_inspect,
+            cancellable: cancellable_action?(f_action)
+          }
+        end
+      end
+    end
+
     def humanized
       { action: get_humanized(:humanized_name),
         input:  get_humanized(:humanized_input),

data/app/services/foreman_tasks/troubleshooting_help_generator.rb

@@ -44,6 +44,10 @@ module ForemanTasks
       # rubocop:enable Rails/OutputSafety
     end
 
+    def generate_text
+      (description + link_descriptions_html).join("\n")
+    end
+
     def link_descriptions_html
       links.map do |link|
         link.description % { link: %(<a href="%{href}">%{title}</a>) % link.to_h }

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

@@ -0,0 +1,18 @@
+object @task if @task
+
+extends 'foreman_tasks/api/tasks/show'
+
+attributes :parent_task_id, :start_at, :start_before, :external_id
+node(:action) { @task.action }
+node(:execution_plan) { { state: @task.execution_plan.state, cancellable: @task.execution_plan.cancellable? } }
+node(:failed_steps) { @task.input_output_failed_steps }
+node(:running_steps) { @task.input_output_running_steps }
+node(:help) { troubleshooting_info_text }
+node(:has_sub_tasks) { @task.sub_tasks.any? }
+node(:allowDangerousActions) { Setting['dynflow_allow_dangerous_actions'] }
+node(:locks) do
+  @task.locks.map do |lock|
+    { name: lock.name, exclusive: lock.exclusive, resource_type: lock.resource_type, resource_id: lock.resource_id }
+  end
+end
+node(:username_path) { username_link_task(@task.owner, @task.username) }

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

@@ -9,4 +9,4 @@
   <div id="foremanTasksReactRoot"></div>
 <% end %>
 <%= render file: "layouts/base" %>
-<%= mount_react_component('ForemanTasks', '#foremanTasksReactRoot') %>
+<%= mount_react_component('ForemanTasks', '#foremanTasksReactRoot',{ :flatten_data => true }) %>

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

@@ -10,6 +10,9 @@
       yo: 'ya'
   }.to_json) %>
 <% end %>
+<% content_for(:breadcrumbs) do %>
+  <% breadcrumbs(:items => breadcrumb_items) %>
+<% end %>
 
 <% title _("Tasks") %>
 <% title_actions csv_link, help_button %>

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

@@ -1,144 +1,20 @@
 <% stylesheet 'foreman_tasks/tasks' %>
-
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :'foreman-tasks' %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :'foreman-tasks' %>
+<% end %>
 <%= breadcrumbs(
-  items: [
-    {
-      caption: _('Tasks'),
-      url: url_for(foreman_tasks_tasks_path)
-    },
-    {
-      caption: format_task_input(@task)
-    }
-  ],
+  items: breadcrumb_items,
   name_field: 'action',
   resource_url: foreman_tasks_api_tasks_path,
   switcher_item_url: foreman_tasks_task_path(:id => ':id')
 ) %>
 
 
-<div class="task-details">
-  <script>
-    if (typeof taskProgressReloader === 'undefined') {
-      var taskProgressReloader = {
-        timeoutId: null,
-        formId: null,
-        reload: function () {
-          tfm.tools.showSpinner();
-          taskProgressReloader.timeoutId = null;
-          taskProgressReloader.formId = null;
-
-          $.ajax({
-            type:'GET',
-            url: document.location.href,
-            headers: {"X-Foreman-Layout": "two-pane"},
-            success: function(response){
-              $('#content .task-details').replaceWith($(response));
-            },
-            error: function(response){
-              document.location.reload();
-            },
-            complete: function(){
-              tfm.tools.hideSpinner();
-            }
-          });
-        },
-
-        start: function () {
-          var button = $('.reload-button');
-          if (!taskProgressReloader.timeoutId) {
-            taskProgressReloader.timeoutId = setTimeout(this.reload, 5000);
-            taskProgressReloader.formId = $(button).closest('form')[0].id;
-          }
-          button.html('<span class="glyphicon glyphicon-refresh spin"></span> <%= _('Stop auto-reloading') %>');
-          button.show();
-        },
-
-        stop: function () {
-          if (taskProgressReloader.timeoutId) {
-            clearTimeout(taskProgressReloader.timeoutId);
-          }
-          taskProgressReloader.timeoutId = null;
-          taskProgressReloader.formId = null;
-          var button = $('.reload-button');
-          button.html('<span class="glyphicon glyphicon-refresh"></span> <%= _('Start auto-reloading') %>');
-          button.show();
-        },
-
-        toggle: function () {
-          if (taskProgressReloader.timeoutId) {
-            this.stop();
-          } else {
-            this.start();
-          }
-        }
-      };
-    }
-
-    $(document).ready(function () {
-      $('.modal-submit').click(function(e){
-        if($(this).hasClass('disabled')){
-          e.preventDefault();
-        }
-      });
-      $('.disable-unlock').click(function() {
-        var button = $(this).parents('.modal').find('.modal-submit');
-
-        if($(this).is(':checked')){
-          button.removeClass('disabled')
-        }
-        else{
-          button.addClass('disabled')
-        }
-      });
-
-      $('.reload-button').click(function (event) {
-        taskProgressReloader.toggle();
-        event.preventDefault();
-      });
-
-      $('.reload-button-stop').click(function (event) {
-        taskProgressReloader.stop();
-      });
-
-      $('ul.nav-tabs a' ).click(function (event) {
-        taskProgressReloader.stop();
-      });
-
-    <% if @task.state != 'stopped' %>
-      taskProgressReloader.start();
-    <% else %>
-      taskProgressReloader.stop();
-    <% end %>
-    });
-  </script>
-
-
-  <%= form_for @task, :url => "#" do %>
-
-  <ul class="nav nav-tabs" data-tabs="tabs">
-    <li class="active"><a href="#primary" data-toggle="tab"><%= _("Task") %></a></li>
-    <li><a href="#running-steps" data-toggle="tab"><%= _("Running Steps") %></a></li>
-    <li><a href="#errors" data-toggle="tab"><%= _("Errors") %></a></li>
-    <li><a href="#locks" data-toggle="tab"><%= _("Locks") %></a></li>
-    <li><a href="#raw" data-toggle="tab"><%= _("Raw") %></a></li>
-  </ul>
+<div class="task-details" id="foremanTaskDetails">
+</div>
 
-  <div class="tab-content">
-    <div class="tab-pane active" id="primary">
-      <%= render :partial => 'details' %>
-    </div>
-    <div class="tab-pane" id="running-steps">
-      <%= render :partial => 'running_steps' %>
-    </div>
-    <div class="tab-pane" id="errors">
-      <%= render :partial => 'errors' %>
-    </div>
-    <div class="tab-pane" id="raw">
-      <%= render :partial => 'raw' %>
-    </div>
-    <div class="tab-pane" id="locks">
-      <%= render :partial => 'locks' %>
-    </div>
 
-  <% end %>
-</div>
+<%= mount_react_component('TaskDetails', '#foremanTaskDetails')  %>