foreman_host_reports 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9695286b83e23f261081f2cf90295bf1eee04ac44d34008873ab108bb8293bc6
-  data.tar.gz: 6db378669511e31557bfd2f846b3cbd3dbe20e2bf10c81a1682ee6d8fe469578
+  metadata.gz: 0ef176b8d987ed56aa02950203e7cfdfc880d050be4701377c15aa8bcd20559a
+  data.tar.gz: 58a23f1ad805649d1dafffa7dcfe2af89c733380476588ae0b31df34b6502c68
 SHA512:
-  metadata.gz: 8a504fa405d02d5b2a5f65530e818e1ba41aaa94aefaf1df199aa7cc0c494c4fe83f49702951a2f253ca442c761e99e109875b6d3aa8ba743cd622b60d8d7b88
-  data.tar.gz: de05ed9c8babe9e6b687db9db1a5052b621cee8dd1757e6013fc2f196181bed4ffed070b7bee2cfd727f49e5ceeda8372aa7a01b6f411d5891269652e8e58649
+  metadata.gz: 64aa7da0150a3857d6f2a6fbefd37d9ee60fc7cdbbf741ee39671708b8e487100616d3632aa8622b649f6c3ab17232a793353a521058debd6a5511565a0f5f90
+  data.tar.gz: 50876e1b5b656de267b8580e3503f2db25c9c954a5cfb333e0b4fc4d0d376fb9aeb18f7309426c599d1173e847940166660469826e2e53b4cc3464cfe0b37389

data/app/helpers/foreman_host_reports/reports_dashboard_helper.rb

@@ -0,0 +1,79 @@
+module ForemanHostReports
+  module ReportsDashboardHelper
+    def host_reports_searchable_links(name, search, counter, format)
+      content_tag :li, :style => "margin-bottom: 5px" do
+        content_tag(:span, sanitize(' '), :class => 'label', :style => "background-color: #{host_reports_report_color[counter]}") +
+          sanitize(' ') +
+          link_to(name, hosts_path(:search => search), :class => "dashboard-links") +
+          content_tag(:span, send(counter, format), class: 'pull-right')
+      end
+    end
+
+    def host_reports_report_color
+      {
+        :change_hosts => "#4572A7",
+        :failure_hosts => "#AA4643",
+        :nochange_hosts => "#DB843D",
+        :disabled_hosts => "#92A8CD",
+      }
+    end
+
+    def host_reports_get_overview(options = {})
+      format = options[:format]
+      state_labels = {
+        change_hosts: _('Change'),
+        failure_hosts: _('Failure'),
+        nochange_hosts: _('No Change'),
+        disabled_hosts: _('Disabled alerts'),
+      }
+      counter = {}
+      total = 0
+      data = state_labels.map do |key, label|
+        counter.store(key, send(key, format))
+        total = counter[key] + total
+        [label, counter[key], host_reports_report_color[key]]
+      end
+      {
+        data: data,
+        searchUrl: hosts_path(search: '~VAL~'),
+        title: { primary: _("#{(counter[:failure_hosts].fdiv(total) * 100).to_i}%"), secondary: state_labels[:failure_hosts] },
+        searchFilters: state_labels.each_with_object({}) do |(key, filter), filters|
+          filters[filter] = counter[key]
+        end,
+      }
+    end
+
+    def latest_reports
+      HostReport.authorized(:view_host_reports).my_reports
+                .reorder(:reported_at => :desc)
+                .limit(9)
+                .preload(:host)
+    end
+
+    def latest_reports?
+      latest_reports.limit(1).present?
+    end
+
+    def host_reports_translated_header(shortname, longname)
+      "<th style='width:85px; class='ca'><span class='small' title='' data-original-title='#{longname}'>#{shortname}</span></th>"
+    end
+
+    private
+
+    def disabled_hosts(_format = nil)
+      Host.authorized(:view_hosts, Host).where(:enabled => false).count
+    end
+
+    def change_hosts(format)
+      HostReport.authorized(:view_host_reports).my_reports.where("format = ? and change > 0", HostReport.formats[format]).reorder('').group(:host_id).maximum(:id).count
+    end
+
+    def nochange_hosts(format)
+      HostReport.authorized(:view_host_reports).my_reports.where("format = ? and nochange > 0", HostReport.formats[format]).reorder('').group(:host_id).maximum(:id).count
+    end
+
+    def failure_hosts(format)
+      HostReport.authorized(:view_host_reports).my_reports.where("format = ? and failure > 0", HostReport.formats[format]).reorder('').group(:host_id).maximum(:id).count
+    end
+  end
+end

data/app/models/concerns/foreman_host_reports/host_extensions.rb

@@ -10,6 +10,7 @@ module ForemanHostReports
       scoped_search relation: :host_reports, on: :change, rename: :report_changes, only_explicit: true
       scoped_search relation: :host_reports, on: :nochange, rename: :report_nochanges, only_explicit: true
       scoped_search relation: :host_reports, on: :failure, rename: :report_failures, only_explicit: true
+      scoped_search relation: :host_reports, on: :format, rename: :report_format, only_explicit: true, complete_value: { plain: 0, puppet: 1, ansible: 2 }
     end
   end
 end

data/app/views/dashboard/_host_reports_status_chart_widget.html.erb

@@ -0,0 +1,13 @@
+<%
+  format = settings[:format]
+%>
+<h4 class="header">
+  <% if format %>
+    <%= _('%s Host Reports Chart') % format %>
+  <% else %>
+    <%= _('All Host Reports Chart') %>
+  <% end %>
+</h4>
+<div class="host-configuration-chart">
+  <%= react_component('DonutChart', host_reports_get_overview(format: format.downcase))%>
+</div>

data/app/views/dashboard/_host_reports_status_links.html.erb

@@ -0,0 +1,5 @@
+
+<%= host_reports_searchable_links _('Hosts with changes'), "report_changes > 0 and report_format = #{format}", :change_hosts, format%>
+<%= host_reports_searchable_links _('Hosts without changes'), "report_nochanges > 0 and report_format = #{format}", :nochange_hosts, format %>
+<%= host_reports_searchable_links _('Hosts with failures'), "report_failures > 0 and report_format =  #{format}" , :failure_hosts, format %>
+<%= host_reports_searchable_links _('Hosts with disabled alerts'), "status.enabled = false" , :disabled_hosts, format %>

data/app/views/dashboard/_host_reports_status_widget.html.erb

@@ -0,0 +1,11 @@
+<h4 class="header">
+  <% if (format = settings[:format]) %>
+    <%= _('%s Host Reports') % settings[:format] %>
+  <% else %>
+    <%= _('All Host Reports %s') % disabled_hosts%>
+  <% end %>
+</h4>
+<ul>
+  <%= render "dashboard/host_reports_status_links", format: format.downcase %>
+  <h4 class="total"><%= _("Total Hosts: %s") % Host.all.count %></h4>
+</ul>

data/app/views/dashboard/_host_reports_widget.html.erb

@@ -0,0 +1,29 @@
+<h4 class="header">
+  <%= _("Latest Host Reports") %>
+</h4>
+
+<% if latest_reports? %>
+  <table class="<%= table_css_classes 'table-fixed reports-table' %>">
+    <thead>
+      <tr>
+        <%= string =  "<th>#{_('Host')}</th>"
+            string += host_reports_translated_header(s_('Changed'), _('Changed'))
+            string += host_reports_translated_header(s_('Unchanged'), _('Unchanged'))
+            string += host_reports_translated_header(s_('Failed'), _('Failed'))
+            string.html_safe %>
+      </tr>
+    </thead>
+    <tbody>
+      <% latest_reports.each do |report| %>
+        <tr>
+          <td class='ellipsis'><%= link_to report.host, host_reports_host_path(report.host.id) %></td>
+          <td class="ca"><%= report_event_column(report.change, "label-info") %></td>
+          <td class="ca"><%= report_event_column(report.nochange, "label-warning") %></td>
+          <td class="ca"><%= report_event_column(report.failure, "label-danger") %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <p class="ca"><%= _("No interesting reports received in the last week") %></p>
+<% end %>

data/lib/foreman_host_reports/engine.rb

@@ -44,6 +44,19 @@ module ForemanHostReports
         add_histogram_telemetry(:host_report_create_keywords, 'Time spent processing keywords (ms)')
         add_histogram_telemetry(:host_report_create_refresh, 'Time spent processing status refresh (ms)')
         add_histogram_telemetry(:host_report_create, 'Time spent saving record (ms)')
+
+        # add dashboard widget
+        in_to_prepare do
+          HostReport.formats.each do |format, _|
+            if format != 'plain' && (format = format.capitalize)
+              widget 'host_reports_status_chart_widget', :name => N_(" %s Host Reports Chart ") % format, :sizex => 4, :sizey => 1, settings: { format: format }
+              widget 'host_reports_status_widget', :name => N_(" %s Host Reports ") % format, :sizex => 4, :sizey => 1, settings: { format: format }
+            end
+          end
+
+          ::DashboardController.helper ForemanHostReports::ReportsDashboardHelper
+          widget 'host_reports_widget', :name => N_('Host Reports'), :sizex => 6, :sizey => 1
+        end
       end
     end
 

data/lib/foreman_host_reports/version.rb

@@ -1,3 +1,3 @@
 module ForemanHostReports
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/lib/tasks/migrate.rake

@@ -0,0 +1,235 @@
+PUPPET_LOG_LEVELS = %w[debug info notice warning err alert emerg crit].freeze
+reports_migrate_running = true
+
+namespace :host_reports do
+  def detect_puppet_keywords(status, logs)
+    result = ["Migrated"]
+    # from statuses
+    result << "PuppetFailed" if status["failed"]&.positive?
+    result << "PuppetFailedToRestart" if status["failed_restarts"]&.positive?
+    result << "PuppetCorrectiveChange" if status["corrective_change"]&.positive?
+    result << "PuppetSkipped" if status["skipped"]&.positive?
+    result << "PuppetRestarted" if status["restarted"]&.positive?
+    result << "PuppetScheduled" if status["scheduled"]&.positive?
+    result << "PuppetOutOfSync" if status["out_of_sync"]&.positive?
+    # from logs
+    logs.each do |level, resource, _message|
+      result << "PuppetFailed:#{resource}" if level == "err" && resource != "Puppet"
+    end
+    result.uniq
+  end
+
+  # Puppet status cannot be directly mapped, let's create unique migration-only keywords.
+  # See: https://community.theforeman.org/t/new-config-report-summary-columns/26531
+  def detect_ansible_keywords(status)
+    result = ["Migrated"]
+    # from statuses
+    result << "AnsibleMigrate:Applied" if status["applied"]&.positive?
+    result << "AnsibleMigrate:Restarted" if status["restarted"]&.positive?
+    result << "AnsibleMigrate:Failed" if status["failed"]&.positive?
+    result << "AnsibleMigrate:FailedRestarts" if status["failed_restarts"]&.positive?
+    result << "AnsibleMigrate:Skipped" if status["skipped"]&.positive?
+    result << "AnsibleMigrate:Pending" if status["pending"]&.positive?
+    result.uniq
+  end
+
+  def puppet_metrics(metrics)
+    return [0, 0, 0] if metrics.empty?
+    change = metrics.dig("events", "success") || 0
+    failure = metrics.dig("events", "failure") || 0
+    total = metrics.dig("events", "total") || 0
+    nochange = total - change - failure
+    [change, failure, nochange]
+  end
+
+  def summary(origin, metrics, status)
+    change, failure, nochange = 0
+    case origin
+    when "Puppet"
+      change, failure, nochange = puppet_metrics(metrics)
+    when "Ansible"
+      # There is not enough data to construct the summary, it is not possible to
+      # efficiently map ansible status values to the new format. See the discussion
+      # at: https://community.theforeman.org/t/new-config-report-summary-columns/26531
+      failure = status["failed"]
+      change = status["applied"]
+      nochange = status["skipped"]
+    end
+
+    {
+      foreman: {
+        change: change,
+        nochange: nochange,
+        failure: failure,
+      },
+      native: metrics[:resources] || {},
+      legacy_status: status || {},
+    }
+  end
+
+  def create_body(format, metrics, reported_at, _status, host, keywords, summary)
+    {
+      version: 1,
+      format: format,
+      migrated: true,
+      host: host.name,
+      reported_at: reported_at,
+      keywords: keywords,
+      summary: summary,
+      # metrics cannot be migrated because Foreman stores them in its own way and
+      # the new host format uses puppet native version
+      metrics: {
+        resources: { values: [] },
+        time: { values: [] },
+        changes: { values: [] },
+        events: { values: [] },
+      },
+      # keep the legacy metrics in the body in case we reconsider and transform it later
+      legacy_metrics: metrics,
+    }
+  end
+
+  def build_report(host_id, origin, body, report_keyword_ids)
+    {
+      host_id: host_id,
+      proxy_id: nil,
+      format: origin,
+      reported_at: body[:reported_at],
+      body: body.to_json,
+      change: body.dig(:summary, :foreman, :change),
+      nochange: body.dig(:summary, :foreman, :nochange),
+      failure: body.dig(:summary, :foreman, :failure),
+      report_keyword_ids: report_keyword_ids,
+    }
+  end
+
+  def create_puppet_logs(id, log_object)
+    logs = [["debug", "migration", "Report migrated from legacy report ID=#{id} at #{Time.now.utc}"]]
+    log_object.includes(:message, :source).find_each do |log|
+      logs << [PUPPET_LOG_LEVELS[log.level_id] || 'unknown', log.source.value, log.message.value]
+    end
+    logs
+  end
+
+  def create_ansible_result(msg, level, result = {}, task = {})
+    {
+      failed: false,
+      level: level,
+      friendly_message: msg,
+      result: result,
+      task: task,
+    }
+  end
+
+  def create_ansible_results(id, log_object)
+    results = []
+    results << create_ansible_result("Report migrated from legacy report ID=#{id} at #{Time.now.utc}", "info")
+    log_object.includes(:message, :source).find_each do |log|
+      lvl = PUPPET_LOG_LEVELS[log.level_id] || 'unknown'
+      msg = begin
+        JSON.parse(log.message.value)
+      rescue StandardError
+        log.message.value
+      end
+      results << create_ansible_result(log.source.value, lvl, msg)
+    end
+    results
+  end
+
+  desc <<-END_DESC
+  Migrates Foreman Configuration Reports to the new Host Reports format.
+  Does not delete legacy reports, can be iterrupted at any time.
+  Accepts from_date option (older reports will be ignored) and from_id,
+  primary key (ID) to start migration from which can be used to resume
+  previously stopped migration. Example:
+
+  foreman-rake host_reports:migrate from_date=2021-01-01 from_id=1234567
+  END_DESC
+  task :migrate => :environment do
+    Rails.logger.level = Logger::ERROR
+    Foreman::Logging.logger('permissions').level = Logger::ERROR
+    Foreman::Logging.logger('audit').level = Logger::ERROR
+    Signal.trap("INT") do
+      reports_migrate_running = false
+    end
+    Signal.trap("TERM") do
+      reports_migrate_running = false
+    end
+
+    from_id = (ENV['from_id'] || '0').to_i
+    from_date = ENV['from_date'] || '1980-01-15'
+    report_count = ConfigReport.unscoped.where("id >= ? and reported_at >= ?", from_id, from_date).count
+    print_each = 1 + (report_count / 100).to_i
+    puts "Starting, #{report_count} report(s) left"
+    counter = 0
+    ConfigReport.unscoped.all.where("id >= ? and reported_at >= ?", from_id, from_date).find_each do |r|
+      raise("Interrupted") unless reports_migrate_running
+      counter += 1
+      puts("Processing report #{counter} out of #{report_count} reports") if (counter % print_each).zero?
+      case r.origin
+      when "Puppet"
+        logs = create_puppet_logs(r.id, r.logs)
+        keywords = detect_puppet_keywords(r.status, logs)
+      when "Ansible"
+        results = create_ansible_results(r.id, r.logs)
+        keywords = detect_ansible_keywords(r.status)
+      end
+      if keywords.present?
+        keywords_to_insert = keywords.each_with_object([]) do |n, ks|
+          ks << { name: n }
+        end
+        ReportKeyword.upsert_all(keywords_to_insert, unique_by: :name)
+        report_keyword_ids = ReportKeyword.where(name: keywords).distinct.pluck(:id)
+      end
+      summary = summary(r.origin, r.metrics, r.status)
+      body = create_body(r.origin&.downcase, r.metrics, r.reported_at, r.status, r.host, report_keyword_ids, summary)
+      case r.origin
+      when "Puppet"
+        body[:logs] = logs
+      when "Ansible"
+        body[:results] = results
+      end
+      origin = r.origin.downcase
+      User.without_auditing do
+        User.as_anonymous_admin do
+          HostReport.create!(build_report(r.host_id, origin, body, report_keyword_ids))
+        end
+      end
+    rescue StandardError => e
+      puts "Error when processing report ID=#{r.id}"
+      puts r.inspect
+      puts "To resume the process:\n\n***\n\nforeman-rake host_reports:migrate from_id=#{r.id} from_date=#{from_date}\n\n***\n\n"
+      raise e
+    end
+    puts "\n\nALL DONE!\n\nCheck the migrated reports in Monitor - Host Reports first"
+    puts "and when ready, expire old configuration reports with:\n\n"
+    puts "  rake reports:expire report_type=config_report days=0\n\n"
+    puts "Report expiration is slow, if you don't use OpenSCAP plugin, then"
+    puts "truncate the following tables in the foreman database"
+    puts "for a quick delete (this will remove also OpenSCAP reports):\n\n"
+    puts "  truncate logs, messages, resources, reports;\n\n"
+    puts "Reclaim postgres database space via VACUUM function in any case."
+    puts "If migration was not successful, truncate tables host_reports and"
+    puts "report_keywords and start over.\n"
+    puts "Optionally, refresh host statuses with:\n\n"
+    puts "  foreman-rake host_reports:refresh\n\n"
+  end
+
+  desc <<-END_DESC
+  Host status information can be incorrect until new report is received.
+  This task refreshes all host statuses and global statuses.
+  END_DESC
+  task :refresh => :environment do
+    Rails.logger.level = Logger::ERROR
+    Foreman::Logging.logger('permissions').level = Logger::ERROR
+    Foreman::Logging.logger('audit').level = Logger::ERROR
+    User.without_auditing do
+      User.as_anonymous_admin do
+        Host.unscoped.all.find_each do |h|
+          h.refresh_statuses
+          h.refresh_global_status
+        end
+      end
+    end
+  end
+end

data/package.json

@@ -21,20 +21,17 @@
     "url": "http://projects.theforeman.org/projects/foreman_host_reports/issues"
   },
   "peerDependencies": {
-    "@theforeman/vendor": "^8.15.0"
+    "@theforeman/vendor": ">= 0"
   },
   "dependencies": {
     "react-json-tree": "^0.11.0"
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
-    "@sheerun/mutationobserver-shim": "^0.3.3",
-    "@theforeman/builder": "^8.15.0",
-    "@theforeman/eslint-plugin-foreman": "^8.15.0",
-    "@theforeman/find-foreman": "^8.15.0",
-    "@theforeman/stories": "^8.15.0",
-    "@theforeman/test": "^8.15.0",
-    "@theforeman/vendor-dev": "^8.15.0",
+    "@theforeman/builder": ">= 0",
+    "@theforeman/eslint-plugin-foreman": ">= 0",
+    "@theforeman/stories": ">= 0",
+    "@theforeman/test": ">= 0",
     "babel-eslint": "^10.0.3",
     "eslint": "^6.7.2",
     "prettier": "^1.19.1",

data/test/controllers/api/v2/host_reports_controller_test.rb

@@ -167,33 +167,6 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
       }
       assert_response :forbidden
     end
-
-    test 'when "require_ssl" is true, HTTP requests should not be able to create a report' do
-      Setting[:restrict_registered_smart_proxies] = true
-      SETTINGS[:require_ssl] = true
-
-      Resolv.any_instance.stubs(:getnames).returns(['else.where'])
-      post :create, params: {
-        host_report: {
-          host: host.name, body: report_body, reported_at: Time.current,
-          change: 1, nochange: 2, failure: 3
-        },
-      }
-      assert_response :redirect
-    end
-
-    test 'when "require_ssl" is false, HTTP requests should be able to create reports' do
-      Setting[:restrict_registered_smart_proxies] = true
-      SETTINGS[:require_ssl] = false
-
-      post :create, params: {
-        host_report: {
-          host: host.name, body: report_body, reported_at: Time.current,
-          change: 1, nochange: 2, failure: 3
-        },
-      }
-      assert_response :created
-    end
   end
 
   test 'should get index' do

data/test/factories/foreman_host_reports_factories.rb

@@ -17,6 +17,18 @@ FactoryBot.define do
     format { 'ansible' }
   end
 
+  trait :with_failure do
+    failure { 1 }
+  end
+
+  trait :with_change do
+    change { 1 }
+  end
+
+  trait :with_nochange do
+    nochange { 1 }
+  end
+
   trait :with_keyword do
     transient do
       name { 'HasError' }

data/test/unit/dashboard_test.rb

@@ -0,0 +1,65 @@
+require 'test_plugin_helper'
+
+class DashboardTest < ActiveSupport::TestCase
+  include ForemanHostReports::ReportsDashboardHelper
+
+  let(:ansible_report_with_change) { FactoryBot.create(:host_report, :ansible_format, :with_change) }
+  let(:ansible_report_with_nochange) { FactoryBot.create(:host_report, :ansible_format, :with_nochange) }
+  let(:ansible_report_with_failure) { FactoryBot.create(:host_report, :ansible_format, :with_failure) }
+
+  let(:puppet_report_with_change) { FactoryBot.create(:host_report, :puppet_format, :with_change) }
+  let(:puppet_report_with_nochange) { FactoryBot.create(:host_report, :puppet_format, :with_nochange) }
+  let(:puppet_report_with_failure) { FactoryBot.create(:host_report, :puppet_format, :with_failure) }
+
+  let(:puppet_format) { puppet_report_with_nochange.format }
+  let(:ansible_format) { ansible_report_with_change.format }
+
+  let(:host1) { ansible_report_with_change.host }
+  let(:host2) { puppet_report_with_nochange.host }
+  let(:host3) { puppet_report_with_failure.host }
+  let(:hosts) { [host1, host2, host3] }
+
+  test 'check number of host reports with changes and ansible format' do
+    changed = ansible_report_with_change.change + ansible_report_with_nochange.change + ansible_report_with_failure.change
+    assert_equal change_hosts(ansible_format), changed
+  end
+
+  test 'check number of host reports with changes and puppet format' do
+    changed = puppet_report_with_change.change + puppet_report_with_nochange.change + puppet_report_with_failure.change
+    assert_equal change_hosts(puppet_format), changed
+  end
+
+  test 'check number of host reports with no changes and ansible format' do
+    nochange = ansible_report_with_change.nochange + ansible_report_with_nochange.nochange + ansible_report_with_failure.nochange
+    assert_equal nochange_hosts(ansible_format), nochange
+  end
+
+  test 'check number of host reports with no changes and puppet format' do
+    nochange = puppet_report_with_change.nochange + puppet_report_with_nochange.nochange + puppet_report_with_failure.nochange
+    assert_equal nochange_hosts(puppet_format), nochange
+  end
+
+  test 'check number of host reports with failures and ansible format' do
+    failure = ansible_report_with_change.failure + ansible_report_with_nochange.failure + ansible_report_with_failure.failure
+    assert_equal failure_hosts(ansible_format), failure
+  end
+
+  test 'check number of host reports with failures and puppet format' do
+    failure = puppet_report_with_change.failure + puppet_report_with_nochange.failure + puppet_report_with_failure.failure
+    assert_equal failure_hosts(puppet_format), failure
+  end
+
+  test 'check Hosts with disabled alerts ' do
+    host1.update(:enabled => false)
+    disabled = hosts.reject(&:enabled?)
+    assert_equal disabled_hosts, disabled.count
+  end
+
+  test 'latest_reports' do
+    FactoryBot.create(:host_report, :ansible_format, :with_change)
+    FactoryBot.create(:host_report, :ansible_format, :with_nochange)
+    as_admin do
+      assert_equal latest_reports.count, 2
+    end
+  end
+end

data/webpack/fills.js

@@ -9,6 +9,12 @@ const fills = [
     component: props => <ReportsTab {...props} />,
     weight: 450,
   },
+  {
+    slot: '[puppet]-reports',
+    name: 'Reports',
+    component: props => <ReportsTab format="puppet" {...props} />,
+    weight: 450,
+  },
 ];
 
 export const registerFills = () => {

data/webpack/src/components/ReportsTab/StatusToggleGroup.js

@@ -0,0 +1,56 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import { ToggleGroup, ToggleGroupItem } from '@patternfly/react-core';
+import {
+  ExclamationCircleIcon,
+  SyncAltIcon,
+  CheckCircleIcon,
+} from '@patternfly/react-icons';
+import { translate as __ } from 'foremanReact/common/I18n';
+
+const StatusToggleGroup = ({ setSelected, selected }) => {
+  const onChange = (isSelected, { currentTarget: { id } }) =>
+    setSelected(prev => ({ ...prev, [id]: isSelected }));
+
+  return (
+    <ToggleGroup aria-label="Icon variant toggle group">
+      <ToggleGroupItem
+        icon={
+          <ExclamationCircleIcon color="var(--pf-global--palette--red-100)" />
+        }
+        text={__('Failed')}
+        aria-label="filter failed icon button"
+        buttonId="failed"
+        isSelected={selected.failed}
+        onChange={onChange}
+      />
+      <ToggleGroupItem
+        icon={<SyncAltIcon color="var(--pf-global--palette--orange-300)" />}
+        text={__('Changed')}
+        aria-label="filter changed icon button"
+        buttonId="changed"
+        isSelected={selected.changed}
+        onChange={onChange}
+      />
+      <ToggleGroupItem
+        icon={<CheckCircleIcon color="var(--pf-global--success-color--100)" />}
+        text={__('Unchanged')}
+        aria-label="filter unchanged icon button"
+        buttonId="unchanged"
+        isSelected={selected.unchanged}
+        onChange={onChange}
+      />
+    </ToggleGroup>
+  );
+};
+
+StatusToggleGroup.propTypes = {
+  setSelected: PropTypes.func.isRequired,
+  selected: PropTypes.object,
+};
+
+StatusToggleGroup.defaultProps = {
+  selected: { failed: false, changed: false, unchanged: false },
+};
+
+export default StatusToggleGroup;

data/webpack/src/components/ReportsTab/helpers.js

@@ -53,7 +53,7 @@ export const statusSummaryFormatter = ({ change, nochange, failure }) => {
 export const globalStatusFormatter = ({ status }) => {
   switch (status) {
     case 'failure':
-      return <FailedIcon label={__('Fail')} />;
+      return <FailedIcon label={__('Failed')} />;
     case 'change':
       return <ChangedIcon label={__('Changed')} />;
     case 'nochange':

data/webpack/src/components/ReportsTab/index.js

@@ -1,5 +1,5 @@
 /* eslint-disable camelcase */
-import React, { useEffect, useCallback } from 'react';
+import React, { useEffect, useCallback, useState } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import { useHistory } from 'react-router-dom';
 import PropTypes from 'prop-types';
@@ -7,7 +7,7 @@ import URI from 'urijs';
 import SearchBar from 'foremanReact/components/SearchBar';
 import Pagination from 'foremanReact/components/Pagination';
 import { get } from 'foremanReact/redux/API';
-import { Grid, GridItem } from '@patternfly/react-core';
+import { Divider, Grid, GridItem } from '@patternfly/react-core';
 import {
   selectAPIStatus,
   selectAPIResponse,
@@ -15,8 +15,9 @@ import {
 import { useForemanSettings } from 'foremanReact/Root/Context/ForemanContext';
 import { HOST_REPORTS_SEARCH_PROPS } from '../../Router/HostReports/IndexPage/constants';
 import ReportsTable from './ReportsTable';
+import StatusToggleGroup from './StatusToggleGroup';
 
-const ReportsTab = ({ hostName }) => {
+const ReportsTab = ({ hostName, format }) => {
   const dispatch = useDispatch();
   const history = useHistory();
   const API_KEY = `get-reports-${hostName}`;
@@ -25,6 +26,11 @@ const ReportsTab = ({ hostName }) => {
   );
   const { perPage: settingsPerPage = 20 } = useForemanSettings() || {};
   const status = useSelector(state => selectAPIStatus(state, API_KEY));
+  const [filters, setFilters] = useState({
+    failed: false,
+    changed: false,
+    unchanged: false,
+  });
   const fetchReports = useCallback(
     ({ search: searchParam, per_page: perPageParam, page: pageParam } = {}) => {
       const {
@@ -42,13 +48,13 @@ const ReportsTab = ({ hostName }) => {
           params: {
             page,
             per_page,
-            search: getServerQuery(search),
+            search: getServerQuery(search, filters),
           },
         })
       );
       updateUrl({ page, per_page, search });
     },
-    [API_KEY, dispatch, getServerQuery, getUrlParams, updateUrl]
+    [API_KEY, dispatch, getServerQuery, getUrlParams, updateUrl, filters]
   );
 
   useEffect(() => {
@@ -61,14 +67,24 @@ const ReportsTab = ({ hostName }) => {
   };
 
   const getServerQuery = useCallback(
-    search => {
+    (search, _filters) => {
       const serverQuery = [`host = ${hostName}`];
+      if (format) {
+        serverQuery.push(`format = ${format}`);
+      }
       if (search) {
-        serverQuery.push(`AND (${search})`);
+        serverQuery.push(`(${search})`);
       }
-      return serverQuery.join(' ').trim();
+
+      Object.keys(_filters).forEach(filter => {
+        if (_filters[filter]) {
+          serverQuery.push(`${filter} > 0`);
+        }
+      });
+
+      return serverQuery.join(' AND ');
     },
-    [hostName]
+    [format, hostName]
   );
 
   const getUrlParams = useCallback(() => {
@@ -94,13 +110,17 @@ const ReportsTab = ({ hostName }) => {
 
   return (
     <Grid id="new_host_details_insights_tab" hasGutter>
-      <GridItem span={6}>
+      <GridItem span={5}>
         <SearchBar
           data={HOST_REPORTS_SEARCH_PROPS}
           onSearch={search => fetchReports({ search, page: 1 })}
         />
       </GridItem>
-      <GridItem span={6}>
+      <GridItem span={4}>
+        <StatusToggleGroup setSelected={setFilters} selected={filters} />
+        <Divider isVertical />
+      </GridItem>
+      <GridItem span={3}>
         <Pagination
           variant="top"
           itemCount={itemCount}
@@ -127,6 +147,11 @@ const ReportsTab = ({ hostName }) => {
 
 ReportsTab.propTypes = {
   hostName: PropTypes.string.isRequired,
+  format: PropTypes.string,
+};
+
+ReportsTab.defaultProps = {
+  format: null,
 };
 
 export default ReportsTab;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_host_reports
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Lukas Zapletal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies: []
 description: Fast and efficient reporting capabilities
 email:
@@ -24,6 +24,7 @@ files:
 - app/controllers/concerns/foreman_host_reports/controller/parameters/host_report.rb
 - app/controllers/host_reports_controller.rb
 - app/helpers/concerns/foreman_host_reports/hosts_helper_extensions.rb
+- app/helpers/foreman_host_reports/reports_dashboard_helper.rb
 - app/models/concerns/foreman_host_reports/host_extensions.rb
 - app/models/concerns/foreman_host_reports/smart_proxy_extensions.rb
 - app/models/host_report.rb
@@ -34,6 +35,10 @@ files:
 - app/views/api/v2/host_reports/index.json.rabl
 - app/views/api/v2/host_reports/main.json.rabl
 - app/views/api/v2/host_reports/show.json.rabl
+- app/views/dashboard/_host_reports_status_chart_widget.html.erb
+- app/views/dashboard/_host_reports_status_links.html.erb
+- app/views/dashboard/_host_reports_status_widget.html.erb
+- app/views/dashboard/_host_reports_widget.html.erb
 - config/routes.rb
 - db/migrate/20210112183526_add_host_reports.rb
 - db/migrate/20210616133601_create_report_keywords.rb
@@ -44,6 +49,7 @@ files:
 - lib/foreman_host_reports/engine.rb
 - lib/foreman_host_reports/version.rb
 - lib/tasks/foreman_host_reports_tasks.rake
+- lib/tasks/migrate.rake
 - locale/Makefile
 - locale/en/foreman_host_reports.po
 - locale/foreman_host_reports.pot
@@ -54,6 +60,7 @@ files:
 - test/model/host_report_status_test.rb
 - test/snapshots/foreman-web.json
 - test/test_plugin_helper.rb
+- test/unit/dashboard_test.rb
 - test/unit/foreman_host_reports_test.rb
 - webpack/__mocks__/foremanReact/common/HOC.js
 - webpack/__mocks__/foremanReact/common/I18n.js
@@ -120,6 +127,7 @@ files:
 - webpack/src/Router/HostReports/constants.js
 - webpack/src/Router/routes.js
 - webpack/src/components/ReportsTab/ReportsTable.js
+- webpack/src/components/ReportsTab/StatusToggleGroup.js
 - webpack/src/components/ReportsTab/helpers.js
 - webpack/src/components/ReportsTab/index.js
 homepage: https://github.com/theforeman/foreman_host_reports
@@ -142,13 +150,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Foreman reporting engine
 test_files:
 - test/factories/foreman_host_reports_factories.rb
 - test/unit/foreman_host_reports_test.rb
+- test/unit/dashboard_test.rb
 - test/controllers/api/v2/host_reports_controller_test.rb
 - test/snapshots/foreman-web.json
 - test/model/host_report_status_test.rb