foreman_bootdisk 13.0.0 → 16.1.0

data/release-gem

@@ -0,0 +1,84 @@
+#!/bin/env ruby
+# frozen_string_literal: true
+# rubocop:disable all
+
+$plugin_name = "foreman_bootdisk"
+RUBY_VERSION_FILE = "lib/#{$plugin_name}/version.rb"
+
+def die(msg)
+  STDERR.puts msg; exit 1
+end
+
+def run(cmd)
+  puts `#{cmd}`
+  die("Command #{cmd} failed with #{$?}!") if $?.to_i != 0
+  true
+end
+
+def action(question)
+  puts "#{question} ? [Y/n]"
+  die("Aborted.") if STDIN.gets.chomp.match(/^(n|no|nope)$/i)
+  die("Check failed, exiting.") if block_given? && ! yield
+end
+
+action "Extracted strings with: rake plugin:gettext[#{$plugin_name}] (Foreman dir)"
+
+action "Pulled updates with: make -C locale tx-update"
+
+action "Merged the updates with: rake plugin:gettext[#{$plugin_name}] (Foreman dir)"
+
+action "Rebuilt the MO files with: make -C locale mo-files" do
+  Dir["locale/**/*.po"].each do |po|
+    mo = po.sub(/#{$plugin_name}\.po$/, "LC_MESSAGES/#{$plugin_name}.mo")
+    puts("Warning, file #{mo} does not exist!") unless File.exist?(mo)
+    puts("Warning, file #{mo} outdated!") if File.mtime(po) > File.mtime(mo)
+  end
+end
+
+action "Want me to update AUTHORS file" do
+  run "git log --pretty=format:'%an' | sort -u > AUTHORS"
+end
+
+action "Modified lib/#{$plugin_name}/engine.rb to match minimum Foreman core version"
+
+action "Modified #{RUBY_VERSION_FILE} to match desired version"
+
+action "Created 'Version X.Y' commit with engine.rb/version.rb change"
+
+action "Created git tag" do
+  $git_version = `git describe --abbrev=0 --tags`.chomp.sub("v", "")
+  $git_version == File.read(RUBY_VERSION_FILE).match(/VERSION\s*=\s'([0-9\.]+)'/)[1]
+end
+
+action "Is version #{$git_version} the one to be released"
+
+$gem_filename = "#{$plugin_name}-#{$git_version}.gem"
+action "Shall I build the #{$gem_filename} now" do
+  run "gem build #{$plugin_name}.gemspec"
+end
+
+action "Investigated the #{$gem_filename} via gem compare -k -b #{$plugin_name} OLD #{$git_version} -k" do
+  run "tar -xOf #{$gem_filename} data.tar.gz | tar -z -list | sort"
+end
+
+action "Created and built OS distribution packages"
+
+action "Updated dependencies in both RPM and DEB spec files"
+
+action "All commits and *tags* pushed to origin"
+
+action "Shell I push the #{$gem_filename} to rubygems.org now" do
+  run "gem push #{$gem_filename}"
+end
+
+action "Is https://rubygems.org/gems/#{$plugin_name} looking good"
+
+action "Created new stable branch and pushed to origin"
+
+action "Updated documentation at www.theforeman.org?"
+
+action "Updated jenkins_job_builder http://bit.ly/2iZKR3B branch"
+
+puts "Well done! Go ahead and create documentation and changelog:"
+puts "  git log --pretty=format:'%s' develop...X.Y.Z"
+puts "  git log --pretty=format:'%an' develop...X.Y.Z | sort -u"

data/test/functional/foreman_bootdisk/api/v2/disks_controller_test.rb

@@ -1,61 +1,63 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class ForemanBootdisk::Api::V2::DisksControllerTest < ActionController::TestCase
   include ForemanBootdiskTestHelper
   setup :setup_bootdisk
 
-  test "should generate generic image" do
-    ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(:ipxe => regexp_matches(/disk generic host template/))).yields("temp ISO")
-    @controller.expects(:read_file).with("temp ISO").returns("ISO image")
+  test 'should generate generic image' do
+    ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(ipxe: regexp_matches(/disk generic host template/))).yields('temp ISO')
+    @controller.expects(:read_file).with('temp ISO').returns('ISO image')
     get :generic
     assert_response :success
-    assert_equal "ISO image", @response.body
+    assert_equal 'ISO image', @response.body
   end
 
-  describe "#host" do
+  describe '#host' do
     setup :setup_referer
     setup :setup_host_env
 
-    test "should generate host image" do
-      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(:ipxe => regexp_matches(/disk host template/))).yields("temp ISO")
-      @controller.expects(:read_file).with("temp ISO").returns("ISO image")
-      get :host, params: {:id => @host.name}
+    test 'should generate host image' do
+      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(ipxe: regexp_matches(/disk host template/))).yields('temp ISO')
+      @controller.expects(:read_file).with('temp ISO').returns('ISO image')
+      get :host, params: { id: @host.name }
       assert_response :success
-      assert_equal "ISO image", @response.body
+      assert_equal 'ISO image', @response.body
     end
 
-    test "should generate full host image" do
-      ForemanBootdisk::ISOGenerator.expects(:generate_full_host).with(@host).yields("temp ISO")
-      @controller.expects(:read_file).with("temp ISO").returns("ISO image")
-      get :host, params: {:id => @host.name, :full => true}
+    test 'should generate full host image' do
+      ForemanBootdisk::ISOGenerator.expects(:generate_full_host).with(@host).yields('temp ISO')
+      @controller.expects(:read_file).with('temp ISO').returns('ISO image')
+      get :host, params: { id: @host.name, full: true }
       assert_response :success
-      assert_equal "ISO image", @response.body
+      assert_equal 'ISO image', @response.body
     end
   end
 
-  describe "default API version 2" do
+  describe 'default API version 2' do
     setup :setup_host_env
 
-    test "path - /api/hosts/:host_id routes to #host" do
-      if Rails::VERSION::MAJOR >= 5
-        expected_path = "/api/v2/hosts/#{@host.id}"
-      else
-        expected_path = "/api/hosts/#{@host.id}"
-      end
+    test 'path - /api/hosts/:host_id routes to #host' do
+      expected_path = if Rails::VERSION::MAJOR >= 5
+                        "/api/v2/hosts/#{@host.id}"
+                      else
+                        "/api/hosts/#{@host.id}"
+                      end
       assert_routing expected_path,
-                     :format     => "json",
-                     :apiv       => "v2",
-                     :controller => "foreman_bootdisk/api/v2/disks",
-                     :action     => "host",
-                     :id         => @host.id.to_s
+                     format: 'json',
+                     apiv: 'v2',
+                     controller: 'foreman_bootdisk/api/v2/disks',
+                     action: 'host',
+                     id: @host.id.to_s
     end
 
-    test "path - /api/generic routes to #generic" do
-      assert_routing "/api/generic",
-                     :format     => "json",
-                     :apiv       => "v2",
-                     :controller => "foreman_bootdisk/api/v2/disks",
-                     :action     => "generic"
+    test 'path - /api/generic routes to #generic' do
+      assert_routing '/api/generic',
+                     format: 'json',
+                     apiv: 'v2',
+                     controller: 'foreman_bootdisk/api/v2/disks',
+                     action: 'generic'
     end
   end
 end

data/test/functional/foreman_bootdisk/api/v2/subnet_disks_controller_test.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class ForemanBootdisk::Api::V2::SubnetDisksControllerTest < ActionController::TestCase
   include ForemanBootdiskTestHelper
   setup :setup_bootdisk
 
-  describe "#subnet_host" do
+  describe '#subnet_host' do
     setup :setup_referer
     setup :setup_org_loc
     setup :setup_subnet
     setup :setup_host
 
-    test "should generate subnet generic host image" do
-      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(:ipxe => regexp_matches(/disk generic host template/))).yields("temp ISO")
-      ForemanBootdisk::Renderer.any_instance.stubs(:bootdisk_chain_url).yields("http://smart-proxy.lan")
-      File.expects(:read).with("temp ISO").returns("ISO image")
-      get :subnet, params: {:id => @host.subnet.id}
+    test 'should generate subnet generic host image' do
+      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(ipxe: regexp_matches(/disk generic host template/))).yields('temp ISO')
+      ForemanBootdisk::Renderer.any_instance.stubs(:bootdisk_chain_url).yields('http://smart-proxy.lan')
+      File.expects(:read).with('temp ISO').returns('ISO image')
+      get :subnet, params: { id: @host.subnet.id }
       assert_response :success
-      assert_equal "ISO image", @response.body
+      assert_equal 'ISO image', @response.body
     end
   end
 end

data/test/functional/foreman_bootdisk/disks_controller_test.rb

@@ -1,64 +1,66 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class ForemanBootdisk::DisksControllerTest < ActionController::TestCase
   include ForemanBootdiskTestHelper
   setup :setup_bootdisk
 
-  test "should generate generic image" do
-    ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(:ipxe => regexp_matches(/disk generic host template/))).yields("temp ISO")
-    @controller.expects(:read_file).with("temp ISO").returns("ISO image")
+  test 'should generate generic image' do
+    ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(ipxe: regexp_matches(/disk generic host template/))).yields('temp ISO')
+    @controller.expects(:read_file).with('temp ISO').returns('ISO image')
     get :generic, session: set_session_user
     assert_response :success
-    assert_equal "ISO image", @response.body
+    assert_equal 'ISO image', @response.body
   end
 
-  describe "#host" do
+  describe '#host' do
     setup :setup_referer
     setup :setup_org_loc
     setup :setup_subnet
     setup :setup_host
 
-    test "should generate host image" do
-      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(:ipxe => regexp_matches(/disk host template/))).yields("temp ISO")
-      @controller.expects(:read_file).with("temp ISO").returns("ISO image")
-      get :host, params: {:id => @host.name}, session: set_session_user
+    test 'should generate host image' do
+      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(ipxe: regexp_matches(/disk host template/))).yields('temp ISO')
+      @controller.expects(:read_file).with('temp ISO').returns('ISO image')
+      get :host, params: { id: @host.name }, session: set_session_user
       assert_response :success
-      assert_equal "ISO image", @response.body
+      assert_equal 'ISO image', @response.body
     end
 
-    test "should generate full host image" do
-      ForemanBootdisk::ISOGenerator.expects(:generate_full_host).with(@host).yields("temp ISO")
-      @controller.expects(:read_file).with("temp ISO").returns("ISO image")
-      get :full_host, params: {:id => @host.name}, session: set_session_user
+    test 'should generate full host image' do
+      ForemanBootdisk::ISOGenerator.expects(:generate_full_host).with(@host).yields('temp ISO')
+      @controller.expects(:read_file).with('temp ISO').returns('ISO image')
+      get :full_host, params: { id: @host.name }, session: set_session_user
       assert_response :success
-      assert_equal "ISO image", @response.body
+      assert_equal 'ISO image', @response.body
     end
 
-    test "should generate subnet image" do
-      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(:ipxe => regexp_matches(/disk generic host template/))).yields("temp ISO")
-      ForemanBootdisk::Renderer.any_instance.stubs(:bootdisk_chain_url).yields("http://smart-proxy.lan")
-      @controller.expects(:read_file).with("temp ISO").returns("ISO image")
-      get :subnet, params: {:id => @host.name}, session: set_session_user
+    test 'should generate subnet image' do
+      ForemanBootdisk::ISOGenerator.expects(:generate).with(has_entry(ipxe: regexp_matches(/disk generic host template/))).yields('temp ISO')
+      ForemanBootdisk::Renderer.any_instance.stubs(:bootdisk_chain_url).yields('http://smart-proxy.lan')
+      @controller.expects(:read_file).with('temp ISO').returns('ISO image')
+      get :subnet, params: { id: @host.name }, session: set_session_user
       assert_empty flash[:error]
       assert_response :success
-      assert_equal "ISO image", @response.body
+      assert_equal 'ISO image', @response.body
     end
   end
 
-  describe "#host without tftp" do
+  describe '#host without tftp' do
     setup :setup_referer
     setup :setup_org_loc
     setup :setup_subnet_no_tftp
     setup :setup_host
 
-    test "should not generate subnet image" do
-      get :subnet, params: {:id => @host.name}, session: set_session_user
+    test 'should not generate subnet image' do
+      get :subnet, params: { id: @host.name }, session: set_session_user
       assert_match(/Failed.*: TFTP feature not enabled/, flash[:error])
       assert_response :redirect
     end
   end
 
-  test "should render help" do
+  test 'should render help' do
     get :help, session: set_session_user
     assert_response :success
   end

data/test/models/host/managed_test.rb

@@ -1,22 +1,26 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
-class Host::ManagedTest < ActiveSupport::TestCase
-  include ForemanBootdiskTestHelper
+module Host
+  class ManagedTest < ActiveSupport::TestCase
+    include ForemanBootdiskTestHelper
 
-  setup do
-    User.current = users(:admin)
-    setup_bootdisk
-  end
+    setup do
+      User.current = users(:admin)
+      setup_bootdisk
+    end
 
-  context 'with host' do
-    let(:host) { FactoryBot.create(:host, :managed, :with_subnet, build: true) }
+    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 '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'
+      test 'renders the host bootdisk template' do
+        assert_includes host.bootdisk_template_render, 'loop_success'
+      end
     end
   end
 end

data/test/test_plugin_helper.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require 'test_helper'
+require 'webmock/minitest'
+require 'webmock'
 
 module ForemanBootdiskTestHelper
   def setup_bootdisk
@@ -26,25 +30,25 @@ module ForemanBootdiskTestHelper
   end
 
   def setup_referer
-    request.env["HTTP_REFERER"] = "/history"
+    request.env['HTTP_REFERER'] = '/history'
   end
 
   def setup_org_loc
     disable_orchestration
-    @org, @loc = FactoryBot.create(:organization), FactoryBot.create(:location)
+    @org = FactoryBot.create(:organization)
+    @loc = FactoryBot.create(:location)
   end
 
   def setup_subnet
-    tftp_proxy = FactoryBot.create(:smart_proxy, :features => [FactoryBot.create(:tftp_feature)])
-    setup_subnet_no_tftp.update! :tftp => tftp_proxy
+    tftp_proxy = FactoryBot.create(:smart_proxy, features: [FactoryBot.create(:tftp_feature)])
+    setup_subnet_no_tftp.update! tftp: tftp_proxy
   end
 
   def setup_subnet_no_tftp
-    @subnet = FactoryBot.create(:subnet_ipv4, :gateway => '10.0.1.254', :dns_primary => '8.8.8.8', :organizations => [@org], :locations => [@loc])
+    @subnet = FactoryBot.create(:subnet_ipv4, gateway: '10.0.1.254', dns_primary: '8.8.8.8', organizations: [@org], locations: [@loc])
   end
 
   def setup_host
-    @host = FactoryBot.create(:host, :managed, :subnet => @subnet, :ip => @subnet.network.sub(/0$/, '4'), :organization => @org, :location => @loc)
+    @host = FactoryBot.create(:host, :managed, subnet: @subnet, ip: @subnet.network.sub(/0$/, '4'), organization: @org, location: @loc)
   end
-
 end

data/test/unit/access_permissions_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 require 'unit/shared/access_permissions_test_base'
 

data/test/unit/concerns/compute_resources/vmware_test.rb

@@ -1,79 +1,83 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
-class ForemanBootdisk::VmwareTest < ActiveSupport::TestCase
-  describe "#create_vm" do
-    setup do
-      @cr = FactoryBot.build(:vmware_cr)
-      @cr.stubs(:test_connection)
-    end
+module ForemanBootdisk
+  class VmwareTest < ActiveSupport::TestCase
+    describe '#create_vm' do
+      setup do
+        @cr = FactoryBot.build(:vmware_cr)
+        @cr.stubs(:test_connection)
+      end
 
-    test "does not call clone_vm when bootdisk provisioning" do
-      args = { "provision_method" => "bootdisk" }
-      mock_vm = mock('vm')
-      mock_vm.stubs(:firmware)
-      mock_vm.expects(:save).returns(mock_vm)
-      @cr.stubs(:parse_networks).returns(args)
-      @cr.expects(:clone_vm).times(0)
-      @cr.expects(:new_vm).returns(mock_vm)
-      @cr.create_vm(args)
+      test 'does not call clone_vm when bootdisk provisioning' do
+        args = { 'provision_method' => 'bootdisk' }
+        mock_vm = mock('vm')
+        mock_vm.stubs(:firmware)
+        mock_vm.expects(:save).returns(mock_vm)
+        @cr.stubs(:parse_networks).returns(args)
+        @cr.expects(:clone_vm).times(0)
+        @cr.expects(:new_vm).returns(mock_vm)
+        @cr.create_vm(args)
+      end
     end
-  end
 
-  describe "#new_vm" do
-    setup do
-      @cr = FactoryBot.build(:vmware_cr)
-    end
+    describe '#new_vm' do
+      setup do
+        @cr = FactoryBot.build(:vmware_cr)
+      end
 
-    test "calls client with cdrom drive and correct boot order when bootdisk provisioning" do
-      args = { "provision_method" => "bootdisk" }
-      mock_client = mock('client')
-      mock_servers = mock('servers')
-      mock_cdrom = mock('cdrom')
-      mock_client.expects(:servers).returns(mock_servers)
-      mock_servers.expects(:new).with() do |args|
-        assert_equal args[:boot_order], ['cdrom', 'disk']
-        assert_equal args[:boot_retry], 10
-        assert_includes args[:cdroms], mock_cdrom
+      test 'calls client with cdrom drive and correct boot order when bootdisk provisioning' do
+        args = { 'provision_method' => 'bootdisk' }
+        mock_client = mock('client')
+        mock_servers = mock('servers')
+        mock_cdrom = mock('cdrom')
+        mock_client.expects(:servers).returns(mock_servers)
+        mock_servers.expects(:new).with do |opts|
+          assert_equal opts[:boot_order], %w[cdrom disk]
+          assert_equal opts[:boot_retry], 10
+          assert_includes opts[:cdroms], mock_cdrom
+        end
+        @cr.expects(:new_cdrom).returns(mock_cdrom)
+        @cr.expects(:new_interface)
+        @cr.expects(:new_volume)
+        @cr.expects(:datacenter)
+        @cr.expects(:client).returns(mock_client)
+        @cr.new_vm(args)
       end
-      @cr.expects(:new_cdrom).returns(mock_cdrom)
-      @cr.expects(:new_interface)
-      @cr.expects(:new_volume)
-      @cr.expects(:datacenter)
-      @cr.expects(:client).returns(mock_client)
-      @cr.new_vm(args)
     end
-  end
 
-  describe "#parse_args" do
-    setup do
-      @cr = FactoryBot.build(:vmware_cr)
-    end
+    describe '#parse_args' do
+      setup do
+        @cr = FactoryBot.build(:vmware_cr)
+      end
 
-    test "should add a cdrom drive while keeping other parameters when provision_method is bootdisk" do
-      mock_cdrom = mock('cdrom')
-      @cr.expects(:new_cdrom).returns(mock_cdrom)
-      attrs_in = HashWithIndifferentAccess.new(
-        'cpus' => '1',
-        :provision_method => 'bootdisk',
-      )
-      attrs_out = {
-        :cpus => '1',
-        :provision_method => 'bootdisk',
-        :cdroms => [mock_cdrom],
-        :boot_order => ['cdrom', 'disk'],
-        :boot_retry => 10
-      }
-      assert_equal attrs_out, @cr.parse_args(attrs_in)
+      test 'should add a cdrom drive while keeping other parameters when provision_method is bootdisk' do
+        mock_cdrom = mock('cdrom')
+        @cr.expects(:new_cdrom).returns(mock_cdrom)
+        attrs_in = HashWithIndifferentAccess.new(
+          'cpus' => '1',
+          :provision_method => 'bootdisk'
+        )
+        attrs_out = {
+          cpus: '1',
+          provision_method: 'bootdisk',
+          cdroms: [mock_cdrom],
+          boot_order: %w[cdrom disk],
+          boot_retry: 10
+        }
+        assert_equal attrs_out, @cr.parse_args(attrs_in)
+      end
     end
-  end
 
-  describe "#capabilities" do
-    setup do
-      @cr = FactoryBot.build(:vmware_cr)
-    end
+    describe '#capabilities' do
+      setup do
+        @cr = FactoryBot.build(:vmware_cr)
+      end
 
-    test "should include bootdisk" do
-      assert_includes @cr.capabilities, :bootdisk
+      test 'should include bootdisk' do
+        assert_includes @cr.capabilities, :bootdisk
+      end
     end
   end
 end