foreman_bootdisk 13.0.0 → 16.1.0

data/app/services/foreman_bootdisk/renderer.rb

@@ -1,30 +1,33 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module ForemanBootdisk
   class Renderer
     def generic_template_render(subnet = nil)
-      if subnet.present?
-        # rendering a subnet-level bootdisk requires tricking the renderer into thinking it has a
-        # 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)
-      end
+      host = if subnet.present?
+               # rendering a subnet-level bootdisk requires tricking the renderer into thinking it has a
+               # valid host, without a token, but with a tftp proxy
+               Struct.new(:token, :provision_interface, :content_source).new(
+                 nil,
+                 Struct.new(:subnet).new(subnet),
+                 nil
+               )
+             else
+               Struct.new(:token, :subnet, :content_source).new(nil, nil, nil)
+             end
 
       render_template(template: generic_host_template, host: host)
     end
 
-    def render_template(template: , host:)
+    def render_template(template:, host:, scope_class: renderer_scope)
       source = Foreman::Renderer.get_source(
         template: template,
         host: host
       )
       scope = Foreman::Renderer.get_scope(
         host: host,
-        klass: renderer_scope
+        klass: scope_class
       )
       Foreman::Renderer.render(source, scope)
     end
@@ -36,8 +39,9 @@ module ForemanBootdisk
     end
 
     def generic_host_template
-      template = ProvisioningTemplate.unscoped.find_by_name(Setting[:bootdisk_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

data/app/views/foreman_bootdisk/generic_static_host.erb

@@ -0,0 +1,34 @@
+#!ipxe
+#
+# Generic host template with interactive static IP configuration. Tokens
+# must be disabled in order to access templates via MAC addresses.
+#
+
+<% (0..32).each do |i| -%>
+:net<%= i %>
+isset ${net<%= i -%>/mac} || goto configure
+echo Found ${net<%= i -%>/mac} as net<%= i -%> on a ${net<%= i -%>/chip}
+goto net<%= i+1 %>
+<% end -%>
+
+:configure
+echo -n Interface (e.g. net0): && read interface
+iseq ${interface} n && goto reboot ||
+iseq ${interface} N && goto reboot ||
+
+ifopen ${interface}
+echo Please enter IPv4 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 <%= bootdisk_chain_url %>${${interface}/mac} || goto reboot
+exit 0
+
+:reboot
+echo Unable to continue, rebooting...
+sleep 30
+exit 1

data/app/views/foreman_bootdisk/host.erb

@@ -7,9 +7,23 @@
 <%
 interface = @host.provision_interface
 bootdisk_raise(N_('Host has no provisioning interface defined')) unless interface
-bootdisk_raise(N_('Host has no IP address defined')) if interface.ip.nil? || interface.ip.empty?
-bootdisk_raise(N_('Host has no subnet defined')) unless interface.subnet
+bootdisk_raise(N_('Host has no IPv4 or IPv6 address defined')) unless interface.ip.present? || interface.ip6.present?
+bootdisk_raise(N_('Host has no subnet defined')) unless interface.subnet || interface.subnet6
 bootdisk_raise(N_('Host has no domain defined')) unless interface.domain
+if interface.ip.present? && interface.subnet
+  ip = interface.ip
+  subnet = interface.subnet
+elsif interface.ip6.present? && interface.subnet6
+  ip = interface.ip6
+  subnet = interface.subnet6
+  bootdisk_raise(N_('Host bootdisk does not work with static IPv6'))
+else
+  bootdisk_raise(N_('Both IP and Subnet must be set'))
+end
+
+mask = subnet.mask
+gw = subnet.gateway
+dns = subnet.dns_servers.first
 %>
 
 echo Foreman Bootdisk: Host image (<%= @host.name %>)
@@ -25,20 +39,22 @@ goto loop_success
 <% end -%>
 
 :loop_success
-echo Configuring net${idx} for static IP address <%= interface.ip %>
+echo Configuring net${idx} for static IP address <%= ip %>
 ifopen net${idx}
-set netX/ip <%= interface.ip %>
-set netX/netmask <%= interface.subnet.mask %>
-<% if interface.subnet.gateway.present? %>
-set netX/gateway <%= interface.subnet.gateway %>
+# netX = last opened NIC
+set netX/ip <%= ip %>
+set netX/netmask <%= mask %>
+<% if gw.present? %>
+set netX/gateway <%= gw %>
 <% end %>
 ifstat net${idx}
 route
 
-<% if interface.subnet.dns_primary.present? %>
-# Note, iPXE can only use one DNS server
-echo Using DNS <%= interface.subnet.dns_primary %>
-set dns <%= interface.subnet.dns_primary %>
+# Note: When multiple DNS servers are specified, only the first
+# server will be used. See: http://ipxe.org/cfg/dns
+<% if dns.present? -%>
+echo Using DNS <%= dns %>
+set dns <%= dns %>
 set domain <%= interface.domain.to_s %>
 <% end %>
 

data/config/routes.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 ForemanBootdisk::Engine.routes.draw do
-  resources :disks, :only => [] do
-    get 'generic', :on => :collection
-    get 'help', :on => :collection
-    constraints(:id => /[^\/]+/) do
-      get 'hosts/:id', :on => :collection, :to => 'disks#host'
-      get 'full_hosts/:id', :on => :collection, :to => 'disks#full_host'
-      get 'subnet/:id', :on => :collection, :to => 'disks#subnet'
+  resources :disks, only: [] do
+    get 'generic', on: :collection
+    get 'help', on: :collection
+    constraints(id: %r{[^/]+}) do
+      get 'hosts/:id', on: :collection, to: 'disks#host'
+      get 'full_hosts/:id', on: :collection, to: 'disks#full_host'
+      get 'subnet/:id', on: :collection, to: 'disks#subnet'
     end
   end
 
-  namespace :api, :defaults => {:format => 'json'} do
-    scope "(:apiv)", :module => :v2, :defaults => {:apiv => 'v2'}, :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2, :default => true) do
-      get 'generic', :to => 'disks#generic'
-      constraints(:id => /[^\/]+/) do
-        get 'hosts/:id', :to => 'disks#host'
-        get 'subnets/:id', :to => 'subnet_disks#subnet'
+  namespace :api, defaults: { format: 'json' } do
+    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/, constraints: ApiConstraints.new(version: 2, default: true) do
+      get 'generic', to: 'disks#generic'
+      constraints(id: %r{[^/]+}) do
+        get 'hosts/:id', to: 'disks#host'
+        get 'subnets/:id', to: 'subnet_disks#subnet'
       end
     end
   end

data/config/routes/mount_engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Foreman::Application.routes.draw do
-  mount ForemanBootdisk::Engine, :at => "/bootdisk"
+  mount ForemanBootdisk::Engine, at: '/bootdisk'
 end

data/db/migrate/20130914211030_create_host_bootdisk_template.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class CreateHostBootdiskTemplate < ActiveRecord::Migration[4.2]
-  def self.up
-  end
+  def self.up; end
 
-  def self.down
-  end
+  def self.down; end
 end

data/db/migrate/20130915104500_edit_host_bootdisk_template_multinic.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class EditHostBootdiskTemplateMultinic < ActiveRecord::Migration[4.2]
-  def self.up
-  end
+  def self.up; end
 
-  def self.down
-  end
+  def self.down; end
 end

data/db/migrate/20130915133321_create_kickstart_bootdisk_template.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class CreateKickstartBootdiskTemplate < ActiveRecord::Migration[4.2]
-  def self.up
-  end
+  def self.up; end
 
-  def self.down
-  end
+  def self.down; end
 end

data/db/migrate/20130915201457_create_generic_host_bootdisk_template.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class CreateGenericHostBootdiskTemplate < ActiveRecord::Migration[4.2]
-  def self.up
-  end
+  def self.up; end
 
-  def self.down
-  end
+  def self.down; end
 end

data/db/migrate/20131021095100_edit_host_bootdisk_template_dns_secondary.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class EditHostBootdiskTemplateDnsSecondary < ActiveRecord::Migration[4.2]
-  def self.up
-  end
+  def self.up; end
 
-  def self.down
-  end
+  def self.down; end
 end

data/db/migrate/20140522185700_change_templatekind_to_bootdisk.rb

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
 class ChangeTemplatekindToBootdisk < ActiveRecord::Migration[4.2]
   class FakeConfigTemplate < ApplicationRecord
-    if ActiveRecord::Base.connection.migration_context.get_all_versions.include?(20150514072626)
-      self.table_name = 'templates'
-    else
-      self.table_name = 'config_templates'
-    end
+    self.table_name = if ActiveRecord::Base.connection.migration_context.get_all_versions.include?(20_150_514_072_626)
+                        'templates'
+                      else
+                        'config_templates'
+                      end
   end
 
   def self.up
-    kind = TemplateKind.where(:name => 'Bootdisk').first_or_create
+    kind = TemplateKind.where(name: 'Bootdisk').first_or_create
 
-    tmpl_h = Setting.find_by_name('bootdisk_host_template').try(:value)
-    tmpl_g = Setting.find_by_name('bootdisk_generic_host_template').try(:value)
+    tmpl_h = Setting.find_by(name: 'bootdisk_host_template').try(:value)
+    tmpl_g = Setting.find_by(name: 'bootdisk_generic_host_template').try(:value)
 
     (FakeConfigTemplate.unscoped.where('name LIKE ?', '%Boot disk%') |
-      FakeConfigTemplate.unscoped.where(:name => [tmpl_h, tmpl_g].compact)).each do |tmpl|
+      FakeConfigTemplate.unscoped.where(name: [tmpl_h, tmpl_g].compact)).each do |tmpl|
       tmpl.update_attribute(:template_kind_id, kind.id)
     end
   end
 
   def self.down
-    old_kind = TemplateKind.find_by_name('Bootdisk')
-    new_kind = TemplateKind.find_by_name('iPXE')
-    if old_kind.present? && new_kind.present?
-      FakeConfigTemplate.unscoped.where(:template_kind_id => old_kind.id).update_all(:template_kind_id => new_kind.id)
-    end
+    old_kind = TemplateKind.find_by(name: 'Bootdisk')
+    new_kind = TemplateKind.find_by(name: 'iPXE')
+    return unless old_kind.present? && new_kind.present?
+
+    FakeConfigTemplate.unscoped.where(template_kind_id: old_kind.id).update_all(template_kind_id: new_kind.id)
   end
 end

data/db/migrate/20171009225200_remove_duplicate_bootdisk_templates.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 class RemoveDuplicateBootdiskTemplates < ActiveRecord::Migration[4.2]
   def up
     template_names = ['Boot disk iPXE - host', 'Boot disk iPXE - generic host']
     template_names.each do |template_name|
-      duplicate_template_ids = ProvisioningTemplate.unscoped.where(:name => template_name, :locked => true).order(:created_at => :asc).pluck(:id).drop(1)
-      ProvisioningTemplate.unscoped.where(:id => duplicate_template_ids).destroy_all if duplicate_template_ids.any?
+      duplicate_template_ids = ProvisioningTemplate.unscoped.where(name: template_name, locked: true).order(created_at: :asc).pluck(:id).drop(1)
+      ProvisioningTemplate.unscoped.where(id: duplicate_template_ids).destroy_all if duplicate_template_ids.any?
     end
   end
 end

data/db/seeds.d/50-bootdisk_templates.rb

@@ -1,46 +1,31 @@
-kind = TemplateKind.unscoped.where(:name => 'Bootdisk').first_or_create
+# frozen_string_literal: true
 
-organizations = Organization.all
-locations = Location.all
-created = []
-
-ProvisioningTemplate.without_auditing do
-  content = File.read(File.join(ForemanBootdisk::Engine.root, 'app', 'views', 'foreman_bootdisk', 'host.erb'))
-  created << 'Boot disk iPXE - host' unless ProvisioningTemplate.find_by_name('Boot disk iPXE - host')
-  tmpl = ProvisioningTemplate.unscoped.where(:name => 'Boot disk iPXE - host').first_or_create do |template|
-    template.attributes = {
-      :template_kind_id => kind.id,
-      :snippet => false,
-      :template => content
-    }
-  end
-  tmpl.attributes = {
-    :template => content,
-    :default  => true,
-    :vendor   => "Foreman boot disk",
-  }
-  tmpl.locked = true
-  tmpl.save!(:validate => false) if tmpl.changes.present?
+def read_bootdisk_template(filename)
+  File.read(File.join(ForemanBootdisk::Engine.root, 'app', 'views', 'foreman_bootdisk', filename))
+end
 
-  content = File.read(File.join(ForemanBootdisk::Engine.root, 'app', 'views', 'foreman_bootdisk', 'generic_host.erb'))
-  created << 'Boot disk iPXE - generic host' unless ProvisioningTemplate.find_by_name('Boot disk iPXE - generic host')
-  tmpl = ProvisioningTemplate.unscoped.where(:name => 'Boot disk iPXE - generic host').first_or_create do |template|
+def ensure_bootdisk_template(name, content)
+  kind = TemplateKind.unscoped.where(name: 'Bootdisk').first_or_create
+  tmpl = ProvisioningTemplate.unscoped.where(name: name).first_or_create do |template|
     template.attributes = {
-      :template_kind_id => kind.id,
-      :snippet => false,
-      :template => content
+      template_kind_id: kind.id,
+      snippet: false,
+      template: content
     }
   end
   tmpl.attributes = {
-    :template => content,
-    :default  => true,
-    :vendor   => "Foreman boot disk",
+    template: content,
+    default: true,
+    vendor: "Foreman boot disk"
   }
   tmpl.locked = true
-  tmpl.save!(:validate => false) if tmpl.changes.present?
+  tmpl.organizations = Organization.unscoped.all if SETTINGS[:organizations_enabled]
+  tmpl.locations = Location.unscoped.all if SETTINGS[:locations_enabled]
+  tmpl.save!(validate: false) if tmpl.changes.present?
+end
 
-  ProvisioningTemplate.unscoped.where(:name => created, :default => true).each do |tmpl|
-    tmpl.organizations = organizations if SETTINGS[:organizations_enabled]
-    tmpl.locations = locations if SETTINGS[:locations_enabled]
-  end
+ProvisioningTemplate.without_auditing do
+  ensure_bootdisk_template("Boot disk iPXE - host", read_bootdisk_template("host.erb"))
+  ensure_bootdisk_template("Boot disk iPXE - generic host", read_bootdisk_template("generic_host.erb"))
+  ensure_bootdisk_template("Boot disk iPXE - generic static host", read_bootdisk_template("generic_static_host.erb"))
 end

data/lib/foreman_bootdisk.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_bootdisk/version'
 require 'foreman_bootdisk/engine'
 

data/lib/foreman_bootdisk/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_bootdisk'
 require 'fast_gettext'
 require 'gettext_i18n_rails'
@@ -15,49 +17,36 @@ module ForemanBootdisk
       app.routes_reloader.paths << "#{ForemanBootdisk::Engine.root}/config/routes/mount_engine.rb"
     end
 
-    initializer 'foreman_bootdisk.load_default_settings', :before => :load_config_initializers do |app|
-      require_dependency File.expand_path("../../../app/models/setting/bootdisk.rb", __FILE__) if (Setting.table_exists? rescue(false))
+    initializer 'foreman_bootdisk.load_default_settings', before: :load_config_initializers do |_app|
+      table_exists = begin
+                       Setting.table_exists?
+                     rescue StandardError
+                       false
+                     end
+      require_dependency File.expand_path('../../app/models/setting/bootdisk.rb', __dir__) if table_exists
     end
 
-    initializer "foreman_bootdisk.load_app_instance_data" do |app|
+    initializer 'foreman_bootdisk.load_app_instance_data' do |app|
       ForemanBootdisk::Engine.paths['db/migrate'].existent.each do |path|
         app.config.paths['db/migrate'] << path
       end
     end
 
-    initializer "foreman_bootdisk.apipie" do
+    initializer 'foreman_bootdisk.apipie' do
       Apipie.configuration.checksum_path += ['/bootdisk/api/']
     end
 
-    # Precompile any JS or CSS files under app/assets/
-    # If requiring files from each other, list them explicitly here to avoid precompiling the same
-    # content twice.
-    assets_to_precompile =
-      Dir.chdir(root) do
-        Dir['app/assets/javascripts/**/*', 'app/assets/stylesheets/**/*'].map do |f|
-          f.split(File::SEPARATOR, 4).last
-        end
-      end
-
-    initializer 'foreman_bootdisk.assets.precompile' do |app|
-      app.config.assets.precompile += assets_to_precompile
-    end
-
-    initializer 'foreman_bootdisk.configure_assets', group: :assets do
-      SETTINGS[:foreman_bootdisk] = { assets: { precompile: assets_to_precompile } }
-    end
-
-    initializer 'foreman_bootdisk.register_plugin', :before => :finisher_hook do |app|
+    initializer 'foreman_bootdisk.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_bootdisk do
-        requires_foreman '>= 1.18'
+        requires_foreman '>= 1.24'
 
-        security_block :bootdisk do |map|
-          permission :download_bootdisk, {:'foreman_bootdisk/disks' => [:generic, :host, :full_host, :subnet, :help],
-                                          :'foreman_bootdisk/api/v2/disks' => [:generic, :host],
-                                          :'foreman_bootdisk/api/v2/subnet_disks' => [:subnet]}
+        security_block :bootdisk do |_map|
+          permission :download_bootdisk, 'foreman_bootdisk/disks': %i[generic host full_host subnet help],
+                                         'foreman_bootdisk/api/v2/disks': %i[generic host],
+                                         'foreman_bootdisk/api/v2/subnet_disks': [:subnet]
         end
 
-        role "Boot disk access", [:download_bootdisk]
+        role 'Boot disk access', [:download_bootdisk], 'Role granting permissions to download bootdisks'
 
         add_all_permissions_to_default_roles
 
@@ -68,20 +57,20 @@ module ForemanBootdisk
       end
     end
 
-    initializer 'foreman_bootdisk.register_gettext', :after => :load_config_initializers do |app|
-      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+    initializer 'foreman_bootdisk.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../..', __dir__), 'locale')
       locale_domain = 'foreman_bootdisk'
       Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
 
     config.to_prepare do
       begin
-        Host::Managed.send(:prepend, ForemanBootdisk::HostExt)
-        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?
-      rescue => e
-        puts "#{ForemanBootdisk::ENGINE_NAME}: skipping engine hook (#{e.to_s})"
+        Host::Managed.prepend ForemanBootdisk::HostExt
+        Host::Managed.include ForemanBootdisk::Orchestration::Compute if SETTINGS[:unattended]
+        HostsHelper.prepend ForemanBootdisk::HostsHelperExt
+        Foreman::Model::Vmware.prepend ForemanBootdisk::ComputeResources::Vmware if Foreman::Model::Vmware.available?
+      rescue StandardError => e
+        Rails.logger.warn "#{ForemanBootdisk::ENGINE_NAME}: skipping engine hook (#{e})"
       end
     end
   end