foreman_host_rundeck 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmMzMTViYjY4ZDUzZjlmMzVjNDUwZWJhMWE1NTI5ZDAyNTVkMWM2Yw==
+    ODU3YjRlMmExZTI3MjQ0NWVkY2ViZTRjYzk1ZjM0ZTY0YWRjOThlYQ==
   data.tar.gz: !binary |-
-    NGNkNGM0NWNiNmMxNWIxMWVmZTUwNmQzNDQxNTA1NmE3NzY0YWVlNQ==
+    ZTNhM2Y3MzQyMjZlNmViODcyYjI3ODQwNjY0MjY2MzY2NDRkODJhYw==
 SHA512:
   metadata.gz: !binary |-
-    MjJhMWUwNDI4MWY0MGM2OTNjZjc4MTU4OTk4ZTQ2ZDYzZjk0Zjg3YjFjYzZl
-    YjQwNTJmMTNmYzRiMTcwZTdiMjQwMGY3NDBmMzhjMTdjZTIwMTY5Njc3NGEy
-    N2E3MWY5MGYyOGQzMTFiMTA0YTFkNjYxNjlmZTc0NmYxMjEwNTY=
+    NmZjYjJhYTUyODRlMzIzODc4Nzk5MWJiMDBlOWY4N2Y5YzdkZGQ0Y2JiZjA3
+    N2ExODA3NGJiMjQzNTI2MWY3NjY0NWNkMDMzNmUyOTVhZjY3YjRlM2UzNzQw
+    NGZlYjEzYmUxNDBiMDRkNDAzMjM2ZjE1NjM2YWY1NjEyOTVlODc=
   data.tar.gz: !binary |-
-    YzcwYzBmYmE3NGUwYmM0ZGY2YWM5NWMzZWJhM2M0MWE2N2I5OGEyN2VhODhm
-    ZDQzNDkwNTFkNGFkN2Y2OWE4Y2JiMjJmOTkzYjVmOTBhMjRmMTJhNWQ5Mjc4
-    MzQ3NmQ5MDg4MWIzNWU0OGYxZDdkMWM1NjZlYjEwZGUyYzZlYzE=
+    N2VhOGNjZGIzOTQyMTUwODhmZDMxZDBlYmY0YTZkZTg1ODM0ZGZhYTFhN2Zi
+    YWNmNWQ2ZTZmMDRmNDk2NjBiNWNkMzNiZTA2NGNmNWU5N2Y5OTA3OGM1NDM3
+    MTliOWZmNjUyNGRhZTI3MTNiMTYyMmM0ODZkYjg4MmZkZTU2NTA=

data/README.md

@@ -1,11 +1,53 @@
-# ForemanHostRundeck
+# Foreman Host Rundeck
 
 Creates a yaml representation of rundeck on hosts
 
+* Website: [TheForeman.org](http://theforeman.org)
+* ServerFault tag: [Foreman](http://serverfault.com/questions/tagged/foreman)
+* Issues: [foreman_rundeck Redmine](http://projects.theforeman.org/projects/rundeck/issues)
+* Wiki: [Foreman wiki](http://projects.theforeman.org/projects/foreman/wiki/About)
+* Community and support: #theforeman for general support, #theforeman-dev for development chat in [Freenode](irc.freenode.net)
+* Mailing lists:
+    * [foreman-users](https://groups.google.com/forum/?fromgroups#!forum/foreman-users)
+    * [foreman-dev](https://groups.google.com/forum/?fromgroups#!forum/foreman-dev)
+
 ## 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
+Please see the Foreman manual for appropriate instructions:
+
+* [Foreman: How to Install a Plugin](http://theforeman.org/plugins/)
+
+### Red Hat, CentOS, Fedora, Scientific Linux (rpm)
+
+Set up the repo as explained in the link above, then run (on 1.10+):
+
+    # yum install tfm-rubygem-foreman_host_rundeck
+
+On 1.9:
+
+    # yum install ruby193-rubygem-foreman_host_rundeck
+
+### Debian, Ubuntu (deb)
+
+Set up the repo as explained in the link above, then run:
+
+    # apt-get install ruby-foreman-host-rundeck
+
+### Bundle (gem)
+
+Add the following to bundler.d/Gemfile.local.rb in your Foreman installation directory (/usr/share/foreman by default)
+
+    $ gem 'foreman_host_rundeck'
+
+Then run `bundle install` and `foreman-rake db:migrate` from the same directory
+
+--------------
+
+To verify that the installation was successful, go to Foreman, top bar **Administer > About** and check 'foreman_host_rundeck' shows up in the **System Status** menu under the Plugins tab.
+
+## Usage
+
+[Our wiki covers the basics of Rundeck integration](http://projects.theforeman.org/projects/foreman/wiki/Rundeck_Integration)
 
 ## Contributing
 

data/app/controllers/concerns/foreman_host_rundeck/hosts_controller_extensions.rb

@@ -7,20 +7,20 @@ module ForemanHostRundeck
       alias_method_chain :show, :rundeck
     end
 
-    def index_with_rundeck
+    def index_with_rundeck(title = nil)
       if params[:format] == 'yaml'
         result = {}
         hosts = resource_base.search_for(params[:search], :order => params[:order]).includes(included_associations)
         hosts.each { |h| result.update(RundeckFormatter.new(h).output) }
         render :text => result.to_yaml
       else
-        index_without_rundeck
+        index_without_rundeck(title)
       end
     end
 
     def show_with_rundeck
       if params[:format] == 'yaml'
-        render :text => RundeckFormatter.new(@host).output.to_yaml
+        render :text => RundeckFormatter.new(@host, params[:add_enc_output]).output.to_yaml
       else
         show_without_rundeck
       end

data/app/services/rundeck_formatter.rb

@@ -1,27 +1,47 @@
 class RundeckFormatter
   attr_reader :host
 
-  delegate :comment, :name, :arch, :environment, :os, :facts_hash, :puppetclasses_names, :params, :to => :host
+  delegate :comment, :name, :arch, :environment, :os, :facts_hash, :puppetclasses_names, :params,
+           :hostgroup, :organization, :location, :info,  :to => :host
   delegate :logger, :to => :Rails
 
-  def initialize(host)
+  def initialize(host, include_enc_output = false)
     @host = host
+    @include_enc_output = include_enc_output
   end
 
     def output
     rdecktags = puppetclasses_names.map { |k| "class=#{k}" }
     unless params['rundeckfacts'].empty?
-      rdecktags += params['rundeckfacts'].gsub(/\s+/, '').split(',').map { |rdf| "#{rdf}=" + (facts_hash[rdf] || 'undefined') }
+      rdecktags += format_tags(params,'rundeckfacts', facts_hash)
     end
 
-    {name => {'description' => comment, 'hostname' => name, 'nodename' => name,
-              'Environment' => environment.name,
-              'osArch' => arch.name, 'osFamily' => os.family, 'osName' => os.name,
-              'osVersion' => os.release, 'tags' => rdecktags,
-              'username' => params['rundeckuser'] || 'root'}
-    }
+    unless params['rundeckglobalparams'].empty?
+      rdecktags += format_tags(params, 'rundeckglobalparams', params)
+    end
+
+    rundeck_hash =  { 'description' => comment, 'hostname' => name, 'nodename' => name,
+                      'osArch' => arch.name, 'osFamily' => os.family, 'osName' => os.name,
+                      'osVersion' => os.release, 'tags' => rdecktags,
+                      'username' => params['rundeckuser'] || 'root'}
+    rundeck_hash['Hostgroup'] = hostgroup.name unless hostgroup.nil?
+    rundeck_hash['Environment'] = environment.name unless environment.nil?
+    rundeck_hash['Enc_output'] = info if @include_enc_output
+
+    if SETTINGS[:locations_enabled]
+      rundeck_hash['Location'] = location.name unless location.nil?
+    end
+    if SETTINGS[:organizations_enabled]
+      rundeck_hash['Organization'] = organization.name unless organization.nil?
+    end
+
+    { name => rundeck_hash }
   rescue => e
     logger.warn "Failed to fetch rundeck info for #{to_s}: #{e}"
     {}
+    end
+
+  def format_tags params, tag, tag_location
+    params[tag].gsub(/\s+/, '').split(',').map { |rdf| "#{rdf}=" + (tag_location[rdf] || 'undefined') }
   end
-end
+end

data/lib/foreman_host_rundeck/engine.rb

@@ -19,8 +19,6 @@ module ForemanHostRundeck
     config.to_prepare do
       begin
         HostsController.send(:include, ForemanHostRundeck::HostsControllerExtensions)
-      # rescue => e
-      #   puts "ForemanHostRundeck: skipping engine hook (#{e})"
        end
     end
   end

data/lib/foreman_host_rundeck/version.rb

@@ -1,3 +1,3 @@
 module ForemanHostRundeck
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/functional/hosts_controller_test.rb

@@ -3,15 +3,17 @@ require 'test_plugin_helper'
 class HostsControllerTest < ActionController::TestCase
   setup do
     User.current = User.find_by_login "admin"
+    @host = FactoryGirl.create(:host, :operatingsystem => FactoryGirl.create(:operatingsystem),
+                               :architecture => FactoryGirl.create(:architecture),
+                               :puppetclasses => [FactoryGirl.create(:puppetclass)])
   end
 
-
     test "index returns YAML output for rundeck" do
       get :index, {:format => 'yaml'}, set_session_user
       hosts = YAML.load(@response.body)
       assert_not_empty hosts
       host = Host.first
-      unless (host.nil? || host.name.nil? || hosts.nil? || hosts[host.name].nil?)
+      unless host.nil? || host.name.nil? || hosts.nil? || hosts[host.name].nil?
         assert_equal host.os.name, hosts[host.name]["osName"] # rundeck-specific field
       end
     end
@@ -20,10 +22,23 @@ class HostsControllerTest < ActionController::TestCase
       host = Host.first
       get :show, {:id => host, :format => 'yaml'}, set_session_user
       yaml = YAML.load(@response.body)
-      unless (host.nil? || host.name.nil? || host.os.nil? || yaml[host.name].nil?)
+      unless host.nil? || host.name.nil? || host.os.nil? || yaml[host.name].nil?
         assert_kind_of Hash, yaml[host.name]
         assert_equal host.name, yaml[host.name]["hostname"]
         assert_equal host.os.name, yaml[host.name]["osName"]  # rundeck-specific field
       end
     end
+
+  test "show with add_enc_output shows enc output in YAML" do
+    host = Host.first
+    get :show, {:id => host, :format => 'yaml', :add_enc_output => true}, set_session_user
+    yaml = YAML.load(@response.body)
+    unless host.nil? || host.name.nil? || host.os.nil? || yaml[host.name].nil?
+      assert_kind_of Hash, yaml[host.name]
+      assert_equal host.name, yaml[host.name]["hostname"]
+      assert_equal host.os.name, yaml[host.name]["osName"]  # rundeck-specific field
+      assert_kind_of Hash, yaml[host.name]["Enc_output"]
+      assert_present yaml[host.name]["Enc_output"]
+    end
+  end
 end

data/test/unit/foreman_host_rundeck_test.rb

@@ -3,28 +3,55 @@ require 'test_plugin_helper'
 class ForemanHostRundeckTest < ActiveSupport::TestCase
   setup do
     User.current = User.find_by_login "admin"
+    @host = FactoryGirl.create(:host, :operatingsystem => FactoryGirl.create(:operatingsystem),
+                               :architecture => FactoryGirl.create(:architecture))
   end
 
   test "#rundeck returns hash" do
-    h = hosts(:one)
-    rundeck = RundeckFormatter.new(h).output
+    rundeck = RundeckFormatter.new(@host).output
     assert_kind_of Hash, rundeck
-    assert_equal ['my5name.mydomain.net'], rundeck.keys
-    assert_kind_of Hash, rundeck[h.name]
-    assert_equal 'my5name.mydomain.net', rundeck[h.name]['hostname']
-    assert_equal ["class=auth", "class=base", "class=chkmk", "class=nagios", "class=pam"], rundeck[h.name]['tags']
+    assert_equal [@host.name], rundeck.keys
+    assert_kind_of Hash, rundeck[@host.name]
+    assert_equal @host.hostname, rundeck[@host.name]['hostname']
+    assert_equal @host.puppetclasses, rundeck[@host.name]['tags']
   end
 
   test "#rundeck returns extra facts as tags" do
-    host = hosts(:one)
-    h = FactoryGirl.create(:host, :os => host.os, :arch => host.arch, :puppetclasses => host.puppetclasses, :environment => host.environment)
-    h.params['rundeckfacts'] = "kernelversion, ipaddress\n"
-    h.save!
-    rundeck = RundeckFormatter.new(h).output
+    @host.puppetclasses = [FactoryGirl.create(:puppetclass, :environments => [@host.environment])]
+    @host.params['rundeckfacts'] = "kernelversion, ipaddress\n"
+    @host.save!
+    rundeck = RundeckFormatter.new(@host).output
+    assert rundeck[@host.name]['tags'].include?("class=#{@host.puppetclasses.first.name}"), 'puppet class missing'
+    assert rundeck[@host.name]['tags'].include?('kernelversion=undefined'), 'kernelversion fact missing'
+    assert rundeck[@host.name]['tags'].include?('ipaddress=undefined'), 'ipaddress fact missing'
+  end
+
+  test "#rundeck returns global parameters with values as tags" do
+    @host.puppetclasses = [FactoryGirl.create(:puppetclass, :environments => [@host.environment])]
+    @host.params['rundeckfacts'] = "kernelversion, ipaddress\n"
+    @host.params['rundeckglobalparams'] = "stage\n"
+    @host.params['stage'] = "prod"
+    @host.save!
+    rundeck = RundeckFormatter.new(@host).output
+    assert rundeck[@host.name]['tags'].include?('stage=prod'), 'stage parameter missing'
+  end
 
-    assert rundeck[h.name]['tags'].include?('class=base'), 'puppet class missing'
-    assert rundeck[h.name]['tags'].include?('kernelversion=undefined'), 'kernelversion fact missing'
-    assert rundeck[h.name]['tags'].include?('ipaddress=undefined'), 'ipaddress fact missing'
+  test "#rundeck returns undefined global parameters as tags" do
+    @host.puppetclasses = [FactoryGirl.create(:puppetclass, :environments => [@host.environment])]
+    @host.params['rundeckfacts'] = "kernelversion, ipaddress\n"
+    @host.params['rundeckglobalparams'] = "someparam, stage\n"
+    @host.save!
+    rundeck = RundeckFormatter.new(@host).output
+    assert rundeck[@host.name]['tags'].include?('someparam=undefined'), 'someparam parameter missing'
+    assert rundeck[@host.name]['tags'].include?('stage=undefined'), 'stage parameter missing'
   end
 
+  test "#rundeck does not returns global parameters that are not in params['rundeckglobalparams']" do
+    @host.puppetclasses = [FactoryGirl.create(:puppetclass, :environments => [@host.environment])]
+    @host.params['rundeckfacts'] = "kernelversion, ipaddress\n"
+    @host.params['rundeckglobalparams'] = "someparam\n"
+    @host.save!
+    rundeck = RundeckFormatter.new(@host).output
+    refute rundeck[@host.name]['tags'].include?('stage=undefined')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_host_rundeck
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ori Rabin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2015-12-24 00:00:00.000000000 Z
 dependencies: []
 description: Plugin to create rundeck output for hosts.
 email:
@@ -49,12 +49,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Plugin to create rundeck output for hosts.
 test_files:
-- test/unit/foreman_host_rundeck_test.rb
-- test/functional/hosts_controller_test.rb
 - test/test_plugin_helper.rb
+- test/unit/foreman_host_rundeck_test.rb
 - test/factories/foreman_host_rundeck_factories.rb
+- test/functional/hosts_controller_test.rb