foreman_rh_cloud 2.0.4 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6361a25739c19a67518378257d51f67fc443839d76d7d07f5bd597f09ef15d
-  data.tar.gz: b558ad39920b634ee4c9be77ec20f65235eb3193de374879dc85bc284a15bfa5
+  metadata.gz: c164b990c325cd1f5e90004585c0074c558ee29ece8b687d37115d88f278274d
+  data.tar.gz: 01f04d99170a49224c7687949acff8d7171ce73d0d620343ce348c324b2b6040
 SHA512:
-  metadata.gz: 83b2169b736d8c57d544b8ce53bda7e91e4741efdd384953fd32a22ac96e531282e97ef740112a7be5310ef44fc0569fe8995972304844302d0b2eb3db6215f8
-  data.tar.gz: 3b7bbd7d76a68b5b41874472961eabd2360de0ad871705430d7549d8c44b48e5811ba9d566d74a3c0a8774b7c3b4c0c5a0f75ae57f2f38519ef528e12239c4f3
+  metadata.gz: dc211d399ff2f518b47ccfe76e8a569cac8b3356bab5dc6f2dabfc8c0a3de2926dd8fe99f2a84ea8dba9e4dea3b871cdd3380dfebb48e51cdcb1198dbac16bc8
+  data.tar.gz: 622e9894c0bef62e38f25b687d2acb0c5db74cf8e299e5a327f102052704324e2aafaee71fa30b595de66a29124789a815899e3f324000c559e3c75ce2ce401c

data/README.md

@@ -11,6 +11,14 @@ for how to install Foreman plugins
 
 *Usage here*
 
+### In Satellite
+
+Normally you run it via UI in RH Cloud -> Inventory Upload -> Restart, but if you need to run from command-line for some reason:
+
+    export organization_id=1
+    export target=/var/lib/foreman/red_hat_inventory/generated_reports/
+    /usr/sbin/foreman-rake foreman_inventory_upload:report:generate
+
 ## TODO
 
 *Todo list here*

data/app/controllers/foreman_inventory_upload/accounts_controller.rb

@@ -1,12 +1,8 @@
 module ForemanInventoryUpload
   class AccountsController < ::ApplicationController
-    # override default "welcome screen behavior, since we don't have a model"
-    def welcome
-      true
-    end
-
     def index
-      labels = Organization.all.pluck(:id, :name)
+      organizations = User.current.my_organizations
+      labels = organizations.pluck(:id, :name)
 
       accounts = Hash[
         labels.map do |id, label|
@@ -25,6 +21,8 @@ module ForemanInventoryUpload
       ]
 
       render json: {
+        autoUploadEnabled: Setting[:allow_auto_inventory_upload],
+        hostObfuscationEnabled: Setting[:obfuscate_inventory_hostnames],
         accounts: accounts,
       }, status: :ok
     end

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -11,14 +11,10 @@ module ForemanInventoryUpload
 
     def download_file
       filename = ForemanInventoryUpload.facts_archive_name(params[:organization_id])
-      path = Rails.root.join(ForemanInventoryUpload.uploads_folder, filename)
-      unless File.exist? path
-        return throw_flash_error(
-          "Path doesn't exist: #{path}"
-        )
-      end
+      files = Dir["{#{ForemanInventoryUpload.uploads_file_path(filename)},#{ForemanInventoryUpload.done_file_path(filename)}}"]
 
-      send_file path, disposition: 'attachment', filename: filename
+      return send_file files.first, disposition: 'attachment', filename: filename unless files.empty?
+      throw_flash_error "File doesn't exist"
     end
 
     def throw_flash_error(message)
@@ -27,5 +23,35 @@ module ForemanInventoryUpload
         :error_msg => message
       )
     end
+
+    def auto_upload
+      Setting[:allow_auto_inventory_upload] = auto_upload_params
+      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

@@ -0,0 +1,11 @@
+module ForemanRhCloud
+  class ReactController < ::ApplicationController
+    layout "foreman_rh_cloud/application"
+
+    def inventory_upload
+    end
+
+    def insights_cloud
+    end
+  end
+end

data/app/controllers/insights_cloud/tasks_controller.rb

@@ -0,0 +1,8 @@
+module InsightsCloud
+  class TasksController < ::ApplicationController
+    def create
+      selected_org = Organization.current
+      InsightsCloud::Async::InsightsFullSync.perform_now(selected_org)
+    end
+  end
+end

data/app/helpers/foreman_inventory_upload_host_helper.rb

@@ -0,0 +1,11 @@
+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 content, class: ['hidden-xs', 'ellipsis']
+  end
+end

data/app/models/insights_facet.rb

@@ -0,0 +1,3 @@
+class InsightsFacet < HostFacets::Base
+  has_many :hits, foreign_key: :host_id, primary_key: :host_id, class_name: 'InsightsHit'
+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/setting/rh_cloud.rb

@@ -0,0 +1,15 @@
+class Setting::RhCloud < Setting
+  def self.default_settings
+    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'), 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
+
+  def self.humanized_category
+    N_('RH Cloud')
+  end
+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

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

data/app/views/{foreman_inventory_upload/layouts/react.html.erb → layouts/foreman_rh_cloud/application.html.erb}

@@ -10,7 +10,7 @@
   <%= notifications %>
   <div id="organization-id" data-id="<%= Organization.current.id if Organization.current %>" ></div>
   <div id="user-id" data-id="<%= User.current.id if User.current %>" ></div>
-  <div id="ForemanInventoryUploadReactRoot"></div>
+  <div id="ForemanRhCloudReactRoot"></div>
+  <%= yield %>
 <% end %>
 <%= render file: "layouts/base" %>
-<%= mount_react_component('ForemanInventoryUpload', '#ForemanInventoryUploadReactRoot') %>

data/config/routes.rb

@@ -1,10 +1,21 @@
 Rails.application.routes.draw do
   namespace :foreman_inventory_upload do
-    get 'index', to: 'react#index'
     get ':organization_id/reports/last', to: 'reports#last', constraints: { organization_id: %r{[^\/]+} }
     post ':organization_id/reports', to: 'reports#generate', constraints: { organization_id: %r{[^\/]+} }
     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'
+  end
+
+  namespace :insights_cloud do
+    resources :tasks, only: [:create]
+  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/lib/foreman_inventory_upload.rb

@@ -18,6 +18,18 @@ module ForemanInventoryUpload
     )
   end
 
+  def self.uploads_file_path(filename)
+    File.join(ForemanInventoryUpload.uploads_folder, filename)
+  end
+
+  def self.done_folder
+    File.join(ForemanInventoryUpload.uploads_folder, 'done/')
+  end
+
+  def self.done_file_path(filename)
+    File.join(ForemanInventoryUpload.done_folder, filename)
+  end
+
   def self.generated_reports_folder
     @generated_reports_folder ||= ensure_folder(
       File.join(

data/lib/foreman_inventory_upload/async/async_helpers.rb

@@ -0,0 +1,13 @@
+module ForemanInventoryUpload
+  module Async
+    module AsyncHelpers
+      extend ActiveSupport::Concern
+
+      def hash_to_s(hash)
+        hash.each_with_object({}) do |(k, v), a|
+          a[k.to_s] = v.to_s
+        end
+      end
+    end
+  end
+end

data/lib/foreman_inventory_upload/async/generate_all_reports_job.rb

@@ -2,6 +2,14 @@ module ForemanInventoryUpload
   module Async
     class GenerateAllReportsJob < ::ApplicationJob
       def perform
+        unless Setting[:allow_auto_inventory_upload]
+          logger.debug(
+            'The scheduled process is disabled due to the "allow_auto_inventory_upload"
+            setting being set to false.'
+          )
+          return
+        end
+
         organizations = Organization.unscoped.all
 
         organizations.map do |organization|

data/lib/foreman_inventory_upload/async/shell_process.rb

@@ -3,11 +3,13 @@ require 'open3'
 module ForemanInventoryUpload
   module Async
     class ShellProcess < ::ApplicationJob
+      include AsyncHelpers
+
       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(env, command) do |_stdin, stdout_stderr, wait_thread|
+        Open3.popen2e(hash_to_s(env), *preprocess_command(command)) do |_stdin, stdout_stderr, wait_thread|
           progress_output.status = "Running in pid #{wait_thread.pid}"
 
           stdout_stderr.each do |out_line|
@@ -31,6 +33,12 @@ module ForemanInventoryUpload
       def logger
         Foreman::Logging.logger('background')
       end
+
+      private
+
+      def preprocess_command(command)
+        command.kind_of?(Array) ? command : [command]
+      end
     end
   end
 end

data/lib/foreman_inventory_upload/async/upload_report_job.rb

@@ -21,7 +21,7 @@ module ForemanInventoryUpload
       end
 
       def command
-        File.join(File.dirname(@filename), ForemanInventoryUpload.upload_script_file)
+        ['/bin/bash', File.join(File.dirname(@filename), ForemanInventoryUpload.upload_script_file)]
       end
 
       def env

data/lib/foreman_inventory_upload/generators/archived_report.rb

@@ -16,9 +16,9 @@ module ForemanInventoryUpload
               first = true
               host_batches.each do |hosts_batch|
                 slice_id = Foreman.uuid
-                hosts_count = hosts_batch.count
-                @logger.info "Adding slice #{slice_id} with #{hosts_count} hosts"
-                generate_slice(tmpdir, slice_id, hosts_batch)
+                @logger.info "Adding slice #{slice_id}"
+                hosts_count = generate_slice(tmpdir, slice_id, hosts_batch)
+                @logger.info "slice #{slice_id} was created with #{hosts_count} hosts"
                 inner_generator.add_slice(slice_id, hosts_count, first)
                 first = false
               end
@@ -43,10 +43,13 @@ module ForemanInventoryUpload
       private
 
       def generate_slice(tmpdir, slice_id, hosts_batch)
+        hosts_count = 0
         File.open(File.join(tmpdir, "#{slice_id}.json"), 'w') do |slice_out|
           slice_generator = ForemanInventoryUpload::Generators::Slice.new(hosts_batch, slice_out, slice_id)
           slice_generator.render
+          hosts_count = slice_generator.hosts_count
         end
+        hosts_count
       end
     end
   end

data/lib/foreman_inventory_upload/generators/fact_helpers.rb

@@ -3,6 +3,11 @@ module ForemanInventoryUpload
     module FactHelpers
       extend ActiveSupport::Concern
 
+      CLOUD_AMAZON = 'aws'
+      CLOUD_GOOGLE = 'google'
+      CLOUD_AZURE = 'azure'
+      CLOUD_ALIBABA = 'alibaba'
+
       def fact_value(host, fact_name)
         value_record = host.fact_values.find do |fact_value|
           fact_value.fact_name_id == ForemanInventoryUpload::Generators::Queries.fact_names[fact_name]
@@ -13,6 +18,57 @@ module ForemanInventoryUpload
       def kilobytes_to_bytes(kilobytes)
         kilobytes * 1024
       end
+
+      def account_id(organization)
+        @organization_accounts ||= {}
+        @organization_accounts[organization.id] ||= organization.pools.where.not(account_number: nil).pluck(:account_number).first
+      end
+
+      def golden_ticket?(organization)
+        result = organization.try(:golden_ticket?)
+        result = organization.content_access_mode == 'org_environment' if result.nil?
+
+        @organization_golden_tickets ||= {}
+        @organization_golden_tickets[organization.id] ||= result
+      end
+
+      def cloud_provider(host)
+        bios_version = fact_value(host, 'dmi::bios::version')
+
+        if bios_version
+          return CLOUD_AMAZON if bios_version.downcase['amazon']
+          return CLOUD_GOOGLE if bios_version.downcase['google']
+        end
+
+        chassis_asset_tag = fact_value(host, 'dmi::chassis::asset_tag')
+        return CLOUD_AZURE if chassis_asset_tag && chassis_asset_tag['7783-7084-3265-9085-8269-3286-77']
+
+        system_manufacturer = fact_value(host, 'dmi::system::manufacturer')
+        return CLOUD_ALIBABA if system_manufacturer && system_manufacturer.downcase['alibaba cloud']
+
+        product_name = fact_value(host, 'dmi::system::product_name')
+        return CLOUD_ALIBABA if product_name && product_name.downcase['alibaba cloud ecs']
+
+        nil
+      end
+
+      def obfuscate_hostname?(host)
+        insights_client_setting = fact_value(host, 'insights_client::obfuscate_hostname_enabled')
+        insights_client_setting = ActiveModel::Type::Boolean.new.cast(insights_client_setting)
+        return insights_client_setting unless insights_client_setting.nil?
+
+        Setting[:obfuscate_inventory_hostnames]
+      end
+
+      def fqdn(host)
+        return host.fqdn unless obfuscate_hostname?(host)
+
+        fact_value(host, 'insights_client::hostname') || obfuscate_fqdn(host.fqdn)
+      end
+
+      def obfuscate_fqdn(fqdn)
+        Digest::SHA1.hexdigest(fqdn)
+      end
     end
   end
 end

data/lib/foreman_inventory_upload/generators/json_stream.rb

@@ -36,6 +36,16 @@ module ForemanInventoryUpload
         @out << ',' unless last
       end
 
+      def string_array_value(name, value, last = false)
+        return if value.empty?
+
+        string_value = value.map { |v| stringify_value(v) }
+
+        array_field(name, last) do
+          raw(string_value.join(', '))
+        end
+      end
+
       def object_field(name, last = false, &block)
         @out << "\"#{name}\": "
         object(&block)