foreman_git_templates 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0477f8453ecbee80aeacc47eca0a8d15e4dfab4c7416a342834682523fe8d620
-  data.tar.gz: 812f5d9a1d5aefce8dfd3fce7c89232c406381d5fcdf1220bf3b949f5efb2e25
+  metadata.gz: 77802b4e97100b9c7e7cec4969831e66935359298e010a978f1086523ff499a3
+  data.tar.gz: 9061fb7d4caec9a6713272116028489bd23fb10240234d2a791acf718019788d
 SHA512:
-  metadata.gz: 3802a1eb148d653a55052f10c87ac215ae044b1b0d883038a75e7c22834ec91df1c4d9ec1f4835e86fa3b68c9a77f89c2e707fa301a9984ae9eb00ae2d4fc531
-  data.tar.gz: 70bd0c85037c17da83cb239a6844d34ccb0fdbb1e4651ab0d6dc8928d7d246bd86dee234c280b97e764221cbde4888890e43047d5137aa9b9ae9f1e58cb1e8b3
+  metadata.gz: be061019f7d11d89d5f1cbb28b8b92c91e7866b9a4c3c3b2ea043c593be33d55038999c40bca88a01bfd7b26bc8ee664c1848955fac221efc999290a370a08d7
+  data.tar.gz: f9ee9ae528c9b6eb8892334aef83bedffda5067832b3b3e98cf9470343ba976fe47e2d7080c49e1d89709e425d9cdf218d9b26f700deb0125033889ab345305b

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

@@ -2,10 +2,20 @@
 
 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 git_template_url
 
-      git_template_tmpfile.path
+      git_template_tmpfile&.path
     end
 
     private
@@ -18,6 +28,9 @@ module ForemanGitTemplates
       return unless git_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

@@ -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_reader.rb

@@ -35,8 +35,9 @@ module ForemanGitTemplates
           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

@@ -8,6 +8,14 @@ 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
+    end
+
     initializer 'foreman_git_templates.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_git_templates do
         requires_foreman '>= 1.20'
@@ -19,6 +27,7 @@ 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)
     rescue StandardError => e

data/lib/foreman_git_templates/version.rb

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

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

@@ -5,7 +5,7 @@ require 'test_plugin_helper'
 class UnattendedControllerTest < ActionController::TestCase
   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
@@ -70,6 +70,10 @@ class UnattendedControllerTest < ActionController::TestCase
   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']

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,7 @@ 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
@@ -13,7 +13,9 @@ module Hostext
             tar.add_file_simple('templates/PXELinux/template.erb', 644, host.name.length) { |io| io.write(host.name) }
           end
 
-          assert_equal 'PXELinux', host.provisioning_template(kind: 'PXELinux')&.name
+          actual = host.provisioning_template(kind: 'PXELinux')
+          assert_equal 'PXELinux', actual.name
+          assert_equal host.name, actual.template
         end
       end
 
@@ -23,7 +25,9 @@ module Hostext
             tar.add_file_simple('templates/PXELinux/template.erb', 644, host.name.length) { |io| io.write(host.name) }
           end
 
-          assert_equal 'PXELinux', host.provisioning_template(kind: :PXELinux)&.name
+          actual = host.provisioning_template(kind: :PXELinux)
+          assert_equal 'PXELinux', actual.name
+          assert_equal host.name, actual.template
         end
       end
     end

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

@@ -15,47 +15,42 @@ 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
-    end
 
-    context 'host is not in build mode' do
-      let(:host) { FactoryBot.create(:host, :managed, :with_template_url, build: false) }
+      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"
 
-      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) }
+            assert_nil host.generate_pxe_template(kind)
           end
-
-          assert_equal default_local_boot_template_content, host.generate_pxe_template('PXELinux')
         end
       end
+    end
 
-      it 'does not generate a pxe template if the corresponding template file is missing in the repo' do
+    context 'host is not in build mode' do
+      let(:host) { FactoryBot.create(:host, :managed, :with_template_url, build: false) }
+
+      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_nil host.generate_pxe_template('PXEGrub2')
+          assert_equal default_local_boot_template_content, host.generate_pxe_template(kind)
         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
-        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) }
-          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_raises ForemanGitTemplates::RepositoryReader::MissingFileError do
-            host.generate_pxe_template('PXELinux')
+            assert_nil host.generate_pxe_template(kind)
           end
         end
       end
@@ -63,7 +58,7 @@ class TFTPOrchestrationTest < ActiveSupport::TestCase
   end
 
   describe '#validate_tftp' do
-    let(:host) { FactoryBot.create(:host, :with_tftp_orchestration, :with_template_url, pxe_loader: 'PXELinux BIOS') }
+    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' }

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

@@ -25,5 +25,78 @@ 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
+        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::Resource.any_instance.stubs(:post).returns(true)
+            ProxyAPI::TFTP.any_instance.stubs(:fetch_boot_file).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
+            ProxyAPI::TFTP.any_instance.stubs(:set).returns(true)
+
+            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)
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_git_templates
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - dmTECH GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2019-12-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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -67,12 +81,14 @@ files:
 - 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
@@ -85,6 +101,7 @@ 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
@@ -121,6 +138,7 @@ test_files:
 - 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