foreman_rh_cloud 0.9.4

data/test/controllers/reports_controller_test.rb

@@ -0,0 +1,21 @@
+require 'test_plugin_helper'
+
+class ReportsControllerTest < ActionController::TestCase
+  tests ForemanInventoryUpload::ReportsController
+
+  test 'Returns latest report generation status' do
+    progress_output = mock('progress_output')
+    test_org = FactoryBot.create(:organization)
+    ForemanInventoryUpload::Async::ProgressOutput
+      .expects(:get)
+      .with(ForemanInventoryUpload::Async::GenerateReportJob.output_label(test_org.id))
+      .returns(progress_output)
+    progress_output.expects(:full_output).returns('test output')
+
+    get :last, params: { organization_id: test_org.id }, session: set_session_user
+
+    assert_response :success
+    actual = JSON.parse(response.body)
+    assert_equal 'test output', actual['output']
+  end
+end

data/test/controllers/uploads_controller_test.rb

@@ -0,0 +1,21 @@
+require 'test_plugin_helper'
+
+class UploadsControllerTest < ActionController::TestCase
+  tests ForemanInventoryUpload::UploadsController
+
+  test 'Returns latest upload status' do
+    progress_output = mock('progress_output')
+    test_org = FactoryBot.create(:organization)
+    ForemanInventoryUpload::Async::ProgressOutput
+      .expects(:get)
+      .with(ForemanInventoryUpload::Async::UploadReportJob.output_label(test_org.id))
+      .returns(progress_output)
+    progress_output.expects(:full_output).returns('test output')
+
+    get :last, params: { organization_id: test_org.id }, session: set_session_user
+
+    assert_response :success
+    actual = JSON.parse(response.body)
+    assert_equal 'test output', actual['output']
+  end
+end

data/test/factories/inventory_upload_factories.rb

@@ -0,0 +1,88 @@
+# redefine katello factories, as long as katello is not compatible with dynamic properties
+FactoryBot.define do
+  factory :katello_organization, :class => "Organization" do
+    type {"Organization"}
+    sequence(:name) { |n| "Organization#{n}" }
+    sequence(:label) { |n| "org#{n}" }
+    sequence(:id) { |n| n }
+
+    trait :acme_corporation do
+      name {"ACME_Corporation"}
+      type {"Organization"}
+      description {"This is the first Organization."}
+      label {"acme_corporation_label"}
+    end
+
+    trait :with_library do
+      association :library, :factory => :katello_library
+    end
+
+    factory :acme_corporation, :traits => [:acme_corporation]
+  end
+end
+
+FactoryBot.define do
+  factory :katello_content_view, :class => Katello::ContentView do
+    sequence(:name) { |n| "Database#{n}" }
+    description {"This content view is for database content"}
+    association :organization, :factory => :katello_organization
+
+    trait :composite do
+      composite {true}
+    end
+  end
+end
+
+FactoryBot.define do
+  factory :katello_k_t_environment, :aliases => [:katello_environment], :class => Katello::KTEnvironment do
+    sequence(:name) { |n| "Environment#{n}" }
+    sequence(:label) { |n| "environment#{n}" }
+    association :organization, :factory => :katello_organization
+  end
+end
+
+FactoryBot.define do
+  factory :katello_content_facets, :aliases => [:content_facet], :class => ::Katello::Host::ContentFacet do
+    sequence(:uuid) { |n| "uuid-#{n}" }
+  end
+end
+
+FactoryBot.define do
+  factory :katello_subscription_facets, :aliases => [:subscription_facet], :class => ::Katello::Host::SubscriptionFacet do
+    sequence(:uuid) { |n| "uuid-#{n}-#{rand(500)}" }
+    facts { {'memory.memtotal' => "12 GB"} }
+  end
+end
+
+FactoryBot.define do
+  factory :katello_pool, :class => Katello::Pool do
+    active {true}
+    end_date {Date.today + 1.year}
+  end
+end
+
+FactoryBot.modify do
+  factory :host do
+    transient do
+      content_view {nil}
+      lifecycle_environment {nil}
+      content_source {nil}
+    end
+
+    trait :with_content do
+      association :content_facet, :factory => :content_facet, :strategy => :build
+
+      after(:build) do |host, evaluator|
+        if host.content_facet
+          host.content_facet.content_view = evaluator.content_view if evaluator.content_view
+          host.content_facet.lifecycle_environment = evaluator.lifecycle_environment if evaluator.lifecycle_environment
+          host.content_facet.content_source = evaluator.content_source if evaluator.content_source
+        end
+      end
+    end
+
+    trait :with_subscription do
+      association :subscription_facet, :factory => :subscription_facet, :strategy => :build
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,26 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+
+# Add plugin to FactoryBot's paths
+FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+# FactoryBot.definition_file_paths << "#{Katello::Engine.root}/test/factories"
+FactoryBot.reload
+
+module FolderIsolation
+  extend ActiveSupport::Concern
+
+  included do
+    setup do
+      @tmpdir = Dir.mktmpdir(self.class.name.underscore)
+
+      ForemanInventoryUpload.stubs(:base_folder).returns(@tmpdir)
+      ForemanInventoryUpload.instance_variable_set(:@outputs_folder, nil)
+      ForemanInventoryUpload.instance_variable_set(:@uploads_folders, nil)
+    end
+
+    teardown do
+      FileUtils.remove_entry @tmpdir
+      ForemanInventoryUpload.unstub(:base_folder)
+    end
+  end
+end

data/test/unit/archived_report_generator_test.rb

@@ -0,0 +1,61 @@
+require 'test_plugin_helper'
+
+class ArchivedReportGeneratorTest < ActiveSupport::TestCase
+  setup do
+    User.current = User.find_by(login: 'secret_admin')
+
+    env = FactoryBot.create(:katello_k_t_environment)
+    cv = env.content_views << FactoryBot.create(:katello_content_view, organization: env.organization)
+
+    @host = FactoryBot.create(
+      :host,
+      :with_subscription,
+      :with_content,
+      content_view: cv.first,
+      lifecycle_environment: env,
+      organization: env.organization
+    )
+
+    @host.subscription_facet.pools << FactoryBot.create(:katello_pool, account_number: '1234', cp_id: 1)
+  end
+
+  def interesting_facts
+    [
+      'dmi::system::uuid',
+      'virt::uuid',
+      'cpu::cpu(s)',
+      'cpu::cpu_socket(s)',
+      'cpu::core(s)_per_socket',
+      'memory::memtotal',
+      'dmi::bios::vendor',
+      'dmi::bios::version',
+      'dmi::bios::relase_date',
+      'distribution::name',
+      'uname::release',
+      'lscpu::flags',
+    ]
+  end
+
+  def fact_names
+    @fact_names ||= Hash[
+      interesting_facts.map do |fact|
+        [fact, FactoryBot.create(:fact_name, name: fact, type: 'Katello::RhsmFactName')]
+      end
+    ]
+  end
+
+  test 'generates a report for a single host' do
+    batches = Host.where(id: @host.id).in_batches
+    test_org = FactoryBot.create(:organization)
+
+    ForemanInventoryUpload::Generators::Queries.expects(:for_org).with(test_org.id).returns(batches)
+    Dir.mktmpdir do |tmpdir|
+      target = File.join(tmpdir, 'test.tar.gz')
+      generator = ForemanInventoryUpload::Generators::ArchivedReport.new(target, Logger.new(STDOUT))
+      generator.render(organization: test_org.id)
+
+      files = Dir["#{tmpdir}/*"]
+      assert_equal "#{tmpdir}/test.tar.gz", files.first
+    end
+  end
+end

data/test/unit/metadata_generator_test.rb

@@ -0,0 +1,40 @@
+require 'test_plugin_helper'
+
+class MetadataGeneratorTest < ActiveSupport::TestCase
+  setup do
+  end
+
+  test 'generates an empty report' do
+    generator = ForemanInventoryUpload::Generators::Metadata.new
+
+    json_str = generator.render do
+    end
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_not_nil actual['report_id']
+    assert_equal 'Satellite', actual['source']
+    assert_equal({}, actual['report_slices'])
+  end
+
+  test 'generates a report for a single slice' do
+    generator = ForemanInventoryUpload::Generators::Metadata.new
+
+    json_str = generator.render do |gen|
+      gen.add_slice('test_123', 1, true)
+      gen.add_slice('test_1234', 2, false)
+      gen.add_slice('test_12345', 3, false)
+    end
+
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_not_nil actual['report_id']
+    assert_equal 'Satellite', actual['source']
+    assert_not_nil(slices = actual['report_slices'])
+    assert_not_nil(slice = slices['test_123'])
+    assert_equal 1, slice['number_hosts']
+    assert_not_nil(slice = slices['test_1234'])
+    assert_equal 2, slice['number_hosts']
+    assert_not_nil(slice = slices['test_12345'])
+    assert_equal 3, slice['number_hosts']
+  end
+end

data/test/unit/shell_process_job_test.rb

@@ -0,0 +1,27 @@
+require 'test_plugin_helper'
+
+class ShellProcessJobTest < ActiveSupport::TestCase
+  class TestProcessJob < ForemanInventoryUpload::Async::ShellProcess
+    def command
+      'echo testing env: $testenv'
+    end
+
+    def env
+      super.merge(
+        'testenv' => 'test_val'
+      )
+    end
+  end
+
+  include FolderIsolation
+
+  test 'Runs a process with environment vars' do
+    label = Foreman.uuid
+    TestProcessJob.perform_now(label)
+
+    progress_output = ForemanInventoryUpload::Async::ProgressOutput.get(label)
+
+    assert_match(/test_val/, progress_output.full_output)
+    assert_match(/exit 0/, progress_output.status)
+  end
+end

data/test/unit/slice_generator_test.rb

@@ -0,0 +1,177 @@
+require 'test_plugin_helper'
+
+class ReportGeneratorTest < ActiveSupport::TestCase
+  setup do
+    User.current = User.find_by(login: 'secret_admin')
+
+    env = FactoryBot.create(:katello_k_t_environment)
+    cv = env.content_views << FactoryBot.create(:katello_content_view, organization: env.organization)
+
+    @host = FactoryBot.create(
+      :host,
+      :with_subscription,
+      :with_content,
+      content_view: cv.first,
+      lifecycle_environment: env,
+      organization: env.organization
+    )
+
+    @host.subscription_facet.pools << FactoryBot.create(:katello_pool, account_number: '1234', cp_id: 1)
+  end
+
+  def interesting_facts
+    [
+      'dmi::system::uuid',
+      'virt::uuid',
+      'cpu::cpu(s)',
+      'cpu::cpu_socket(s)',
+      'cpu::core(s)_per_socket',
+      'memory::memtotal',
+      'dmi::bios::vendor',
+      'dmi::bios::version',
+      'dmi::bios::relase_date',
+      'distribution::name',
+      'uname::release',
+      'lscpu::flags',
+    ]
+  end
+
+  def fact_names
+    @fact_names ||= Hash[
+      interesting_facts.map do |fact|
+        [fact, FactoryBot.create(:fact_name, name: fact, type: 'Katello::RhsmFactName')]
+      end
+    ]
+  end
+
+  test 'generates a report for a single host' do
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = ForemanInventoryUpload::Generators::Slice.new(batch, [], 'slice_123')
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal @host.name, actual_host['display_name']
+    assert_equal @host.fqdn, actual_host['fqdn']
+    assert_equal '1234', actual_host['account']
+  end
+
+  test 'generates a report with satellite facts' do
+    Foreman.expects(:instance_id).twice.returns('satellite-id')
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = ForemanInventoryUpload::Generators::Slice.new(batch, [], 'slice-123')
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    facts = actual['hosts'].first['facts'].first
+    assert_equal 'satellite', facts['namespace']
+    satellite_facts = facts['facts']
+    assert_equal 'satellite-id', satellite_facts['satellite_instance_id']
+    assert_equal @host.organization_id, satellite_facts['organization_id']
+
+    instance_id_tag = actual['hosts'].first['tags'].find { |tag| tag['namespace'] == 'satellite' && tag['key'] == 'satellite_instance_id'}
+    assert_not_nil instance_id_tag
+    assert_equal 'satellite-id', instance_id_tag['value']
+
+    org_id_tag = actual['hosts'].first['tags'].find { |tag| tag['namespace'] == 'satellite' && tag['key'] == 'organization_id'}
+    assert_not_nil org_id_tag
+    assert_equal @host.organization_id, org_id_tag['value']
+
+    version = satellite_facts['satellite_version']
+    if defined?(ForemanThemeSatellite)
+      assert_equal ForemanThemeSatellite::SATELLITE_VERSION, version
+    else
+      assert_nil version
+    end
+  end
+
+  test 'generates a report for a host with hypervisor' do
+    hypervisor_host = FactoryBot.create(
+      :host,
+      :with_subscription,
+      :with_content,
+      content_view: @host.content_view,
+      lifecycle_environment: @host.lifecycle_environment,
+      organization: @host.organization
+    )
+
+    @host.subscription_facet.hypervisor_host = hypervisor_host
+    @host.save!
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = ForemanInventoryUpload::Generators::Slice.new(batch, [], 'slice_123')
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal @host.name, actual_host['display_name']
+    assert_equal @host.fqdn, actual_host['fqdn']
+    assert_not_nil(host_facts = actual_host['facts']&.first)
+    assert_equal 'satellite', host_facts['namespace']
+    assert_not_nil(fact_values = host_facts['facts'])
+    assert_equal hypervisor_host.name, fact_values['virtual_host_name']
+    assert_equal hypervisor_host.subscription_facet.uuid, fact_values['virtual_host_uuid']
+  end
+
+  test 'generates a report with system purpose' do
+    @host.subscription_facet.purpose_usage = 'test_usage'
+    @host.subscription_facet.purpose_role = 'test_role'
+    @host.subscription_facet.save!
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = ForemanInventoryUpload::Generators::Slice.new(batch, [], 'slice_123')
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal @host.name, actual_host['display_name']
+    assert_equal @host.fqdn, actual_host['fqdn']
+    assert_not_nil(host_facts = actual_host['facts']&.first)
+    assert_equal 'satellite', host_facts['namespace']
+    assert_not_nil(fact_values = host_facts['facts'])
+    assert_equal 'test_usage', fact_values['system_purpose_usage']
+    assert_equal 'test_role', fact_values['system_purpose_role']
+  end
+
+  test 'skips hosts without subscription' do
+    a_host = FactoryBot.create(
+      :host,
+      organization: @host.organization
+    )
+
+    # make a_host last
+    batch = Host.where(id: [@host.id, a_host.id]).order(:name).in_batches.first
+    generator = ForemanInventoryUpload::Generators::Slice.new(batch, [], 'slice_123')
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal @host.name, actual_host['display_name']
+    assert_equal @host.fqdn, actual_host['fqdn']
+    assert_equal '1234', actual_host['account']
+  end
+
+  test 'shows system_memory_bytes in bytes' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['memory::memtotal'], value: '1', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = ForemanInventoryUpload::Generators::Slice.new(batch, [], 'slice_123')
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_not_nil(actual_profile = actual_host['system_profile'])
+    assert_equal 1024, actual_profile['system_memory_bytes']
+  end
+end