foreman_git_templates 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f37d8fd9a09c475e1e544c46d1d17d52b928d1dbdb8f37a77c83e4e45aafb026
-  data.tar.gz: 4dca8880532ee1fcd6d5b28d45896bd922505841e68af7945e2115f3b51de16a
+  metadata.gz: ef1542116b039a0e33811e4eaa3c65b3c05da618735f47f9f30fe5dd9b243599
+  data.tar.gz: fbbd7adb1894aac45862a92653cc2e84667a1ea14a19c2a1e17ab44d882e6358
 SHA512:
-  metadata.gz: 403f6ec203c8d2f1a9267249f9107d3323ec24c0e68a23420ec8f89b3a6d75fb091d25931fc2de6785b3b635c91ac97a6d48435a4678ff799f0968dee598e51f
-  data.tar.gz: e13f00738e2878f7f7f102e9b5d4df745e3b54caa3aba7afe1c82b9ebd297415b4c5f9b634ddb0cb6b9764737acf60d76951d58f77aec261fa1eb76e86466397
+  metadata.gz: 3ba5ffceb6a9049d268589824b73bcf9c1d135d05db12242e08473abe3a2aa47fe4aa21129baf27e646e42d1ce7cddad8d7272b23d173c8a3bb82a75d64dec43
+  data.tar.gz: 9539d07fd4eee73f05d467a5a5f3e2b83d3ff34337b155a96913c53cc69006b25840010d07df79b90ae2f0d219a986e341d094bc4c06b3b80b89525d28938fab

data/README.md

@@ -44,6 +44,14 @@ From now the template content for this host will be fetched from the repository.
 - `There was an error rendering the provision template: Cannot read <template> from repository`
   - check if there is requested template in the repository
 
+### Gitlab Repository Integration
+
+If you want to use a private repository hosted on a Gitlab instance to store your Foreman templates, you can use [Gitlab's repositories API](https://docs.gitlab.com/ee/api/repositories.html#get-file-archive) to construct the `template_url` parameter in Foreman. Create a dedicated Foreman user in Gitlab and set up a Personal Access Token that you can use in the `template_url`.
+
+```
+https://gitlab.example.com/api/v4/projects/${GITLAB_PROJECT_ID}/repository/archive.tar.gz?sha=${GITLAB_BRANCH_NAME}&private_token=${PERSONAL_ACCESS_TOKEN}
+```
+
 ## Contributing
 
 Fork and send a Pull Request. Thanks!

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module UnattendedControllerExtensions
+    extend ActiveSupport::Concern
+
+    module Overrides
+      def render_local_boot_template
+        return super unless @host&.repository_path
+
+        return unless verify_found_host
+
+        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'))
+      end
+    end
+
+    included do
+      prepend Overrides
+    end
+  end
+end

data/app/helpers/foreman_git_templates/application_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module ApplicationHelper
+    extend ActiveSupport::Concern
+
+    module Overrides
+      def display_link_if_authorized(name, options = {}, html_options = {})
+        # rubocop:disable Rails/HelperInstanceVariable
+
+        return if @host&.repository_path && options[:use_route] == 'edit_provisioning_template'
+
+        # rubocop:enable Rails/HelperInstanceVariable
+
+        super
+      end
+    end
+
+    included do
+      prepend Overrides
+    end
+  end
+end

data/app/lib/foreman_git_templates/renderer.rb

@@ -2,14 +2,22 @@
 
 module ForemanGitTemplates
   module Renderer
-    def get_source(klass: Foreman::Renderer::Source::Database, template:, **args)
+    REPOSITORY_SOURCE_CLASS = ForemanGitTemplates::Renderer::Source::Repository
+
+    # rubocop:disable Metrics/PerceivedComplexity
+    def get_source(klass: nil, template:, **args)
+      return super if klass && klass != REPOSITORY_SOURCE_CLASS
+
       repository_path = repository_path(args[:host])
       if repository_path
-        ForemanGitTemplates::Renderer::Source::Repository.new(template, 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_extensions.rb

@@ -2,10 +2,35 @@
 
 module ForemanGitTemplates
   module HostExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      validates_associated :host_parameters
+    end
+
+    def repository_klass
+      build? ? MainRepositoryTemplate : DefaultLocalBootRepositoryTemplate
+    end
+
     def repository_path
-      return unless host_params['template_url']
+      return unless git_template_url
+
+      git_template_tmpfile&.path
+    end
+
+    private
+
+    def git_template_url
+      @git_template_url ||= host_params['template_url']
+    end
+
+    def git_template_tmpfile
+      return unless git_template_url
 
-      @repository_path ||= RepositoryFetcher.call(host_params['template_url'])
+      @git_template_tmpfile ||= RepositoryFetcher.call(git_template_url)
+    rescue ::ForemanGitTemplates::RepositoryFetcher::RepositoryFetcherError => e
+      Foreman::Logging.exception("GitTemplates: Failed to fetch data from #{git_template_url}", e)
+      nil
     end
   end
 end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ForemanGitTemplates
+  module HostParameterExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      validate :template_url_is_reachable, if: ->(p) { p.name == 'template_url' }
+    end
+
+    private
+
+    def template_url_is_reachable
+      RestClient::Request.execute(method: :head, url: value, timeout: Setting::GitTemplates['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 })
+    end
+  end
+end

data/app/models/concerns/foreman_git_templates/hostext/operating_system.rb

@@ -9,7 +9,7 @@ module ForemanGitTemplates
         def provisioning_template(opts = {})
           return super unless repository_path
 
-          kind = opts[:kind] || 'provision'
+          kind = opts[:kind].to_s || 'provision'
           available_template_kinds.find { |template| template.name == kind }
         end
 
@@ -17,8 +17,8 @@ module ForemanGitTemplates
           return super unless repository_path
 
           @available_template_kinds ||= template_kinds(provisioning).map do |kind|
-            MainRepositoryTemplate.new(name: kind.name).tap do |template|
-              RepositoryReader.call(repository_path, template.path)
+            repository_klass.new(name: kind.name).tap do |t|
+              t.template = RepositoryReader.call(repository_path, t.path)
             end
           rescue RepositoryReader::FileUnreadableError # file is missing or empty
             next

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

@@ -9,16 +9,26 @@ module ForemanGitTemplates
         delegate :render_template, to: :host
 
         def generate_pxe_template(kind)
-          return super unless host.repository_path
+          return super unless host.params['template_url']
 
-          template_klass = build? ? MainRepositoryTemplate : DefaultLocalBootRepositoryTemplate
-          template = template_klass.new(name: kind)
+          template = host.repository_klass.new(name: kind)
           render_template(template: template)
-        rescue ForemanGitTemplates::RepositoryReader::MissingFileError => e
-          # re-raise the exception if we have a main template defined for this type
-          raise e if host.available_template_kinds.map(&:name).include?(kind)
+        rescue ForemanGitTemplates::RepositoryReader::MissingFileError
           nil
         end
+
+        private
+
+        def validate_tftp
+          return super unless host.params['template_url']
+          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'] }
+        end
       end
 
       included do

data/app/models/setting/git_templates.rb

@@ -0,0 +1,26 @@
+# 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

data/app/services/foreman_git_templates/repository_fetcher.rb

@@ -9,7 +9,7 @@ module ForemanGitTemplates
     end
 
     def call
-      Down.download(repository_url).path
+      Down.download(repository_url)
     rescue Down::ResponseError => e
       raise RepositoryFetcherError, "Cannot fetch repository from #{repository_url}. Response code: #{e.response.code}"
     rescue Down::Error => e

data/app/services/foreman_git_templates/repository_reader.rb

@@ -9,6 +9,7 @@ module ForemanGitTemplates
 
     def call
       raise MissingFileError, "The #{file} file is missing" if content.nil?
+
       content
     end
 
@@ -30,13 +31,15 @@ module ForemanGitTemplates
       @content ||= Tar.untar(repository_path) do |tar|
         return tar.each do |entry|
           next unless entry.file? && entry.full_name.end_with?(file)
+
           break entry.read.tap do |entry_content|
             raise EmptyFileError, "The #{file} file is empty" if entry_content.nil?
           end
         end
       end
-    rescue Errno::ENOENT
-      raise RepositoryUnreadableError, "Cannot read repository from #{repository_path}"
+    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 }
     end
   end
 end

data/lib/foreman_git_templates/engine.rb

@@ -6,6 +6,15 @@ module ForemanGitTemplates
 
     config.autoload_paths += Dir["#{config.root}/app/lib"]
     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
+    end
 
     initializer 'foreman_git_templates.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_git_templates do
@@ -18,7 +27,10 @@ module ForemanGitTemplates
       Foreman::Renderer.singleton_class.prepend(ForemanGitTemplates::Renderer)
       Host::Managed.include(ForemanGitTemplates::Hostext::OperatingSystem)
       Host::Managed.include(ForemanGitTemplates::HostExtensions)
+      HostParameter.include(ForemanGitTemplates::HostParameterExtensions)
       Nic::Managed.include(ForemanGitTemplates::Orchestration::TFTP)
+      UnattendedController.include(ForemanGitTemplates::UnattendedControllerExtensions)
+      ::ApplicationHelper.include(ForemanGitTemplates::ApplicationHelper)
     rescue StandardError => e
       Rails.logger.warn "ForemanGitTemplates: skipping engine hook (#{e})"
     end

data/lib/foreman_git_templates/version.rb

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

data/lib/tasks/foreman_git_templates_tasks.rake

@@ -2,46 +2,19 @@
 
 require 'rake/testtask'
 
-# Tasks
-namespace :foreman_git_templates do
-  namespace :example do
-    desc 'Example Task'
-    task task: :environment do
-      # Task goes here
-    end
-  end
-end
-
 # Tests
 namespace :test do
   desc 'Test ForemanGitTemplates'
   Rake::TestTask.new(:foreman_git_templates) do |t|
-    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    test_dir = File.join(ForemanGitTemplates::Engine.root, 'test')
     t.libs << ['test', test_dir]
-    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.pattern = File.join(test_dir, '**', '*_test.rb')
     t.verbose = true
     t.warning = false
   end
 end
 
-namespace :foreman_git_templates do
-  task :rubocop do
-    begin
-      require 'rubocop/rake_task'
-      RuboCop::RakeTask.new(:rubocop_foreman_git_templates) do |task|
-        task.patterns = ["#{ForemanGitTemplates::Engine.root}/app/**/*.rb",
-                         "#{ForemanGitTemplates::Engine.root}/lib/**/*.rb",
-                         "#{ForemanGitTemplates::Engine.root}/test/**/*.rb"]
-      end
-    rescue StandardError
-      puts 'Rubocop not loaded.'
-    end
-
-    Rake::Task['rubocop_foreman_git_templates'].invoke
-  end
-end
-
 Rake::Task[:test].enhance ['test:foreman_git_templates']
 
 load 'tasks/jenkins.rake'
-Rake::Task['jenkins:unit'].enhance ['test:foreman_git_templates', 'foreman_git_templates:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')
+Rake::Task['jenkins:unit'].enhance ['test:foreman_git_templates'] if Rake::Task.task_defined?(:'jenkins:unit')

data/test/controllers/hosts_controller_test.rb

@@ -3,7 +3,7 @@
 require 'test_plugin_helper'
 
 class HostsControllerTest < ActionController::TestCase
-  let(:host) { FactoryBot.create(:host, :managed, :with_template_url) }
+  let(:host) { FactoryBot.create(:host, :managed, :with_template_url, build: true) }
 
   describe '#templates' do
     it 'returns only templates that are defined in the archive' do

data/test/controllers/unattended_controller_test.rb

@@ -3,9 +3,9 @@
 require 'test_plugin_helper'
 
 class UnattendedControllerTest < ActionController::TestCase
-  let(:os) { FactoryBot.create(:operatingsystem, :with_archs, :with_ptables, type: 'Redhat') }
+  let(:os) { FactoryBot.create(:operatingsystem, :with_associations, type: 'Redhat') }
   let(:host) do
-    FactoryBot.create(:host, :managed, :with_template_url, operatingsystem: os, ptable: os.ptables.first)
+    FactoryBot.create(:host, :managed, :with_template_url, build: true, operatingsystem: os, ptable: os.ptables.first)
   end
 
   test 'should render template from repository' do
@@ -68,4 +68,53 @@ class UnattendedControllerTest < ActionController::TestCase
       assert_equal 'foo bar', 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)
+    end
+
+    context 'host not in build mode' do
+      test 'should render iPXE local boot template from repository' do
+        assert_not_nil host.params['template_url']
+
+        Dir.mktmpdir do |dir|
+          kind = 'iPXE'
+
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, 5) { |io| io.write('local') }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, host.name.length) { |io| io.write(host.name) }
+          end
+
+          get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
+          assert_response :success
+          assert_equal 'local', response.body.strip
+        end
+      end
+    end
+
+    context 'host in build mode' do
+      setup do
+        host.update!(build: true)
+      end
+
+      test 'should render iPXE template from repository' do
+        host.reload
+        assert_not_nil host.params['template_url']
+
+        Dir.mktmpdir do |dir|
+          kind = 'iPXE'
+
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple("templates/#{kind}/default_local_boot.erb", 644, 5) { |io| io.write('local') }
+            tar.add_file_simple("templates/#{kind}/template.erb", 644, host.name.length) { |io| io.write(host.name) }
+          end
+
+          get :host_template, params: { kind: kind, hostname: host.name }, session: set_session_user
+          assert_response :success
+          assert_equal host.name, response.body.strip
+        end
+      end
+    end
+  end
 end

data/test/factories/foreman_git_templates_factories.rb

@@ -4,7 +4,9 @@ FactoryBot.modify do
   factory :host do
     trait :with_template_url do
       after(:create) do |host, _evaluator|
-        FactoryBot.create(:host_parameter, host: host, name: 'template_url', value: 'http://www.api.com/repository.tar.gz')
+        url = 'http://www.api.com/repository.tar.gz'
+        WebMock::API.stub_request(:head, url).to_return(status: 200)
+        FactoryBot.create(:host_parameter, host: host, name: 'template_url', value: url)
       end
     end
   end

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

@@ -4,7 +4,33 @@ require 'test_plugin_helper'
 
 module Hostext
   class OperatingSystemTest < ActiveSupport::TestCase
-    let(:host) { FactoryBot.create(:host, :managed, :with_template_url) }
+    let(:host) { FactoryBot.create(:host, :managed, :with_template_url, build: true) }
+
+    describe '#provisioning_template' do
+      it 'finds all PXELinux template kinds' do
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple('templates/PXELinux/template.erb', 644, host.name.length) { |io| io.write(host.name) }
+          end
+
+          actual = host.provisioning_template(kind: 'PXELinux')
+          assert_equal 'PXELinux', actual.name
+          assert_equal host.name, actual.template
+        end
+      end
+
+      it 'finds all PXELinux template kinds by symbol' do
+        Dir.mktmpdir do |dir|
+          stub_repository host.params['template_url'], "#{dir}/repo.tar.gz" do |tar|
+            tar.add_file_simple('templates/PXELinux/template.erb', 644, host.name.length) { |io| io.write(host.name) }
+          end
+
+          actual = host.provisioning_template(kind: :PXELinux)
+          assert_equal 'PXELinux', actual.name
+          assert_equal host.name, actual.template
+        end
+      end
+    end
 
     test 'available_template_kinds finds only templates that are defined in the repository' do
       Dir.mktmpdir do |dir|

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

@@ -15,10 +15,19 @@ 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) }
           end
 
-          assert_equal template_content, host.generate_pxe_template('PXELinux')
+          assert_equal template_content, host.generate_pxe_template(kind)
+        end
+      end
+
+      context 'when corresponding default local boot template file is missing in the repo' do
+        it 'does not generate a pxe template' do
+          Dir.mktmpdir do |dir|
+            stub_repository host.params['template_url'], "#{dir}/repo.tar.gz"
+
+            assert_nil host.generate_pxe_template(kind)
+          end
         end
       end
     end
@@ -29,41 +38,67 @@ 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}/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) }
           end
 
-          assert_equal default_local_boot_template_content, host.generate_pxe_template('PXELinux')
+          assert_equal default_local_boot_template_content, host.generate_pxe_template(kind)
         end
       end
 
-      it 'does not generate a pxe template if the corresponding template file is missing in the repo' do
+      context 'when corresponding default local boot template file is missing in the repo' do
+        it 'does not generate a pxe template' do
+          Dir.mktmpdir do |dir|
+            stub_repository host.params['template_url'], "#{dir}/repo.tar.gz"
+
+            assert_nil host.generate_pxe_template(kind)
+          end
+        end
+      end
+    end
+  end
+
+  describe '#validate_tftp' do
+    let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, build: false, pxe_loader: 'PXELinux BIOS') }
+    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.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) }
           end
 
-          assert_nil host.generate_pxe_template('PXEGrub2')
+          host.provision_interface.send(:validate_tftp)
+          assert_empty host.errors.messages
         end
       end
+    end
 
-      it 'raises an exception when generating a pxe template if the corresponding default local boot template file is missing in the repo' do
+    context 'host is not build mode' do
+      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) }
           end
 
-          assert_raises ForemanGitTemplates::RepositoryReader::MissingFileError do
-            host.generate_pxe_template('PXELinux')
-          end
+          host.provision_interface.send(:validate_tftp)
+          assert_empty host.errors.messages
         end
       end
     end
   end
 
   describe '#setTFTP' do
-    let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url) }
+    let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, pxe_loader: 'PXELinux BIOS') }
 
     let(:kind) { 'PXELinux' }
     let(:template_content) { 'main template content' }
@@ -71,6 +106,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.update(build: true)
       end
 

data/test/models/foreman_git_templates/host_parameter_test.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanGitTemplates
+  class HostParameterTest < ActiveSupport::TestCase
+    describe 'template_url validation' do
+      let(:template_url) { 'http://api.com/repo.tar.gz' }
+      let(:host) { FactoryBot.create(:host) }
+      let(:host_parameter) { FactoryBot.build(:host_parameter, name: 'template_url', value: template_url, host: host) }
+
+      context 'when template_url returns 200' do
+        it 'is valid' do
+          stub_request(:head, template_url).to_return(status: 200)
+
+          assert host_parameter.valid?
+        end
+      end
+
+      context 'when template_url returns 401' do
+        it 'is invlid' do
+          stub_request(:head, template_url).to_return(status: 401)
+
+          assert_equal false, host_parameter.valid?
+          assert_not_empty host_parameter.errors[:value]
+        end
+      end
+
+      context 'when template_url returns 404' do
+        it 'is invlid' do
+          stub_request(:head, template_url).to_return(status: 404)
+
+          assert_equal false, host_parameter.valid?
+          assert_not_empty host_parameter.errors[:value]
+        end
+      end
+
+      context 'when template_url returns 500' do
+        it 'is invlid' do
+          stub_request(:head, template_url).to_return(status: 500)
+
+          assert_equal false, host_parameter.valid?
+          assert_not_empty host_parameter.errors[:value]
+        end
+      end
+
+      context 'when template_url is not a valid URL' do
+        let(:template_url) { 'not URL value' }
+
+        it 'is invlid' do
+          assert_equal false, host_parameter.valid?
+          assert_not_empty host_parameter.errors[:value]
+        end
+      end
+    end
+  end
+end

data/test/models/foreman_git_templates/host_test.rb

@@ -6,11 +6,12 @@ module ForemanGitTemplates
   class HostTest < ActiveSupport::TestCase
     describe '#repository_path' do
       context 'with template_url parameter' do
-        let(:repo_path) { '/tmp/repo.tar.gz' }
+        let(:repo_tempfile) { Tempfile.new }
+        let(:repo_path) { repo_tempfile.path }
         let(:host) { FactoryBot.create(:host, :managed, :with_template_url) }
 
         it 'returns path to the repository' do
-          ForemanGitTemplates::RepositoryFetcher.expects(:call).once.with(host.params['template_url']).returns(repo_path)
+          ForemanGitTemplates::RepositoryFetcher.expects(:call).once.with(host.params['template_url']).returns(repo_tempfile)
           assert_equal repo_path, host.repository_path
         end
       end
@@ -24,5 +25,93 @@ module ForemanGitTemplates
         end
       end
     end
+
+    describe '#update' do
+      let(:os) { FactoryBot.create(:operatingsystem, :with_associations, type: 'Redhat') }
+
+      setup do
+        host.expects(:skip_orchestration_for_testing?).at_least_once.returns(false)
+      end
+
+      context 'with valid template_url' do
+        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
+        end
+
+        context 'when host is in build mode' do
+          let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: true) }
+
+          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) }
+              end
+
+              assert host.update(name: 'newname')
+              assert_empty host.errors.messages
+            end
+          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) }
+
+          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) }
+              end
+
+              assert host.update(name: 'newname')
+              assert_empty host.errors.messages
+            end
+          end
+        end
+      end
+
+      context 'with invalid template_url' do
+        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
+        end
+
+        let(:expected_errors) { ["No PXEGrub2 template was found for host #{host.name}. Repository url: #{host.params['template_url']}"] }
+
+        context 'when host is in build mode' do
+          let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, operatingsystem: os, build: true) }
+
+          it 'does not update the host' do
+            assert_equal false, 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) }
+
+          it 'does not update the host' do
+            assert_equal false, host.update(name: 'newname')
+            assert_equal expected_errors, host.errors[:base]
+            assert_equal expected_errors, host.errors[:'interfaces.base']
+          end
+        end
+      end
+    end
   end
 end

data/test/unit/foreman/renderer_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class RendererTest < ActiveSupport::TestCase
+  describe '.get_source' do
+    subject { Foreman::Renderer.get_source(template: template, host: host, klass: source_klass) }
+
+    let(:template) { FactoryBot.create(:provisioning_template) }
+
+    context 'when the host has a template_url defined' do
+      let(:host) { FactoryBot.create(:host, :with_template_url) }
+
+      context 'when the source class is not passed' do
+        let(:source_klass) { nil }
+
+        it 'uses ForemanGitTemplates::Renderer::Source::Repository' do
+          Dir.mktmpdir do |dir|
+            stub_repository host.params['template_url'], "#{dir}/repo.tar.gz"
+
+            assert_equal ForemanGitTemplates::Renderer::Source::Repository, subject.class
+          end
+        end
+      end
+
+      context 'when the source class is implicitly passed' do
+        let(:source_klass) { Foreman::Renderer::Source::Database }
+
+        it { assert_equal Foreman::Renderer::Source::Database, subject.class }
+      end
+    end
+
+    context 'when the host has no template_url defined' do
+      let(:host) { FactoryBot.create(:host) }
+      let(:source_klass) { nil }
+
+      it { assert_equal Foreman::Renderer::Source::Database, subject.class }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_git_templates
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - dmTECH GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -42,17 +56,31 @@ dependencies:
   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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
-description: 
+        version: '0'
+description:
 email:
 - opensource@dm.de
 executables: []
@@ -62,16 +90,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/controllers/concerns/foreman_git_templates/unattended_controller_extensions.rb
+- app/helpers/foreman_git_templates/application_helper.rb
 - app/lib/foreman_git_templates/renderer.rb
 - app/lib/foreman_git_templates/renderer/source/repository.rb
 - app/lib/foreman_git_templates/tar.rb
 - app/models/concerns/foreman_git_templates/host_extensions.rb
+- app/models/concerns/foreman_git_templates/host_parameter_extensions.rb
 - app/models/concerns/foreman_git_templates/hostext/operating_system.rb
 - app/models/concerns/foreman_git_templates/orchestration/tftp.rb
 - app/models/foreman_git_templates/base_repository_template.rb
 - 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
@@ -84,17 +116,19 @@ files:
 - 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/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/unit/foreman/renderer/source/repository_test.rb
+- test/unit/foreman/renderer_test.rb
 - test/unit/repository_fetcher_test.rb
 - test/unit/repository_reader_test.rb
 homepage: https://github.com/dm-drogeriemarkt/foreman_git_templates
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,17 +143,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+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/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