foreman_openscap 0.11.5 → 0.12.0

data/test/factories/policy_factory.rb

@@ -11,5 +11,6 @@ FactoryBot.define do
     cron_line nil
     hosts []
     assets []
+    deploy_by 'manual'
   end
 end

data/test/functional/api/v2/compliance/arf_reports_controller_test.rb

@@ -96,8 +96,7 @@ class Api::V2::Compliance::ArfReportsControllerTest < ActionController::TestCase
   test "should not create report when host is missing" do
     reports_cleanup
     date = Time.new(1984, 9, 16)
-    ForemanOpenscap::Helper.stubs(:find_host_by_name_or_uuid).returns(nil)
-
+    ForemanOpenscap::Helper.stubs(:get_asset).returns(nil)
     cname = '9521a5c5-8f44-495f-b087-20e86b30bffg'
     post :create,
          :params => @from_json.merge(:cname => cname,
@@ -114,7 +113,7 @@ class Api::V2::Compliance::ArfReportsControllerTest < ActionController::TestCase
   test "should not create report when policy is missing" do
     reports_cleanup
     date = Time.new(1984, 9, 17)
-    ForemanOpenscap::Helper.stubs(:find_host_by_name_or_uuid).returns(@host)
+    ForemanOpenscap::Helper.stubs(:get_asset).returns(@asset)
     policy_id = 0
     post :create,
          :params => @from_json.merge(:cname => @cname,

data/test/functional/api/v2/compliance/policies_controller_test.rb

@@ -2,13 +2,13 @@ require 'test_plugin_helper'
 
 class Api::V2::Compliance::PoliciesControllerTest < ActionController::TestCase
   setup do
-    ::ForemanOpenscap::Policy.any_instance.stubs(:ensure_needed_puppetclasses).returns(true)
     @scap_content_profile = FactoryBot.create(:scap_content_profile)
     @attributes = { :policy => { :name => 'my_policy',
                                  :scap_content_profile_id => @scap_content_profile.id,
                                  :scap_content_id => @scap_content_profile.scap_content_id,
                                  :period => 'weekly',
-                                 :weekday => 'friday' } }
+                                 :weekday => 'friday',
+                                 :deploy_by => 'manual' } }
   end
 
   test "should get index" do

data/test/test_plugin_helper.rb

@@ -6,10 +6,30 @@ FactoryBot.definition_file_paths << File.join(File.dirname(__FILE__), 'factories
 FactoryBot.reload
 
 module ScapClientPuppetclass
-  def skip_scap_callback
-    Host::Managed.any_instance.stubs(:update_scap_client).returns(nil)
-    Host::Managed.any_instance.stubs(:scap_client_class_present).returns(nil)
-    Hostgroup.any_instance.stubs(:update_scap_client).returns(nil)
+  def setup_puppet_class
+    puppet_config = ::ForemanOpenscap::ClientConfig::Puppet.new
+    Puppetclass.find_by(:name => puppet_config.puppetclass_name)&.destroy
+
+    puppet_class = FactoryBot.create(:puppetclass, :name => puppet_config.puppetclass_name)
+    server_param = FactoryBot.create(:puppetclass_lookup_key, :key => puppet_config.server_param, :puppetclass_id => puppet_class.id)
+    port_param = FactoryBot.create(:puppetclass_lookup_key, :key => puppet_config.port_param, :puppetclass_id => puppet_class.id)
+    policies_param = FactoryBot.create(:puppetclass_lookup_key, :key => puppet_config.policies_param, :puppetclass_id => puppet_class.id)
+
+    env = FactoryBot.create :environment
+
+    FactoryBot.create(:environment_class,
+                      :puppetclass_id => puppet_class.id,
+                      :environment_id => env.id,
+                      :puppetclass_lookup_key_id => server_param.id)
+    FactoryBot.create(:environment_class,
+                      :puppetclass_id => puppet_class.id,
+                      :environment_id => env.id,
+                      :puppetclass_lookup_key_id => port_param.id)
+    FactoryBot.create(:environment_class,
+                      :puppetclass_id => puppet_class.id,
+                      :environment_id => env.id,
+                      :puppetclass_lookup_key_id => policies_param.id)
+    { :puppet_class => puppet_class, :env => env, :server_param => server_param, :port_param => port_param, :policies_param => policies_param }
   end
 end
 
@@ -45,7 +65,6 @@ end
 
 class ActionMailer::TestCase
   include ScapClientPuppetclass
-  setup :skip_scap_callback
 end
 
 class ActionController::TestCase
@@ -53,7 +72,7 @@ class ActionController::TestCase
   include ScapTestProxy
   include ScapTestCommon
 
-  setup :add_smart_proxy, :skip_scap_callback
+  setup :add_smart_proxy
 end
 
 class ActiveSupport::TestCase
@@ -61,5 +80,5 @@ class ActiveSupport::TestCase
   include ScapTestProxy
   include ScapTestCommon
 
-  setup :add_smart_proxy, :skip_scap_callback
+  setup :add_smart_proxy
 end

data/test/unit/openscap_host_test.rb

@@ -4,8 +4,6 @@ class OpenscapHostTest < ActiveSupport::TestCase
   setup do
     disable_orchestration
     User.current = users :admin
-    ForemanOpenscap::Policy.any_instance.stubs(:ensure_needed_puppetclasses).returns(true)
-    ForemanOpenscap::Policy.any_instance.stubs(:find_scap_puppetclass).returns(FactoryBot.create(:puppetclass, :name => 'foreman_scap_client'))
     @policy = FactoryBot.create(:policy)
   end
 

data/test/unit/policy_test.rb

@@ -2,7 +2,6 @@ require 'test_plugin_helper'
 
 class PolicyTest < ActiveSupport::TestCase
   setup do
-    ForemanOpenscap::Policy.any_instance.stubs(:ensure_needed_puppetclasses).returns(true)
     ForemanOpenscap::DataStreamValidator.any_instance.stubs(:validate)
     ForemanOpenscap::ScapContent.any_instance.stubs(:fetch_profiles).returns({ 'test_profile_key' => 'test_profile_title' })
     @scap_content = FactoryBot.create(:scap_content)
@@ -11,8 +10,6 @@ class PolicyTest < ActiveSupport::TestCase
   end
 
   test "should assign hostgroups by their ids" do
-    ForemanOpenscap::Policy.any_instance.stubs(:find_scap_puppetclass).returns(FactoryBot.create(:puppetclass, :name => 'foreman_scap_client'))
-    ForemanOpenscap::Policy.any_instance.stubs(:populate_overrides)
     hg1 = FactoryBot.create(:hostgroup)
     hg2 = FactoryBot.create(:hostgroup)
     host = FactoryBot.create(:compliance_host)
@@ -27,8 +24,6 @@ class PolicyTest < ActiveSupport::TestCase
   end
 
   test "should assign hosts by their ids" do
-    ForemanOpenscap::Policy.any_instance.stubs(:find_scap_puppetclass).returns(FactoryBot.create(:puppetclass, :name => 'foreman_scap_client'))
-    ForemanOpenscap::Policy.any_instance.stubs(:populate_overrides)
     host1 = FactoryBot.create(:compliance_host)
     host2 = FactoryBot.create(:compliance_host)
     hostgroup = FactoryBot.create(:hostgroup)
@@ -43,8 +38,6 @@ class PolicyTest < ActiveSupport::TestCase
   end
 
   test "should remove associated hostgroup" do
-    ForemanOpenscap::Policy.any_instance.stubs(:find_scap_puppetclass).returns(FactoryBot.create(:puppetclass, :name => 'foreman_scap_client'))
-    ForemanOpenscap::Policy.any_instance.stubs(:populate_overrides)
     hg = FactoryBot.create(:hostgroup)
     asset = FactoryBot.create(:asset, :assetable_id => hg.id, :assetable_type => 'Hostgroup')
     policy = FactoryBot.create(:policy, :assets => [asset], :scap_content => @scap_content, :scap_content_profile => @scap_profile)
@@ -59,7 +52,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'custom',
-                                    :cron_line => '6 * 15 12 0')
+                                    :cron_line => '6 * 15 12 0',
+                                    :deploy_by => 'manual')
     assert p.save
   end
 
@@ -68,7 +62,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'custom',
-                                    :cron_line => 'aaa')
+                                    :cron_line => 'aaa',
+                                    :deploy_by => 'manual')
     refute p.save
     assert p.errors[:cron_line].include?("does not consist of 5 parts separated by space")
   end
@@ -78,7 +73,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'weekly',
-                                    :weekday => 'monday')
+                                    :weekday => 'monday',
+                                    :deploy_by => 'manual')
     assert p.save
   end
 
@@ -87,7 +83,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'weekly',
-                                    :weekday => 'someday')
+                                    :weekday => 'someday',
+                                    :deploy_by => 'manual')
     refute p.save
     assert p.errors[:weekday].include?("is not a valid value")
   end
@@ -97,7 +94,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'monthly',
-                                    :day_of_month => '1')
+                                    :day_of_month => '1',
+                                    :deploy_by => 'manual')
     assert p.save
   end
 
@@ -106,7 +104,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'monthly',
-                                    :day_of_month => '0')
+                                    :day_of_month => '0',
+                                    :deploy_by => 'manual')
     refute p.save
     assert p.errors[:day_of_month].include?("must be between 1 and 31")
   end
@@ -117,13 +116,15 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'monthly',
                                     :weekday => 'tuesday',
-                                    :cron_line => "0 0 0 0 0")
+                                    :cron_line => "0 0 0 0 0",
+                                    :deploy_by => 'manual')
     policy = ForemanOpenscap::Policy.new(:name => "test policy",
                                          :scap_content_id => @scap_content.id,
                                          :scap_content_profile_id => @scap_profile.id,
                                          :period => 'custom',
                                          :weekday => 'tuesday',
-                                         :day_of_month => "15")
+                                         :day_of_month => "15",
+                                         :deploy_by => 'manual')
     refute p.save
     refute policy.save
     assert p.weekday.empty?
@@ -137,7 +138,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'monthly',
-                                    :day_of_month => '5')
+                                    :day_of_month => '5',
+                                    :deploy_by => 'manual')
     assert p.save
     p.period = 'weekly'
     p.weekday = 'monday'
@@ -149,7 +151,8 @@ class PolicyTest < ActiveSupport::TestCase
     p = ForemanOpenscap::Policy.new(:name => "custom_policy",
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'monthly',
-                                    :day_of_month => '5')
+                                    :day_of_month => '5',
+                                    :deploy_by => 'manual')
     refute p.save
     assert p.errors[:scap_content_id].include?("can't be blank")
   end
@@ -158,7 +161,8 @@ class PolicyTest < ActiveSupport::TestCase
     p = ForemanOpenscap::Policy.new(:name => "custom_policy",
                                     :scap_content_id => @scap_content.id,
                                     :period => 'monthly',
-                                    :day_of_month => '5')
+                                    :day_of_month => '5',
+                                    :deploy_by => 'manual')
     assert p.save
   end
 
@@ -180,7 +184,8 @@ class PolicyTest < ActiveSupport::TestCase
                                        :scap_content => @scap_content,
                                        :scap_content_profile => @scap_profile,
                                        :tailoring_file => tailoring_file,
-                                       :tailoring_file_profile => @scap_profile)
+                                       :tailoring_file_profile => @scap_profile,
+                                       :deploy_by => 'manual')
     refute p.valid?
     p.tailoring_file_profile = tailoring_profile
     assert p.save
@@ -191,7 +196,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :scap_content_id => @scap_content.id,
                                     :scap_content_profile_id => @scap_profile.id,
                                     :period => 'monthly',
-                                    :day_of_month => '5')
+                                    :day_of_month => '5',
+                                    :deploy_by => 'manual')
     assert_equal 6, p.to_enc['download_path'].split('/').length
     assert_equal @scap_content.digest, p.to_enc['download_path'].split('/').last
   end
@@ -204,7 +210,8 @@ class PolicyTest < ActiveSupport::TestCase
                                     :tailoring_file => tailoring_file,
                                     :tailoring_file_profile => @tailoring_profile,
                                     :period => 'monthly',
-                                    :day_of_month => '5')
+                                    :day_of_month => '5',
+                                    :deploy_by => 'manual')
     assert_equal 6, p.to_enc['tailoring_download_path'].split('/').length
     assert_equal tailoring_file.digest, p.to_enc['tailoring_download_path'].split('/').last
   end
@@ -215,13 +222,15 @@ class PolicyTest < ActiveSupport::TestCase
                                        :scap_content_id => @scap_content.id,
                                        :scap_content_profile_id => @scap_profile.id,
                                        :period => 'monthly',
-                                       :day_of_month => '5')
+                                       :day_of_month => '5',
+                                       :deploy_by => 'manual')
     assert p.valid?
     q = ForemanOpenscap::Policy.create(:name => "invalid_profile_policy",
                                        :scap_content_id => scap_content_2.id,
                                        :scap_content_profile_id => @scap_profile.id,
                                        :period => 'monthly',
-                                       :day_of_month => '5')
+                                       :day_of_month => '5',
+                                       :deploy_by => 'manual')
     refute q.valid?
     assert_equal "does not have the selected SCAP content profile", q.errors.messages[:scap_content_id].first
   end

data/test/unit/services/config_name_service_test.rb

@@ -0,0 +1,39 @@
+require 'test_plugin_helper'
+
+class ConfigNameServiceTest < ActiveSupport::TestCase
+  setup do
+    @name_service = ForemanOpenscap::ConfigNameService.new
+  end
+
+  test 'should find config for Puppet' do
+    assert @name_service.config_for(:puppet).is_a?(ForemanOpenscap::ClientConfig::Puppet)
+  end
+
+  test 'should find config for Ansible' do
+    assert @name_service.config_for(:ansible).is_a?(ForemanOpenscap::ClientConfig::Ansible)
+  end
+
+  test 'should find config for Manual' do
+    assert @name_service.config_for(:manual).is_a?(ForemanOpenscap::ClientConfig::Manual)
+  end
+
+  test 'should find all except Manual' do
+    configs = @name_service.all_except(:manual)
+    assert_equal 2, configs.size
+    refute configs.map(&:type).include?(:manual)
+  end
+
+  test 'should find all available except Manual' do
+    ForemanOpenscap::ClientConfig::Ansible.any_instance.stubs(:available?).returns(false)
+    configs = @name_service.all_available_except(:manual)
+    assert_equal 1, configs.size
+    assert_equal :puppet, configs.first.type
+  end
+
+  test 'should find all available with overrides except Puppet' do
+    ForemanOpenscap::ClientConfig::Ansible.any_instance.stubs(:available?).returns(true)
+    configs = @name_service.all_available_with_overrides_except(:puppet)
+    assert_equal 1, configs.size
+    assert_equal :ansible, configs.first.type
+  end
+end

data/test/unit/services/hostgroup_overrider_test.rb

@@ -0,0 +1,78 @@
+require 'test_plugin_helper'
+
+class HostgroupOverriderTest < ActiveSupport::TestCase
+  setup do
+    ForemanOpenscap::ScapContent.any_instance.stubs(:fetch_profiles).returns({ 'test_profile_key' => 'test_profile_title' })
+
+    @scap_content = FactoryBot.create(:scap_content)
+    @scap_profile = FactoryBot.create(:scap_content_profile, :scap_content => @scap_content)
+  end
+
+  test 'should populate puppet overrides' do
+    puppet_class, env, port_param, server_param = setup_puppet_class.values_at :puppet_class, :env, :port_param, :server_param
+
+    proxy = FactoryBot.create(:openscap_proxy, :url => 'https://override-keys.example.com:8998')
+
+    hostgroup = FactoryBot.create(:hostgroup, :environment_id => env.id, :openscap_proxy_id => proxy.id)
+    refute hostgroup.puppetclasses.include? puppet_class
+    assert LookupValue.where(:match => "hostgroup=#{hostgroup.to_label}",
+                             :lookup_key_id => port_param.id,
+                             :value => '8998').empty?
+    assert LookupValue.where(:match => "hostgroup=#{hostgroup.to_label}",
+                             :lookup_key_id => server_param.id,
+                             :value => 'override-keys.example.com').empty?
+
+    port_param.override = true
+    port_param.save
+    server_param.override = true
+    server_param.save
+    hostgroup.puppetclasses << puppet_class
+    policy = FactoryBot.build(:policy, :scap_content => @scap_content,
+                                       :scap_content_profile => @scap_profile,
+                                       :deploy_by => 'puppet',
+                                       :hostgroup_ids => [hostgroup.id])
+    policy.save
+    refute LookupValue.where(:match => "hostgroup=#{hostgroup.to_label}",
+                             :lookup_key_id => port_param.id,
+                             :value => 8998).empty?
+    refute LookupValue.where(:match => "hostgroup=#{hostgroup.to_label}",
+                             :lookup_key_id => server_param.id,
+                             :value => 'override-keys.example.com').empty?
+  end
+
+  test "should return when policy has blank deploy_by" do
+    policy = FactoryBot.build(:policy, :scap_content => @scap_content,
+                                       :scap_content_profile => @scap_profile)
+    overrider = ForemanOpenscap::HostgroupOverrider.new(policy)
+    overrider.expects(:populate_overrides).never
+    overrider.populate
+  end
+
+  test "should return when deploy_by type is not supported" do
+    policy = FactoryBot.build(:policy, :scap_content => @scap_content,
+                                       :scap_content_profile => @scap_profile,
+                                       :deploy_by => 'salt')
+    overrider = ForemanOpenscap::HostgroupOverrider.new(policy)
+    overrider.expects(:populate_overrides).never
+    overrider.populate
+  end
+
+  test "should return when deployment type is not available" do
+    ForemanOpenscap::ClientConfig::Ansible.any_instance.stubs(:available?).returns(false)
+    policy = FactoryBot.build(:policy, :scap_content => @scap_content,
+                                       :scap_content_profile => @scap_profile,
+                                       :deploy_by => 'ansible')
+    overrider = ForemanOpenscap::HostgroupOverrider.new(policy)
+    overrider.expects(:populate_overrides).never
+    overrider.populate
+  end
+
+  test "should return when config has unmanaged overrides" do
+    policy = FactoryBot.build(:policy, :scap_content => @scap_content,
+                                       :scap_content_profile => @scap_profile,
+                                       :deploy_by => 'manual')
+    overrider = ForemanOpenscap::HostgroupOverrider.new(policy)
+    overrider.expects(:populate_overrides).never
+    overrider.populate
+  end
+end

data/test/unit/services/lookup_key_overrider_test.rb

@@ -0,0 +1,52 @@
+require 'test_plugin_helper'
+
+class LookupKeyOverriderTest < ActiveSupport::TestCase
+  setup do
+    ForemanOpenscap::ScapContent.any_instance.stubs(:fetch_profiles).returns({ 'test_profile_key' => 'test_profile_title' })
+    @scap_content = FactoryBot.create(:scap_content)
+    @scap_profile = FactoryBot.create(:scap_content_profile, :scap_content => @scap_content)
+  end
+
+  test 'should override puppet class parameters' do
+    server_param, port_param, policies_param = setup_puppet_class.values_at :server_param, :port_param, :policies_param
+    refute server_param.override
+    refute port_param.override
+    refute policies_param.override
+    policy = FactoryBot.create(:policy, :scap_content => @scap_content, :scap_content_profile => @scap_content_profile, :deploy_by => :puppet)
+    ForemanOpenscap::LookupKeyOverrider.new(policy).override
+    assert server_param.reload.override
+    assert port_param.reload.override
+    assert policies_param.reload.override
+    assert_equal '<%= @host.policies_enc %>', policies_param.default_value
+  end
+
+  test 'should add error when no puppet class found' do
+    puppet_class = Puppetclass.find_by :name => ForemanOpenscap::ClientConfig::Puppet.new.puppetclass_name
+    puppet_class.destroy if puppet_class
+    policy = FactoryBot.create(:policy, :scap_content => @scap_content, :scap_content_profile => @scap_content_profile, :deploy_by => :puppet)
+    ForemanOpenscap::LookupKeyOverrider.new(policy).override
+    assert_equal ["Required Puppet class foreman_scap_client was not found, please ensure it is imported first."], policy.errors[:base]
+  end
+
+  test 'should add error when deployment type is not available' do
+    ForemanOpenscap::ClientConfig::Ansible.any_instance.stubs(:available?).returns(false)
+    policy = FactoryBot.build(:policy, :scap_content => @scap_content,
+                                       :scap_content_profile => @scap_profile,
+                                       :deploy_by => 'ansible')
+    overrider = ForemanOpenscap::LookupKeyOverrider.new(policy)
+    overrider.expects(:override_required_params).never
+    overrider.override
+    assert_equal "Ansible was selected to deploy policy to clients, but Ansible is not available. Are you missing a plugin?",
+                 policy.errors[:deploy_by].first
+  end
+
+  test 'should add error when lookup keys not present' do
+    server_param, port_param, policies_param = setup_puppet_class.values_at :server_param, :port_param, :policies_param
+    server_param.destroy
+    port_param.destroy
+    policy = FactoryBot.create(:policy, :scap_content => @scap_content, :scap_content_profile => @scap_content_profile, :deploy_by => :puppet)
+    ForemanOpenscap::LookupKeyOverrider.new(policy).override
+    err = "The following Smart Class Parameters were missing for foreman_scap_client: port, server. Make sure they are imported before proceeding."
+    assert_equal err, policy.errors[:base].first
+  end
+end