From 361861eebbcbb51e776b6b909954c51d3edf9345 Mon Sep 17 00:00:00 2001 From: Partha Aji Date: Thu, 12 Dec 2024 19:29:58 -0500 Subject: [PATCH] Foreman RH Cloud API Bindings to upload hits --- .../insights_advisor_controller.rb | 70 +++++++++++++++++++ app/models/concerns/rh_cloud_host.rb | 2 + config/routes.rb | 6 +- ...to_rule_id_and_host_id_in_insights_hits.rb | 5 ++ lib/foreman_hits/async/upload.rb | 50 +++++++++++++ 5 files changed, 132 insertions(+), 1 deletion(-) create mode 100644 app/controllers/api/v2/insights_advisor/insights_advisor_controller.rb create mode 100644 db/migrate/20241217190624_add_unique_index_to_rule_id_and_host_id_in_insights_hits.rb create mode 100644 lib/foreman_hits/async/upload.rb diff --git a/app/controllers/api/v2/insights_advisor/insights_advisor_controller.rb b/app/controllers/api/v2/insights_advisor/insights_advisor_controller.rb new file mode 100644 index 00000000..ba438df7 --- /dev/null +++ b/app/controllers/api/v2/insights_advisor/insights_advisor_controller.rb @@ -0,0 +1,70 @@ +module Api + module V2 + module InsightsAdvisor + class InsightsAdvisorController < ::Api::V2::BaseController + include ::Api::Version2 + + api :POST, "insights_advisor/upload_hits", N_("Upload from insights advisor") + param :host_name, String, required: true + param :host_uuid, String, required: true + + param :payload, Hash, :desc => N_("On prem payload including resolutions, rules, hits") do + param :resolutions, Array, :desc => N_("upload resolutions related to the hits") do + param :rule_id, String, :desc => N_("rule id"), :required => true + param :description, String, :desc => N_("resolution description") + param :needs_reboot, :bool, :desc => N_("need reboot") + param :resolution_risk, String, :desc => N_("resolution risk") + param :resolution_type, String, :desc => N_("type") + end + + param :rules, Array, :desc => N_("upload rules related to the hits") do + param :rule_id, String, :desc => N_("rule id"), :required => true + param :description, String, :desc => N_("rule description") + param :category_name, String, :desc => N_("category name") + param :impact_name, String, :desc => N_("impact name") + param :summary, String, :desc => N_("summary") + param :generic, String, :desc => N_("generic") + param :reason, String, :desc => N_("reason") + param :total_risk, :number, :desc => N_("total risk") + param :reboot_required, :bool, :desc => N_("reboot required") + param :more_info, String, :desc => N_("more info") + param :rating, :number, :desc => N_("rating") + end + + param :hits, Array, :desc => N_("upload hits information") do + param :rule_id, String, :desc => N_("rule id"), :required => true + param :title, String, :desc => N_("rule title") + param :solution_url, String, :desc => N_("solution url") + param :total_risk, :number, :desc => N_("total risk") + param :likelihood, :number, :desc => N_("likelihood number") + param :publish_date,String, :desc => N_("publish date (YYYY-MM-DD)") + param :results_url, String, :desc => N_("result url") + end + param :details, String, :desc => N_("upload hits details json") + end + def upload_hits + host = Host.find_by(name: params.require(:host_name)) + payload = payload_params.to_h + task = ForemanTasks.async_task(ForemanHits::Async::Upload, host, params.require(:host_uuid), payload) + + render json: { + task: task, + }, status: :ok + end + + def payload_params + params.require(:payload).permit( + { :resolutions => [:rule_id, :description, :needs_reboot, :resolution_risk, :resolution_type], + :rules => [:rule_id, :description, :category_name, :impact_name, :summary, + :generic, :reason, :total_risk, :reboot_required, :more_info, :rating, + ], + :hits => [:rule_id, :title, :solution_url, :total_risk, :likelihood, :publish_date, :results_url], + :details => {} + } + ) + end + end + end + end +end + diff --git a/app/models/concerns/rh_cloud_host.rb b/app/models/concerns/rh_cloud_host.rb index e776ae84..f90cbd46 100644 --- a/app/models/concerns/rh_cloud_host.rb +++ b/app/models/concerns/rh_cloud_host.rb @@ -21,5 +21,7 @@ module RhCloudHost scoped_search :relation => :inventory_sync_status_object, :on => :status, :rename => :insights_inventory_sync_status, :complete_value => { :disconnect => ::InventorySync::InventoryStatus::DISCONNECT, :sync => ::InventorySync::InventoryStatus::SYNC } + + scoped_search :relation => :insights, :on => :uuid, :only_explicit => true, :rename => :insights_uuid end end diff --git a/config/routes.rb b/config/routes.rb index 1c7aaa77..0777dc49 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -23,6 +23,7 @@ collection do get 'auto_complete_search' get 'resolutions', to: 'hits#resolutions' + post 'upload', to: 'hits#upload' end end match 'hits/:host_id', to: 'hits#show', via: :get @@ -60,9 +61,12 @@ end end + namespace 'insights_advisor' do + post 'upload_hits', to: 'insights_advisor#upload_hits' + end + namespace 'rh_cloud' do post 'enable_connector', to: 'inventory#enable_cloud_connector' - post 'cloud_request', to: 'cloud_request#update' end end diff --git a/db/migrate/20241217190624_add_unique_index_to_rule_id_and_host_id_in_insights_hits.rb b/db/migrate/20241217190624_add_unique_index_to_rule_id_and_host_id_in_insights_hits.rb new file mode 100644 index 00000000..74887690 --- /dev/null +++ b/db/migrate/20241217190624_add_unique_index_to_rule_id_and_host_id_in_insights_hits.rb @@ -0,0 +1,5 @@ +class AddUniqueIndexToRuleIdAndHostIdInInsightsHits < ActiveRecord::Migration[7.0] + def change + add_index :insights_hits, [:rule_id, :host_id], unique: true, name: 'index_insight_hits_on_rule_id_and_host_id' + end +end diff --git a/lib/foreman_hits/async/upload.rb b/lib/foreman_hits/async/upload.rb new file mode 100644 index 00000000..d3704eef --- /dev/null +++ b/lib/foreman_hits/async/upload.rb @@ -0,0 +1,50 @@ +module ForemanHits + module Async + class Upload < ::Actions::EntryAction + def plan(host, uuid, payload = {}) + plan_self(host_id: host.id, uuid: uuid, payload: payload) + end + + + def run + host = Host.find(input[:host_id]) + payload = input[:payload] + update_facets(host, input[:uuid]) + update_hits(host, payload) + update_rules_and_resolutions(payload) + update_details(host, payload) + end + + def update_facets(host, uuid) + InsightsFacet.find_or_create_by(host_id: host.id) do |facet| + facet.uuid = uuid + end + host.reload + end + def update_hits(host, payload) + facet = host.insights + facet.hits.delete_all + hits = payload[:hits] + facet.hits.insert_all(hits) + facet.update(hits_count: facet.hits.count) + end + + def update_rules_and_resolutions(payload) + ::InsightsRule.upsert_all(payload[:rules], unique_by: :rule_id) + rules = payload[:rules].map {|rule| rule[:rule_id]} + ::InsightsResolution.where(rule_id: rules).delete_all + ::InsightsResolution.insert_all(payload[:resolutions]) + end + + def update_details(host, payload) + fact_name = FactName.where(name: "insights::hit_details", short_name: 'insights_details').first_or_create + fact_value = host.fact_values.where(fact_name: fact_name).first_or_create + fact_value.update(value: payload[:details]) + end + + def rescue_strategy_for_self + Dynflow::Action::Rescue::Fail + end + end + end +end