foreman_ipxe 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cfc852927c96c23627c18d000d58c49d6e8279b6
-  data.tar.gz: e8dbaa9a5b65805e06471ebbf71413bd1bd68151
+SHA256:
+  metadata.gz: d6b0acc3adbccdc5259b52d8843a8dc658fed064c06f6e2904791c90444822c4
+  data.tar.gz: 4a4a13198eb1b7a0d6837b21a48ecb6a7e9de8a47ecd364cbdb18df1f72b81ec
 SHA512:
-  metadata.gz: 128182c97baeb0b5baa50e10d26cb69644a42f72740f60b233f45b23ca8acfea86bd93050d1a843552948a4de795d265998ace84c21989a7462dcfcef08de19e
-  data.tar.gz: cbd1a39f93b79d58af811403277dd5e36a58487b641b8145dd393996264f2e1838dcaa65868800fbd148a59e02182c62c08aeafe7f23e2439c599e6b7293845a
+  metadata.gz: 0ac724a5b17329600276dc29c3f16833cebaaf4e97c26007c63a070234f8601b678d6a3b8e1836ac247b3b62dac9b05591828074ec269a697fb6a28d8b5dd8fd
+  data.tar.gz: 37cdea5e26cbb5f7a4c72fadd52857c157e742da3f8035577f7799409f20cdda046a828e99a524f0ca451cb283f892ca1656e8d62a619683b2c116ec6faee0aa

data/.rubocop.yml

@@ -0,0 +1,63 @@
+---
+AllCops:
+  TargetRubyVersion: 2.3
+  TargetRailsVersion: 5.1
+  Exclude:
+    - 'Rakefile'
+
+Rails:
+  Enabled: true
+
+# Don't enforce documentation
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 250
+
+Style/WordArray:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Performance/FixedSize:
+  Exclude:
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+  Exclude:
+    - 'config/routes.rb'
+    - 'lib/foreman_ipxe/engine.rb'
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 200
+  Exclude:
+    - 'test/**/*'
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*'

data/.travis.yml

@@ -1,5 +1,35 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.1.9
-before_install: gem install bundler -v 1.13.7
+  - 2.3
+install:
+  - unset BUNDLE_GEMFILE
+  - cd ..
+  - git clone https://github.com/theforeman/foreman.git -b ${FOREMAN_CORE_BRANCH} --depth 1
+  - cd ${FOREMAN_PLUGIN_NAME}
+  - bundle install --jobs=3 --retry=3
+  - cd ../foreman
+  - echo "gemspec :path => '../${FOREMAN_PLUGIN_NAME}'" > bundler.d/${FOREMAN_PLUGIN_NAME}.local.rb
+  - ln -s settings.yaml.test config/settings.yaml
+  - ln -s database.yml.example config/database.yml
+  - bundle install --jobs=3 --retry=3 --without journald development postgresql mysql2 console journald
+  - bundle exec rake db:migrate RAILS_ENV=test
+script:
+  - cd ../${FOREMAN_PLUGIN_NAME}
+  - bundle exec rubocop
+  - cd ../foreman
+  - bundle exec rake test:${FOREMAN_PLUGIN_NAME}
+env:
+  global:
+    - TESTOPTS=-v
+    - FOREMAN_PLUGIN_NAME=foreman_ipxe
+  matrix:
+    - FOREMAN_CORE_BRANCH=1.18-stable
+    - FOREMAN_CORE_BRANCH=1.19-stable
+addons:
+  apt:
+    packages:
+    - nodejs
+    - git
+    - libsqlite3-dev
+    - zlib1g-dev
+    - libvirt-dev

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in foreman_ipxe.gemspec

data/README.md

@@ -1,15 +1,88 @@
-# foreman_ipxe
+# Foreman iPXE
 
 Adds in PXE loaders for chainloaded iPXE (`undionly.kpxe`, `ipxe.efi`)
 
+This is useful for when you want to selectively chainload specific hosts into iPXE without affecting all other machines with the same OS.
+
 
 ## Installation
 
 Follow the Foreman manual for [advanced installation from gems](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems)
 
+For full usage of this plugin, you might want to create at least a global default iPXE boot template.
+You can also specify a local boot template if need be, though in the case one is missing then a default template will be rendered that just closes iPXE and lets BIOS/UEFI continue the boot with the next device.
+
+## Compatibility
+
+| Foreman Version | Plugin Version |
+| --------------- | --------------:|
+| >= 1.14         | ~> 0.1         |
+| >= 1.18         | ~> 0.2         |
 
 ## Usage
 
+### Global
+
+This plugin adds global iPXE templates for hosts, if your DHCP is set up to always boot iPXE on all hosts - or hosts have iPXE embedded as their boot software.
+
+You'll need to create a global default template for iPXE to support this feature, an example given below;
+
+```erb
+<%#
+kind: iPXE
+model: ProvisioningTemplate
+name: iPXE global default
+snippet: false
+-%>
+#!ipxe
+
+set menu-default local
+set menu-timeout 5000
+
+:start
+menu iPXE global boot menu
+item --key l local     Continue local boot
+item shell             Drop into iPXE shell
+item reboot            Reboot system
+item
+item --key d discovery Foreman Discovery
+choose --timeout ${menu-timeout} --default ${menu-default} selected || goto cancel
+set menu-timeout 0
+goto ${selected}
+
+:cancel
+echo Menu canceled, dropping to shell
+
+:shell
+echo Use the command 'exit' to return to menu
+shell
+set menu-timeout 0
+goto start
+
+:failed
+echo Boot failed, dropping to shell
+goto shell
+
+:reboot
+reboot
+
+:local
+exit
+
+:discovery
+dhcp
+kernel ${next-server}/boot/fdi-image/vmlinuz0 rootflags=loop root=live:/fdi.iso rootfstype=auto ro rd.live.image acpi=force rd.luks=0 rd.md=0 rd.dm=0 rd.lvm=0 rd.bootif=0 rd.neednet=0 nomodeset proxy.url=<%= foreman_server_url %> proxy.type=foreman BOOTIF=01-${net0/mac}
+initrd ${next-server}/boot/fdi-image/initrd0.img
+boot || goto failed
+goto start
+```
+
+If you need to set a host-specific iPXE template, you can set the host parameter `iPXE_Template` to the name of the template that should be rendered for it.
+
+### Chainloading
+
+#### Without DHCP setup
+
 To use the chainloading, you need to generate the iPXE executables first.
 
 ```sh
@@ -29,10 +102,16 @@ make bin-x86_64-efi/ipxe.efi EMBED=default.ipxe
 
 The generated executables should then be uploaded to the root of your TFTP server (or depending on your root path DHCP option).
 
+#### With DHCP setup
+
+Install the officially available iPXE executables (`undionly.kpxe`, `ipxe.efi`) into your TFTP server, then follow the [iPXE guide for "breaking the loop"](http://ipxe.org/howto/chainloading#breaking_the_loop_with_the_dhcp_server).
+
+You want to add a rule that passes the bootfile "https://foreman.example.com/unattended/iPXE" to any client reporting in as user class "iPXE".
+
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ace13/foreman_ipxe.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/foreman_ipxe
 
 
 ## License

data/app/controllers/concerns/foreman_ipxe/unattended_controller_extensions.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ForemanIpxe
+  module UnattendedControllerExtensions
+    extend ActiveSupport::Concern
+
+    IPXE_TEMPLATE_PARAMETER = 'iPXE_Template'
+
+    module Overrides
+      def render_template(type)
+        return super(type) unless ipxe_request?(type)
+
+        @host ||= find_host_by_spoof || find_host_by_token || find_host_by_ip_or_mac
+
+        ipxe_template_kind = TemplateKind.find_by(name: 'iPXE')
+
+        # rubocop:disable Style/SafeNavigation
+        if !@host
+          name = ProvisioningTemplate.global_template_name_for('iPXE', self)
+          template = ProvisioningTemplate.find_global_default_template(name, 'iPXE')
+
+          unless template
+            render_ipxe_message(message: _("Global iPXE template '%s' not found") % name)
+            return
+          end
+        elsif @host && !@host.build?
+          return unless verify_found_host
+
+          name = Setting[:local_boot_iPXE] || ProvisioningTemplate.local_boot_name(:iPXE)
+          template = ProvisioningTemplate.find_by(name: name, template_kind: ipxe_template_kind)
+          template ||= ProvisioningTemplate.new(
+            name: 'iPXE default local boot fallback',
+            template: ForemanIpxe::IpxeStubRenderer.new(
+              message: 'iPXE default local boot fallback'
+            ).to_s
+          )
+        elsif @host && @host.host_params[IPXE_TEMPLATE_PARAMETER]
+          name = @host.host_params[IPXE_TEMPLATE_PARAMETER]
+          template = ProvisioningTemplate.find_by(name: name, template_kind: ipxe_template_kind)
+
+          unless template
+            render_ipxe_message(message: _("iPXE template '%s' specified via a host parameter not found") % name)
+            return
+          end
+        end
+        # rubocop:enable Style/SafeNavigation
+
+        return safe_render(template) if template
+
+        return unless verify_found_host
+        return unless allowed_to_install?
+        load_template_vars
+
+        super
+      end
+    end
+
+    included do
+      prepend Overrides
+
+      skip_before_action :get_host_details, if: -> { ipxe_request?(params[:kind]) }
+      skip_before_action :allowed_to_install?, if: -> { ipxe_request?(params[:kind]) }
+      skip_before_action :load_template_vars, if: -> { ipxe_request?(params[:kind]) }
+    end
+
+    private
+
+    def ipxe_request?(type)
+      %w[iPXE gPXE].include?(type)
+    end
+
+    def render_ipxe_message(message: _('An error occured.'), status: :not_found)
+      render(plain: ForemanIpxe::IpxeMessageRenderer.new(message: message).to_s, status: status, content_type: 'text/plain')
+    end
+  end
+end

data/app/models/concerns/foreman_ipxe/operatingsystem_extensions.rb

@@ -1,13 +1,20 @@
+# frozen_string_literal: true
+
 module ForemanIpxe
   module OperatingsystemExtensions
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def all_loaders_map(arch = 'x64')
-        super(arch)
-          .merge('iPXE BIOS' => 'undionly.kpxe', 'iPXE UEFI' => 'ipxe.efi')
+      def all_loaders_map(*args)
+        super
+          .merge('iPXE Chain BIOS' => 'undionly.kpxe', 'iPXE Chain UEFI' => 'ipxe.efi', 'iPXE' => nil)
           .freeze
       end
+
+      def boot_filename(host = nil)
+        return host.foreman_url('iPXE') if host.pxe_loader == 'iPXE'
+        super(host)
+      end
     end
   end
 end

data/app/models/setting/ipxe.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Setting
+  class Ipxe < ::Setting
+    def self.load_defaults
+      return unless ActiveRecord::Base.connection.table_exists?('settings')
+      return unless super
+
+      templates = proc { Hash[ProvisioningTemplate.unscoped.of_kind('iPXE').map { |tmpl| [tmpl.name, tmpl.name] }] }
+
+      Setting.transaction do
+        [
+          set('global_iPXE', N_('Global default iPXE template.'), ProvisioningTemplate.global_default_name('iPXE'), N_('Global default iPXE template'), nil, collection: templates),
+          set('local_boot_iPXE', N_('Template that will be selected as iPXE default for local boot.'), ProvisioningTemplate.local_boot_name('iPXE'), N_('Local boot iPXE template'), nil, collection: templates)
+        ].compact.each { |s| Setting::Provisioning.create s.update(category: 'Setting::Provisioning') }
+      end
+
+      true
+    end
+
+    def self.humanized_category
+      N_('iPXE')
+    end
+  end
+end

data/app/services/foreman_ipxe/ipxe_message_renderer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ForemanIpxe
+  class IpxeMessageRenderer
+    attr_accessor :message
+
+    def initialize(message: nil)
+      @message = message
+    end
+
+    def to_s
+      <<~MESSAGE
+        #!ipxe
+        echo #{message}
+        shell
+      MESSAGE
+    end
+  end
+end

data/app/services/foreman_ipxe/ipxe_stub_renderer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ForemanIpxe
+  class IpxeStubRenderer
+    attr_accessor :message
+
+    def initialize(message: 'Deliberately empty iPXE template')
+      @message = message
+    end
+
+    def to_s
+      <<~MESSAGE
+        #!ipxe
+        # #{message}
+        exit
+      MESSAGE
+    end
+  end
+end

data/foreman_ipxe.gemspec

@@ -1,8 +1,6 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'foreman_ipxe/version'
+require "#{File.expand_path('lib', __dir__)}/foreman_ipxe/version"
 
 Gem::Specification.new do |spec|
   spec.name          = 'foreman_ipxe'
@@ -12,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Adds chainloaded iPXE loaders'
   spec.description   = 'Allows provisioning iPXE with chainloaded iPXE binaries'
-  spec.homepage      = 'https://github.com/ace13/foreman_ipxe'
+  spec.homepage      = 'https://github.com/ananace/foreman_ipxe'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -20,7 +18,6 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'rubocop', '0.52.1'
 end

data/lib/foreman_ipxe/engine.rb

@@ -1,17 +1,32 @@
+# frozen_string_literal: true
+
 module ForemanIpxe
   class Engine < ::Rails::Engine
     engine_name 'foreman_ipxe'
 
+    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+    config.autoload_paths += Dir["#{config.root}/app/services"]
+
+    initializer 'foreman_ipxe.load_default_settings', before: :load_config_initializers do
+      require_dependency File.expand_path('../../app/models/setting/ipxe.rb', __dir__) if begin
+                                                                                             Setting.table_exists?
+                                                                                           rescue StandardError
+                                                                                             (false)
+                                                                                           end
+    end
+
     initializer 'foreman_ipxe.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_ipxe do
-        requires_foreman '>= 1.14'
+        requires_foreman '>= 1.18'
       end
     end
 
     config.to_prepare do
       begin
-        ::Operatingsystem.send :include, ForemanIpxe::OperatingsystemExtensions
-      rescue => e
+        ::Operatingsystem.send(:include, ForemanIpxe::OperatingsystemExtensions)
+        ::UnattendedController.send(:include, ForemanIpxe::UnattendedControllerExtensions)
+      rescue StandardError => e
         Rails.logger.warn "ForemanIpxe: skipping engine hook(#{e})"
       end
     end

data/lib/foreman_ipxe/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanIpxe
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'
 end

data/lib/foreman_ipxe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_ipxe/engine'
 
 module ForemanIpxe

data/lib/tasks/foreman_ipxe_tasks.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+# Tests
+namespace :test do
+  desc 'Test ForemanIpxe'
+  Rake::TestTask.new(:foreman_ipxe) do |t|
+    test_dir = File.join(File.dirname(__FILE__), '../..', 'test')
+    t.libs << ['test', test_dir]
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
+  end
+end
+
+namespace :foreman_ipxe do
+  task :rubocop do
+    begin
+      require 'rubocop/rake_task'
+      RuboCop::RakeTask.new(:rubocop_foreman_ipxe) do |task|
+        task.patterns = ["#{ForemanIpxe::Engine.root}/app/**/*.rb",
+                         "#{ForemanIpxe::Engine.root}/lib/**/*.rb",
+                         "#{ForemanIpxe::Engine.root}/test/**/*.rb"]
+      end
+    rescue StandardError
+      puts 'Rubocop not loaded.'
+    end
+
+    Rake::Task['rubocop_foreman_ipxe'].invoke
+  end
+end
+
+Rake::Task[:test].enhance ['test:foreman_ipxe']
+
+load 'tasks/jenkins.rake'
+Rake::Task['jenkins:unit'].enhance ['test:foreman_ipxe', 'foreman_ipxe:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: foreman_ipxe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Olofsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.52.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.52.1
 description: Allows provisioning iPXE with chainloaded iPXE binaries
 email:
 - alexander.olofsson@liu.se
@@ -60,17 +46,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/concerns/foreman_ipxe/unattended_controller_extensions.rb
 - app/models/concerns/foreman_ipxe/operatingsystem_extensions.rb
+- app/models/setting/ipxe.rb
+- app/services/foreman_ipxe/ipxe_message_renderer.rb
+- app/services/foreman_ipxe/ipxe_stub_renderer.rb
 - foreman_ipxe.gemspec
 - lib/foreman_ipxe.rb
 - lib/foreman_ipxe/engine.rb
 - lib/foreman_ipxe/version.rb
-homepage: https://github.com/ace13/foreman_ipxe
+- lib/tasks/foreman_ipxe_tasks.rake
+homepage: https://github.com/ananace/foreman_ipxe
 licenses:
 - MIT
 metadata: {}
@@ -90,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Adds chainloaded iPXE loaders