foreman-tasks 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75a0c194b28a59aafb23cc9b70c07cab8f0fb7b8
-  data.tar.gz: 192f323079a16cb61e860c817e18c76f1ad9c5c6
+  metadata.gz: f66037fda7e3529fd63392dcbc458f472077c81a
+  data.tar.gz: 539c7bee3ef29e07296f9d84fa846af50f4512d7
 SHA512:
-  metadata.gz: 93738395b7781693f7d0613ff1085406a97593e0a94049993a5ae623d511c7617f336b29e2923b503324d427456a6e56306656f51894132be047b9c1788b5efa
-  data.tar.gz: f5ffb4b22a8168074c3aaddc7ee57f591a6412349c90fc644865389b12647d0f9815c5775a18dcb1cd1012983f675e56fbf005ef65a77cfb8a89c98555d45c3a
+  metadata.gz: 7197ef1b6480a4242f9220b699916d49ceb435624ac6a00982e970447b427f8ced258cc8b7d1528ca86ee9bdedbde872b9d8fab222b7347756684df6c9322f61
+  data.tar.gz: 6274bccce4a943b22bb0b55e80f2bcd394899f59c3e5faf5869101e443428cbabd47bb75f4a12ca2686e2889a18afacfae71adc016b92d21ddbc303c146c6255

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# TODO: remove this file by either moving cops here or fixing code
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - 'Rakefile'
+    - 'app/views/foreman_tasks/api/**/*.rabl'
+    - lib/**/*.rake
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+# Don't prefer is_a? over kind_of?
+Style/ClassCheck:
+  Enabled: false
+
+# Don't enforce documentation
+Style/Documentation:
+  Enabled: false
+
+# Support both ruby19 and hash_rockets
+Style/HashSyntax:
+  Enabled: false
+
+# Both double and single quotes are OK
+Style/StringLiterals:
+  Enabled: false
+
+# Don't enforce frozen string literals
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,138 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-12-21 14:29:23 +0200 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Lint/EmptyWhen:
+  Exclude:
+    - 'app/lib/actions/proxy_action.rb'
+
+Lint/ShadowingOuterLocalVariable:
+  Exclude:
+    - 'bin/dynflow-executor'
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/foreman_tasks/tasks/export_tasks.rake'
+
+Metrics/AbcSize:
+  Max: 41
+
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 105
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 230
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 244
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 37
+
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 170
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Configuration parameters: Include.
+# Include: app/**/*.rb, config/**/*.rb, lib/**/*.rb
+Rails/Exit:
+  Exclude:
+    - 'lib/**/*.rake'
+    - 'lib/foreman_tasks/dynflow/daemon.rb'
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+# Configuration parameters: Include.
+# Include: app/**/*.rb, config/**/*.rb, db/**/*.rb, lib/**/*.rb
+Rails/Output:
+  Exclude:
+    - 'lib/foreman_tasks/cleaner.rb'
+
+Rails/OutputSafety:
+  Exclude:
+    - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
+
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'app/lib/actions/action_with_sub_plans.rb'
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+    - 'app/models/foreman_tasks/task/status_explicator.rb'
+    - 'app/models/foreman_tasks/task/summarizer.rb'
+    - 'app/models/foreman_tasks/task/task_cancelled_exception.rb'
+    - 'app/models/setting/foreman_tasks.rb'
+    - 'lib/foreman_tasks/dynflow/configuration.rb'
+    - 'lib/foreman_tasks/dynflow/console_authorizer.rb'
+    - 'lib/foreman_tasks/dynflow/daemon.rb'
+    - 'lib/foreman_tasks/dynflow/persistence.rb'
+    - 'test/controllers/api/recurring_logics_controller_test.rb'
+    - 'test/controllers/api/tasks_controller_test.rb'
+    - 'test/unit/actions/action_with_sub_plans_test.rb'
+
+Style/DoubleNegation:
+  Exclude:
+    - 'app/models/foreman_tasks/lock.rb'
+    - 'app/models/foreman_tasks/recurring_logic.rb'
+
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'db/seeds.d/20-foreman_tasks_permissions.rb'
+    - 'db/seeds.d/60-dynflow_proxy_feature.rb'
+    - 'db/seeds.d/61-foreman_tasks_bookmarks.rb'
+    - 'lib/foreman-tasks.rb'
+
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Exclude:
+    - 'app/models/foreman_tasks/task/dynflow_task.rb'
+    - 'lib/foreman_tasks/tasks/export_tasks.rake'
+
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+Style/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'app/models/foreman_tasks/task/status_explicator.rb'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/foreman_tasks/dynflow/console_authorizer.rb'
+
+# Configuration parameters: Methods.
+# Methods: {"reduce"=>["acc", "elem"]}, {"inject"=>["acc", "elem"]}
+Style/SingleLineBlockParams:
+  Exclude:
+    - 'app/models/foreman_tasks/concerns/action_subject.rb'
+    - 'app/models/foreman_tasks/lock.rb'

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

@@ -9,7 +9,7 @@ module ForemanTasks
         api_base_url '/foreman_tasks/api'
       end
 
-      before_filter :find_resource, :only => %w{show cancel destroy}
+      before_action :find_resource, :only => %w(show cancel destroy)
 
       api :GET, '/recurring_logics', N_('List recurring logics')
       def index
@@ -17,9 +17,8 @@ module ForemanTasks
       end
 
       api :GET, '/recurring_logics/:id', N_('Show recurring logic details')
-      param :id, :identifier, desc: "ID of the recurring logic", required: true
-      def show
-      end
+      param :id, :identifier, desc: 'ID of the recurring logic', required: true
+      def show; end
 
       api :POST, '/recurring_logics/:id/cancel', N_('Cancel recurring logic')
       param :id, :identifier, desc: 'ID of the recurring logic', required: true

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

@@ -1,26 +1,13 @@
-#
-# Copyright 2013 Red Hat, Inc.
-#
-# This software is licensed to you under the GNU General Public
-# License as published by the Free Software Foundation; either version
-# 2 of the License (GPLv2) or (at your option) any later version.
-# There is NO WARRANTY for this software, express or implied,
-# including the implied warranties of MERCHANTABILITY,
-# NON-INFRINGEMENT, or FITNESS FOR A PARTICULAR PURPOSE. You should
-# have received a copy of GPLv2 along with this software; if not, see
-# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
-
 module ForemanTasks
   module Api
     class TasksController < ::Api::V2::BaseController
-
       include ::Foreman::Controller::SmartProxyAuth
       add_smart_proxy_filters :callback, :features => 'Dynflow'
 
       resource_description do
         resource_id 'foreman_tasks'
         api_version 'v2'
-        api_base_url "/foreman_tasks/api"
+        api_base_url '/foreman_tasks/api'
       end
 
       # Foreman right now doesn't have mechanism to
@@ -29,25 +16,24 @@ module ForemanTasks
       class BadRequest < Apipie::ParamError
       end
 
-      before_filter :find_task, :only => [:show]
+      before_action :find_task, :only => [:show]
 
-      api :GET, "/tasks/summary", "Show task summary"
+      api :GET, '/tasks/summary', 'Show task summary'
       def summary
         render :json => ForemanTasks::Task::Summarizer.new.summarize_by_status
       end
 
-      api :GET, "/tasks/:id", "Show task details"
-      param :id, :identifier, desc: "UUID of the task"
-      def show
-      end
+      api :GET, '/tasks/:id', 'Show task details'
+      param :id, :identifier, desc: 'UUID of the task'
+      def show; end
 
-      api :POST, "/tasks/bulk_search", "List dynflow tasks for uuids"
+      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
           Arbitraty value for client to identify the the request parts with results.
           It's passed in the results to be able to pair the requests and responses properly.
         DESC
-        param :type, %w[user resource task]
+        param :type, %w(user resource task)
         param :task_id, String, :desc => <<-DESC
           In case :type = 'task', find the task by the uuid
         DESC
@@ -104,8 +90,8 @@ module ForemanTasks
           if task.resumable?
             begin
               ForemanTasks.dynflow.world.execute(task.execution_plan.id)
-              resumed  << task_hash(task)
-            rescue RuntimeError => e
+              resumed << task_hash(task)
+            rescue RuntimeError
               failed << task_hash(task)
             end
           else
@@ -114,59 +100,58 @@ module ForemanTasks
         end
 
         render :json => {
-                          total: resumed.length + failed.length + skipped.length,
-                          resumed: resumed,
-                          failed: failed,
-                          skipped: skipped
-                        }
+          total: resumed.length + failed.length + skipped.length,
+          resumed: resumed,
+          failed: failed,
+          skipped: skipped
+        }
       end
 
-      api :GET, '/tasks', N_("List tasks")
-      param :search, String, :desc => N_("Search string")
-      param :page, :number, :desc => N_("Page number, starting at 1")
-      param :per_page,  :number, :desc => N_("Number of results per page to return")
+      api :GET, '/tasks', N_('List tasks')
+      param :search, String, :desc => N_('Search string')
+      param :page, :number, :desc => N_('Page number, starting at 1')
+      param :per_page, :number, :desc => N_('Number of results per page to return')
       param :order, String, :desc => N_("Sort field and order, e.g. 'name DESC'")
       param :sort, Hash, :desc => N_("Hash version of 'order' param") do
-        param :by, String, :desc => N_("Field to sort the results on")
-        param :order, String, :desc => N_("How to order the sorted results (e.g. ASC for ascending)")
+        param :by, String, :desc => N_('Field to sort the results on')
+        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.*')
+        scope = resource_scope.search_for(params[:search]).select('DISTINCT foreman_tasks_tasks.*')
         total = scope.count
 
-        ordering_params =  {
-                             sort_by: params[:sort_by] || 'started_at',
-                             sort_order: params[:sort_order] || 'DESC'
-                           }
+        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] || 20
-                            }
+          page: params[:page] || 1,
+          per_page: params[:per_page] || 20
+        }
         scope = pagination_scope(scope, pagination_params)
         results = scope.map { |task| task_hash(task) }
 
         render :json => {
-                          total: total,
-                          subtotal: results.count,
-                          page: pagination_params[:page],
-                          per_page: pagination_params[:per_page],
-                          sort: {
-                                  by: ordering_params[:sort_by],
-                                  order: ordering_params[:sort_order]
-                                },
-                          results: results
-                        }
+          total: total,
+          subtotal: results.count,
+          page: pagination_params[:page],
+          per_page: pagination_params[:per_page],
+          sort: {
+            by: ordering_params[:sort_by],
+            order: ordering_params[:sort_order]
+          },
+          results: results
+        }
       end
 
-      api :POST, '/tasks/callback', N_("Send data to the task from external executor (such as smart_proxy_dynflow)")
+      api :POST, '/tasks/callback', N_('Send data to the task from external executor (such as smart_proxy_dynflow)')
       param :callback, Hash do
-        param :task_id, :identifier, :desc => N_("UUID of the task")
-        param :step_id, String, :desc => N_("The ID of the step inside the execution plan to send the event to")
+        param :task_id, :identifier, :desc => N_('UUID of the task')
+        param :step_id, String, :desc => N_('The ID of the step inside the execution plan to send the event to')
       end
-      param :data, Hash, :desc => N_("Data to be sent to the action")
+      param :data, Hash, :desc => N_('Data to be sent to the action')
       def callback
         task = ForemanTasks::Task::DynflowTask.find(params[:callback][:task_id])
         ForemanTasks.dynflow.world.event(task.external_id,
@@ -193,7 +178,7 @@ module ForemanTasks
           scope
         when 'user'
           if search_params[:user_id].blank?
-            raise BadRequest, _("User search_params requires user_id to be specified")
+            raise BadRequest, _('User search_params requires user_id to be specified')
           end
           scope.joins(:locks).where(foreman_tasks_locks:
                                         { name:          ::ForemanTasks::Lock::OWNER_LOCK_NAME,
@@ -202,18 +187,18 @@ module ForemanTasks
         when 'resource'
           if search_params[:resource_type].blank? || search_params[:resource_id].blank?
             raise BadRequest,
-                  _("Resource search_params requires resource_type and resource_id to be specified")
+                  _('Resource search_params requires resource_type and resource_id to be specified')
           end
           scope.joins(:locks).where(foreman_tasks_locks:
                                         { resource_type: search_params[:resource_type],
                                           resource_id:   search_params[:resource_id] })
         when 'task'
           if search_params[:task_id].blank?
-            raise BadRequest, _("Task search_params requires task_id to be specified")
+            raise BadRequest, _('Task search_params requires task_id to be specified')
           end
           scope.where(id: search_params[:task_id])
         else
-          raise BadRequest, _("Type %s for search_params is not supported") % search_params[:type]
+          raise BadRequest, _('Type %s for search_params is not supported') % search_params[:type]
         end
       end
 
@@ -237,7 +222,7 @@ module ForemanTasks
       def pagination_scope(scope, search_params)
         page     = search_params[:page] || 1
         per_page = search_params[:per_page] || 10
-        scope    = scope.limit(per_page).offset((page.to_i - 1) * per_page.to_i)
+        scope.limit(per_page).offset((page.to_i - 1) * per_page.to_i)
       end
 
       def ordering_scope(scope, ordering_params)
@@ -248,22 +233,21 @@ module ForemanTasks
 
       def task_hash(task)
         return @tasks[task.id] if @tasks && @tasks[task.id]
-        task_hash       = Rabl.render(
-            task, 'show',
-            view_path: "#{ForemanTasks::Engine.root}/app/views/foreman_tasks/api/tasks",
-            format:    :hash,
-            scope:     self)
+        task_hash = Rabl.render(
+          task, 'show',
+          view_path: "#{ForemanTasks::Engine.root}/app/views/foreman_tasks/api/tasks",
+          format:    :hash,
+          scope:     self
+        )
         @tasks[task.id] = task_hash if @tasks
-        return task_hash
+        task_hash
       end
 
-      private
-
       def find_task
         @task = Task.find(params[:id])
       end
 
-      def resource_scope(options = {})
+      def resource_scope(_options = {})
         @resource_scope ||= ForemanTasks::Task.authorized("#{action_permission}_foreman_tasks")
       end
 

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

@@ -15,12 +15,10 @@ module ForemanTasks
                                        params[:certname],
                                        detected_proxy.try(:id))
 
-        render :json => {:task_id => task.id}, :status => 202
+        render :json => { :task_id => task.id }, :status => 202
       rescue ::Foreman::Exception => e
-        render :json => {'message'=>e.to_s}, :status => :unprocessable_entity
+        render :json => { 'message' => e.to_s }, :status => :unprocessable_entity
       end
-
     end
   end
 end
-