foreman_host_reports 0.0.4 → 1.0.0

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

@@ -1,20 +1,22 @@
 require 'test_plugin_helper'
 
 class Api::V2::HostReportsControllerTest < ActionController::TestCase
+  let :host_report do
+    as_admin do
+      FactoryBot.create(:host_report)
+    end
+  end
+  let :report_body do
+    read_report('foreman-web.json', URI.parse(host_report.proxy.url).host)
+  end
   setup do
-    @proxy = FactoryBot.create(:smart_proxy,
-      url: "http://reports.foreman.example.com",
-      features: [FactoryBot.create(:feature, name: 'Reports')])
-    Resolv.any_instance.stubs(:getnames).returns([URI.parse(@proxy.url).host])
-    SmartProxy.any_instance.stubs(:with_features).returns([@proxy])
+    Resolv.any_instance.stubs(:getnames).returns([URI.parse(host_report.proxy.url).host])
+    SmartProxy.any_instance.stubs(:with_features).returns([host_report.proxy])
+    SmartProxy.any_instance.stubs(:find_by).returns([host_report.proxy])
     ProxyAPI::V2::Features.any_instance.stubs(:features).returns({ "reports" => { "state" => "running" } })
   end
 
   context 'when user does not have permission to view hosts' do
-    let :host_report do
-      as_admin { FactoryBot.create(:host_report) }
-    end
-
     setup { setup_user('view', 'host_reports') }
 
     test 'cannot view any reports' do
@@ -34,10 +36,6 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
       User.current = users(:one) # use an unprivileged user, not apiadmin
     end
 
-    def report_body
-      @report_body ||= read_report('foreman-web.json')
-    end
-
     let :host do
       as_admin { FactoryBot.create(:host) }
     end
@@ -47,7 +45,7 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
       post :create, params: {
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }, session: set_session_user
       assert_response :success
@@ -65,15 +63,14 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
           keywords: %w[HasError HasFailedResource],
-          applied: 5, failed: 1, pending: 1, other: 6
+          change: 1, nochange: 2, failure: 3
         },
       }, session: set_session_user
       report = ActiveSupport::JSON.decode(@response.body)
       assert_response :created
-      assert_equal 5, report['applied']
-      assert_equal 1, report['failed']
-      assert_equal 1, report['pending']
-      assert_equal 6, report['other']
+      assert_equal 1, report['change']
+      assert_equal 2, report['nochange']
+      assert_equal 3, report['failure']
     end
 
     test 'assign keywords' do
@@ -82,7 +79,7 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
           keywords: %w[HasError HasFailedResource],
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }, session: set_session_user
       report = ActiveSupport::JSON.decode(@response.body)
@@ -97,7 +94,7 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
           host_report: {
             host: host.name, body: report_body, reported_at: Time.current,
             keywords: %w[HasError HasFailedResource],
-            applied: 5, failed: 1, pending: 1, other: 0
+            change: 1, nochange: 2, failure: 3
           },
         }, session: set_session_user
 
@@ -105,7 +102,7 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
           host_report: {
             host: host.name, body: report_body, reported_at: Time.current,
             keywords: %w[HasError HasFailedResource],
-            applied: 5, failed: 1, pending: 1, other: 0
+            change: 1, nochange: 2, failure: 3
           },
         }, session: set_session_user
       end
@@ -119,52 +116,23 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
       post :create, params: {
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }
       assert_nil @controller.detected_proxy
       assert_response :created
     end
 
-    test 'hosts with a registered smart proxy on should create a report successfully' do
-      Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_smart_proxies] = false
-
-      post :create, params: {
-        host_report: {
-          host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
-        },
-      }
-      assert_equal @proxy, @controller.detected_proxy
-      assert_response :created
-    end
-
-    test 'hosts without a registered smart proxy on should not be able to create a report' do
-      Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_smart_proxies] = false
-
-      Resolv.any_instance.stubs(:getnames).returns(['another.host'])
-      post :create, params: {
-        host_report: {
-          host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
-        },
-      }
-      assert_response :forbidden
-    end
-
     test 'hosts with a registered smart proxy and SSL cert should create a report successfully' do
       Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_smart_proxies] = true
 
       @request.env['HTTPS'] = 'on'
-      @request.env['SSL_CLIENT_S_DN'] = 'CN=reports.foreman.example.com'
+      @request.env['SSL_CLIENT_S_DN'] = "CN=#{URI.parse(host_report.proxy.url).host}"
       @request.env['SSL_CLIENT_VERIFY'] = 'SUCCESS'
       post :create, params: {
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }
       assert_response :created
@@ -172,15 +140,14 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
 
     test 'hosts without a registered smart proxy but with an SSL cert should not be able to create a report' do
       Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_smart_proxies] = true
 
       @request.env['HTTPS'] = 'on'
-      @request.env['SSL_CLIENT_S_DN'] = 'CN=another.host'
+      @request.env['SSL_CLIENT_S_DN'] = "CN=else.where"
       @request.env['SSL_CLIENT_VERIFY'] = 'SUCCESS'
       post :create, params: {
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }
       assert_response :forbidden
@@ -188,7 +155,6 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
 
     test 'hosts with an unverified SSL cert should not be able to create a report' do
       Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_smart_proxies] = true
 
       @request.env['HTTPS'] = 'on'
       @request.env['SSL_CLIENT_S_DN'] = 'CN=else.where'
@@ -196,37 +162,34 @@ class Api::V2::HostReportsControllerTest < ActionController::TestCase
       post :create, params: {
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }
       assert_response :forbidden
     end
 
-    test 'when "require_ssl_smart_proxies" and "require_ssl" are true, HTTP requests should not be able to create a report' do
+    test 'when "require_ssl" is true, HTTP requests should not be able to create a report' do
       Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_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,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }
-      assert_response :forbidden
+      assert_response :redirect
     end
 
-    test 'when "require_ssl_smart_proxies" is true and "require_ssl" is false, HTTP requests should be able to create reports' do
-      # since require_ssl_smart_proxies is only applicable to HTTPS connections, both should be set
+    test 'when "require_ssl" is false, HTTP requests should be able to create reports' do
       Setting[:restrict_registered_smart_proxies] = true
-      Setting[:require_ssl_smart_proxies] = true
       SETTINGS[:require_ssl] = false
 
       post :create, params: {
         host_report: {
           host: host.name, body: report_body, reported_at: Time.current,
-          applied: 5, failed: 1, pending: 1, other: 0
+          change: 1, nochange: 2, failure: 3
         },
       }
       assert_response :created

data/test/factories/foreman_host_reports_factories.rb

@@ -1,12 +1,20 @@
 FactoryBot.define do
   factory :host_report do
     host
+    sequence(:proxy) { |n| FactoryBot.create(:smart_proxy, url: "http://proxy#{n}.example.com", features: [FactoryBot.create(:feature, name: 'Reports')]) }
     reported_at { Time.now.utc }
-    applied { 0 }
-    failed { 0 }
-    pending { 0 }
-    other { 0 }
-    body { 'report data' }
+    change { 0 }
+    nochange { 0 }
+    failure { 0 }
+    body { '{}' }
+  end
+
+  trait :puppet_format do
+    format { 'puppet' }
+  end
+
+  trait :ansible_format do
+    format { 'ansible' }
   end
 
   trait :with_keyword do

data/test/model/host_report_status_test.rb

@@ -0,0 +1,204 @@
+require 'test_helper'
+
+class HostReportStatusTest < ActiveSupport::TestCase
+  let(:report) { FactoryBot.create(:host_report) }
+  let(:host) { report.host }
+  let(:status) { HostStatus::HostReportStatus.new(host: host).tap(&:refresh) }
+
+  test 'is valid' do
+    assert_valid status
+  end
+
+  test 'last_report defaults to hosts last if nothing was set yet' do
+    assert_equal report, status.last_report
+  end
+
+  test '#last_report returns custom value that was set using writer method' do
+    status.last_report = :something
+    assert_equal :something, status.last_report
+  end
+
+  test '#last_report returns custom value that was set using writer method even for nil' do
+    status.last_report = nil
+    assert_nil status.last_report
+  end
+
+  describe "host with no reports" do
+    let(:host) { FactoryBot.create(:host) }
+
+    test '#no_reports? results in warning only if puppet reports are expected' do
+      refute host.last_report
+
+      status.stubs(:error? => false)
+      status.stubs(:out_of_sync? => false)
+      status.stubs(:no_reports? => true)
+      assert_equal HostStatus::Global::OK, status.to_global
+
+      host.expects(:configuration? => true)
+      assert_equal HostStatus::Global::WARN, status.to_global
+
+      host.expects(:configuration? => false)
+      Setting[:always_show_configuration_status] = true
+      assert_equal HostStatus::Global::WARN, status.to_global
+    end
+  end
+
+  test 'status is disabled when reporting is disabled' do
+    host.enabled = false
+    assert_equal HostStatus::HostReportStatus::UNKNOWN, status.refresh
+  end
+
+  test '#out_of_sync? is false when reported_at is unknown' do
+    status.reported_at = nil
+    refute status.out_of_sync?
+  end
+
+  test '#out_of_sync? is false when window is big enough' do
+    original = Setting[:outofsync_interval]
+    Setting[:outofsync_interval] = (Time.now.utc - report.reported_at).to_i / 60 + 1
+    refute status.out_of_sync?
+    Setting[:outofsync_interval] = original
+  end
+
+  describe '#out_of_sync?' do
+    let(:report) { FactoryBot.create(:host_report, reported_at: Time.now.utc - 1.year) }
+
+    test '#out_of_sync? is false when out of sync is disabled' do
+      status.stubs(:out_of_sync_disabled?).returns(true)
+      refute status.out_of_sync?
+    end
+
+    context 'with last report format' do
+      setup do
+        status.last_report.stubs(:format).returns('Test')
+      end
+
+      test 'is false when formats out of sync is disabled' do
+        stub_outofsync_setting(true)
+        refute status.out_of_sync?
+      end
+
+      test "is true when formats out of sync isn't disbled and it is ouf of sync" do
+        stub_outofsync_setting(false)
+        status.reported_at = '2015-01-01 00:00:00'
+        status.save
+        assert status.out_of_sync?
+      end
+
+      def stub_outofsync_setting(value)
+        Foreman.settings._add('test_out_of_sync_disabled',
+          context: :test,
+          type: :boolean,
+          category: 'Setting',
+          full_name: 'Test out of sync',
+          description: 'description',
+          default: false)
+        Setting[:test_out_of_sync_disabled] = value
+      end
+    end
+  end
+
+  test '#refresh! refreshes the date and persists the record' do
+    status.expects(:refresh)
+    status.refresh!
+
+    assert status.persisted?
+  end
+
+  test '#refresh updates date to reported_at of last report' do
+    status.reported_at = nil
+    status.refresh
+
+    assert_equal report&.reported_at&.to_i, status&.reported_at&.to_i
+  end
+
+  test '#relevant? only for hosts with #configuration? true, or a last report, or setting enabled' do
+    host.expects(:configuration?).returns(true)
+    assert status.relevant?
+
+    host.expects(:configuration?).returns(false)
+    status.expects(:last_report).returns(mock)
+    assert status.relevant?
+
+    host.expects(:configuration?).returns(false)
+    status.expects(:last_report).returns(nil)
+    refute status.relevant?
+
+    host.expects(:configuration?).returns(false)
+    status.expects(:last_report).returns(nil)
+    Setting[:always_show_configuration_status] = true
+    assert status.relevant?
+  end
+
+  describe "host with puppet report" do
+    let(:report) { FactoryBot.create(:host_report, :puppet_format) }
+
+    test 'overwrite puppet_interval as host parameter' do
+      if defined? ForemanPuppet
+        Setting['puppet_interval'] = 25
+      end
+      Setting['outofsync_interval'] = 25
+      status.reported_at = Time.now.utc - 30.minutes
+      assert status.out_of_sync?
+      host.params['puppet_interval'] = 35
+      refute status.out_of_sync?
+    end
+  end
+
+  describe "host with applied changes" do
+    let(:report) { FactoryBot.create(:host_report, nochange: 0, change: 10, failure: 0) }
+
+    test 'is found via host scoped search' do
+      status.save
+      assert_equal [host], Host.search_for('report_changes > 0')
+      assert_empty Host.search_for('report_changes < 0')
+      assert_empty Host.search_for('report_changes = 0')
+    end
+
+    test 'is found via host report scoped search' do
+      status.save
+      assert_equal [report], HostReport.search_for('changes > 0')
+      assert_equal [report], HostReport.search_for('changed > 0')
+      assert_empty HostReport.search_for('changes < 0')
+      assert_empty HostReport.search_for('changed = 0')
+    end
+  end
+
+  describe "host with failures" do
+    let(:report) { FactoryBot.create(:host_report, nochange: 0, change: 0, failure: 10) }
+
+    test 'is found via host scoped search' do
+      status.save
+      assert_equal [host], Host.search_for('report_failures > 0')
+      assert_empty Host.search_for('report_failures < 0')
+      assert_empty Host.search_for('report_failures = 0')
+    end
+
+    test 'is found via host report scoped search' do
+      status.save
+      assert_equal [report], HostReport.search_for('failures > 0')
+      assert_equal [report], HostReport.search_for('failed > 0')
+      assert_empty HostReport.search_for('failures < 0')
+      assert_empty HostReport.search_for('failed = 0')
+    end
+  end
+
+  describe "host with no changes" do
+    let(:report) { FactoryBot.create(:host_report, nochange: 10, change: 0, failure: 0) }
+
+    test 'is found via host scoped search' do
+      status.save
+      assert_equal [host], Host.search_for('report_nochanges > 0')
+      assert_empty Host.search_for('report_nochanges < 0')
+      assert_empty Host.search_for('report_nochanges = 0')
+    end
+
+    test 'is found via host report scoped search' do
+      status.save
+      assert_equal [report], HostReport.search_for('unchanged > 0')
+      assert_equal [report], HostReport.search_for('nochanges > 0')
+      assert_empty HostReport.search_for('unchanged < 0')
+      assert_empty HostReport.search_for('nochanges = 0')
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -5,7 +5,9 @@ require 'test_helper'
 FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
 FactoryBot.reload
 
-def read_report(file)
+def read_report(file, override_proxy = "localhost")
   json = File.expand_path(File.join('..', 'snapshots', file), __FILE__)
-  File.read(json)
+  json = JSON.parse(File.read(json))
+  json["proxy"] = override_proxy
+  json.to_s
 end

data/webpack/__mocks__/foremanReact/components/Pagination/index.js

@@ -0,0 +1,2 @@
+const Pagination = () => jest.fn();
+export default Pagination;

data/webpack/fills.js

@@ -0,0 +1,23 @@
+import React from 'react';
+import { addGlobalFill } from 'foremanReact/components/common/Fill/GlobalFill';
+import ReportsTab from './src/components/ReportsTab';
+
+const fills = [
+  {
+    slot: 'host-details-page-tabs',
+    name: 'Reports',
+    component: props => <ReportsTab {...props} />,
+    weight: 450,
+  },
+];
+
+export const registerFills = () => {
+  fills.forEach(({ slot, name, component: Component, weight }, index) =>
+    addGlobalFill(
+      slot,
+      name,
+      <Component key={`host-reports-fill-${index}`} />,
+      weight
+    )
+  );
+};

data/webpack/global_index.js

@@ -1,4 +1,6 @@
 import { registerRoutes } from 'foremanReact/routes/RoutingService';
+import { registerFills } from './fills';
 import ForemanHostReportsRoutes from './src/Router/routes';
 
 registerRoutes('foreman_host_reports', ForemanHostReportsRoutes);
+registerFills();

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/Formatters/statusFormatter.js

@@ -4,10 +4,9 @@ import StatusCell from '../StatusCell';
 
 const statusFormatter = () => (_, { rowData }) => {
   const statuses = {
-    applied: rowData.applied,
-    failed: rowData.failed,
-    pending: rowData.pending,
-    other: rowData.other,
+    change: rowData.change,
+    nochange: rowData.nochange,
+    failure: rowData.failure,
   };
   return <StatusCell statuses={statuses} />;
 };

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/Components/StatusCell.js

@@ -10,7 +10,7 @@ const StatusCell = ({ statuses }) => (
       {Object.keys(statuses).map(status => {
         let style = '';
         switch (status) {
-          case 'failed':
+          case 'failure':
             style = 'label-danger';
             break;
           default:

data/webpack/src/Router/HostReports/IndexPage/Components/HostReportsTable/HostReportsTable.js

@@ -2,7 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 
 import { Table } from 'foremanReact/components/common/table';
-import Pagination from 'foremanReact/components/Pagination/PaginationWrapper';
+import Pagination from 'foremanReact/components/Pagination';
 import DefaultEmptyState from 'foremanReact/components/common/EmptyState';
 import { translate as __ } from 'foremanReact/common/I18n';
 
@@ -18,7 +18,6 @@ const HostReportsTable = ({
   pagination,
   toDelete,
   onDeleteClick,
-  reloadWithSearch,
   hostId,
 }) => {
   const onDeleteSuccess = () => {
@@ -54,13 +53,7 @@ const HostReportsTable = ({
     <React.Fragment>
       <HostReportDeleteModal toDelete={toDelete} onSuccess={onDeleteSuccess} />
       {body}
-      <Pagination
-        viewType="list"
-        itemCount={itemCount}
-        pagination={pagination}
-        onChange={fetchAndPush}
-        dropdownButtonId="host-reports-page-pagination-dropdown"
-      />
+      <Pagination itemCount={itemCount} onChange={fetchAndPush} />
     </React.Fragment>
   );
 };
@@ -73,7 +66,6 @@ HostReportsTable.propTypes = {
   sort: PropTypes.object,
   pagination: PropTypes.object.isRequired,
   toDelete: PropTypes.object.isRequired,
-  reloadWithSearch: PropTypes.func.isRequired,
   hostId: PropTypes.string,
 };
 

data/webpack/src/Router/HostReports/IndexPage/IndexPage.js

@@ -56,7 +56,6 @@ const HostReportsIndexPage = ({
         sort={sort}
         toDelete={toDelete}
         setToDelete={setToDelete}
-        reloadWithSearch={reloadWithSearch}
         hostId={hostId}
       />
     </PageLayout>

data/webpack/src/Router/HostReports/IndexPage/IndexPageActions.js

@@ -11,7 +11,7 @@ import {
 
 export const initializeHostReports = () => dispatch => {
   const params = getParams();
-  dispatch(fetchHostReports(params));
+  dispatch(fetchHostReports({ per_page: params.perPage, ...params }));
   if (!history.action === 'POP') {
     history.replace({
       pathname: HOST_REPORTS_PATH,
@@ -21,7 +21,8 @@ export const initializeHostReports = () => dispatch => {
 };
 
 export const fetchHostReports = (
-  { page, perPage, searchQuery, sort },
+  /* eslint-disable-next-line camelcase */
+  { page, per_page, searchQuery, sort },
   url = HOST_REPORTS_API_PATH
 ) => async dispatch => {
   const sortString =
@@ -33,7 +34,7 @@ export const fetchHostReports = (
       url,
       params: {
         page,
-        per_page: perPage,
+        per_page,
         search: searchQuery,
         order: sortString,
       },
@@ -46,7 +47,7 @@ export const fetchAndPush = (params = {}) => (dispatch, getState) => {
   dispatch(fetchHostReports(query));
   history.push({
     pathname: HOST_REPORTS_PATH,
-    search: stringifyParams(query),
+    search: stringifyParams({ perPage: query.per_page, ...query }),
   });
 };
 

data/webpack/src/Router/HostReports/IndexPage/IndexPageHelpers.js

@@ -18,7 +18,7 @@ export const buildQuery = (query, state) => {
 
   return {
     page: query.page || selectPage(state),
-    perPage: query.perPage || selectPerPage(state),
+    per_page: query.per_page || selectPerPage(state),
     searchQuery:
       query.searchQuery === undefined ? selectSearch(state) : query.searchQuery,
     ...(querySort && { sort: querySort }),

data/webpack/src/Router/HostReports/IndexPage/__tests__/HostReportsIndexPage.test.js

@@ -25,10 +25,9 @@ const fixtures = {
         proxyName: 'foreman.example.com',
         format: 'plain',
         reportedAt: '2021-01-19T12:34:02.841645028Z',
-        applied: 0,
-        failed: 0,
-        pending: 0,
-        other: 0,
+        change: 0,
+        nochange: 0,
+        failure: 0,
       },
     ],
   },

data/webpack/src/Router/HostReports/IndexPage/__tests__/__snapshots__/HostReportsIndexPage.test.js.snap

@@ -11,7 +11,7 @@ exports[`HostReportsIndexPage redering render with minimal props 1`] = `
       "autocomplete": Object {
         "id": "searchBar",
         "searchQuery": "",
-        "url": "host_reports/auto_complete_search",
+        "url": "/host_reports/auto_complete_search",
         "useKeyShortcuts": true,
       },
       "bookmarks": Object {
@@ -41,18 +41,16 @@ exports[`HostReportsIndexPage redering render with minimal props 1`] = `
         "perPage": 20,
       }
     }
-    reloadWithSearch={[MockFunction]}
     results={
       Array [
         Object {
-          "applied": 0,
-          "failed": 0,
+          "change": 0,
+          "failure": 0,
           "format": "plain",
           "hostId": "1",
           "hostName": "foreman.example.com",
           "id": "1",
-          "other": 0,
-          "pending": 0,
+          "nochange": 0,
           "proxyId": "1",
           "proxyName": "foreman.example.com",
           "reportedAt": "2021-01-19T12:34:02.841645028Z",