foreman_host_reports 0.0.3

data/app/controllers/host_reports_controller.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class HostReportsController < ::ApplicationController
+  include Foreman::Controller::AutoCompleteSearch
+
+  def show
+    @host_report = resource_scope.find(params[:id])
+
+    return not_found unless @host_report
+
+    respond_to do |format|
+      format.html do
+        render '/react/index'
+      end
+      format.json do
+        render json: {
+          host_report: {
+            id: @host_report.id,
+            body: JSON.parse(@host_report.body),
+            format: @host_report.format,
+            host: {
+              id: @host_report.host.id,
+              name: @host_report.host.name,
+            },
+            proxy: {
+              id: @host_report.proxy&.id,
+              name: @host_report.proxy&.name,
+            },
+            reported_at: @host_report.reported_at,
+          },
+          permissions: {
+            can_delete: authorized_for(auth_object: @host_report, authorizer: authorizer, permission: "destroy_#{controller_permission}"),
+            can_view: authorized_for(auth_object: @host_report, authorizer: authorizer, permission: "view_#{controller_permission}"),
+          },
+        }, status: :ok
+      end
+    end
+  end
+
+  private
+
+  def resource_scope(options = {})
+    options[:permission] = :view_host_reports
+    super(options).my_reports
+  end
+end

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

@@ -0,0 +1,9 @@
+module ForemanHostReports
+  module HostExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :host_reports, foreign_key: :host_id, class_name: 'HostReport', inverse_of: :host, dependent: :destroy
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module ForemanHostReports
+  module SmartProxyExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :host_reports, foreign_key: :proxy_id, class_name: 'HostReport', inverse_of: :proxy, dependent: :destroy
+    end
+  end
+end

data/app/models/host_report.rb

@@ -0,0 +1,85 @@
+class HostReport < ApplicationRecord
+  include Authorizable
+  include ScopedSearchExtensions
+
+  delegate :logger, to: :Rails
+
+  validates_lengths_from_database
+  belongs_to_host
+  belongs_to :proxy, class_name: 'SmartProxy'
+  has_one :organization, through: :host
+  has_one :location, through: :host
+
+  validates :host_id, :reported_at, :status, presence: true
+
+  enum format: {
+    # plain text report (no processing)
+    plain: 0,
+    # standard report (status + logs in plain text)
+    puppet: 1,
+    ansible: 2,
+  }.freeze
+
+  STATUS = {
+    plain: %w[debug normal warning error],
+  }.freeze
+
+  scoped_search relation: :host, on: :name, complete_value: true, rename: :host, aliases: %i[host_name]
+  scoped_search relation: :proxy, on: :name, complete_value: true, rename: :proxy
+  scoped_search relation: :organization, on: :name, complete_value: true, rename: :organization
+  scoped_search relation: :location, on: :name, complete_value: true, rename: :location
+  scoped_search on: :reported_at, complete_value: true, default_order: :desc, rename: :reported, only_explicit: true, aliases: %i[last_report reported_at]
+  scoped_search on: :format, complete_value: { plain: 0, puppet: 1, ansible: 2 }
+  # This is to simulate has_many :report_keywords relation for scoped_search library to work
+  # NOTE: This won't work for any other purpose
+  reflections['report_keywords'] = ReportKeyword
+  scoped_search relation: :report_keywords, on: :name, complete_value: true, rename: :keyword, ext_method: :search_by_keyword, operators: ['=']
+
+  scope :recent, ->(*args) { where("reported_at > ?", (args.first || 1.day.ago)).order(:reported_at) }
+
+  scope :my_reports, lambda {
+    if !User.current.admin? || Organization.expand(Organization.current).present? || Location.expand(Location.current).present?
+      joins_authorized(Host, :view_hosts)
+    end
+  }
+
+  default_scope -> { order('reported_at DESC') }
+
+  # TODO: temporary until we decide what will status bitfiled be exactly
+  # rubocop:disable Style/RescueModifier
+  def status
+    @status ||= case format
+                when 'puppet'
+                  JSON.parse(body)['metrics']['resources']['values'] rescue []
+                when 'ansible'
+                  JSON.parse(body)['status'] rescue {}
+                else
+                  super
+                end
+  end
+  # rubocop:enable Style/RescueModifier
+
+  def report_keywords
+    ReportKeyword.where(id: report_keyword_ids)
+  end
+
+  def self.authorized_smart_proxy_features
+    @authorized_smart_proxy_features ||= %w[Puppet Ansible]
+  end
+
+  def self.register_smart_proxy_feature(feature)
+    @authorized_smart_proxy_features = (authorized_smart_proxy_features + [feature]).uniq
+  end
+
+  def self.unregister_smart_proxy_feature(feature)
+    @authorized_smart_proxy_features -= [feature]
+  end
+
+  def self.search_by_keyword(_key, operator, value)
+    conditions = sanitize_sql_for_conditions(["report_keywords.name #{operator} ?", value_to_sql(operator, value)])
+    keyword_ids = ReportKeyword.where(conditions).distinct.pluck(:id)
+    {
+      conditions: sanitize_sql_for_conditions(["host_reports.report_keyword_ids @> ?", "{#{keyword_ids.join(',')}}"]),
+    }
+  end
+end

data/app/models/report_keyword.rb

@@ -0,0 +1,11 @@
+class ReportKeyword < ApplicationRecord
+  def host_reports
+    HostReport.where("report_keyword_ids @> ?", "{#{id}}")
+  end
+
+  # This is to simulate has_many :report_keywords relation for scoped_search library to work
+  # NOTE: This won't work for any other purpose
+  def self.klass
+    self
+  end
+end

data/app/views/api/v2/host_reports/base.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @host_report
+
+attributes :id

data/app/views/api/v2/host_reports/create.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @host_report
+
+extends 'api/v2/host_reports/show'

data/app/views/api/v2/host_reports/index.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+collection @host_reports
+
+extends 'api/v2/host_reports/main'

data/app/views/api/v2/host_reports/main.json.rabl

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+object @host_report
+
+extends 'api/v2/host_reports/base'
+extends 'api/v2/layouts/permissions'
+
+attributes :format, :host_id, :proxy_id, :reported_at, :status
+
+node(:host_name) do |report|
+  report.host.name
+end
+node(:proxy_name) do |report|
+  report.proxy&.name
+end

data/app/views/api/v2/host_reports/show.json.rabl

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+object @host_report
+
+extends 'api/v2/host_reports/main'
+
+attributes :body
+
+node :keywords do |report|
+  report.report_keywords.map(&:name)
+end

data/config/routes.rb

@@ -0,0 +1,33 @@
+Rails.application.routes.draw do
+  match '/host_reports' => 'react#index', via: :get
+
+  resources :hosts do
+    member do
+      match 'host_reports', to: 'react#index', via: :get
+    end
+  end
+
+  resources :host_reports, only: %i[show] 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
+      resources :host_reports, only: %i[index show create destroy] do
+        collection do
+          get 'export'
+        end
+      end
+      constraints(id: %r{[^/]+}) do
+        resources :hosts, only: [] do
+          constraints(host_id: %r{[^/]+}) do
+            resources :host_reports, only: %i[index]
+          end
+        end
+      end
+    end
+  end
+end

data/db/migrate/20210112183526_add_host_reports.rb

@@ -0,0 +1,36 @@
+# rubocop:disable Rails/CreateTableWithTimestamps
+class AddHostReports < ActiveRecord::Migration[6.0]
+  def change
+    create_table :host_reports do |t|
+      # Host reference, b-tree index.
+      t.integer "host_id", null: false
+
+      # Smart proxy which processed and uploaded, no index.
+      t.integer "proxy_id"
+
+      # Explicit timestamp, replaces Rails timestamps, b-tree descending index.
+      t.datetime "reported_at", null: false
+
+      # Use StatusCalculator to store arbitrary amount of counters in this
+      # bit array (e.g. info, debug, error, fatal messages). Each report
+      # implementation decides how to use this bitfield. No index.
+      t.bigint "status"
+
+      # Report contents, usually in JSON format depending on implementation.
+      # Text field is by default compressed and not searchable, use
+      # ReportKeyword model for searching. Other formats like JSON/JSONB were
+      # considered but this appears to be the fastest option. No index.
+      t.text "body"
+
+      # Report type "enum", integer is faster and smaller than varchar.
+      # No index since cardinality is very low (1-3 effectively)
+      t.integer "format", default: 0, null: false
+
+      # Indices. Keep it at the bare minimum, this model should be optimized
+      # for updates not for reads.
+      t.index "host_id"
+      t.index "reported_at", order: { reported_at: :desc }
+    end
+  end
+end
+# rubocop:enable Rails/CreateTableWithTimestamps

data/db/migrate/20210616133601_create_report_keywords.rb

@@ -0,0 +1,12 @@
+# rubocop:disable Rails/CreateTableWithTimestamps
+class CreateReportKeywords < ActiveRecord::Migration[6.0]
+  def change
+    create_table :report_keywords do |t|
+      t.string :name, null: false, index: { unique: true }
+    end
+
+    add_column :host_reports, :report_keyword_ids, :integer, array: true, default: []
+    add_index :host_reports, :report_keyword_ids, using: 'gin'
+  end
+end
+# rubocop:enable Rails/CreateTableWithTimestamps

data/lib/foreman_host_reports/engine.rb

@@ -0,0 +1,68 @@
+module ForemanHostReports
+  class Engine < ::Rails::Engine
+    isolate_namespace ForemanHostReports
+    engine_name 'foreman_host_reports'
+
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/overrides"]
+    config.autoload_paths += Dir["#{config.root}/lib"]
+
+    # Add any db migrations
+    initializer 'foreman_host_reports.load_app_instance_data' do |app|
+      ForemanHostReports::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
+    end
+
+    initializer 'foreman_host_reports.register_plugin', :before => :finisher_hook do |_app|
+      Foreman::Plugin.register :foreman_host_reports do
+        requires_foreman '>= 3.0.0'
+
+        apipie_documented_controllers ["#{ForemanHostReports::Engine.root}/app/controllers/api/v2/*.rb"]
+        # Add Global files for extending foreman-core components and routes
+        register_global_js_file 'global'
+
+        # Add permissions
+        security_block :foreman_host_reports do
+          permission :view_host_reports, { host_reports: %i[index show auto_complete_search],
+                                           'api/v2/host_reports': %i[index show export] }, resource_type: 'HostReport'
+          permission :create_host_reports, { 'api/v2/host_reports': [:create] }, resource_type: 'HostReport'
+          permission :destroy_host_reports, { 'api/v2/host_reports': [:destroy] }, resource_type: 'HostReport'
+        end
+
+        role 'Host reports manager', %i[view_host_reports create_host_reports destroy_host_reports]
+
+        # add menu entry
+        menu :top_menu, :host_reports, url: '/host_reports',
+                                       url_hash: { controller: :host_reports, action: :index },
+                                       caption: N_('Host Reports'),
+                                       parent: :monitor_menu,
+                                       before: :reports
+      end
+    end
+
+    # Include concerns in this config.to_prepare block
+    # rubocop:disable Style/RescueStandardError
+    config.to_prepare do
+      Host::Managed.include ForemanHostReports::HostExtensions
+      SmartProxy.include ForemanHostReports::HostExtensions
+    rescue => e
+      Rails.logger.warn "ForemanHostReports: skipping engine hook (#{e})"
+    end
+    # rubocop:enable Style/RescueStandardError
+
+    rake_tasks do
+      Rake::Task['db:seed'].enhance do
+        ForemanHostReports::Engine.load_seed
+      end
+    end
+
+    initializer 'foreman_host_reports.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
+      locale_domain = 'foreman_host_reports'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
+    end
+  end
+end

data/lib/foreman_host_reports/version.rb

@@ -0,0 +1,3 @@
+module ForemanHostReports
+  VERSION = '0.0.3'.freeze
+end

data/lib/foreman_host_reports.rb

@@ -0,0 +1,4 @@
+require 'foreman_host_reports/engine'
+
+module ForemanHostReports
+end

data/lib/tasks/foreman_host_reports_tasks.rake

@@ -0,0 +1,50 @@
+require 'rake/testtask'
+
+# Tasks
+namespace :foreman_host_reports do
+  namespace :example do
+    desc 'Example Task'
+    task task: :environment do
+      # Task goes here
+    end
+  end
+end
+
+# Tests
+namespace :test do
+  desc 'Test ForemanHostReports'
+  Rake::TestTask.new(:foreman_host_reports) do |t|
+    test_dir = File.expand_path('../../test', __dir__)
+    t.libs << 'test'
+    t.libs << test_dir
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_host_reports do
+  # rubocop:disable Rails/RakeEnvironment, Style/RescueStandardError
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_host_reports) do |task|
+        task.patterns = ["#{ForemanHostReports::Engine.root}/app/**/*.rb",
+                         "#{ForemanHostReports::Engine.root}/lib/**/*.rb",
+                         "#{ForemanHostReports::Engine.root}/test/**/*.rb"]
+      end
+    rescue
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_host_reports'].invoke
+  end
+  # rubocop:enable Rails/RakeEnvironment, Style/RescueStandardError
+end
+
+Rake::Task[:test].enhance ['test:foreman_host_reports']
+
+load 'tasks/jenkins.rake'
+if Rake::Task.task_defined?(:'jenkins:unit')
+  Rake::Task['jenkins:unit'].enhance ['test:foreman_host_reports', 'foreman_host_reports:rubocop']
+end

data/locale/Makefile

@@ -0,0 +1,60 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = foreman_host_reports
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+%.edit.po:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_host_reports.po

@@ -0,0 +1,19 @@
+# foreman_host_reports
+#
+# This file is distributed under the same license as foreman_host_reports.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+

data/locale/foreman_host_reports.pot

@@ -0,0 +1,19 @@
+# foreman_host_reports
+#
+# This file is distributed under the same license as foreman_host_reports.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,2 @@
+# Matches foreman_host_reports.gemspec
+_('TODO: Description of ForemanPluginTemplate.')

data/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "foreman_host_reports",
+  "version": "1.0.0",
+  "description": "Foreman plugin providing reporting feature optimized for high-performance.",
+  "main": "index.js",
+  "scripts": {
+    "lint": "tfm-lint --plugin -d /webpack",
+    "test": "tfm-test --config jest.config.js",
+    "test:watch": "tfm-test --plugin --watchAll",
+    "test:current": "tfm-test --plugin --watch",
+    "publish-coverage": "tfm-publish-coverage",
+    "stories": "tfm-stories --plugin",
+    "stories:build": "tfm-build-stories --plugin",
+    "create-react-component": "yo react-domain"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theforeman/foreman_host_reports.git"
+  },
+  "bugs": {
+    "url": "http://projects.theforeman.org/projects/foreman_host_reports/issues"
+  },
+  "peerDependencies": {
+    "@theforeman/vendor": ">= 6.0.0"
+  },
+  "dependencies": {
+    "react-intl": "^2.8.0",
+    "react-json-tree": "^0.11.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.7.0",
+    "@sheerun/mutationobserver-shim": "^0.3.3",
+    "@theforeman/builder": "^8.4.1",
+    "@theforeman/eslint-plugin-foreman": "8.4.1",
+    "@theforeman/find-foreman": "^8.4.1",
+    "@theforeman/stories": "^8.4.1",
+    "@theforeman/test": "^8.4.1",
+    "@theforeman/vendor-dev": "^8.4.1",
+    "babel-eslint": "^10.0.3",
+    "eslint": "^6.7.2",
+    "prettier": "^1.19.1",
+    "stylelint-config-standard": "^18.0.0",
+    "stylelint": "^9.3.0"
+  }
+}