foreman_git_templates 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1542116b039a0e33811e4eaa3c65b3c05da618735f47f9f30fe5dd9b243599
-  data.tar.gz: fbbd7adb1894aac45862a92653cc2e84667a1ea14a19c2a1e17ab44d882e6358
+  metadata.gz: a94d6d6381bf398d3f036ca2fb9fed20c9868140ab53e116d76805e0bee2d30b
+  data.tar.gz: 0b7a8fd7ae5d564da6be772161c8f7a4480102d5a950ac573560060eb44f08ea
 SHA512:
-  metadata.gz: 3ba5ffceb6a9049d268589824b73bcf9c1d135d05db12242e08473abe3a2aa47fe4aa21129baf27e646e42d1ce7cddad8d7272b23d173c8a3bb82a75d64dec43
-  data.tar.gz: 9539d07fd4eee73f05d467a5a5f3e2b83d3ff34337b155a96913c53cc69006b25840010d07df79b90ae2f0d219a986e341d094bc4c06b3b80b89525d28938fab
+  metadata.gz: cba39a64316baa32786d262f0e94aa173ef164c9325a69b9e698bd6b698ffa9d89bfe7a08353fa259cb044041586b04a112fd5c87acf47a9b838e5dd5903a6f6
+  data.tar.gz: e60a95dd0e3ab7da8cdba0752515eb6c324a909779363f492f0d16807fb2432d26f0562957d64ebd8b02ae115969e14ea9fc722ac680f09d0de5cdbd3f392e3a

data/README.md

@@ -9,6 +9,7 @@ This is a plugin for Foreman that adds support for using templates from Git repo
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
 | >= 1.20         | ~> 1.0         |
+| >= 3.9          | ~> 2.0         |
 
 ## Installation
 

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -20,7 +22,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
 
@@ -38,7 +40,7 @@ task default: :test
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
-rescue => _
+rescue StandardError
   puts 'Rubocop not loaded.'
 end
 

data/app/controllers/concerns/foreman_git_templates/unattended_controller_extensions.rb

@@ -13,7 +13,7 @@ module ForemanGitTemplates
         template = ForemanGitTemplates::DefaultLocalBootRepositoryTemplate.new(name: 'iPXE')
         safe_render(template)
       rescue ForemanGitTemplates::RepositoryReader::MissingFileError
-        render_ipxe_message(message: _('iPXE default local boot template not found in repository at templates/iPXE/default_local_boot.erb'))
+        render_ipxe_message(message: _('iPXE default local boot template not found in repository at templates/iPXE/default_local_boot.erb')) # rubocop:disable Layout/LineLength
       end
     end
 

data/app/lib/foreman_git_templates/renderer/source/repository.rb

@@ -5,7 +5,7 @@ module ForemanGitTemplates
     module Source
       class Repository < Foreman::Renderer::Source::Base
         def initialize(template, repository_path)
-          @template = template
+          super(template)
           @repository_path = repository_path
         end
 
@@ -20,6 +20,7 @@ module ForemanGitTemplates
         private
 
         attr_reader :repository_path
+
         delegate :path, to: :template, prefix: true
       end
     end

data/app/lib/foreman_git_templates/renderer.rb

@@ -4,20 +4,16 @@ module ForemanGitTemplates
   module Renderer
     REPOSITORY_SOURCE_CLASS = ForemanGitTemplates::Renderer::Source::Repository
 
-    # rubocop:disable Metrics/PerceivedComplexity
-    def get_source(klass: nil, template:, **args)
+    def get_source(template:, klass: nil, **args)
       return super if klass && klass != REPOSITORY_SOURCE_CLASS
 
       repository_path = repository_path(args[:host])
       if repository_path
         REPOSITORY_SOURCE_CLASS.new(template, repository_path)
-      elsif !repository_path && Gem::Version.new(SETTINGS[:version].version) < Gem::Version.new('1.23')
-        super(klass: klass || Foreman::Renderer::Source::Database, template: template, **args)
       else
         super
       end
     end
-    # rubocop:enable Metrics/PerceivedComplexity
 
     private
 

data/app/models/concerns/foreman_git_templates/host_parameter_extensions.rb

@@ -11,9 +11,9 @@ module ForemanGitTemplates
     private
 
     def template_url_is_reachable
-      RestClient::Request.execute(method: :head, url: value, timeout: Setting::GitTemplates['template_url_validation_timeout'])
+      RestClient::Request.execute(method: :head, url: value, timeout: Setting['template_url_validation_timeout'])
     rescue RestClient::ExceptionWithResponse, URI::InvalidURIError, SocketError => e
-      errors.add(:value, _('Cannot fetch templates from %{url}: %{error}') % { url: value, error: e.message })
+      errors.add(:value, format(_('Cannot fetch templates from %<url>s: %<error>s'), url: value, error: e.message))
     end
   end
 end

data/app/models/concerns/foreman_git_templates/orchestration/tftp.rb

@@ -19,15 +19,25 @@ module ForemanGitTemplates
 
         private
 
+        # rubocop:todo Metrics/AbcSize
         def validate_tftp
-          return super unless host.params['template_url']
+          return super unless feasible_for_git_template_rendering?
           return unless tftp? || tftp6?
           return unless host.operatingsystem
 
           pxe_kind = host.operatingsystem.pxe_loader_kind(host)
           return unless pxe_kind && host.provisioning_template(kind: pxe_kind).nil?
 
-          failure _('No %{kind} template was found for host %{host}. Repository url: %{url}') % { kind: pxe_kind, host: host.name, url: host.params['template_url'] }
+          failure format(_('No %<kind>s template was found for host %<host>s. Repository url: %<url>s'),
+            kind: pxe_kind, host: host.name, url: host.params['template_url'])
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def feasible_for_git_template_rendering?
+          return false unless host.is_a?(Host::Managed)
+          return false unless host.params['template_url']
+
+          true
         end
       end
 

data/app/services/foreman_git_templates/repository_fetcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'down'
+require 'rest-client'
 
 module ForemanGitTemplates
   class RepositoryFetcher
@@ -9,10 +9,10 @@ module ForemanGitTemplates
     end
 
     def call
-      Down.download(repository_url)
-    rescue Down::ResponseError => e
+      RestClient::Request.execute(method: :get, url: repository_url, raw_response: true).file
+    rescue RestClient::RequestFailed => e
       raise RepositoryFetcherError, "Cannot fetch repository from #{repository_url}. Response code: #{e.response.code}"
-    rescue Down::Error => e
+    rescue RestClient::Exception => e
       raise RepositoryFetcherError, "Cannot fetch repository from #{repository_url}, #{e.message}"
     end
 

data/app/services/foreman_git_templates/repository_reader.rb

@@ -27,6 +27,7 @@ module ForemanGitTemplates
 
     attr_reader :repository_path, :file
 
+    # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
     def content
       @content ||= Tar.untar(repository_path) do |tar|
         return tar.each do |entry|
@@ -39,7 +40,13 @@ module ForemanGitTemplates
       end
     rescue Errno::ENOENT, Zlib::GzipFile::Error => e
       Foreman::Logging.exception("GitTemplates: Cannot read repository from #{repository_path}", e)
-      raise RepositoryUnreadableError, _('Cannot read repository from %{repository_path}: %{error}') % { repository_path: repository_path, error: e.message }
+      raise RepositoryUnreadableError,
+        format(
+          _('Cannot read repository from %<repository_path>s: %<error>s'),
+          repository_path: repository_path,
+          error: e.message
+        )
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
   end
 end

data/db/migrate/20230203130941_fix_git_templates_settings_category_to_dsl.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class FixGitTemplatesSettingsCategoryToDsl < ActiveRecord::Migration[6.0]
+  class MigrationSettings < ActiveRecord::Base
+    self.table_name = :settings
+  end
+
+  def up
+    return unless column_exists?(:settings, :category)
+
+    MigrationSettings.where(category: 'Setting::GitTemplates').update_all(category: 'Setting')
+  end
+end

data/lib/foreman_git_templates/engine.rb

@@ -8,17 +8,24 @@ module ForemanGitTemplates
     config.autoload_paths += Dir["#{config.root}/app/services"]
     config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
 
-    initializer 'foreman_git_templates.load_default_settings', before: :load_config_initializers do
-      require_dependency File.expand_path('../../app/models/setting/git_templates.rb', __dir__) if begin
-                                                                                                     Setting.table_exists?
-                                                                                                   rescue StandardError
-                                                                                                     (false)
-                                                                                                   end
+    initializer 'foreman_git_templates.load_app_instance_data' do |app|
+      ForemanGitTemplates::Engine.paths['db/migrate'].existent.each do |path|
+        app.config.paths['db/migrate'] << path
+      end
     end
 
     initializer 'foreman_git_templates.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_git_templates do
-        requires_foreman '>= 1.20'
+        requires_foreman '>= 3.9'
+
+        settings do
+          category :git_templates, N_('Git Templates') do
+            setting :template_url_validation_timeout,
+              type: :integer,
+              default: 15,
+              description: _('Template URL validation timeout in seconds')
+          end
+        end
       end
     end
 

data/lib/foreman_git_templates/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanGitTemplates
-  VERSION = '1.0.5'
+  VERSION = '2.0.0'
 end

data/lib/tasks/foreman_git_templates_tasks.rake

@@ -15,6 +15,3 @@ namespace :test do
 end
 
 Rake::Task[:test].enhance ['test:foreman_git_templates']
-
-load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_git_templates'] if Rake::Task.task_defined?(:'jenkins:unit')

data/test/controllers/hosts_controller_test.rb

@@ -8,7 +8,7 @@ class HostsControllerTest < ActionController::TestCase
   describe '#templates' do
     it 'returns only templates that are defined in the archive' do
       Dir.mktmpdir do |dir|
-        expected_kinds = ['PXEGrub', 'PXELinux', 'iPXE', 'PXEGrub2', 'provision']
+        expected_kinds = %w[PXEGrub PXELinux iPXE PXEGrub2 provision]
 
         stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
           expected_kinds.each do |kind|

data/test/controllers/unattended_controller_test.rb

@@ -34,8 +34,12 @@ class UnattendedControllerTest < ActionController::TestCase
       template_content = "<%= snippet('#{snippet_name}', variables: { foo: 'bar' }) %>"
 
       stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-        tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
-        tar.add_file_simple("templates/snippets/#{snippet_name.downcase}.erb", 644, snippet_content.length) { |io| io.write(snippet_content) }
+        tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+          io.write(template_content)
+        end
+        tar.add_file_simple("templates/snippets/#{snippet_name.downcase}.erb", 644, snippet_content.length) do |io|
+          io.write(snippet_content)
+        end
       end
 
       get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
@@ -58,20 +62,34 @@ class UnattendedControllerTest < ActionController::TestCase
       template_content = "<%= snippet('#{snippet_name}', variables: { foo: 'foo' }) %>"
 
       stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-        tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
-        tar.add_file_simple("templates/snippets/#{snippet_name.downcase}.erb", 644, snippet_content.length) { |io| io.write(snippet_content) }
-        tar.add_file_simple("templates/snippets/#{nested_snippet_name.downcase}.erb", 644, nested_snippet_content.length) { |io| io.write(nested_snippet_content) }
+        tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+          io.write(template_content)
+        end
+        tar.add_file_simple("templates/snippets/#{snippet_name.downcase}.erb", 644, snippet_content.length) do |io|
+          io.write(snippet_content)
+        end
+        tar.add_file_simple("templates/snippets/#{nested_snippet_name.downcase}.erb", 644,
+          nested_snippet_content.length) do |io|
+          io.write(nested_snippet_content)
+        end
       end
 
       get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
       assert_response :success
-      assert_equal 'foo bar', response.body.strip
+      assert_equal 'foo foobar', response.body.strip
     end
   end
 
   describe 'iPXE templates' do
     let(:host) do
-      FactoryBot.create(:host, :managed, :with_template_url, build: false, operatingsystem: os, ptable: os.ptables.first)
+      FactoryBot.create(
+        :host,
+        :managed,
+        :with_template_url,
+        build: false,
+        operatingsystem: os,
+        ptable: os.ptables.first
+      )
     end
 
     context 'host not in build mode' do

data/test/models/concerns/foreman_git_templates/hostext/operating_system_test.rb

@@ -34,7 +34,7 @@ module Hostext
 
     test 'available_template_kinds finds only templates that are defined in the repository' do
       Dir.mktmpdir do |dir|
-        expected_kinds = ['PXEGrub', 'PXELinux', 'iPXE', 'PXEGrub2', 'provision']
+        expected_kinds = %w[PXEGrub PXELinux iPXE PXEGrub2 provision]
 
         stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
           expected_kinds.each do |kind|

data/test/models/concerns/foreman_git_templates/orchestration/tftp_test.rb

@@ -14,7 +14,9 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
       it 'renders main template' do
         Dir.mktmpdir do |dir|
           stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+              io.write(template_content)
+            end
           end
 
           assert_equal template_content, host.generate_pxe_template(kind)
@@ -38,7 +40,10 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
       it 'renders default local boot template' do
         Dir.mktmpdir do |dir|
           stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644,
+              default_local_boot_template_content.length) do |io|
+              io.write(default_local_boot_template_content)
+            end
           end
 
           assert_equal default_local_boot_template_content, host.generate_pxe_template(kind)
@@ -58,22 +63,29 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
   end
 
   describe '#validate_tftp' do
-    let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, build: false, pxe_loader: 'PXELinux BIOS') }
+    let(:host) do
+      FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, build: false, pxe_loader: 'PXELinux BIOS')
+    end
     let(:kind) { 'PXELinux' }
     let(:template_content) { 'main template content' }
     let(:default_local_boot_template_content) { 'default local boot template content' }
 
     context 'host is in build mode' do
       setup do
-        host.primary_interface.expects(:valid?).returns(true) if Gem::Version.new(SETTINGS[:version].notag) >= Gem::Version.new('2.0')
+        host.primary_interface.expects(:valid?).returns(true)
         host.update(build: true)
       end
 
       it 'validates that the host is ready for tftp' do
         Dir.mktmpdir do |dir|
           stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
-            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+              io.write(template_content)
+            end
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644,
+              default_local_boot_template_content.length) do |io|
+              io.write(default_local_boot_template_content)
+            end
           end
 
           host.provision_interface.send(:validate_tftp)
@@ -86,8 +98,13 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
       it 'validates that the host is ready for tftp' do
         Dir.mktmpdir do |dir|
           stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
-            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+              io.write(template_content)
+            end
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644,
+              default_local_boot_template_content.length) do |io|
+              io.write(default_local_boot_template_content)
+            end
           end
 
           host.provision_interface.send(:validate_tftp)
@@ -106,7 +123,7 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
 
     context 'host is in build mode' do
       setup do
-        host.primary_interface.expects(:valid?).returns(true) if Gem::Version.new(SETTINGS[:version].notag) >= Gem::Version.new('2.0')
+        host.primary_interface.expects(:valid?).returns(true)
         host.update(build: true)
       end
 
@@ -115,11 +132,17 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
 
         Dir.mktmpdir do |dir|
           stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
-            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+              io.write(template_content)
+            end
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644,
+              default_local_boot_template_content.length) do |io|
+              io.write(default_local_boot_template_content)
+            end
           end
 
-          ProxyAPI::TFTP.any_instance.expects(:set).with(kind, host.interfaces.first.mac, pxeconfig: template_content).once
+          ProxyAPI::TFTP.any_instance.expects(:set).with(kind, host.interfaces.first.mac,
+            pxeconfig: template_content).once
 
           host.provision_interface.send(:setTFTP, kind)
         end
@@ -136,11 +159,17 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
 
         Dir.mktmpdir do |dir|
           stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) { |io| io.write(template_content) }
-            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, default_local_boot_template_content.length) { |io| io.write(default_local_boot_template_content) }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, template_content.length) do |io|
+              io.write(template_content)
+            end
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644,
+              default_local_boot_template_content.length) do |io|
+              io.write(default_local_boot_template_content)
+            end
           end
 
-          ProxyAPI::TFTP.any_instance.expects(:set).with(kind, host.interfaces.first.mac, pxeconfig: default_local_boot_template_content).once
+          ProxyAPI::TFTP.any_instance.expects(:set).with(kind, host.interfaces.first.mac,
+            pxeconfig: default_local_boot_template_content).once
 
           host.provision_interface.send(:setTFTP, kind)
         end

data/test/models/foreman_git_templates/host_parameter_test.rb

@@ -21,7 +21,7 @@ module ForemanGitTemplates
         it 'is invlid' do
           stub_request(:head, template_url).to_return(status: 401)
 
-          assert_equal false, host_parameter.valid?
+          assert_not host_parameter.valid?
           assert_not_empty host_parameter.errors[:value]
         end
       end
@@ -30,7 +30,7 @@ module ForemanGitTemplates
         it 'is invlid' do
           stub_request(:head, template_url).to_return(status: 404)
 
-          assert_equal false, host_parameter.valid?
+          assert_not host_parameter.valid?
           assert_not_empty host_parameter.errors[:value]
         end
       end
@@ -39,7 +39,7 @@ module ForemanGitTemplates
         it 'is invlid' do
           stub_request(:head, template_url).to_return(status: 500)
 
-          assert_equal false, host_parameter.valid?
+          assert_not host_parameter.valid?
           assert_not_empty host_parameter.errors[:value]
         end
       end
@@ -48,7 +48,7 @@ module ForemanGitTemplates
         let(:template_url) { 'not URL value' }
 
         it 'is invlid' do
-          assert_equal false, host_parameter.valid?
+          assert_not host_parameter.valid?
           assert_not_empty host_parameter.errors[:value]
         end
       end

data/test/models/foreman_git_templates/host_test.rb

@@ -28,6 +28,17 @@ module ForemanGitTemplates
 
     describe '#update' do
       let(:os) { FactoryBot.create(:operatingsystem, :with_associations, type: 'Redhat') }
+      let(:fake_response) do
+        {
+          'name' => 'www.example.com',
+          'mac' => '00:11:22:33:44:55',
+          'ip' => '192.168.0.10',
+          'filename' => 'pxelinux.0',
+          'nextServer' => '1.2.3.4',
+          'hostname' => 'www.example.com',
+          'subnet' => '192.168.0.0/255.255.255.0',
+        }
+      end
 
       setup do
         host.expects(:skip_orchestration_for_testing?).at_least_once.returns(false)
@@ -37,24 +48,35 @@ module ForemanGitTemplates
         setup do
           ProxyAPI::TFTP.any_instance.expects(:set).returns(true)
 
-          if Gem::Version.new(SETTINGS[:version].notag) >= Gem::Version.new('2.0')
-            ProxyAPI::TFTP.any_instance.expects(:bootServer).returns('127.0.0.1')
-            ProxyAPI::DHCP.any_instance.expects(:set).returns(true)
-            ProxyAPI::DHCP.any_instance.expects(:record).with(host.subnet.network, host.dhcp_records.first.mac).returns(host.dhcp_records.first)
-            ProxyAPI::DHCP.any_instance.expects(:records_by_ip).with(host.subnet.network, host.provision_interface.ip).returns([host.dhcp_records.first])
-            ProxyAPI::DHCP.any_instance.expects(:delete).returns(true)
-          end
+          stub_request(:get, %r{https://.*:8443/tftp/serverName})
+            .to_return(status: 200, body: 'server.com')
+
+          stub_request(:get, %r{.+://.+/dhcp/[0-9.]{7,15}/mac/([0-9a-f]{2}:){5}[0-9a-f]{2}})
+            .to_return(status: 200, body: fake_rest_client_response(fake_response))
+
+          ProxyAPI::TFTP.any_instance.expects(:bootServer).returns('127.0.0.1').twice
+
+          ProxyAPI::DHCP.any_instance.expects(:records_by_ip).with(host.subnet.network,
+            host.provision_interface.ip).returns([host.dhcp_records.first])
+          ProxyAPI::DHCP.any_instance.expects(:delete).returns(true)
+          ProxyAPI::DHCP.any_instance.expects(:record).with(host.subnet.network,
+            host.dhcp_records.first.mac).returns(host.dhcp_records.first)
+          ProxyAPI::DHCP.any_instance.expects(:set).returns(true)
         end
 
         context 'when host is in build mode' do
-          let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: true) }
+          let(:host) do
+            FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: true)
+          end
 
           it 'updates the host' do
             ProxyAPI::TFTP.any_instance.expects(:fetch_boot_file).twice.returns(true)
 
             Dir.mktmpdir do |dir|
               stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-                tar.add_file_simple('templates/PXEGrub2/template.erb', 644, host.name.length) { |io| io.write(host.name) }
+                tar.add_file_simple('templates/PXEGrub2/template.erb', 644, host.name.length) do |io|
+                  io.write(host.name)
+                end
               end
 
               assert host.update(name: 'newname')
@@ -64,12 +86,16 @@ module ForemanGitTemplates
         end
 
         context 'when host is not in build mode' do
-          let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: false) }
+          let(:host) do
+            FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: false)
+          end
 
           it 'updates the host' do
             Dir.mktmpdir do |dir|
               stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
-                tar.add_file_simple('templates/PXEGrub2/default_local_boot.erb', 644, host.name.length) { |io| io.write(host.name) }
+                tar.add_file_simple('templates/PXEGrub2/default_local_boot.erb', 644, host.name.length) do |io|
+                  io.write(host.name)
+                end
               end
 
               assert host.update(name: 'newname')
@@ -83,30 +109,36 @@ module ForemanGitTemplates
         setup do
           stub_request(:get, host.params['template_url']).to_return(status: 404)
 
-          if Gem::Version.new(SETTINGS[:version].notag) >= Gem::Version.new('2.0')
-            ProxyAPI::TFTP.any_instance.expects(:bootServer).returns('127.0.0.1')
-            ProxyAPI::DHCP.any_instance.expects(:record).with(host.subnet.network, host.dhcp_records.first.mac).returns(host.dhcp_records.first)
-            ProxyAPI::DHCP.any_instance.expects(:records_by_ip).with(host.subnet.network, host.provision_interface.ip).returns([host.dhcp_records.first])
-          end
+          ProxyAPI::TFTP.any_instance.expects(:bootServer).returns('127.0.0.1').twice
+          ProxyAPI::DHCP.any_instance.expects(:record).with(host.subnet.network,
+            host.dhcp_records.first.mac).returns(host.dhcp_records.first)
+          ProxyAPI::DHCP.any_instance.expects(:records_by_ip).with(host.subnet.network,
+            host.provision_interface.ip).returns([host.dhcp_records.first])
         end
 
-        let(:expected_errors) { ["No PXEGrub2 template was found for host #{host.name}. Repository url: #{host.params['template_url']}"] }
+        let(:expected_errors) do
+          ["No PXEGrub2 template was found for host #{host.name}. Repository url: #{host.params['template_url']}"]
+        end
 
         context 'when host is in build mode' do
-          let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: true) }
+          let(:host) do
+            FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: true)
+          end
 
           it 'does not update the host' do
-            assert_equal false, host.update(name: 'newname')
+            assert_not host.update(name: 'newname')
             assert_equal expected_errors, host.errors[:base]
             assert_equal expected_errors, host.errors[:'interfaces.base']
           end
         end
 
         context 'when host is not in build mode' do
-          let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: false) }
+          let(:host) do
+            FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: false)
+          end
 
           it 'does not update the host' do
-            assert_equal false, host.update(name: 'newname')
+            assert_not host.update(name: 'newname')
             assert_equal expected_errors, host.errors[:base]
             assert_equal expected_errors, host.errors[:'interfaces.base']
           end

data/test/models/foreman_git_templates/snippet_repository_template_test.rb

@@ -4,7 +4,9 @@ require 'test_plugin_helper'
 
 module ForemanGitTemplates
   class SnippetRepositoryTest < ActiveSupport::TestCase
-    let(:snippet_repository_template) { ForemanGitTemplates::SnippetRepositoryTemplate.new(name: 'CoreOS provision Ignition') }
+    let(:snippet_repository_template) do
+      ForemanGitTemplates::SnippetRepositoryTemplate.new(name: 'CoreOS provision Ignition')
+    end
 
     test '#path downcases the filename and replaces spaces with underscores' do
       assert_equal 'templates/snippets/coreos_provision_ignition.erb', snippet_repository_template.path

data/test/unit/foreman/renderer/source/repository_test.rb

@@ -22,7 +22,7 @@ class RepositorySourceTest < ActiveSupport::TestCase
 
     test 'should return snippet template' do
       assert snippet.is_a?(ForemanGitTemplates::SnippetRepositoryTemplate)
-      assert snippet.respond_to?(:render)
+      assert_respond_to snippet, :render
       assert_equal snippet_name, snippet.name
     end
   end

data/test/unit/foreman_git_templates/access_permissions_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+require 'unit/shared/access_permissions_test_base'
+
+# Permissions are added in AccessPermissions with lists of controllers and
+# actions that they enable access to.  For non-admin users, we need to test
+# that there are permissions available that cover every controller action, else
+# it can't be delegated and this will lead to parts of the application that
+# aren't functional for non-admin users.
+#
+# In particular, it's important that actions for AJAX requests are added to
+# an appropriate permission so views using those requests function.
+class AccessPermissionsTest < ActiveSupport::TestCase
+  include AccessPermissionsTestBase
+
+  check_routes(ForemanGitTemplates::Engine.routes, [])
+end

data/test/unit/repository_fetcher_test.rb

@@ -29,7 +29,11 @@ class RepositoryFetcherTest < ActiveSupport::TestCase
   test 'should raise RepositoryFetcherError when url is incorrect' do
     url = 'incorrect_url'
 
-    msg = 'URL scheme needs to be http or https'
+    # "rest-client" normalizes a URL by adding a protocol if none is present
+    requested_url = "http://#{url}"
+    stub_request(:get, requested_url).to_return(status: 404)
+
+    msg = 'Response code: 404'
     assert_raises_with_message(ForemanGitTemplates::RepositoryFetcher::RepositoryFetcherError, msg) do
       ForemanGitTemplates::RepositoryFetcher.call(url)
     end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: foreman_git_templates
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - dmTECH GmbH
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2024-05-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: down
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.5'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
+  name: theforeman-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.2
 description:
 email:
 - opensource@dm.de
@@ -103,10 +75,10 @@ files:
 - app/models/foreman_git_templates/default_local_boot_repository_template.rb
 - app/models/foreman_git_templates/main_repository_template.rb
 - app/models/foreman_git_templates/snippet_repository_template.rb
-- app/models/setting/git_templates.rb
 - app/services/foreman_git_templates/repository_fetcher.rb
 - app/services/foreman_git_templates/repository_reader.rb
 - config/routes.rb
+- db/migrate/20230203130941_fix_git_templates_settings_category_to_dsl.rb
 - lib/foreman_git_templates.rb
 - lib/foreman_git_templates/engine.rb
 - lib/foreman_git_templates/version.rb
@@ -122,6 +94,7 @@ files:
 - test/test_plugin_helper.rb
 - test/unit/foreman/renderer/source/repository_test.rb
 - test/unit/foreman/renderer_test.rb
+- test/unit/foreman_git_templates/access_permissions_test.rb
 - test/unit/repository_fetcher_test.rb
 - test/unit/repository_reader_test.rb
 homepage: https://github.com/dm-drogeriemarkt/foreman_git_templates
@@ -136,28 +109,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Adds support for using templates from Git repositories
 test_files:
-- test/unit/repository_fetcher_test.rb
-- test/unit/foreman/renderer/source/repository_test.rb
-- test/unit/foreman/renderer_test.rb
-- test/unit/repository_reader_test.rb
-- test/models/foreman_git_templates/snippet_repository_template_test.rb
-- test/models/foreman_git_templates/host_test.rb
-- test/models/foreman_git_templates/host_parameter_test.rb
+- test/controllers/hosts_controller_test.rb
+- test/controllers/unattended_controller_test.rb
+- test/factories/foreman_git_templates_factories.rb
 - test/models/concerns/foreman_git_templates/hostext/operating_system_test.rb
 - test/models/concerns/foreman_git_templates/orchestration/tftp_test.rb
-- test/factories/foreman_git_templates_factories.rb
+- test/models/foreman_git_templates/host_parameter_test.rb
+- test/models/foreman_git_templates/host_test.rb
+- test/models/foreman_git_templates/snippet_repository_template_test.rb
 - test/test_plugin_helper.rb
-- test/controllers/unattended_controller_test.rb
-- test/controllers/hosts_controller_test.rb
+- test/unit/foreman/renderer/source/repository_test.rb
+- test/unit/foreman/renderer_test.rb
+- test/unit/foreman_git_templates/access_permissions_test.rb
+- test/unit/repository_fetcher_test.rb
+- test/unit/repository_reader_test.rb

data/app/models/setting/git_templates.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-class Setting
-  class GitTemplates < ::Setting
-    def self.default_settings
-      [
-        set('template_url_validation_timeout', N_('Template URL validation timeout in seconds'), 15, N_('Template URL validation timeout'))
-      ]
-    end
-
-    def self.load_defaults
-      # Check the table exists
-      return unless super
-
-      transaction do
-        default_settings.each { |s| create! s.update(category: 'Setting::GitTemplates') }
-      end
-
-      true
-    end
-
-    def self.humanized_category
-      N_('GitTemplates')
-    end
-  end
-end