foreman-tasks 2.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1026fe8670d8a41977697a9ff2bd4f04758dca2f18a9bac806dea4856cb4478
-  data.tar.gz: 8ec9ddbfb5a444a525cc27d178ade81c30e5c7c8b4fe0e577aba7d780ed3b37d
+  metadata.gz: 6442bb42dbd73e86c09da30b7b10651a055108a43169ec9aa99b6ee9afe67cc4
+  data.tar.gz: b65ed0dbeac486d6cfce23e4af226a1c87289284d4c4962482e6f74ad4f24a36
 SHA512:
-  metadata.gz: 044b43805dcfd80a9607154d0a8be54b54b8b054923727d79f699dec5a4f355fe84d1533f5049ecc47d65efd3313447a070cc9bd01bea47bbd639f800847375e
-  data.tar.gz: edd5a4f741c2e55eb7d695011e8dc7a017214e0a5b43027035352095ad8132d8ea93a75c5991a97c5ffa05645f970f6d878a5d33ba6f6c75ed7ece1b16af4237
+  metadata.gz: 7f1f2cc08a2d6a1d312c302d27f965ce9bcf5c1dafb8de0d63299952f598478a1b9c5637f2b940e840d31836ec4a6a236cf176de53d25e980001efa41871dd7e
+  data.tar.gz: 671329ba2b9539fd586d82092e77458b482a445e34c4cbed18d9d9e9854b4573a59f7e475aa7ae2ec41f1959938020a376a4adf2f48e09747023109fb518d1ae

data/.github/workflows/js_tests.yml

@@ -0,0 +1,31 @@
+name: JavaScript Testing
+on:
+  pull_request:
+    paths:
+      - 'webpack/**'
+      - 'package.json'
+      - '.github/workflows/js_tests.yml'
+
+jobs:
+  test_js:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [10, 12]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Npm install
+        run: npm install
+      - name: Run plugin linter
+        run: npm run lint
+      - name: Run plugin tests
+        run: npm run test
+      - name: Publish Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/ruby_tests.yml

@@ -0,0 +1,74 @@
+name: Ruby Testing
+on: [pull_request]
+env:
+  RAILS_ENV: test
+  DATABASE_URL: postgresql://postgres:@localhost/test
+  DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: true
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Setup
+        run: |
+          gem install bundler
+          bundle install --jobs=3 --retry=3
+      - name: Run rubocop
+        run: bundle exec rubocop
+  test_ruby:
+    runs-on: ubuntu-latest
+    needs: rubocop
+    services:
+      postgres:
+        image: postgres:12.1
+        ports: ['5432:5432']
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+    strategy:
+      fail-fast: false
+      matrix:
+        foreman-core-branch: [develop]
+        ruby-version: [2.5, 2.6]
+        node-version: [12]
+    steps:
+      - run: sudo apt-get update
+      - run: sudo apt-get install build-essential libcurl4-openssl-dev zlib1g-dev libpq-dev
+      - uses: actions/checkout@v2
+        with:
+          repository: theforeman/foreman
+          ref: ${{ matrix.foreman-core-branch }}
+      - uses: actions/checkout@v2
+        with:
+          path: foreman-tasks
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version:  ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-fgems-${{ matrix.ruby-version }}-${{ hashFiles('Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-fgems-${{ matrix.ruby-version }}-
+      - name: Setup Bundler
+        run: |
+          echo "gem 'foreman-tasks', path: './foreman-tasks'" > bundler.d/foreman-tasks.local.rb
+          gem install bundler
+          bundle config set without journald development console libvirt
+          bundle config set path vendor/bundle
+      - name: Prepare test env
+        run: |
+          bundle install --jobs=3 --retry=3
+          bundle exec rake db:create
+          bundle exec rake db:migrate
+      - name: Run plugin tests
+        run: |
+          bundle exec rake test:foreman-tasks
+          bundle exec rake test TEST="test/unit/foreman/access_permissions_test.rb"

data/.rubocop.yml

@@ -6,10 +6,10 @@ require:
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  Include:
-    - 'Rakefile'
-    - 'app/views/foreman_tasks/api/**/*.rabl'
-    - lib/**/*.rake
+  Exclude:
+    - 'node_modules/**/*'
+    - 'locale/*'
+  TargetRubyVersion: 2.5
 
 Lint/ShadowingOuterLocalVariable:
   Enabled: false
@@ -68,6 +68,8 @@ Naming/FileName:
     - Gemfile
     - db/seeds.d/*
     - lib/foreman-tasks.rb
+    - gemfile.d/foreman-tasks.rb
+
 
 Layout/HeredocIndentation:
   Exclude:
@@ -115,3 +117,9 @@ Naming/RescuedExceptionsVariableName:
 
 Style/WordArray:
   Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.rubocop_todo.yml

@@ -1,21 +1,34 @@
-# Offense count: 1
-Lint/EmptyWhen:
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-08-07 08:31:32 UTC using RuboCop version 0.89.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.
+
+# Offense count: 2
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
   Exclude:
-    - 'app/lib/actions/proxy_action.rb'
+    - 'foreman-tasks-core.gemspec'
+    - 'foreman-tasks.gemspec'
 
 # Offense count: 1
 Lint/UselessAssignment:
   Exclude:
     - 'lib/foreman_tasks/tasks/export_tasks.rake'
 
-Minitest/AssertEmpty:
-  Enabled: false
-
-Minitest/AssertEqual:
-  Enabled: false
-
-Minitest/GlobalExpectations:
-  Enabled: false
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - '*.gemspec'
+    - 'Gemfile'
+    - 'db/seeds.d/*'
+    - 'lib/foreman-tasks.rb'
+    - 'gemfile.d/foreman-tasks.rb'
 
 # Offense count: 3
 # Configuration parameters: EnforcedStyleForLeadingUnderscores.
@@ -28,7 +41,7 @@ Naming/MemoizedInstanceVariableName:
 
 # Offense count: 11
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: io, id, to, by, on, in, at, ip, db, os, pp
+# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
   Exclude:
     - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
@@ -67,11 +80,13 @@ Rails/OutputSafety:
   Exclude:
     - 'app/helpers/foreman_tasks/foreman_tasks_helper.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: Include.
 # Include: **/Rakefile, **/*.rake
 Rails/RakeEnvironment:
   Exclude:
+    - 'lib/capistrano/tasks/**/*.rake'
+    - 'lib/foreman_tasks/tasks/dynflow.rake'
     - 'lib/foreman_tasks/tasks/test.rake'
 
 # Offense count: 12
@@ -92,22 +107,14 @@ Style/ClassAndModuleChildren:
     - 'test/controllers/api/recurring_logics_controller_test.rb'
     - 'test/controllers/api/tasks_controller_test.rb'
 
-# Offense count: 2
+# Offense count: 1
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: allowed_in_returns, forbidden
 Style/DoubleNegation:
   Exclude:
-    - 'app/models/foreman_tasks/lock.rb'
     - 'app/models/foreman_tasks/recurring_logic.rb'
 
-# Offense count: 36
+# Offense count: 35
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Enabled: false
-
-Style/HashEachMethods:
-  Enabled: false
-
-Style/HashTransformKeys:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false

data/Gemfile

@@ -13,3 +13,8 @@ gemspec :name => 'foreman-tasks'
 
 # To use debugger
 # gem 'debugger'
+
+gem 'rubocop', '~> 0.87'
+gem 'rubocop-minitest', '~> 0.9.0'
+gem 'rubocop-performance', '~> 1.5.2'
+gem 'rubocop-rails', '~> 2.5.2'

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

@@ -31,17 +31,6 @@ 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 }
-
-        filtered_scope = DashboardTableFilter.new(filtered_scope, params).scope
-        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
@@ -86,11 +75,16 @@ module ForemanTasks
       end
 
       api :POST, '/tasks/bulk_resume', N_('Resume all paused error tasks')
+      desc <<~DOC
+        Resumes all selected resumable tasks. If neither a search query nor an
+        explicit list of task IDs is provided, it tries to resume all tasks in
+        paused state with result error.
+      DOC
       param :search, String, :desc => N_('Resume tasks matching search string')
       param :task_ids, Array, :desc => N_('Resume specific tasks by ID')
       def bulk_resume
         if params[:search].nil? && params[:task_ids].nil?
-          raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
+          params[:search] = 'state = paused and result = error'
         end
         resumed = []
         failed = []
@@ -116,13 +110,18 @@ module ForemanTasks
           total: resumed.length + failed.length + skipped.length,
           resumed: resumed,
           failed: failed,
-          skipped: skipped
+          skipped: skipped,
         }
       end
 
-      api :POST, '/tasks/bulk_cancel', N_('Cancel all cancellable tasks')
+      api :POST, '/tasks/bulk_cancel', N_('Cancel selected cancellable tasks')
+      desc <<~DOC
+        Cancels all selected cancellable tasks. Requires a search query or an
+        explicit list of task IDs to be provided.
+      DOC
       param :search, String, :desc => N_('Cancel tasks matching search string')
       param :task_ids, Array, :desc => N_('Cancel specific tasks by ID')
+      error :bad_request, 'Returned if neither search nor task_ids parameter is provided.'
       def bulk_cancel
         if params[:search].nil? && params[:task_ids].nil?
           raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
@@ -137,13 +136,18 @@ module ForemanTasks
         render :json => {
           total: cancelled.length + skipped.length,
           cancelled: cancelled,
-          skipped: skipped
+          skipped: skipped,
         }
       end
 
-      api :POST, '/tasks/bulk_stop', N_('Stop all stoppable tasks')
+      api :POST, '/tasks/bulk_stop', N_('Stop selected stoppable tasks')
+      desc <<~DOC
+        Stops all selected tasks which are not already stopped. Requires a
+        search query or an explicit list of task IDs to be provided.
+      DOC
       param :search, String, :desc => N_('Stop tasks matching search string')
       param :task_ids, Array, :desc => N_('Stop specific tasks by ID')
+      error :bad_request, 'Returned if neither search nor task_ids parameter is provided.'
       def bulk_stop
         if params[:search].nil? && params[:task_ids].nil?
           raise BadRequest, _('Please provide at least one of search or task_ids parameters in the request')
@@ -165,22 +169,33 @@ module ForemanTasks
         render :json => {
           total: total_length,
           stopped_length: to_stop_length,
-          skipped_length: skipped_length
+          skipped_length: skipped_length,
         }
       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')
-      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)')
-      end
+      api :GET, '/tasks/:parent_task_id/sub_tasks', 'Show sub_tasks details'
+      param :parent_task_id, :identifier, desc: 'UUID of the task'
+      param_group :search_and_pagination, ::Api::V2::BaseController
       def index
-        filtered_scope = DashboardTableFilter.new(resource_scope, params).scope
-        render :json => tasks_list(filtered_scope)
+        if params[:sort_by] || params[:sort_order]
+          Foreman::Deprecation.api_deprecation_warning(
+            "The sort params sort_by and sort_order are deprecated.
+            Please use the order param instead as one string 'order=started_at desc'"
+          )
+
+          ordering_params = {
+            sort_by: params[:sort_by] || 'started_at',
+            sort_order: params[:sort_order] || 'DESC',
+          }
+          params[:order] = "#{ordering_params[:sort_by]} #{ordering_params[:sort_order]}"
+        end
+        params[:order] ||= 'started_at DESC'
+        @tasks = DashboardTableFilter.new(resource_scope_for_index, params).scope.order(params[:order].to_s)
+      end
+
+      def search_options
+        [params[:search], {}]
       end
 
       def_param_group :callback_target do
@@ -221,7 +236,7 @@ module ForemanTasks
       end
 
       def search_tasks(search_params)
-        scope = resource_scope_for_index.select('DISTINCT foreman_tasks_tasks.*')
+        scope = resource_scope_for_index
         scope = ordering_scope(scope, search_params)
         scope = search_scope(scope, search_params)
         scope = active_scope(scope, search_params)
@@ -287,7 +302,6 @@ module ForemanTasks
         sort_by = ordering_params[:sort_by] || 'started_at'
         sort_by = 'foreman_tasks_tasks.' + sort_by if sort_by == 'started_at'
         sort_order = ordering_params[:sort_order] || 'DESC'
-        scope = scope.select("foreman_tasks_tasks.*, coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) as duration")
         scope.order("#{sort_by} #{sort_order}")
       end
 
@@ -312,7 +326,17 @@ module ForemanTasks
       end
 
       def resource_scope(_options = {})
-        @resource_scope ||= ForemanTasks::Task.authorized("#{action_permission}_foreman_tasks")
+        scope = ForemanTasks::Task.authorized("#{action_permission}_foreman_tasks")
+        scope = scope.where(:parent_task_id => params[:parent_task_id]) if params[:parent_task_id]
+        scope
+      end
+
+      def resource_scope_for_index(*args)
+        super.select("DISTINCT foreman_tasks_tasks.*, coalesce(ended_at, current_timestamp) - coalesce(coalesce(started_at, ended_at), current_timestamp) as duration")
+      end
+
+      def controller_permission
+        'foreman_tasks'
       end
 
       def action_permission
@@ -326,39 +350,6 @@ module ForemanTasks
         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
-
       def bulk_scope
         scope = resource_scope
         scope = scope.search_for(params[:search]) if params[:search]