foreman_bootdisk 13.0.0 → 14.0.0

data/app/services/foreman_bootdisk/renderer.rb

@@ -1,30 +1,32 @@
+# 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).new(
+                 nil,
+                 Struct.new(:subnet).new(subnet)
+               )
+             else
+               Struct.new(:token, :subnet).new(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 +38,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/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,4 +1,6 @@
-kind = TemplateKind.unscoped.where(:name => 'Bootdisk').first_or_create
+# frozen_string_literal: true
+
+kind = TemplateKind.unscoped.where(name: 'Bootdisk').first_or_create
 
 organizations = Organization.all
 locations = Location.all
@@ -6,41 +8,41 @@ 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|
+  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
+      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.save!(validate: false) if tmpl.changes.present?
 
   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|
+  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|
     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.save!(validate: false) if tmpl.changes.present?
 
-  ProvisioningTemplate.unscoped.where(:name => created, :default => true).each do |tmpl|
-    tmpl.organizations = organizations if SETTINGS[:organizations_enabled]
-    tmpl.locations = locations if SETTINGS[:locations_enabled]
+  ProvisioningTemplate.unscoped.where(name: created, default: true).each do |template|
+    template.organizations = organizations if SETTINGS[:organizations_enabled]
+    template.locations = locations if SETTINGS[:locations_enabled]
   end
 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.20'
 
-        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]
 
         add_all_permissions_to_default_roles
 
@@ -68,8 +57,8 @@ 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
@@ -80,8 +69,8 @@ module ForemanBootdisk
         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})"
+      rescue StandardError => e
+        Rails.logger.warn "#{ForemanBootdisk::ENGINE_NAME}: skipping engine hook (#{e})"
       end
     end
   end

data/lib/foreman_bootdisk/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanBootdisk
-  VERSION = '13.0.0'
+  VERSION = '14.0.0'
 end

data/lib/tasks/bootdisk.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'rake/testtask'
 require 'tmpdir'
@@ -15,12 +17,12 @@ namespace :bootdisk do
 
   namespace :generate do
     desc 'Generate a static boot disk for a specific host.  NAME=fqdn, OUTPUT path'
-    task :host => :environment do
+    task host: :environment do
       User.as_anonymous_admin do
-        host = Host::Base.unscoped.find_by_name(ENV['NAME']) || raise("cannot find host '#{ENV['NAME']}', specify NAME=fqdn")
+        host = Host::Base.unscoped.find_by(name: ENV['NAME']) || raise("cannot find host '#{ENV['NAME']}', specify NAME=fqdn")
         tmpl = host.bootdisk_template_render
 
-        ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl, :dir => outputdir) do |image|
+        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "#{host.name}.iso")
           FileUtils.mv image, output
           puts "Wrote #{output}"
@@ -29,10 +31,10 @@ namespace :bootdisk do
     end
 
     desc 'Generate a full boot disk for a specific host with the OS bootloader included.  NAME=fqdn, OUTPUT path'
-    task :full_host => :environment do
+    task full_host: :environment do
       User.as_anonymous_admin do
-        host = Host::Base.unscoped.find_by_name(ENV['NAME']) || raise("cannot find host '#{ENV['NAME']}', specify NAME=fqdn")
-        ForemanBootdisk::ISOGenerator.generate_full_host(host, :dir => outputdir) do |image|
+        host = Host::Base.unscoped.find_by(name: ENV['NAME']) || raise("cannot find host '#{ENV['NAME']}', specify NAME=fqdn")
+        ForemanBootdisk::ISOGenerator.generate_full_host(host, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "#{host.name}_#{Date.today.strftime('%Y%m%d')}.iso")
           FileUtils.cp image, output
           puts "Wrote #{output}"
@@ -41,11 +43,11 @@ namespace :bootdisk do
     end
 
     desc 'Generate a generic boot disk.  OUTPUT=path'
-    task :generic => :environment do
+    task generic: :environment do
       User.as_anonymous_admin do
         tmpl = ForemanBootdisk::Renderer.new.generic_template_render
 
-        ForemanBootdisk::ISOGenerator.generate(:ipxe => tmpl, :dir => outputdir) do |image|
+        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "bootdisk_#{URI.parse(Setting[:foreman_url]).host}.iso")
           FileUtils.cp image, output
           puts "Wrote #{output}"
@@ -54,12 +56,12 @@ namespace :bootdisk do
     end
 
     desc 'Generate a subnet disk for a specific subnet. NAME=subnet, OUTPUT=path'
-    task :subnet => :environment do
+    task subnet: :environment do
       User.as_anonymous_admin do
-        subnet = Subnet.unscoped.find_by_name(ENV['NAME']) || raise("cannot find subnet '#{ENV['NAME']}', specify NAME=subnet")
-        subnet.tftp || raise(::Foreman::Exception.new(N_("TFTP feature not enabled for subnet %s"), subnet.name))
+        subnet = Subnet.unscoped.find_by(name: ENV['NAME']) || raise("cannot find subnet '#{ENV['NAME']}', specify NAME=subnet")
+        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, :dir => outputdir) do |image|
+        ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl, dir: outputdir) do |image|
           output = ENV['OUTPUT'] || File.join(outputdir, "bootdisk_subnet_#{subnet.name}.iso")
           FileUtils.cp image, output
           puts "Wrote #{output}"
@@ -71,10 +73,10 @@ end
 
 # Tests
 namespace :test do
-  desc "Test foreman_bootdisk"
+  desc 'Test foreman_bootdisk'
   Rake::TestTask.new(:foreman_bootdisk) do |t|
     test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
-    t.libs << ["test",test_dir]
+    t.libs << ['test', test_dir]
     t.pattern = "#{test_dir}/**/*_test.rb"
     t.verbose = true
     t.warning = false
@@ -83,7 +85,22 @@ end
 
 Rake::Task[:test].enhance ['test:foreman_bootdisk']
 
-load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task["jenkins:unit"].enhance ['test:foreman_bootdisk']
+namespace :foreman_bootdisk do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_bootdisk) do |task|
+        task.patterns = ["#{ForemanBootdisk::Engine.root}/app/**/*.rb",
+                         "#{ForemanBootdisk::Engine.root}/lib/**/*.rb",
+                         "#{ForemanBootdisk::Engine.root}/test/**/*.rb"]
+      end
+    rescue StandardError
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_bootdisk'].invoke
+  end
 end
+
+load 'tasks/jenkins.rake'
+Rake::Task['jenkins:unit'].enhance ['test:foreman_bootdisk', 'foreman_bootdisk:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')