foreman_icinga 0.0.3 → 0.1.0

data/README.md

@@ -0,0 +1,35 @@
+# Foreman Icingaweb2 Plugin
+
+This is a foreman plugin to interact with icingaweb2's [deployment module](https://github.com/Thomas-Gelf/icingaweb2-module-deployment).
+At the moment it basically sets a downtime for a hosts that gets deleted in foreman.
+
+This plugin is work in progress. It should work well, but is subject to a lot of major changes. Try it, report your feedback and contribute!
+
+# Installation
+
+See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)
+for how to install Foreman plugins
+
+# Usage
+
+Go to Administer > Settings > Icinga and set `icinga_address` with your Icingaweb2 address, `icinga_enabled` to either true or false if you want to enable or disable Icingaweb2 integration. In addition you need to set `icinga_token` to an api token specified in the Icingaweb2 deployment module settings.
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+# Copyright
+Copyright 2015 FILIADATA GmbH, Germany
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,47 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanIcinga'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue => _
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/models/concerns/foreman_icinga/host_extensions.rb

@@ -41,21 +41,24 @@ module ForemanIcinga
           'duration' => '7200'
         }
         response = icinga.call('deployment/downtime/schedule', '', params)
-        errors.add(:base, _("Error from Icinga server: '%s'") % response['message']) if response['status'] == 'error'
 
+        if response['status'] == 'error' && ! icinga_ignore_failed_action?
+          errors.add(:base, _("Error from Icinga server: '%s'") % response['message'])
+        end
       rescue => error
         message = _('Failed to set Icinga downtime for %s.') % name
-        errors.add(:base, message)
+        errors.add(:base, message) unless icinga_ignore_failed_action?
         Foreman::Logging.exception(message, error)
       end
-      errors.empty?
+      icinga_ignore_failed_action? || errors.empty?
     end
 
     private
 
     def icinga_configured?
       if icinga_enabled? && (Setting[:icinga_address].blank? || Setting[:icinga_token].blank?)
-        errors.add(:base, _('Icinga plugin is enabled but not configured. Please configure it before trying to delete a host.'))
+        errors.add(:base,
+                   _('Icinga plugin is enabled but not configured. Please configure it before trying to delete a host.'))
       end
       errors.empty?
     end
@@ -63,5 +66,9 @@ module ForemanIcinga
     def icinga_enabled?
       [true, 'true'].include? Setting[:icinga_enabled]
     end
+
+    def icinga_ignore_failed_action?
+      [true, 'true'].include? Setting[:icinga_ignore_failed_action]
+    end
   end
 end

data/app/models/host_status/icinga_status.rb

@@ -14,7 +14,8 @@ module HostStatus
     end
 
     def to_global(_options = {})
-      case self.status
+      return HostStatus::Global::OK unless should_affect_global_status?
+      case status
       when OK
         HostStatus::Global::OK
       when WARNING
@@ -31,7 +32,7 @@ module HostStatus
     end
 
     def to_label(_options = {})
-      case self.status
+      case status
       when OK
         N_('OK')
       when WARNING
@@ -51,12 +52,16 @@ module HostStatus
       true
     end
 
+    def should_affect_global_status?
+      Setting[:icinga_affect_global_status]
+    end
+
     def client
       @icinga ||= Icinga.new
     end
 
     def call_icinga
-      client.call('deployment/health/check', '', {'host' => host.name})
+      client.call('deployment/health/check', '', 'host' => host.name)
     end
 
     def parse_host_status(response)

data/app/models/setting/icinga.rb

@@ -1,42 +1,39 @@
-class Setting::Icinga < ::Setting
-  BLANK_ATTRS << 'icinga_address'
-  BLANK_ATTRS << 'icinga_token'
+class Setting
+  class Icinga < ::Setting
+    BLANK_ATTRS << 'icinga_address'
+    BLANK_ATTRS << 'icinga_token'
 
-  def self.load_defaults
-    if SETTINGS[:icinga].present?
-      default_enabled = SETTINGS[:icinga][:enabled]
-      default_address = SETTINGS[:icinga][:address]
-      default_token = SETTINGS[:icinga][:token]
-      default_icinga_ssl_ca_file = SETTINGS[:icinga][:icinga_ssl_ca_file]
-    end
+    def self.load_defaults
+      # Check the table exists
+      return unless super
 
-    default_enabled = false if default_enabled.nil?
-    default_address ||= 'https://icingahost/icingaweb2/'
-    default_token ||= ''
-    default_icinga_ssl_ca_file ||= "#{SETTINGS[:puppetssldir]}/certs/ca.pem"
+      Setting.transaction do
+        [
+          set('icinga_enabled',
+              _("Integration with Icingaweb2, enabled will set a downtime for a host when it's deleted in Foreman"),
+              false, N_('Icinga enabled?')),
 
-    Setting.transaction do
-      [
-        set('icinga_enabled', _("Integration with Icingaweb2, enabled will set a downtime for a host when it's deleted in Foreman"), default_enabled)
-      ].compact.each { |s| create s.update(:category => 'Setting::Icinga') }
-    end
+          set('icinga_address',
+              _('Foreman will send Icingaweb2 requests to this address'),
+              'https://icingahost/icingaweb2/', N_('Icinga address')),
 
-    Setting.transaction do
-      [
-        set('icinga_address', _('Foreman will send Icingaweb2 requests to this address'), default_address)
-      ].compact.each { |s| create s.update(:category => 'Setting::Icinga') }
-    end
+          set('icinga_token',
+              _('Foreman will authenticate to icingaweb2 using this token'),
+              '', N_('Icinga Token')),
 
-    Setting.transaction do
-      [
-        set('icinga_token', _('Foreman will authenticate to icingaweb2 using this token'), default_token)
-      ].compact.each { |s| create s.update(:category => 'Setting::Icinga') }
-    end
+          set('icinga_ssl_ca_file',
+              _('SSL CA file that Foreman will use to communicate with icinga'),
+              "#{SETTINGS[:puppetssldir]}/certs/ca.pem", N_('Icinga SSL CA file')),
+
+          set('icinga_affect_global_status',
+              _("Icinga status will affect a host's global status when enabled"),
+              true, N_('Icinga should affect global status')),
 
-    Setting.transaction do
-      [
-        set('icinga_ssl_ca_file', _('SSL CA file that Foreman will use to communicate with icinga'), default_icinga_ssl_ca_file)
-      ].compact.each { |s| create s.update(:category => 'Setting::Icinga') }
+          set('icinga_ignore_failed_action',
+              _("Host will be deleted in Foreman even though Foreman was unable to set a downtime in Icinga"),
+              false, N_('Ignore failed icinga requests'))
+        ].compact.each { |s| create! s.update(:category => 'Setting::Icinga') }
+      end
     end
   end
 end

data/app/services/icinga.rb

@@ -10,7 +10,7 @@ class Icinga
 
   def call(endpoint, payload = '', params = {})
     uri = icinga_url_for(endpoint, params.merge(default_params))
-    parse client(uri).post(payload)
+    parse post(uri, payload)
   rescue OpenSSL::SSL::SSLError => e
     message = "SSL Connection to Icinga failed: #{e}"
     logger.warn message
@@ -56,6 +56,10 @@ class Icinga
     RestClient::Resource.new(uri, connect_params)
   end
 
+  def post(path, payload = '')
+    client(path).post(payload)
+  end
+
   def parse(response)
     if response && response.code >= 200 && response.code < 300
       return response.body.present? ? JSON.parse(response.body) : error_response(_('received empty result'))

data/lib/foreman_icinga.rb

@@ -1,3 +1,4 @@
+require 'foreman_icinga/engine'
+
 module ForemanIcinga
-  require 'foreman_icinga/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
 end

data/lib/foreman_icinga/engine.rb

@@ -9,11 +9,13 @@ module ForemanIcinga
     config.autoload_paths += Dir["#{config.root}/app/services"]
 
     initializer 'foreman_icinga.load_default_settings', :before => :load_config_initializers do |_app|
-      require_dependency File.expand_path('../../../app/models/setting/icinga.rb', __FILE__) if begin
-                                                                                                   Setting.table_exists?
-                                                                                                 rescue
-                                                                                                   (false)
-                                                                                                 end
+      if begin
+        Setting.table_exists?
+      rescue
+        false
+      end
+        require_dependency File.expand_path('../../../app/models/setting/icinga.rb', __FILE__)
+      end
     end
 
     initializer 'foreman_icinga.register_plugin', :after => :finisher_hook do |_app|
@@ -24,8 +26,18 @@ module ForemanIcinga
     end
 
     config.to_prepare do
-      Host::Managed.send :include, ForemanIcinga::HostExtensions
-      HostsHelper.send(:include, ForemanIcinga::HostsHelperExt)
+      begin
+        Host::Managed.send :include, ForemanIcinga::HostExtensions
+        HostsHelper.send(:include, ForemanIcinga::HostsHelperExt)
+      rescue => e
+        Rails.logger.warn "ForemanIcinga: skipping engine hook (#{e})"
+      end
+    end
+
+    initializer 'foreman_icinga.register_gettext', after: :load_config_initializers do |_app|
+      locale_dir = File.join(File.expand_path('../../..', __FILE__), 'locale')
+      locale_domain = 'foreman_icinga'
+      Foreman::Gettext::Support.add_text_domain locale_domain, locale_dir
     end
   end
 end

data/lib/foreman_icinga/version.rb

@@ -0,0 +1,3 @@
+module ForemanIcinga
+  VERSION = '0.1.0'
+end

data/lib/tasks/foreman_icinga_tasks.rake

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

data/locale/Makefile

@@ -0,0 +1,62 @@
+#
+# 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_icinga
+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 '*.po')
+MOFILES = $(patsubst %.po,%.mo,$(POFILES))
+POXFILES = $(patsubst %.po,%.pox,$(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 $@
+
+check: $(POXFILES)
+	msgfmt -c ${POTFILE}
+
+# Merge PO files
+update-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msgmerge -N --backup=none -U $$f ${POTFILE} ; \
+	done
+
+# Unify duplicate translations
+uniq-po:
+	for f in $(shell find ./ -name "*.po") ; do \
+		msguniq $$f -o $$f ; \
+	done
+
+tx-pull:
+	tx pull -f
+	for f in $(POFILES) ; do \
+		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
+	done
+	-git commit -a -m "i18n - pulling from tx"
+
+reset-po:
+	# merging po files is unnecessary when using transifex.com
+	git checkout -- ../locale/*/*po
+
+tx-update: tx-pull reset-po $(MOFILES)
+	# amend mo files
+	git add ../locale/*/LC_MESSAGES
+	git commit -a --amend -m "i18n - pulling from tx"
+	-echo Changes commited!

data/locale/en/foreman_icinga.po

@@ -0,0 +1,19 @@
+# foreman_icinga
+#
+# This file is distributed under the same license as foreman_icinga.
+#
+#, 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_icinga.pot

@@ -0,0 +1,19 @@
+# foreman_icinga
+#
+# This file is distributed under the same license as foreman_icinga.
+#
+#, 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"
+