foreman_rescue 0.1.0

data/locale/Makefile

@@ -0,0 +1,60 @@
+#
+# Makefile for PO merging and MO generation. More info in the README.
+#
+# make all-mo (default) - generate MO files
+# make check - check translations using translate-tool
+# make tx-update - download and merge translations from Transifex
+# make clean - clean everything
+#
+DOMAIN = foreman_rescue
+VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
+POTFILE = $(DOMAIN).pot
+MOFILE = $(DOMAIN).mo
+POFILES = $(shell find . -name '$(DOMAIN).po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(POFILES))
+EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+
+%.mo: %.po
+	mkdir -p $(shell dirname $@)/LC_MESSAGES
+	msgfmt -o $(shell dirname $@)/LC_MESSAGES/$(MOFILE) $<
+
+# Generate MO files from PO files
+all-mo: $(MOFILES)
+
+# Check for malformed strings
+%.pox: %.po
+	msgfmt -c $<
+	pofilter --nofuzzy -t variables -t blank -t urls -t emails -t long -t newlines \
+		-t endwhitespace -t endpunc -t puncspacing -t options -t printf -t validchars --gnome $< > $@
+	cat $@
+	! grep -q msgid $@
+
+%.edit.po:
+	touch $@
+
+check: $(POXFILES)
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull: $(EDITFILES)
+	tx pull -f
+	for f in $(EDITFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+
+tx-update: tx-pull
+	@echo
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo
+
+mo-files: $(MOFILES)
+	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git commit -m "i18n - pulling from tx"
+	@echo
+	@echo Changes commited!
+	@echo

data/locale/en/foreman_rescue.po

@@ -0,0 +1,19 @@
+# foreman_rescue
+#
+# This file is distributed under the same license as foreman_rescue.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:54+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+

data/locale/foreman_rescue.pot

@@ -0,0 +1,19 @@
+# foreman_rescue
+#
+# This file is distributed under the same license as foreman_rescue.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: version 0.0.1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2014-08-20 08:46+0100\n"
+"PO-Revision-Date: 2014-08-20 08:46+0100\n"
+"Last-Translator: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language-Team: Foreman Team <foreman-dev@googlegroups.com>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;\n"
+

data/locale/gemspec.rb

@@ -0,0 +1,2 @@
+# Matches foreman_rescue.gemspec
+_('TODO: Description of ForemanRescue.')

data/test/factories/host.rb

@@ -0,0 +1,7 @@
+FactoryGirl.modify do
+  factory :host do
+    trait :rescue_mode do
+      rescue_mode true
+    end
+  end
+end

data/test/functional/hosts_controller_test.rb

@@ -0,0 +1,121 @@
+require 'test_plugin_helper'
+
+module ForemanRescue
+  class HostsControllerTest < ::ActionController::TestCase
+    setup do
+      User.current = FactoryGirl.create(:user, :admin)
+    end
+
+    let(:host) { FactoryGirl.create(:host, :managed) }
+
+    describe '#set_rescue' do
+      setup do
+        @request.env['HTTP_REFERER'] = hosts_path
+      end
+
+      teardown do
+        @request.env['HTTP_REFERER'] = ''
+      end
+
+      context 'when host is not saved' do
+        test 'the flash should inform it' do
+          Host::Managed.any_instance.expects(:set_rescue).returns(false)
+          put :set_rescue, { :id => host.name }, set_session_user
+          assert_response :found
+          assert_redirected_to hosts_path
+          assert flash[:error] =~ /Failed to enable #{host} for rescue system/
+        end
+      end
+
+      context 'when host is saved' do
+        setup do
+          Host::Managed.any_instance.expects(:set_rescue).returns(true)
+        end
+
+        test 'the flash should inform it' do
+          put :set_rescue, { :id => host.name }, set_session_user
+          assert_response :found
+          assert_redirected_to hosts_path
+          assert_equal "Enabled #{host} for rescue system on next boot.", flash[:notice]
+        end
+
+        context 'when reboot is requested' do
+          let(:power_mock) { mock('power') }
+
+          setup do
+            Host::Managed.any_instance.stubs(:power).returns(power_mock)
+          end
+
+          test 'the flash should inform it' do
+            power_mock.stubs(:reset).returns(true)
+            put :set_rescue, { :id => host.name, :host => { :rescue_mode => '1' } }, set_session_user
+            assert_response :found
+            assert_redirected_to hosts_path
+            assert_equal "Enabled #{host} for reboot into rescue system.", flash[:notice]
+          end
+
+          test 'with failed reboot, the flash should inform it' do
+            power_mock.stubs(:reset).returns(false)
+            put :set_rescue, { :id => host.name, :host => { :rescue_mode => '1' } }, set_session_user
+            host.power.reset
+            assert_response :found
+            assert_redirected_to hosts_path
+            assert_equal "Enabled #{host} for boot into rescue system on next boot, but failed to power cycle the host.", flash[:notice]
+          end
+
+          test 'reboot raised exception, the flash should inform it' do
+            power_mock.stubs(:reset).raises(Foreman::Exception)
+            put :set_rescue, { :id => host.name, :host => { :rescue_mode => '1' } }, set_session_user
+            assert_response :found
+            assert_redirected_to hosts_path
+            assert_equal "Enabled #{host} for rescue system on next boot.", flash[:notice]
+          end
+        end
+      end
+    end
+
+    describe '#cancel_rescue' do
+      setup do
+        @request.env['HTTP_REFERER'] = hosts_path
+      end
+
+      teardown do
+        @request.env['HTTP_REFERER'] = ''
+      end
+
+      context 'when host is saved' do
+        setup do
+          Host::Managed.any_instance.expects(:cancel_rescue).returns(true)
+        end
+
+        test 'the flash should inform it' do
+          put :cancel_rescue, { :id => host.name }, set_session_user
+          assert_response :found
+          assert_redirected_to hosts_path
+          assert_equal "Canceled booting into rescue system for #{host}.", flash[:notice]
+        end
+      end
+
+      context 'when host is not saved' do
+        setup do
+          Host::Managed.any_instance.expects(:cancel_rescue).returns(false)
+        end
+
+        test 'the flash should inform it' do
+          put :cancel_rescue, { :id => host.name }, set_session_user
+          assert_response :found
+          assert_redirected_to hosts_path
+          assert_includes flash[:error], "Failed to cancel booting into rescue system for #{host}"
+        end
+      end
+    end
+
+    describe '#rescue' do
+      test 'renders page' do
+        get :rescue, { :id => host.name }, set_session_user
+        assert_response :success
+        assert_template 'foreman_rescue/hosts/rescue'
+      end
+    end
+  end
+end

data/test/test_plugin_helper.rb

@@ -0,0 +1,24 @@
+# This calls the main test_helper in Foreman-core
+require 'test_helper'
+require 'database_cleaner'
+
+# Add plugin to FactoryGirl's paths
+FactoryGirl.definition_file_paths << File.join(File.dirname(__FILE__), 'factories')
+FactoryGirl.reload
+
+# Foreman's setup doesn't handle cleaning up for Minitest::Spec
+DatabaseCleaner.strategy = :transaction
+
+def setup_settings
+  Setting::Rescue.load_defaults
+end
+
+class Minitest::Spec
+  before :each do
+    DatabaseCleaner.start
+  end
+
+  after :each do
+    DatabaseCleaner.clean
+  end
+end

data/test/unit/host_test.rb

@@ -0,0 +1,80 @@
+require 'test_plugin_helper'
+
+class HostTest < ActiveSupport::TestCase
+  setup do
+    User.current = FactoryGirl.build(:user, :admin)
+    setup_settings
+    disable_orchestration
+  end
+
+  context 'a host with tftp orchestration' do
+    let(:organization) { FactoryGirl.create(:organization) }
+    let(:tax_location) { FactoryGirl.create(:location) }
+    let(:template) do
+      FactoryGirl.create(
+        :provisioning_template,
+        :template_kind => TemplateKind.find_by_name('PXELinux'),
+        :locations => [tax_location],
+        :organizations => [organization]
+      )
+    end
+    let(:os) do
+      FactoryGirl.create(
+        :operatingsystem,
+        :with_os_defaults,
+        :with_associations,
+        :family => 'Redhat',
+        :provisioning_templates => [template]
+      )
+    end
+    let(:host) do
+      FactoryGirl.create(
+        :host,
+        :managed,
+        :with_tftp_orchestration,
+        :operatingsystem => os,
+        :pxe_loader => 'PXELinux BIOS',
+        :organization => organization,
+        :location => tax_location
+      )
+    end
+
+    context 'with rescue mode enabled' do
+      setup do
+        host.queue.clear
+        host.rescue_mode = true
+      end
+
+      test 'should queue tftp update' do
+        assert_valid host
+        tasks = host.queue.all.map(&:name)
+        assert_includes tasks, "Deploy TFTP PXEGrub2 config for #{host}"
+        assert_includes tasks, "Deploy TFTP PXELinux config for #{host}"
+        assert_includes tasks, "Deploy TFTP PXEGrub config for #{host}"
+        assert_equal 3, tasks.size
+      end
+
+      test 'should deploy rescue template' do
+        Setting['rescue_pxelinux_tftp_template'] = template.name
+        ProxyAPI::TFTP.any_instance.expects(:set).with('PXELinux', host.mac, :pxeconfig => template.template).once
+        host.stubs(:skip_orchestration?).returns(false) # Enable orchestration
+        assert host.save
+      end
+    end
+  end
+
+  context 'rescue mode tftp remplate rendering' do
+    let(:host) { FactoryGirl.build(:host, :managed, :rescue_mode) }
+    let(:template) do
+      FactoryGirl.create(:provisioning_template, :name => 'my template',
+                                                 :template => 'test content',
+                                                 :template_kind => template_kinds(:pxelinux))
+    end
+
+    test 'renders tftp template' do
+      Setting['rescue_pxelinux_tftp_template'] = template.name
+      rendered = host.primary_interface.send(:rescue_mode_pxe_render, 'PXELinux')
+      assert_equal template.template, rendered
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: foreman_rescue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timo Goebel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Foreman Plugin to provide the ability to boot a host into a rescue system.
+email:
+- timo.goebel@dm.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/foreman_rescue/hosts_controller.rb
+- app/helpers/concerns/foreman_rescue/hosts_helper_extensions.rb
+- app/models/concerns/foreman_rescue/host_extensions.rb
+- app/models/concerns/foreman_rescue/orchestration/tftp.rb
+- app/models/setting/rescue.rb
+- app/views/foreman_rescue/hosts/rescue.html.erb
+- config/routes.rb
+- db/migrate/20170901131321_add_rescue_mode_to_host.foreman_rescue.rb
+- lib/foreman_rescue.rb
+- lib/foreman_rescue/engine.rb
+- lib/foreman_rescue/version.rb
+- lib/tasks/foreman_rescue_tasks.rake
+- locale/Makefile
+- locale/en/foreman_rescue.po
+- locale/foreman_rescue.pot
+- locale/gemspec.rb
+- test/factories/host.rb
+- test/functional/hosts_controller_test.rb
+- test/test_plugin_helper.rb
+- test/unit/host_test.rb
+homepage: https://github.com/dm-drogeriemarkt/foreman_rescue
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Provides the ability to boot a host into a rescue system.
+test_files:
+- test/unit/host_test.rb
+- test/factories/host.rb
+- test/test_plugin_helper.rb
+- test/functional/hosts_controller_test.rb