foreman_host_extra_validator 0.0.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8eeec4fa6fadb2f03e751ad816c36fbdf8477f90
-  data.tar.gz: 29490772cacbbe78288e887b8943a3b9138f0846
+SHA256:
+  metadata.gz: 2cd1faf2a634cac57b3603ab51bed47ca72cd9da17ed55d7497d9d108030b61e
+  data.tar.gz: a4802142256b0e139ebc923b1d6615735f40aae117d3968cc0f2ac04bacf5441
 SHA512:
-  metadata.gz: 224a52d469474305ea6450d0fffc79853ce3c5b5a3e9ea2793c534e2295b8eaf7c4d744a815ca864c55792fa4bd15452143343f312fc012117b9743bfa571e66
-  data.tar.gz: 532bd3b18dcc198903aaf5b798b4db106ec6a34a5de1b846098c40065e0e12a3494e4f10f13337dd0f5866afbde82d32e66fcecd7e4cb6a76de45f1be0a27b4e
+  metadata.gz: b092cf27e78b4e20ef904026148bda130ab76b05d2d944581ade639c34e939009ffc38d8796971803b863311f123511c8c7787a69f4ce73435e9dc0bdccb439e
+  data.tar.gz: e3fa88d65f80b9885e4c3209c0b29c28c5642d36c5ecb28958c6c812555bea96bfa7dc1fd70668247411b2faae3bb02d61f212a1db450bf34bcff155894b070a

data/Rakefile

@@ -20,7 +20,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 

data/app/models/concerns/foreman_host_extra_validator/host_extensions.rb

@@ -6,12 +6,14 @@ module ForemanHostExtraValidator
     end
 
     def validate_name_by_regex
-      return unless validate_name_regex
+      return unless validate_name_regex.present?
       errors.add(:name, _('must match regex /%s/') % validate_name_regex) unless shortname =~ /#{validate_name_regex}/
     end
 
+    private
+
     def validate_name_regex
-      host_inherited_params['host_name_validation_regex'] || Setting[:host_name_validation_regex]
+      inherited_params_hash.dig('host_name_validation_regex', :value) || Setting[:host_name_validation_regex]
     end
   end
 end

data/db/migrate/20220923181701_fix_extra_validation_settings_category_to_dsl.rb

@@ -0,0 +1,5 @@
+class FixExtraValidationSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  def up
+    Setting.where(category: 'Setting::ForemanHostExtraValidator').update_all(category: 'Setting')
+  end
+end

data/lib/foreman_host_extra_validator/engine.rb

@@ -4,29 +4,30 @@ module ForemanHostExtraValidator
 
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
 
-    initializer 'foreman_host_extra_validator.load_default_settings', :before => :load_config_initializers do |_app|
-      require_dependency File.expand_path('../../../app/models/setting/foreman_host_extra_validator.rb', __FILE__) if begin
-                                                                                                                         Setting.table_exists?
-                                                                                                                       rescue
-                                                                                                                         (false)
-                                                                                                                       end
-    end
-
     initializer 'foreman_host_extra_validator.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_host_extra_validator do
+        requires_foreman '>= 3.0.0'
+
+        settings do
+          category(:host_extra_validator, N_('Host Extra Validator')) do
+            setting('host_name_validation_regex',
+                    description:  N_('Default regex the name of a host is validated against'),
+                    type: :string,
+                    default: '^[a-zA-Z0-9\-_]+$',
+                    full_name: N_('Regular expresssion'))
+          end
+        end
       end
     end
 
     config.to_prepare do
-      begin
-        Host::Managed.send(:include, ForemanHostExtraValidator::HostExtensions)
-      rescue => e
-        Rails.logger.warn "ForemanPluginTemplate: skipping engine hook (#{e})\n#{e.backtrace}"
-      end
+      Host::Managed.include ForemanHostExtraValidator::HostExtensions
+    rescue => e
+      Rails.logger.warn "ForemanHostExtraValidator: skipping engine hook (#{e})\n#{e.backtrace}"
     end
 
     initializer 'foreman_host_extra_validator.register_gettext', after: :load_config_initializers do |_app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_host_extra_validator'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end

data/lib/foreman_host_extra_validator/version.rb

@@ -1,3 +1,3 @@
 module ForemanHostExtraValidator
-  VERSION = '0.0.4'
+  VERSION = '0.2.0'
 end

data/locale/Makefile

@@ -6,7 +6,7 @@
 # make tx-update - download and merge translations from Transifex
 # make clean - clean everything
 #
-DOMAIN = foreman_plugin_template
+DOMAIN = foreman_host_extra_validator
 VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
 POTFILE = $(DOMAIN).pot
 MOFILE = $(DOMAIN).mo

data/locale/gemspec.rb

@@ -1,2 +1,2 @@
-# Matches foreman_plugin_template.gemspec
+# Matches foreman_host_extra_validator.gemspec
 _('This plugin adds extra validations to a host.')

data/test/unit/foreman_host_extra_validator_test.rb

@@ -1,31 +1,42 @@
 require 'test_plugin_helper'
 
-class ForemanPluginTemplateTest < ActiveSupport::TestCase
+class ForemanHostExtraValidatorTest < ActiveSupport::TestCase
   setup do
-    Setting::HostValidation.load_defaults
+    Setting::ForemanHostExtraValidator.load_defaults
     disable_orchestration
-    User.current = User.find_by_login 'admin'
+    User.current = FactoryBot.build(:user, :admin)
   end
 
-  test '#validate_name_regex should return regex from setting when no regex is inherited' do
-    regex = '^[0-9]+$'
-    Setting[:host_name_validation_regex] = regex
-    host = FactoryGirl.build(:host, :managed)
-    assert_equal regex, host.validate_name_regex
-  end
+  context 'with validation regex' do
+    setup do
+      Setting[:host_name_validation_regex] = '^[0-9]+$'
+      @host = FactoryBot.build(:host)
+    end
 
-  test 'host should validate when host name matches regex' do
-    regex = '^[0-9]+$'
-    Setting[:host_name_validation_regex] = regex
-    host = Host.new name: '054354'
-    assert host.valid?
-  end
+    test 'host should validate from settings' do
+      @host.name = '054354'
+      assert_valid @host
+    end
+
+    test 'host should not validate when host name does not match regex' do
+      @host.name = 'invalidhostname'
+      refute_valid @host
+      assert_includes @host.errors[:name], "must match regex /#{Setting[:host_name_validation_regex]}/"
+    end
+
+    test 'host should validate from hostgroup parameter' do
+      hostgroup = FactoryBot.create(:hostgroup)
+      @host.hostgroup = hostgroup
+      FactoryBot.create(:hostgroup_parameter, :name => 'host_name_validation_regex', :value => '^[a-z]+$', :hostgroup => hostgroup)
+
+      assert_equal '^[a-z]+$', @host.send(:validate_name_regex)
+      @host.hostname = 'abcdef'
+      assert_valid @host
+
+      @host.hostname = '1234'
+      refute_valid @host
+      assert_includes @host.errors[:name], "must match regex /^[a-z]+$/"
+    end
 
-  test 'host should not validate when host name does not match regex' do
-    regex = '^[0-9]+$'
-    Setting[:host_name_validation_regex] = regex
-    host = Host.new name: 'invalidhostname'
-    refute host.valid?
-    assert_includes host.errors[:name], "must match regex /#{regex}/"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_host_extra_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Timo Goebel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -49,7 +49,7 @@ files:
 - README.md
 - Rakefile
 - app/models/concerns/foreman_host_extra_validator/host_extensions.rb
-- app/models/setting/foreman_host_extra_validator.rb
+- db/migrate/20220923181701_fix_extra_validation_settings_category_to_dsl.rb
 - lib/foreman_host_extra_validator.rb
 - lib/foreman_host_extra_validator/engine.rb
 - lib/foreman_host_extra_validator/version.rb
@@ -61,10 +61,11 @@ files:
 - locale/gemspec.rb
 - test/test_plugin_helper.rb
 - test/unit/foreman_host_extra_validator_test.rb
-homepage: https://github.com/FILIADATAGmbH/
-licenses: []
+homepage: https://github.com/theforeman/foreman_host_extra_validator
+licenses:
+- GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,12 +80,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: This plugin adds extra validations to a host.
 test_files:
 - test/test_plugin_helper.rb
 - test/unit/foreman_host_extra_validator_test.rb
-has_rdoc: 

data/app/models/setting/foreman_host_extra_validator.rb

@@ -1,16 +0,0 @@
-class Setting
-  class ForemanHostExtraValidator < ::Setting
-    def self.load_defaults
-      # Check the table exists
-      return unless super
-
-      self.transaction do
-        [
-          self.set('host_name_validation_regex', _('Default regex the name of a host is validated against'), '^[a-zA-Z0-9-_]+$')
-        ].compact.each { |s| self.create! s.update(:category => 'Setting::ForemanHostExtraValidator') }
-      end
-
-      true
-    end
-  end
-end