foreman_rh_cloud 1.0.7 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf631b63f0110a4a5d39aa664905fef695e8b402d458fe20704db84880bdf33f
-  data.tar.gz: ac49f7073bf0e2828964587434f84275029ca0aef285f963d00ddc7e569b8197
+  metadata.gz: d2b83d27b99fc0f9f0a7b522230231712da3f1e96560b46e47db9d492640bb7c
+  data.tar.gz: 8ba8a7d0d5c08b73c313edf7f384015a98ed84e293d6f56e171d426d6f5b079e
 SHA512:
-  metadata.gz: 9d9015a4931ab563c5d56cc38c1ea9ba54df04ebf9305f4077d5b88284b84b78da02f9dfed267192a8ce7ed49e98bf4b89e884eda8eae08a68fe8699771a9f69
-  data.tar.gz: 45a135ff52da1cedacb37b84a70b3f73347d741e62beb95a96e0fed7cf022928649ca470b6d9242c9bfe55b790e28f2fb734f76fa0524f6548351fcc81d7b580
+  metadata.gz: 4115f3514b17c89258d375fdd2d14cf6919e915c1520741e2d23e4e4459652124b686493511d43c04e4f0a492e8223ee1f1333f1d52f5288fc7e76621d27ddc6
+  data.tar.gz: d11b69c3becd476ae2a914f8101bdf6c82904a9af0242571a8755dee930d27b264ea153d2e3f24cfb5d07826728e9dfe955a582a9ed6c1de6977d69143f137ae

data/README.md

@@ -11,6 +11,39 @@ for how to install Foreman plugins
 
 *Usage here*
 
+### In Satellite
+
+#### Inventory upload
+
+In UI: Configure -> Inventory Upload -> Restart
+
+From command-line:
+
+    export organization_id=1
+    export target=/var/lib/foreman/red_hat_inventory/generated_reports/
+    /usr/sbin/foreman-rake rh_cloud_inventory:report:generate
+
+#### Fetch hosts remediation data
+
+In UI: Configure -> Insights -> Sync now
+
+From command-line:
+
+    /usr/sbin/foreman-rake rh_cloud_inventory:sync
+
+#### Synchronize inventory status
+
+In UI: Configure -> Inventory Upload -> Sync inventory status
+
+From command-line:
+
+    # all organizations
+    /usr/sbin/foreman-rake rh_cloud_insights:sync
+    
+    # specific organization with id 1
+    export organization_id=1
+    /usr/sbin/foreman-rake rh_cloud_insights:sync
+
 ## TODO
 
 *Todo list here*

data/app/controllers/foreman_inventory_upload/accounts_controller.rb

@@ -22,6 +22,8 @@ module ForemanInventoryUpload
 
       render json: {
         autoUploadEnabled: Setting[:allow_auto_inventory_upload],
+        hostObfuscationEnabled: Setting[:obfuscate_inventory_hostnames],
+        cloudToken: Setting[:rh_cloud_token],
         accounts: accounts,
       }, status: :ok
     end

data/app/controllers/foreman_inventory_upload/tasks_controller.rb

@@ -0,0 +1,25 @@
+module ForemanInventoryUpload
+  class TasksController < ::ApplicationController
+    def create
+      selected_org = Organization.current
+      subscribed_hosts_ids = Set.new(
+        ForemanInventoryUpload::Generators::Queries.for_slice(
+          Host.unscoped.where(organization: selected_org)
+        ).pluck(:id)
+      )
+
+      if subscribed_hosts_ids.empty?
+        return render json: {
+          message: N_('Nothing to sync, there are no hosts with subscription for this organization.'),
+        }, status: :method_not_allowed
+      else
+        host_statuses = InventorySync::Async::InventoryFullSync.perform_now(selected_org)
+      end
+
+      render json: {
+        syncHosts: host_statuses[:sync],
+        disconnectHosts: host_statuses[:disconnect],
+      }, status: :ok
+    end
+  end
+end

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -26,13 +26,32 @@ module ForemanInventoryUpload
 
     def auto_upload
       Setting[:allow_auto_inventory_upload] = auto_upload_params
-      render json: {
-        autoUploadEnabled: Setting[:allow_auto_inventory_upload],
-      }
+      render_setting(:autoUploadEnabled, :allow_auto_inventory_upload)
+    end
+
+    def show_auto_upload
+      render_setting(:autoUploadEnabled, :allow_auto_inventory_upload)
     end
 
     def auto_upload_params
       ActiveModel::Type::Boolean.new.cast(params.require(:value))
     end
+
+    def host_obfuscation
+      Setting[:obfuscate_inventory_hostnames] = host_obfuscation_params
+      render_setting(:hostObfuscationEnabled, :obfuscate_inventory_hostnames)
+    end
+
+    def host_obfuscation_params
+      ActiveModel::Type::Boolean.new.cast(params.require(:value))
+    end
+
+    private
+
+    def render_setting(node_name, setting)
+      render json: {
+        node_name => Setting[setting],
+      }
+    end
   end
 end

data/app/controllers/foreman_rh_cloud/react_controller.rb

@@ -4,5 +4,8 @@ module ForemanRhCloud
 
     def inventory_upload
     end
+
+    def insights_cloud
+    end
   end
 end

data/app/controllers/insights_cloud/hits_controller.rb

@@ -0,0 +1,17 @@
+module InsightsCloud
+  class HitsController < ::ApplicationController
+    def index
+      host = Host.where(id: host_id_param).first
+
+      render json: {
+        hits: host.insights.hits,
+      }, status: :ok
+    end
+
+    private
+
+    def host_id_param
+      params.require(:host_id)
+    end
+  end
+end

data/app/controllers/insights_cloud/settings_controller.rb

@@ -0,0 +1,24 @@
+module InsightsCloud
+  class SettingsController < ::ApplicationController
+    def show
+      render_setting(:insightsSyncEnabled, :allow_auto_insights_sync)
+    end
+
+    def update
+      Setting[:allow_auto_insights_sync] = settings_params
+      render_setting(:insightsSyncEnabled, :allow_auto_insights_sync)
+    end
+
+    private
+
+    def render_setting(node_name, setting)
+      render json: {
+        node_name => Setting[setting],
+      }
+    end
+
+    def settings_params
+      ActiveModel::Type::Boolean.new.cast(params.require(:insightsSyncEnabled))
+    end
+  end
+end

data/app/controllers/insights_cloud/tasks_controller.rb

@@ -0,0 +1,7 @@
+module InsightsCloud
+  class TasksController < ::ApplicationController
+    def create
+      InsightsCloud::Async::InsightsFullSync.perform_now
+    end
+  end
+end

data/app/helpers/foreman_inventory_upload_host_helper.rb

@@ -0,0 +1,20 @@
+module ForemanInventoryUploadHostHelper
+  def hits_counts
+    @hits_counts ||= InsightsHit.where(host_id: @hosts).group(:host_id).count
+  end
+
+  def hits_counts_cell(host)
+    host_hits = hits_counts[host.id]
+    content = n_('One recommendation', '%{hits} recommendations', host_hits) % { hits: host_hits } if host_hits
+    tag.td class: ['hidden-xs', 'ellipsis'] do
+      if host_hits
+        link_to(
+          content,
+          InsightsCloud::WebUi.system_url(InsightsCloud::WebUi::ADVISOR, host.insights.uuid),
+          :rel => 'external noopener noreferrer',
+          :target => '_blank'
+        )
+      end
+    end
+  end
+end

data/app/models/concerns/rh_cloud_host.rb

@@ -0,0 +1,12 @@
+module RhCloudHost
+  extend ActiveSupport::Concern
+
+  included do
+    has_many(
+      :inventory_upload_facts,
+      -> { where(fact_name_id: ForemanInventoryUpload::Generators::Queries.fact_names.values) },
+      class_name: 'FactValue',
+      :foreign_key => :host_id
+    )
+  end
+end

data/app/models/insights_facet.rb

@@ -0,0 +1,7 @@
+class InsightsFacet < HostFacets::Base
+  has_many :hits,
+    foreign_key: :host_id,
+    primary_key: :host_id,
+    class_name: 'InsightsHit',
+    dependent: :destroy
+end

data/app/models/insights_hit.rb

@@ -0,0 +1,6 @@
+class InsightsHit < ApplicationRecord
+  has_one :host
+  # since the facet is one-to-one association with a host, we can connect
+  # through host_id column on both this model and facet.
+  has_one :insights_facet, foreign_key: 'host_id', primary_key: 'host_id'
+end

data/app/models/inventory_sync/inventory_status.rb

@@ -0,0 +1,30 @@
+module InventorySync
+  class InventoryStatus < HostStatus::Status
+    DISCONNECT = 0
+    SYNC = 1
+
+    def self.status_name
+      N_('Inventory')
+    end
+
+    def to_global(_options = {})
+      case status
+      when DISCONNECT
+        ::HostStatus::Global::WARN
+      when SYNC
+        ::HostStatus::Global::OK
+      else
+        ::HostStatus::Global::WARN
+      end
+    end
+
+    def to_label
+      case status
+        when DISCONNECT
+          N_('Host was not uploaded to your RH cloud inventory')
+        when SYNC
+          N_('Successfully uploaded to your RH cloud inventory')
+      end
+    end
+  end
+end

data/app/models/setting/rh_cloud.rb

@@ -3,8 +3,10 @@ class Setting::RhCloud < Setting
     return unless ActiveRecord::Base.connection.table_exists?('settings')
     return unless super
     [
-      set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), true),
+      set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), false),
+      set('allow_auto_insights_sync', N_('Allow recommendations synchronization from Red Hat cloud'), false),
       set('obfuscate_inventory_hostnames', N_('Obfuscate host names sent to Red Hat cloud'), false),
+      set('rh_cloud_token', N_('Authentication token to Red Hat cloud services. Used to authenticate requests to cloud APIs'), 'DEFAULT', N_('Red Hat Cloud token'), nil, encrypted: true),
     ]
   end
 

data/app/overrides/hosts_list.rb

@@ -0,0 +1,13 @@
+Deface::Override.new(
+  virtual_path: 'hosts/_list',
+  name: 'insights_hits_header',
+  insert_before: 'thead tr th.hidden-xs:first-of-type',
+  text: '<th class="hidden-xs" width="10%"><%= _("Insights")%></th>'
+)
+
+Deface::Override.new(
+  virtual_path: 'hosts/_list',
+  name: 'insights_hits_cells',
+  insert_before: 'tbody tr td.hidden-xs:first-of-type',
+  text: '<%= hits_counts_cell(host) %>'
+)

data/app/views/foreman_rh_cloud/react/insights_cloud.html.erb

@@ -0,0 +1,6 @@
+<%= mount_react_component(
+'InsightsCloudSync',
+'#ForemanRhCloudReactRoot',
+{
+  settingsUrl: settings_url(search: 'name = rh_cloud_token')
+}.to_json) %>

data/app/views/foreman_rh_cloud/react/inventory_upload.html.erb

@@ -1 +1 @@
-<%= mount_react_component("ForemanInventoryUpload", '#ForemanRhCloudReactRoot') %>
+<%= mount_react_component('ForemanInventoryUpload', '#ForemanRhCloudReactRoot') %>

data/app/views/hosts/_insights_tab.html.erb

@@ -0,0 +1,15 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :'foreman_rh_cloud' %>
+<% end %>
+
+<% content_for(:stylesheets) do %>
+    <%= webpacked_plugins_css_for :'foreman_rh_cloud' %>
+<% end %>
+
+<div id="host_details_insights_react_container"></div>
+<%= mount_react_component(
+  'InsightsHostDetailsTab',
+  '#host_details_insights_react_container',
+  { hostID: host.id }.to_json,
+  flatten_data: true
+) %>

data/config/routes.rb

@@ -5,10 +5,21 @@ Rails.application.routes.draw do
     get ':organization_id/uploads/last', to: 'uploads#last', constraints: { organization_id: %r{[^\/]+} }
     get ':organization_id/uploads/file', to: 'uploads#download_file', constraints: { organization_id: %r{[^\/]+} }
     get 'accounts', to: 'accounts#index'
+    get 'auto_upload', to: 'uploads#show_auto_upload'
     post 'auto_upload', to: 'uploads#auto_upload'
+    post 'host_obfuscation', to: 'uploads#host_obfuscation'
+
+    resources :tasks, only: [:create]
+  end
+
+  namespace :insights_cloud do
+    resources :tasks, only: [:create]
+    resource :settings, only: [:show, :update]
+    get 'hits/:host_id', to: 'hits#index'
   end
 
   namespace :foreman_rh_cloud do
     get 'inventory_upload', to: 'react#inventory_upload'
+    get 'insights_cloud', to: 'react#insights_cloud'
   end
 end

data/db/migrate/20191215104806_create_insights_hits.foreman_inventory_upload.rb

@@ -0,0 +1,14 @@
+class CreateInsightsHits < ActiveRecord::Migration[5.2]
+  def change
+    create_table :insights_hits do |t|
+      t.references :host, foreign_key: true, null: false
+      t.datetime :last_seen
+      t.string :title
+      t.string :solution_url
+      t.integer :total_risk
+      t.integer :likelihood
+      t.datetime :publish_date
+      t.string :results_url
+    end
+  end
+end

data/db/migrate/20191216062008_create_insights_facets.foreman_inventory_upload.rb

@@ -0,0 +1,7 @@
+class CreateInsightsFacets < ActiveRecord::Migration[5.2]
+  def change
+    create_table :insights_facets do |t|
+      t.references :host, foreign_key: true, null: false
+    end
+  end
+end

data/db/migrate/20200727111529_add_uuid_column_to_insights_facets.foreman_rh_cloud.rb

@@ -0,0 +1,5 @@
+class AddUuidColumnToInsightsFacets < ActiveRecord::Migration[5.2]
+  def change
+    add_column :insights_facets, :uuid, :string
+  end
+end

data/lib/foreman_inventory_upload.rb

@@ -60,4 +60,8 @@ module ForemanInventoryUpload
     FileUtils.mkdir_p(folder)
     folder
   end
+
+  def self.inventory_export_url
+    ForemanRhCloud.base_url + '/api/inventory/v1/hosts'
+  end
 end

data/lib/foreman_inventory_upload/async/generate_report_job.rb

@@ -23,7 +23,7 @@ module ForemanInventoryUpload
       end
 
       def command
-        "#{rake_prefix}rake foreman_inventory_upload:report:generate"
+        "#{rake_prefix}rake rh_cloud_inventory:report:generate"
       end
 
       def env

data/lib/foreman_inventory_upload/async/shell_process.rb

@@ -8,24 +8,30 @@ module ForemanInventoryUpload
       def perform(instance_label)
         klass_name = self.class.name
         logger.debug("Starting #{klass_name} with label #{instance_label}")
-        progress_output = ProgressOutput.register(instance_label)
-        Open3.popen2e(hash_to_s(env), command) do |_stdin, stdout_stderr, wait_thread|
-          progress_output.status = "Running in pid #{wait_thread.pid}"
+        progress_output_for(instance_label) do |progress_output|
+          Open3.popen2e(hash_to_s(env), command) do |_stdin, stdout_stderr, wait_thread|
+            progress_output.status = "Running in pid #{wait_thread.pid}"
 
-          stdout_stderr.each do |out_line|
-            progress_output.write_line(out_line)
-          end
+            stdout_stderr.each do |out_line|
+              progress_output.write_line(out_line)
+            end
 
-          progress_output.status = wait_thread.value.to_s
+            progress_output.status = wait_thread.value.to_s
+          end
         end
         logger.debug("Finished job #{klass_name} with label #{instance_label}")
-      ensure
-        progress_output.close
       end
 
       def command
       end
 
+      def progress_output_for(instance_label)
+        progress_output = ProgressOutput.register(instance_label)
+        yield(progress_output)
+      ensure
+        progress_output.close
+      end
+
       def env
         {}
       end

data/lib/foreman_inventory_upload/async/upload_report_job.rb

@@ -8,15 +8,33 @@ module ForemanInventoryUpload
       end
 
       def perform(filename, organization_id)
+        label = UploadReportJob.output_label(organization_id)
         @filename = filename
         @organization = Organization.find(organization_id)
 
+        if Setting[:content_disconnected]
+          progress_output_for(label) do |progress_output|
+            progress_output.write_line('Upload was stopped since disconnected mode setting is enabled for content on this instance.')
+            progress_output.status = "Task aborted, exit 1"
+          end
+          return
+        end
+
+        unless @organization.owner_details&.fetch('upstreamConsumer')&.fetch('idCert')
+          logger.info("Skipping organization '#{@organization}', no candlepin certificate defined.")
+          progress_output_for(label) do |progress_output|
+            progress_output.write_line("Skipping organization #{@organization}, no candlepin certificate defined.")
+            progress_output.status = "Task aborted, exit 1"
+          end
+          return
+        end
+
         Tempfile.create([@organization.name, '.pem']) do |cer_file|
           cer_file.write(rh_credentials[:cert])
           cer_file.write(rh_credentials[:key])
           cer_file.flush
           @cer_path = cer_file.path
-          super(UploadReportJob.output_label(organization_id))
+          super(label)
         end
       end
 
@@ -29,6 +47,8 @@ module ForemanInventoryUpload
           'FILES' => @filename,
           'CER_PATH' => @cer_path
         )
+
+        http_proxy_string = ForemanRhCloud.http_proxy_string(logger: logger)
         if http_proxy_string
           env_vars['http_proxy'] = http_proxy_string
           env_vars['https_proxy'] = http_proxy_string
@@ -36,14 +56,6 @@ module ForemanInventoryUpload
         env_vars
       end
 
-      def http_proxy_string
-        @http_proxy_string ||= begin
-          if Setting[:content_default_http_proxy]
-            HttpProxy.unscoped.find_by(name: Setting[:content_default_http_proxy])&.full_url
-          end
-        end
-      end
-
       def rh_credentials
         @rh_credentials ||= begin
           candlepin_id_certificate = @organization.owner_details['upstreamConsumer']['idCert']