Fixes #39246 - Add sorting and searching to the new Leapp preupgrade report

Author: kmalyjur

app/controllers/api/v2/preupgrade_reports_controller.rb

@@ -15,8 +15,16 @@ def index
 
       api :GET, '/preupgrade_reports/:id', N_('Show Preupgrade report')
       param :id, :identifier, required: true
+      param :search, String, required: false, desc: N_('Filter entries')
+      param :order, String, required: false, desc: N_('Sort entries, e.g. "title ASC"')
+      param :page, :number, required: false, desc: N_('Page number')
+      param :per_page, :number, required: false, desc: N_('Items per page')
       def show
         @preupgrade_report = resource_scope.find(params[:id])
+        scope = @preupgrade_report.preupgrade_report_entries
+        @entries = scope.search_for(params[:search], order: params[:order]).paginate(paginate_options)
+        @total = scope.count
+        @subtotal = @entries.total_entries
       end
 
       api :GET, '/job_invocations/:id/preupgrade_reports', N_('List Preupgrade reports for Job invocation')
@@ -30,8 +38,8 @@ def job_invocation
       # By overriding path_to_authenticate we can require REX's permission view_job_invocations
       def path_to_authenticate
         params['action'] = 'show' if params['action'] == 'job_invocation'
-        Foreman::AccessControl.normalize_path_hash params.slice(:action, :id, :user_id)
-                                                         .merge({ controller: 'api/v2/job_invocations' })
+        path_params = params.slice(:action, :id, :user_id).merge(controller: 'api/v2/job_invocations')
+        Foreman::AccessControl.normalize_path_hash(path_params)
       end
     end
   end

app/controllers/preupgrade_report_entries_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class PreupgradeReportEntriesController < ApplicationController
+  include Foreman::Controller::AutoCompleteSearch
+
+  # rubocop:disable Rails/LexicallyScopedActionFilter
+  skip_before_action :authorize, only: %i[auto_complete_search]
+  before_action :authorize_autocomplete, only: %i[auto_complete_search]
+  # rubocop:enable Rails/LexicallyScopedActionFilter
+
+  def index
+    @preupgrade_report_entries = resource_scope
+                                 .search_for(params[:search], order: params[:order])
+                                 .paginate(paginate_options)
+    render 'api/v2/preupgrade_report_entries/index'
+  end
+
+  protected
+
+  def model_of_controller
+    PreupgradeReportEntry.joins(:host).merge(Host.authorized(:view_hosts, Host))
+  end
+
+  def resource_scope
+    model_of_controller
+  end
+
+  private
+
+  def authorize_autocomplete
+    unless User.current.can?('view_job_invocations')
+      render json: {
+        error: {
+          message: _('Missing one of the required permissions: view_job_invocations'),
+          missing_permissions: ['view_job_invocations']
+        }
+      }, status: :forbidden
+      return
+    end
+
+    return if User.current.can?('view_hosts')
+
+    render json: {
+      error: {
+        message: _('Missing one of the required permissions: view_hosts'),
+        missing_permissions: ['view_hosts']
+      }
+    }, status: :forbidden
+  end
+
+  def action_permission
+    'view'
+  end
+
+  def controller_permission
+    'job_invocations'
+  end
+end

app/models/preupgrade_report_entry.rb

@@ -8,9 +8,43 @@ class PreupgradeReportEntry < ApplicationRecord
   serialize :flags, Array
   serialize :detail, JSON
 
-  validates :preupgrade_report, :host, :hostname, :title, :actor, :audience, :severity, :leapp_run_id, presence: true
+  validates :preupgrade_report, :host, :hostname, :title, :actor,
+            :audience, :severity, :leapp_run_id, presence: true
+
+  scoped_search on: :title, complete_value: true
+  scoped_search on: :hostname, complete_value: true
+  scoped_search on: :severity, complete_value: { high: 'high', medium: 'medium', low: 'low', info: 'info' }
+  scoped_search on: :summary
+
+  scoped_search on: :flags,
+                rename: :inhibitor,
+                only_explicit: true,
+                operators: ['=', '!='],
+                complete_value: { yes: 'yes', no: 'no' },
+                ext_method: :search_yes_no_fields
+
+  scoped_search on: :detail,
+                rename: :has_remediation,
+                only_explicit: true,
+                operators: ['=', '!='],
+                complete_value: { yes: 'yes', no: 'no' },
+                ext_method: :search_yes_no_fields
 
   def self.remediation_details(remediation_ids, host)
     where(id: remediation_ids, host: host).where.not(detail: nil).pluck(:detail)
   end
+
+  def self.search_yes_no_fields(key, operator, value)
+    column, term = case key.to_sym
+                   when :inhibitor       then %w[flags inhibitor]
+                   when :has_remediation then %w[detail remediations]
+                   end
+
+    if (operator == '=' && value == 'yes') || (operator == '!=' && value == 'no')
+      { conditions: "preupgrade_report_entries.#{column} LIKE '%%#{term}%%'" }
+    else
+      { conditions: "(preupgrade_report_entries.#{column} NOT LIKE '%%#{term}%%' OR " \
+                    "preupgrade_report_entries.#{column} IS NULL)" }
+    end
+  end
 end

app/views/api/v2/preupgrade_report_entries/index.json.rabl

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+object false
+
+child(@preupgrade_report_entries => :results) do
+  extends 'api/v2/preupgrade_report_entries/main'
+end
+
+node(:total) { @preupgrade_report_entries.total_entries }
+node(:subtotal) { @preupgrade_report_entries.total_entries }
+node(:page) { params[:page].to_i.positive? ? params[:page].to_i : 1 }
+node(:per_page) { params[:per_page].to_i.positive? ? params[:per_page].to_i : Setting[:entries_per_page] }

app/views/api/v2/preupgrade_report_entries/main.json.rabl

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+extends 'api/v2/preupgrade_report_entries/base'

app/views/api/v2/preupgrade_reports/show.json.rabl

@@ -1,7 +1,13 @@
-object @preupgrade_report
+# frozen_string_literal: true
 
-extends 'api/v2/preupgrade_reports/base'
+object @preupgrade_report
+attributes :id, :status, :reported_at
 
-child :preupgrade_report_entries do
-  extends 'api/v2/preupgrade_report_entries/base'
+child(@entries => :results) do
+  extends 'api/v2/preupgrade_report_entries/main'
 end
+
+node(:total) { @total }
+node(:subtotal) { @subtotal }
+node(:page) { params[:page].to_i.positive? ? params[:page].to_i : 1 }
+node(:per_page) { params[:per_page].to_i.positive? ? params[:per_page].to_i : Setting[:entries_per_page] }

config/routes.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
 Rails.application.routes.draw do
-  resources :preupgrade_reports, :only => %i[index]
+  resources :preupgrade_reports, only: %i[index]
+
+  resources :preupgrade_report_entries, only: [] do
+    collection do
+      get :auto_complete_search
+    end
+  end
 
   namespace :api, defaults: { format: 'json' } do
     scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v2/,
-      constraints: ApiConstraints.new( version: 2, default: true) do
+                     constraints: ApiConstraints.new(version: 2, default: true) do
       resources :preupgrade_reports, only: %i[index show]
       get 'job_invocations/:id/preupgrade_reports', to: 'preupgrade_reports#job_invocation'
     end

test/functional/api/v2/preupgrade_reports_controller_test.rb

@@ -4,6 +4,7 @@
 
 module Api
   module V2
+    # rubocop:disable Metrics/ClassLength
     class PreupgradeReportsControllerTest < ActionController::TestCase
       setup do
         @host = FactoryBot.create(:host)
@@ -22,9 +23,11 @@ class PreupgradeReportsControllerTest < ActionController::TestCase
         get :show, params: { id: @report.id }
         assert_response :success
 
-        response = JSON.parse(@response.body)
-        assert_equal response['id'], @report.id
-        assert_not_empty response['preupgrade_report_entries']
+        body = JSON.parse(@response.body)
+        assert_equal @report.id, body['id']
+        assert_not_empty body['results']
+        assert_not_nil body['total']
+        assert_not_nil body['subtotal']
       end
 
       test 'should get :job_invocation' do
@@ -96,7 +99,7 @@ class PreupgradeReportsControllerTest < ActionController::TestCase
           assert_includes JSON.parse(@response.body)['error']['missing_permissions'], 'view_hosts'
         end
 
-        test 'should not get :job_invocation' do
+        test 'should not get :show' do
           get :show, params: { id: @report.id }, session: set_session_user(@user)
           assert_response :forbidden
           assert_includes JSON.parse(@response.body)['error']['missing_permissions'], 'view_hosts'
@@ -108,6 +111,34 @@ class PreupgradeReportsControllerTest < ActionController::TestCase
           assert_includes JSON.parse(@response.body)['error']['missing_permissions'], 'view_hosts'
         end
       end
+
+      test 'should filter entries by search on :show' do
+        get :show, params: { id: @report.id, search: "title = \"#{@entry.title}\"" }
+        assert_response :success
+        body = JSON.parse(@response.body)
+        assert_equal 1, body['results'].length
+        assert_equal @entry.id, body['results'].first['id']
+      end
+
+      test 'should sort entries on :show' do
+        FactoryBot.create(:preupgrade_report_entry, host: @host, preupgrade_report: @report,
+                                                    title: 'Aaa first alphabetically')
+        get :show, params: { id: @report.id, order: 'title ASC' }
+        assert_response :success
+        titles = JSON.parse(@response.body)['results'].map { |e| e['title'] }
+        assert_equal titles.sort, titles
+      end
+
+      test ':show always returns paginated results with total and subtotal' do
+        get :show, params: { id: @report.id }
+        assert_response :success
+        body = JSON.parse(@response.body)
+        assert_not_empty body['results']
+        assert_not_nil body['total']
+        assert_not_nil body['subtotal']
+        assert_equal body['total'], body['subtotal']
+      end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

test/functional/preupgrade_report_entries_controller_test.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class PreupgradeReportEntriesControllerTest < ActionController::TestCase
+  setup do
+    @user = FactoryBot.create(:user, admin: false)
+    @host = FactoryBot.create(:host)
+    @report = FactoryBot.create(:preupgrade_report, host: @host)
+    @entry = FactoryBot.create(:preupgrade_report_entry, host: @host, preupgrade_report: @report)
+  end
+
+  test 'should get auto_complete_search with required permissions' do
+    User.any_instance.stubs(:can?).with('view_job_invocations').returns(true)
+    User.any_instance.stubs(:can?).with('view_hosts').returns(true)
+
+    get :auto_complete_search, params: { format: :json }, session: set_session_user(@user)
+    assert_response :success
+  end
+
+  test 'should not get auto_complete_search without :view_hosts' do
+    User.any_instance.stubs(:can?).with('view_job_invocations').returns(true)
+    User.any_instance.stubs(:can?).with('view_hosts').returns(false)
+
+    get :auto_complete_search, params: { format: :json }, session: set_session_user(@user)
+    assert_response :forbidden
+    assert_includes JSON.parse(@response.body)['error']['missing_permissions'], 'view_hosts'
+  end
+
+  test 'should not get auto_complete_search without :view_job_invocations' do
+    User.any_instance.stubs(:can?).with('view_job_invocations').returns(false)
+
+    get :auto_complete_search, params: { format: :json }, session: set_session_user(@user)
+    assert_response :forbidden
+    assert_includes JSON.parse(@response.body)['error']['missing_permissions'], 'view_job_invocations'
+  end
+end

test/models/preupgrade_report_entry_test.rb

@@ -33,4 +33,23 @@ class PreupgradeReportEntryTest < ActiveSupport::TestCase
       assert_equal details.size, 0
     end
   end
+
+  describe 'scoped_search' do
+    it 'filters correctly by has_remediation and inhibitor' do
+      host = FactoryBot.create(:host)
+      report = FactoryBot.create(:preupgrade_report)
+
+      entry1 = FactoryBot.create(:preupgrade_report_entry, preupgrade_report: report, host: host,
+                                                           flags: ['inhibitor'],
+                                                           detail: { 'remediations' => [{ 'type' => 'hint' }] })
+      entry2 = FactoryBot.create(:preupgrade_report_entry, preupgrade_report: report, host: host,
+                                                           flags: [],
+                                                           detail: nil)
+
+      assert_includes PreupgradeReportEntry.search_for('inhibitor = yes'), entry1
+      assert_not_includes PreupgradeReportEntry.search_for('inhibitor = yes'), entry2
+      assert_includes PreupgradeReportEntry.search_for('has_remediation = no'), entry2
+      assert_not_includes PreupgradeReportEntry.search_for('has_remediation = no'), entry1
+    end
+  end
 end