foreman_bootdisk 12.0.1 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abab6031b8511f7af62b971e9c5c71f6232939598072f768293bccd601006426
-  data.tar.gz: b00a72a8e9671356e7bb6fa2f0de33024d58c8e6eb96aa72da75149e99c2e496
+  metadata.gz: d43b8549de63eaac53bdccedfed1db1c8c96f9481ee411724686686476e01767
+  data.tar.gz: 30d918f87198e96711e2d75506127bb7ded00cafef415e5eaa176c24810f1a94
 SHA512:
-  metadata.gz: 5a8be6424824875972b6416ed1b68415ced0c1979db35b693a05e91660078114ff0489c7ba113d4be11b1ae3c15c779012ed71d770242248e9d87859c67adb75
-  data.tar.gz: 0fd0503eb874bd3c3a73b9e2515a5a15d28076a1a714a484865b447302601af299615b14f8f7d430b89eb373d1f684dfdc93279ce0fd7f06409e8d5afee47437
+  metadata.gz: c8d73855b7dbf1f7ed717883a56813917d1fba38ca226cf77fa0c73005b38e44220563bd411c112c636182ba328d52ef336b912c80c7c356f29a4d8bb29687ab
+  data.tar.gz: 832d7248d4bc1364f17507dad46325cd929e719790d3ebe08529459a21762d557987d908c5fca82d632bd8e522df3f4a1ba34b49a24faff60a0f5ebc0c6b5251

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v13.0.0
+* static credentials failover
+* Rails 5.2 support
+* use of core new renderer framework
+
 ## v12.0.0
 * fixed subnet image token stub (#22428)
 * moved MAC based identification to Foreman core (#22858)

data/README.md

@@ -47,6 +47,8 @@ gPXE images are unsupported due to lack of initrd support.
 | >= 1.15         | ~> 10.0        |
 | >= 1.17         | ~> 11.0        |
 | >= 1.18         | ~> 12.0        |
+| >= 1.19         | ~> 12.0        |
+| >= 1.20         | ~> 13.0        |
 
 # Usage
 

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -4,6 +4,10 @@ module ForemanBootdisk
   class DisksController < ::ApplicationController
     before_action :find_resource, :only => %w[host full_host subnet]
 
+    # as this engine is isolated, we need to include url helpers from core explicitly
+    # to render help page layout
+    include Rails.application.routes.url_helpers
+
     def generic
       begin
         tmpl = ForemanBootdisk::Renderer.new.generic_template_render

data/app/lib/foreman_bootdisk/scope/bootdisk.rb

@@ -0,0 +1,21 @@
+module ForemanBootdisk
+  module Scope
+    class Bootdisk < ::Foreman::Renderer::Scope::Provisioning
+      def bootdisk_chain_url(mac = host.try(:mac), action = 'iPXE')
+        url = foreman_url(action)
+        u = URI.parse(url)
+        ForemanBootdisk.logger.warn("Foreman or proxy is configured with HTTPS, probably not supported by iPXE: #{u}") if u.scheme == 'https'
+        new_query_data = URI.decode_www_form(u.query || '') << ['mac', mac || '']
+        new_querystring = URI.encode_www_form(new_query_data)
+        u.query = nil
+        u.query = new_querystring if new_querystring.present?
+        u.fragment = nil
+        u.to_s
+      end
+
+      def bootdisk_raise(*args)
+        raise ::Foreman::Exception.new(*args)
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_bootdisk/host_ext.rb

@@ -6,8 +6,7 @@ module ForemanBootdisk::HostExt
   end
 
   def bootdisk_template_render
-    @host = self
-    unattended_render(bootdisk_template.template)
+    ForemanBootdisk::Renderer.new.render_template(template: bootdisk_template, host: self)
   end
 
   def bootdisk_build?
@@ -26,6 +25,10 @@ module ForemanBootdisk::HostExt
     /i.86|x86[_-]64/ =~ architecture.name
   end
 
+  def validate_media?
+    super || (managed && bootdisk_build? && build?)
+  end
+
   def can_be_built?
     super || (managed? and SETTINGS[:unattended] and bootdisk_build? and !build?)
   end

data/app/services/foreman_bootdisk/renderer.rb

@@ -2,28 +2,43 @@ require 'uri'
 
 module ForemanBootdisk
   class Renderer
-    include ::Foreman::Renderer
-    include Rails.application.routes.url_helpers
-    delegate :logger, :to => :ForemanBootdisk
-    include RendererMethods
-
     def generic_template_render(subnet = nil)
-      tmpl = ProvisioningTemplate.unscoped.find_by_name(Setting[:bootdisk_generic_host_template]) || raise(::Foreman::Exception.new(N_('Unable to find template specified by %s setting'), 'bootdisk_generic_host_template'))
-
       if subnet.present?
         # rendering a subnet-level bootdisk requires tricking the renderer into thinking it has a
-        # valid host, with a token, and with a tftp proxy
-        @host = Struct.new(:token, :provision_interface).new(
-          Struct.new(:value).new('faketoken'),
+        # valid host, without a token, but with a tftp proxy
+        host = Struct.new(:token, :provision_interface).new(
+          nil,
           Struct.new(:subnet).new(subnet)
         )
       else
-        @host = Struct.new(:token, :subnet).new(nil,nil)
+        host = Struct.new(:token, :subnet).new(nil, nil)
       end
-      modified_template = unattended_render(tmpl.template)
-      # remove the token from subnet-level generation, since this is meant to be generic
-      modified_template.gsub!(/(?<=iPXE\?)token=faketoken\&(?=mac=)/,'')
-      modified_template
+
+      render_template(template: generic_host_template, host: host)
+    end
+
+    def render_template(template: , host:)
+      source = Foreman::Renderer.get_source(
+        template: template,
+        host: host
+      )
+      scope = Foreman::Renderer.get_scope(
+        host: host,
+        klass: renderer_scope
+      )
+      Foreman::Renderer.render(source, scope)
+    end
+
+    private
+
+    def renderer_scope
+      ForemanBootdisk::Scope::Bootdisk
+    end
+
+    def generic_host_template
+      template = ProvisioningTemplate.unscoped.find_by_name(Setting[:bootdisk_generic_host_template])
+      raise ::Foreman::Exception.new(N_('Unable to find template specified by %s setting'), 'bootdisk_generic_host_template') unless template
+      template
     end
   end
 end

data/app/views/foreman_bootdisk/generic_host.erb

@@ -21,8 +21,26 @@ dhcp net<%= i %> || goto net<%= i+1 %>
 chain <%= url %>${net<%= i -%>/mac} || goto net<%= i+1 %>
 exit 0
 <% end -%>
+echo Failed to chainload from any network interface, fallback to static.
+ifstat
 
 :no_nic
-echo Failed to chainload from any network interface
-sleep 30
-exit 1
+echo -n Enter interface name to boot from (e.g. net0):  && read interface
+isset ${${interface}/mac} && goto get_static_ip
+echo Interface ${interface} is not initialized, try again
+goto no_nic
+
+:get_static_ip
+ifopen ${interface}
+echo Please enter IP details for ${interface}
+echo
+echo -n IP address      :  && read ${interface}/ip
+echo -n Subnet mask     :  && read ${interface}/netmask
+echo -n Default gateway :  && read ${interface}/gateway
+echo -n DNS server      :  && read dns
+chain <%= url %>${${interface}/mac} || goto boot_failure
+exit 0
+
+:boot_failure
+echo Cannot continue, spawning shell
+shell

data/app/views/foreman_bootdisk/host.erb

@@ -48,6 +48,5 @@ chain <%= bootdisk_chain_url %>
 exit 0
 
 :no_nic
-echo Cannot find interface with MAC <%= interface.mac %>
-sleep 30
-exit 1
+echo Cannot find interface with MAC <%= interface.mac %>, spawning shell
+shell

data/db/migrate/20140522185700_change_templatekind_to_bootdisk.rb

@@ -1,6 +1,6 @@
 class ChangeTemplatekindToBootdisk < ActiveRecord::Migration[4.2]
   class FakeConfigTemplate < ApplicationRecord
-    if ActiveRecord::Migrator.get_all_versions.include?(20150514072626)
+    if ActiveRecord::Base.connection.migration_context.get_all_versions.include?(20150514072626)
       self.table_name = 'templates'
     else
       self.table_name = 'config_templates'

data/lib/foreman_bootdisk/engine.rb

@@ -9,8 +9,9 @@ module ForemanBootdisk
     config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
     config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/lib"]
 
-    initializer 'foreman_bootdisk.mount_engine', :after=> :build_middleware_stack do |app|
+    initializer 'foreman_bootdisk.mount_engine' do |app|
       app.routes_reloader.paths << "#{ForemanBootdisk::Engine.root}/config/routes/mount_engine.rb"
     end
 
@@ -60,11 +61,10 @@ module ForemanBootdisk
 
         add_all_permissions_to_default_roles
 
-        allowed_template_helpers :bootdisk_chain_url, :bootdisk_raise
         apipie_documented_controllers ["#{ForemanBootdisk::Engine.root}/app/controllers/foreman_bootdisk/api/v2/*.rb"]
         provision_method 'bootdisk', N_('Boot disk based')
         template_labels 'Bootdisk' => N_('Boot disk embedded template')
-        extend_template_helpers ForemanBootdisk::RendererMethods
+        allowed_template_helpers :bootdisk_chain_url, :bootdisk_raise
       end
     end
 
@@ -77,7 +77,6 @@ module ForemanBootdisk
     config.to_prepare do
       begin
         Host::Managed.send(:prepend, ForemanBootdisk::HostExt)
-        Host::Managed.send(:include, ForemanBootdisk::RendererMethods)
         Host::Managed.send(:include, ForemanBootdisk::Orchestration::Compute) if SETTINGS[:unattended]
         HostsHelper.send(:prepend, ForemanBootdisk::HostsHelperExt)
         Foreman::Model::Vmware.send(:prepend, ForemanBootdisk::ComputeResources::Vmware) if Foreman::Model::Vmware.available?

data/lib/foreman_bootdisk/version.rb

@@ -1,3 +1,3 @@
 module ForemanBootdisk
-  VERSION = '12.0.1'
+  VERSION = '13.0.0'
 end

data/test/models/host/managed_test.rb

@@ -0,0 +1,22 @@
+require 'test_plugin_helper'
+
+class Host::ManagedTest < ActiveSupport::TestCase
+  include ForemanBootdiskTestHelper
+
+  setup do
+    User.current = users(:admin)
+    setup_bootdisk
+  end
+
+  context 'with host' do
+    let(:host) { FactoryBot.create(:host, :managed, :with_subnet, build: true) }
+
+    test 'finds the bootdisk_template specified in settings' do
+      assert_kind_of ProvisioningTemplate, host.bootdisk_template
+    end
+
+    test 'renders the host bootdisk template' do
+      assert_includes host.bootdisk_template_render, 'loop_success'
+    end
+  end
+end

data/test/unit/concerns/host_test.rb

@@ -9,6 +9,14 @@ class ForemanBootdisk::HostTest < ActiveSupport::TestCase
     refute host.pxe_build?
   end
 
+  test "#validate_media? must be true when provision_method is bootdisk" do
+    host = FactoryBot.build(:host, :managed,
+                             :provision_method => "bootdisk",
+                             :build => true,
+                             )
+    assert host.validate_media?
+  end
+
   test "#can_be_built? must be true when provision_method is bootdisk" do
     host = FactoryBot.build(:host, :managed,
                              :provision_method => "bootdisk"

data/test/unit/foreman_bootdisk/renderer_test.rb

@@ -0,0 +1,34 @@
+require 'test_plugin_helper'
+
+module ForemanBootdisk
+  class RendererTest < ActiveSupport::TestCase
+    include ForemanBootdiskTestHelper
+
+    setup do
+      User.current = users(:admin)
+      setup_bootdisk
+    end
+
+    let(:renderer) { ForemanBootdisk::Renderer.new }
+
+    describe 'a generic template' do
+      test 'can be rendered' do
+        rendered_template = renderer.generic_template_render
+        assert_includes rendered_template, 'ifstat'
+      end
+
+      test 'does not include a host token' do
+        rendered_template = renderer.generic_template_render
+        assert_includes rendered_template, 'http://foreman.some.host.fqdn/unattended/iPXE?mac=${net0/mac}'
+        refute_includes rendered_template, 'token'
+      end
+    end
+
+    context 'with a subnet' do
+      let(:subnet) { FactoryBot.create(:subnet_ipv4) }
+      test 'renders a subnet template' do
+        assert_includes renderer.generic_template_render(subnet), 'ifstat'
+      end
+    end
+  end
+end

data/test/unit/foreman_bootdisk/scope/bootdisk_test.rb

@@ -0,0 +1,29 @@
+require 'test_plugin_helper'
+
+module ForemanBootdisk
+  module Scope
+    class BootdiskTest < ActiveSupport::TestCase
+      let(:host) { FactoryBot.build(:host, :managed) }
+      let(:source) { Foreman::Renderer::Source::String.new(content: 'Test') }
+      let(:scope) { ForemanBootdisk::Scope::Bootdisk.new(host: host, source: source) }
+
+      describe '#bootdisk_chain_url' do
+        test 'should render bootdisk chain url' do
+          assert_equal "http://foreman.some.host.fqdn/unattended/iPXE?mac=#{URI.encode_www_form_component(host.mac)}", scope.bootdisk_chain_url
+        end
+
+        test 'should render bootdisk chain url with custom mac' do
+          assert_equal "http://foreman.some.host.fqdn/unattended/iPXE?mac=00%3A11%3A22%3A33%3A44%3A55", scope.bootdisk_chain_url('00:11:22:33:44:55')
+        end
+      end
+
+      describe '#bootdisk_raise' do
+        test 'should raise a Foreman::Exception' do
+          assert_raise ::Foreman::Exception do
+            scope.bootdisk_raise('Some error.')
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_bootdisk
 version: !ruby/object:Gem::Version
-  version: 12.0.1
+  version: 13.0.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2018-10-04 00:00:00.000000000 Z
 dependencies: []
 description: Plugin for Foreman that creates iPXE-based boot disks to provision hosts
   without the need for PXE infrastructure.
@@ -29,13 +29,13 @@ files:
 - app/controllers/foreman_bootdisk/api/v2/subnet_disks_controller.rb
 - app/controllers/foreman_bootdisk/disks_controller.rb
 - app/helpers/concerns/foreman_bootdisk/hosts_helper_ext.rb
+- app/lib/foreman_bootdisk/scope/bootdisk.rb
 - app/models/concerns/foreman_bootdisk/compute_resources/vmware.rb
 - app/models/concerns/foreman_bootdisk/host_ext.rb
 - app/models/concerns/foreman_bootdisk/orchestration/compute.rb
 - app/models/setting/bootdisk.rb
 - app/services/foreman_bootdisk/iso_generator.rb
 - app/services/foreman_bootdisk/renderer.rb
-- app/services/foreman_bootdisk/renderer_methods.rb
 - app/views/foreman_bootdisk/disks/help.html.erb
 - app/views/foreman_bootdisk/generic_host.erb
 - app/views/foreman_bootdisk/host.erb
@@ -89,11 +89,14 @@ files:
 - test/functional/foreman_bootdisk/api/v2/disks_controller_test.rb
 - test/functional/foreman_bootdisk/api/v2/subnet_disks_controller_test.rb
 - test/functional/foreman_bootdisk/disks_controller_test.rb
+- test/models/host/managed_test.rb
 - test/test_plugin_helper.rb
 - test/unit/access_permissions_test.rb
 - test/unit/concerns/compute_resources/vmware_test.rb
 - test/unit/concerns/host_test.rb
 - test/unit/concerns/orchestration/compute_test.rb
+- test/unit/foreman_bootdisk/renderer_test.rb
+- test/unit/foreman_bootdisk/scope/bootdisk_test.rb
 - test/unit/iso_generator_test.rb
 homepage: http://github.com/theforeman/foreman_bootdisk
 licenses:

data/app/services/foreman_bootdisk/renderer_methods.rb

@@ -1,27 +0,0 @@
-module ForemanBootdisk
-  module RendererMethods
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def format_bootdisk_chain_url(url, mac)
-        u = URI.parse(url)
-        ForemanBootdisk.logger.warn("Foreman or proxy is configured with HTTPS, probably not supported by iPXE: #{u}") if u.scheme == 'https'
-        u.query = "#{u.query}&mac=#{mac}"
-        u.fragment = nil
-        u.to_s
-      end
-
-      def bootdisk_raise(*args)
-        raise ::Foreman::Exception.new(*args)
-      end
-    end
-
-    def bootdisk_chain_url(mac = self.try(:mac), action = 'iPXE')
-      self.class.format_bootdisk_chain_url(foreman_url(action), mac)
-    end
-
-    def bootdisk_raise(*args)
-      self.class.bootdisk_raise(*args)
-    end
-  end
-end