foreman_bootdisk 12.0.1 → 16.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abab6031b8511f7af62b971e9c5c71f6232939598072f768293bccd601006426
-  data.tar.gz: b00a72a8e9671356e7bb6fa2f0de33024d58c8e6eb96aa72da75149e99c2e496
+  metadata.gz: 3a69fd6de3a18c8670dfe431cf989b8c02f94b9aa48da2c17aa93e504d98f869
+  data.tar.gz: 7354aff9025bfdd9f1acd3e312b2350268866b108a534dc3143b99ff731de1b9
 SHA512:
-  metadata.gz: 5a8be6424824875972b6416ed1b68415ced0c1979db35b693a05e91660078114ff0489c7ba113d4be11b1ae3c15c779012ed71d770242248e9d87859c67adb75
-  data.tar.gz: 0fd0503eb874bd3c3a73b9e2515a5a15d28076a1a714a484865b447302601af299615b14f8f7d430b89eb373d1f684dfdc93279ce0fd7f06409e8d5afee47437
+  metadata.gz: 1fe67673899bbaf6b8588103341bf6f8436aecc7d761e574f9c835940d530eb199bbc29c44a61234710abd7ec00a76e2e89dc7ecbcb17211a0c7ff5df27d8c16
+  data.tar.gz: 70838f0a73b4c1541bc728de2f0399aa3946da0714e31b05d1dee08a7254aa6be8c1cd0a3b769dcfa566b21963fd9fb0591792e23758c6ceeb4885a1a2a3ff20

data/AUTHORS

@@ -0,0 +1,26 @@
+Bryan Kearney
+Dominic Cleal
+Greg Sutcliffe
+Ido Kanner
+Jon Fautley
+Justin Sherrill
+Lukas Zapletal
+Lukáš Zapletal
+Marek Hulan
+Marek Hulán
+Martin Bačovský
+Michael Hofer
+Michael Moll
+Ohad Levy
+Ondrej Prazak
+Ondřej Ezr
+Ondřej Pražák
+Robert Antoni Buj Gelonch
+Rohan21Lobo
+Ronald van Zantvoort
+Sam Kottler
+Sean O'Keeffe
+Stephen Benjamin
+Swapnil Abnave
+Timo Goebel
+crito

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v14.0.0
+* use new medium provider framework
+* droped some unused code
+
+## 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,9 @@ gPXE images are unsupported due to lack of initrd support.
 | >= 1.15         | ~> 10.0        |
 | >= 1.17         | ~> 11.0        |
 | >= 1.18         | ~> 12.0        |
+| >= 1.19         | ~> 13.0        |
+| >= 1.20         | ~> 14.0        |
+| >= 1.21         | ~> 15.0        |
 
 # Usage
 
@@ -233,6 +236,22 @@ To generate from the command line on the Foreman server:
 Set `OUTPUT=/path` to change the output destination path (directory or file).
 It must be writable by the 'foreman' user.
 
+### Generic static image
+
+This is generic image type which asks for network credentials instead of doing
+DHCP request. Tokens must be turned off in order to find the host by MAC
+address. To do that, set Token duration to 0 in Administer - Settings.
+
+- Network interface name
+- IP Address
+- Netmask
+- Gateway
+- DNS
+
+To use generic static host image, set "Generic image template" to "Bootdisk
+iPXE - host template" in Administer - Settings - Boot disk. Only one template
+can be used at one time across all hosts.
+
 ### Subnet images
 
 Subnet images are similar to generic images, but chain-loading is done via the

data/app/controllers/foreman_bootdisk/api/v2/disks_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module ForemanBootdisk
@@ -7,10 +9,10 @@ module ForemanBootdisk
         include ::Api::Version2
 
         resource_description do
-          api_base_url "/bootdisk/api"
+          api_base_url '/bootdisk/api'
         end
 
-        before_action :find_resource, :only => :host
+        before_action :find_resource, only: :host
         skip_after_action :log_response_body
 
         # no-op, but required for apipie documentation
@@ -20,24 +22,24 @@ module ForemanBootdisk
         api :GET, '/generic', N_('Download generic image')
         def generic
           tmpl = ForemanBootdisk::Renderer.new.generic_template_render
-          ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
-            send_data read_file(iso), :filename => "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
+          ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
+            send_data read_file(iso), filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
           end
         end
 
         api :GET, '/hosts/:host_id', N_('Download host image')
-        param :full, :bool, :required => false, :desc => N_('True for full, false for basic reusable image')
-        param :host_id, :identifier_dottable, :required => true
+        param :full, :bool, required: false, desc: N_('True for full, false for basic reusable image')
+        param :host_id, :identifier_dottable, required: true
         def host
           host = @disk
           if params[:full]
             ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-              send_data read_file(iso), :filename => "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
+              send_data read_file(iso), filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
             end
           else
             tmpl = host.bootdisk_template_render
-            ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
-              send_data read_file(iso), :filename => "#{host.name}.iso"
+            ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
+              send_data read_file(iso), filename: "#{host.name}.iso"
             end
           end
         end

data/app/controllers/foreman_bootdisk/api/v2/subnet_disks_controller.rb

@@ -1,37 +1,43 @@
-require 'uri'
-
-module ForemanBootdisk::Api::V2
-  class SubnetDisksController < ::Api::V2::BaseController
-    include ::Api::Version2
-
-    resource_description do
-      api_base_url "/bootdisk/api"
-    end
-
-    before_action :find_resource, :only => :subnet
+# frozen_string_literal: true
 
-    skip_after_action :log_response_body
-
-    # no-op, but required for apipie documentation
-    api :GET, '', N_('Subnet boot disks')
-    def index; end
+require 'uri'
 
-    api :GET, '/subnets/:subnet_id', N_('Download subnet generic image')
-    param :subnet_id, :identifier_dottable, :required => true
-    def subnet
-      subnet = @subnet_disk
-      subnet.tftp || raise(::Foreman::Exception.new(N_("TFTP feature not enabled for subnet %s"), subnet.name))
-      tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
-      ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
-        name=subnet.name
-        send_data File.read(iso), :filename => "bootdisk_subnet_#{name}.iso"
+module ForemanBootdisk
+  module Api
+    module V2
+      class SubnetDisksController < ::Api::V2::BaseController
+        include ::Api::Version2
+
+        resource_description do
+          api_base_url '/bootdisk/api'
+        end
+
+        before_action :find_resource, only: :subnet
+
+        skip_after_action :log_response_body
+
+        # no-op, but required for apipie documentation
+        api :GET, '', N_('Subnet boot disks')
+        def index; end
+
+        api :GET, '/subnets/:subnet_id', N_('Download subnet generic image')
+        param :subnet_id, :identifier_dottable, required: true
+        def subnet
+          subnet = @subnet_disk
+          subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), subnet.name))
+          tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
+          ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
+            name = subnet.name
+            send_data File.read(iso), filename: "bootdisk_subnet_#{name}.iso"
+          end
+        end
+
+        private
+
+        def resource_scope
+          Subnet.authorized('view_subnets')
+        end
       end
     end
-
-    private
-
-    def resource_scope
-      Subnet.authorized('view_subnets')
-    end
   end
 end

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -1,20 +1,26 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 module ForemanBootdisk
   class DisksController < ::ApplicationController
-    before_action :find_resource, :only => %w[host full_host subnet]
+    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
-      rescue => e
+      rescue StandardError => e
         error_rendering(e)
         redirect_back(fallback_location: '/')
         return
       end
 
-      ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
-        send_data read_file(iso), :filename => "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
+      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
+        send_data read_file(iso), filename: "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso"
       end
     end
 
@@ -22,43 +28,42 @@ module ForemanBootdisk
       host = @disk
       begin
         tmpl = host.bootdisk_template_render
-      rescue => e
+      rescue StandardError => e
         error_rendering(e)
         redirect_back(fallback_location: '/')
         return
       end
 
-      ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
-        send_data read_file(iso), :filename => "#{host.name}.iso"
+      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
+        send_data read_file(iso), filename: "#{host.name}.iso"
       end
     end
 
     def full_host
       host = @disk
       ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-        send_data read_file(iso), :filename => "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
+        send_data read_file(iso), filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso"
       end
     end
 
     def subnet
       host = @disk
       begin
-        subnet = host.try(:subnet) || raise(::Foreman::Exception.new(N_("Subnet is not assigned to the host %s"), host.name))
-        subnet.tftp || raise(::Foreman::Exception.new(N_("TFTP feature not enabled for subnet %s"), subnet.name))
+        subnet = host.try(:subnet) || raise(::Foreman::Exception.new(N_('Subnet is not assigned to the host %s'), host.name))
+        subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), subnet.name))
         tmpl = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
-      rescue => e
+      rescue StandardError => e
         error_rendering(e)
         redirect_back(fallback_location: '/')
         return
       end
 
-      ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl) do |iso|
-        send_data read_file(iso), :filename => "bootdisk_subnet_#{subnet.name}.iso"
+      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
+        send_data read_file(iso), filename: "bootdisk_subnet_#{subnet.name}.iso"
       end
     end
 
-    def help
-    end
+    def help; end
 
     private
 
@@ -66,14 +71,14 @@ module ForemanBootdisk
       File.read(filename)
     end
 
-    def resource_scope(controller = controller_name)
+    def resource_scope(_controller = controller_name)
       Host::Managed.authorized(:view_hosts)
     end
 
-    def error_rendering(e)
+    def error_rendering(exception)
       msg = _('Failed to render boot disk template')
-      error("#{msg}: #{e.message}")
-      ::Foreman::Logging.exception(msg, e)
+      error("#{msg}: #{exception.message}")
+      ::Foreman::Logging.exception(msg, exception)
     end
   end
 end

data/app/helpers/concerns/foreman_bootdisk/hosts_helper_ext.rb

@@ -1,58 +1,99 @@
-module ForemanBootdisk::HostsHelperExt
-  def host_title_actions(*args)
-    if @host.bootdisk_downloadable?
-      title_actions(
-        button_group(
-          select_action_button(_('Boot disk'), {:class => 'btn btn-group'},
-            display_bootdisk_link_if_authorized(_("Host '%s' image") % @host.name.split('.')[0], {:controller => 'foreman_bootdisk/disks', :action => 'host', :id => @host}, :class=>'la'),
-            display_bootdisk_link_if_authorized(_("Full host '%s' image") % @host.name.split('.')[0], {:controller => 'foreman_bootdisk/disks', :action => 'full_host', :id => @host}, :class=>'la'),
-            content_tag(:li, "", :class => "divider"),
-            display_bootdisk_link_if_authorized(_("Generic image"), {:controller => 'foreman_bootdisk/disks', :action => 'generic'}, :class=>'la'),
-            display_bootdisk_for_subnet,
-            content_tag(:li, "", :class => "divider"),
-            display_bootdisk_link_if_authorized(_("Help"), {:controller => 'foreman_bootdisk/disks', :action => 'help'}, :class=>'la')
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  module HostsHelperExt
+    def host_title_actions(host)
+      if host.bootdisk_downloadable?
+        title_actions(
+          button_group(
+            select_action_button(
+              _('Boot disk'), { class: 'btn btn-group' },
+              display_bootdisk_link_if_authorized(
+                _("Host '%s' image") % host.name.split('.')[0],
+                {
+                  controller: 'foreman_bootdisk/disks',
+                  action: 'host',
+                  id: host
+                },
+                class: 'la'
+              ),
+              display_bootdisk_link_if_authorized(
+                _("Full host '%s' image") % host.name.split('.')[0],
+                {
+                  controller: 'foreman_bootdisk/disks',
+                  action: 'full_host',
+                  id: host
+                },
+                class: 'la'
+              ),
+              content_tag(:li, '', class: 'divider'),
+              display_bootdisk_link_if_authorized(
+                _('Generic image'),
+                {
+                  controller: 'foreman_bootdisk/disks',
+                  action: 'generic'
+                },
+                class: 'la'
+              ),
+              display_bootdisk_for_subnet(host),
+              content_tag(:li, '', class: 'divider'),
+              display_bootdisk_link_if_authorized(
+                _('Help'), {
+                  controller: 'foreman_bootdisk/disks',
+                  action: 'help'
+                },
+                class: 'la'
+              )
+            )
           )
         )
-      )
-    else
-      bootdisk_button_disabled
-    end
+      else
+        bootdisk_button_disabled(host)
+      end
 
-    super
-  end
+      super
+    end
 
-  def bootdisk_button_disabled
-    title_actions(
-      button_group(
-        link_to(_("Boot disk"), '#', :disabled => true, :class => 'btn btn-default',
-                :title => _("Boot disk download not available for %s architecture") % @host.architecture.name)
+    def bootdisk_button_disabled(host)
+      title_actions(
+        button_group(
+          link_to(_('Boot disk'), '#', disabled: true, class: 'btn btn-default',
+                                       title: _('Boot disk download not available for %s architecture') % host.architecture.name)
+        )
       )
-    )
-  end
+    end
 
-  # need to wrap this one in a test for template proxy presence
-  def display_bootdisk_for_subnet
-    if (proxy = @host.try(:subnet).try(:tftp)) && proxy.has_feature?('Templates')
-      display_bootdisk_link_if_authorized(_("Subnet '%s' generic image") % @host.subnet.name, {:controller => 'foreman_bootdisk/disks', :action => 'subnet', :id => @host}, :class=>'la')
-    else
-      ""
+    # need to wrap this one in a test for template proxy presence
+    def display_bootdisk_for_subnet(host)
+      if (proxy = host.try(:subnet).try(:tftp)) && proxy.has_feature?('Templates')
+        display_bootdisk_link_if_authorized(
+          _("Subnet '%s' generic image") % host.subnet.name, {
+            controller: 'foreman_bootdisk/disks',
+            action: 'subnet',
+            id: host
+          },
+          class: 'la'
+        )
+      else
+        ''
+      end
     end
-  end
 
-  # Core Foreman helpers can't look up a URL against a mounted engine
-  def display_bootdisk_link_if_authorized(name, options = {}, html_options = {})
-    if bootdisk_authorized_for(options)
-      link_to(name, bootdisk_url(options), html_options)
-    else
-      ""
+    # Core Foreman helpers can't look up a URL against a mounted engine
+    def display_bootdisk_link_if_authorized(name, options = {}, html_options = {})
+      if bootdisk_authorized_for(options)
+        link_to(name, bootdisk_url(options), html_options)
+      else
+        ''
+      end
     end
-  end
 
-  def bootdisk_url(options)
-    ForemanBootdisk::Engine.routes.url_for(options.merge(:only_path => true, :script_name => foreman_bootdisk_path))
-  end
+    def bootdisk_url(options)
+      ForemanBootdisk::Engine.routes.url_for(options.merge(only_path: true, script_name: foreman_bootdisk_path))
+    end
 
-  def bootdisk_authorized_for(options)
-    User.current.allowed_to?(options)
+    def bootdisk_authorized_for(options)
+      User.current.allowed_to?(options)
+    end
   end
 end