foreman_hooks-host_rename 0.0.3

data/Gemfile

@@ -0,0 +1,2 @@
+gemspec
+source 'https://rubygems.org'

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    foreman_hooks-host_rename (0.0.3)
+      foreman_hooks
+      json
+      kwalify
+      minitest
+      rest_client
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    foreman_hooks (0.3.7)
+    json (1.8.1)
+    kwalify (0.7.2)
+    minitest (5.4.2)
+    netrc (0.7.9)
+    rake (10.3.2)
+    rest_client (1.8.1)
+      netrc (~> 0.7.7)
+    sqlite3 (1.3.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  foreman_hooks-host_rename!
+  rake

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2014 Bronto Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+foreman_hooks-host_rename
+===================
+
+This hook is designed to extend the Foreman Hooks mechanism to detect when a host 
+has been renamed and fire a custom 'rename' hook.
+
+Requirements
+============
+
+This hook has only been tested in the following environment:
+
+ * CentOS 6.5
+ * Ruby 1.9.3 installed via the SCL mechanism
+
+Installation
+============
+
+  1. Install the gem as root, using the Ruby 1.9 install location:
+  
+        sudo scl enable ruby193 'gem install foreman_hooks-host_rename'
+  
+  2. Create a configuration file in /etc/foreman_hooks-host_rename/settings.yaml.
+     See the 'Configuration' section for details.
+  
+  3. Run 'sudo foreman_hooks-host_rename --install' to register the hook with
+     Foreman.
+  
+  4. Restart Apache via 'sudo service httpd restart'
+
+Configuration
+=============
+
+The configuration file is stored in conf/settings.yaml. Here are the variables:
+
+foreman_host        
+
+  The FQDN of the host that runs Foreman
+
+foreman_user, foreman_password
+  
+  The user account to login to Foreman with
+
+rename_hook_command
+
+  The command to run after a host is renamed. A JSON object will be passed in via STDIN, and two parameters will be set in ARGV:
+    1. the old hostname, as a FQDN
+    2. the new hostname, as a FQDN
+
+For an example, see conf/settings.yaml.EXAMPLE
+
+Uninstallation
+==============
+
+To remove the hook, perform the following steps:
+
+1. Run 'sudo foreman_hooks-host_rename --uninstall' to unregister the hook with
+   Foreman.
+
+2. Restart Apache via 'sudo service httpd restart'
+
+Bugs
+====
+
+ * Some configuration options are undocumented.
+ * The database and logs are stored in /var/tmp by default.
+   
+Copyright
+=========
+
+Copyright (c) 2014 Bronto Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/foreman_hooks-host_rename

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+#
+
+require 'optparse'
+require 'ostruct'
+require 'foreman_hook/host_rename'
+
+action = :run
+options = OpenStruct.new
+options.verbose = false
+
+OptionParser.new do |opts|
+  opts.on( '--verbose', 'Display extra debugging information') do |arg|
+    options.verbose = true
+  end
+
+  opts.on( '--install', 'Install the hook into Foreman') do
+    action = :install
+  end
+
+  opts.on( '--uninstall', 'Install the hook from Foreman') do
+    action = :uninstall
+  end
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end.parse!
+
+hook = ForemanHook::HostRename.new
+case action
+when :install
+  hook.install
+when :uninstall
+  hook.uninstall
+when :run
+  hook.run
+else
+  raise ArgumentError, 'Must specify a valid action' if action.nil?
+end

data/conf/schema.yaml

@@ -0,0 +1,28 @@
+type:    map
+mapping:
+  "foreman_user":
+    type:     str
+    required: yes
+  "foreman_password":
+    type:     str
+    required: yes
+  "foreman_host":
+    type:     str
+    required: yes
+  "hook_user":
+    type:     str
+    required: no
+  "log_path":
+    type:     str
+    required: no
+  "log_level":
+    type:     str
+    required: no
+    pattern:  /^(debug|warn|notice)$/
+  "database_path":
+    type:     str
+    pattern:  /^\//
+    required: no
+  "rename_hook_command":
+    type:     str
+    required: yes

data/conf/settings.yaml.EXAMPLE

@@ -0,0 +1,5 @@
+---
+:foreman_host: 'foreman.acme.com'
+:foreman_user: 'api-user'
+:foreman_password: 'password1'
+:rename_hook_command: '/bin/true'

data/db/.gitignore

@@ -0,0 +1 @@
+*.db

data/foreman_hooks-host_rename.gemspec

@@ -0,0 +1,31 @@
+require File.expand_path("../lib/foreman_hooks/host_rename/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "foreman_hooks-host_rename"
+  s.version     = ForemanHooks::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mark Heily", "Bronto Software, Inc."]
+  s.email       = ["mark.heily@bronto.com"]
+  s.homepage    = "https://github.com/bronto/foreman_hooks-host_rename"
+  s.summary     = "Foreman hook that fires when a host is renamed"
+  s.description = "See the README for details"
+
+  # Dependencies
+  s.required_ruby_version = '>= 1.9.3'
+  %w(foreman_hooks minitest json sqlite3 rest_client kwalify).each do |dep| 
+    s.add_runtime_dependency dep
+  end
+
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+
+  # If you need to check in files that aren't .rb files, add them here
+  s.files        = Dir[
+	"conf/{schema.yaml,settings.yaml.EXAMPLE}", "db/.gitignore",
+	"LICENSE", "*.md", "Gemfile", "Gemfile.lock", "*.gemspec",
+	] + Dir.glob("{bin,lib}/**/*")
+  s.require_path = 'lib'
+
+  s.executables = ["foreman_hooks-host_rename"]
+
+end

data/lib/foreman_hooks/host_rename.rb

@@ -0,0 +1,290 @@
+#
+# Foreman hook that detects when a host has been renamed and runs a 'rename' hook
+#
+# Copyright (c) 2014 Bronto Software Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+raise 'Unsupported version of Ruby' unless RUBY_VERSION >= '1.9.3'
+
+module ForemanHook
+  class HostRename
+    require 'fileutils'
+    require 'json'
+    require 'logger'
+    require 'kwalify'
+    require 'sqlite3'
+    require 'rest_client'
+    require 'pp'
+    require 'yaml'
+    
+    attr_accessor :database_path
+
+    # Given a nested hash, convert all keys from String to Symbol type
+    # Based on http://stackoverflow.com/questions/800122/best-way-to-convert-strings-to-symbols-in-hash
+    #
+    def symbolize(obj)
+      return obj.inject({}){|memo,(k,v)| memo[k.to_sym] =  symbolize(v); memo} if obj.is_a? Hash
+      return obj.inject([]){|memo,v    | memo           << symbolize(v); memo} if obj.is_a? Array
+      return obj
+    end
+    
+    # Parse the configuration file
+    def parse_config(conffile = nil)
+      conffile ||= Dir.glob([
+	  "/etc/foreman_hooks-host_rename/settings.yaml",
+	  "#{confdir}/settings.yaml"])[0]
+      raise "Could not locate the configuration file" if conffile.nil?
+    
+      # Parse the configuration file
+      config = {
+          hook_user: 'foreman',
+          database_path: prefix + '/db/foreman_hook_rename.db',
+          log_path: '/var/tmp/foreman_hook_rename.log',
+          log_level: 'warn',
+          rename_hook_command: '/bin/true',
+      }.merge(symbolize(YAML.load(File.read(conffile))))
+      config.each do |k,v|
+        instance_variable_set("@#{k}",v)
+      end
+    
+      # Validate the schema
+      document = Kwalify::Yaml.load_file(conffile)
+      schema = Kwalify::Yaml.load_file("#{confdir}/schema.yaml")
+      validator = Kwalify::Validator.new(schema)
+      errors = validator.validate(document)
+      if errors && !errors.empty?
+        puts "WARNING: The following errors were found in #{conffile}:"
+        for e in errors
+          puts "[#{e.path}] #{e.message}"
+        end
+        raise "Errors in the configuration file"
+      end
+    
+      check_script @rename_hook_command
+    end
+    
+    # Do additional sanity checking on the database path
+    def validate_database
+      db = @database_path
+      raise "bad mode of #{db}" unless File.world_readable?(db).nil?
+    end
+
+    # Do additional sanity checking on a hook script
+    def check_script(path)
+      binary=path.split(' ')[0]
+      raise "#{path} does not exist" unless File.exist? binary
+      raise "#{path} is not executable" unless File.executable? binary
+      path
+    end
+    
+    # Given an absolute [+path+] within the Foreman API, return the full URI
+    def foreman_uri(path)
+      raise ArgumentError, 'path must start with a /' unless path =~ /^\//
+      ['https://', @foreman_user, ':', @foreman_password, '@',
+       @foreman_host, '/api/v2', path].join('')
+    end
+    
+    # Get all the host IDs and FQDNs and populate the host table
+    def sync_host_table
+      uri = foreman_uri('/hosts?per_page=9999999')
+      debug "Loading hosts from #{uri}"
+      json = RestClient.get uri
+      debug "Got JSON: #{json}"
+      JSON.parse(json)['results'].each do |rec|
+        @db.execute "insert into host (id,name) values ( ?, ? )",
+                   rec['id'], rec['name']
+      end
+    end
+
+    # Initialize an empty database
+    def initialize_database
+      @db = SQLite3::Database.new @database_path
+      File.chmod 0600, @database_path
+      begin
+        @db.execute 'drop table if exists host;'
+        @db.execute <<-SQL
+            create table host (
+              id INT,
+              name varchar(254)
+            );
+        SQL
+        sync_host_table
+      rescue
+        File.unlink @database_path
+        raise
+      end
+    end
+    
+    # Open a database connection. If the database does not exist, initialize it.
+    def open_database
+      if File.exist? @database_path
+        validate_database
+        @db = SQLite3::Database.new @database_path
+      else
+        initialize_database
+      end
+    end
+    
+    # Update the database based on the foreman_hook
+    def execute_hook_action
+      @rename = false
+      name = @rec['host']['name']
+      id = @rec['host']['id']
+    
+      case @action
+      when 'create'
+        sql = "insert into host (id, name) values (?, ?)"
+        params = [id, name]
+      when 'update'
+        # Check if we are renaming the host
+        @old_name = @db.get_first_row('select name from host where id = ?', id)[0]
+        if @old_name.nil?
+          warn 'received an update for a non-existent host'
+        else
+          @rename = @old_name != name
+        end
+        debug "checking for a rename: old=#{@old_name} new=#{name} rename?=#{@rename}"
+    
+        sql = 'update host set name = ? where id = ?'
+        params = [name, id]
+      when 'destroy'
+        sql = 'delete from host where id = ?'
+        params = [id]
+      else
+        raise ArgumentError, "unsupported action: #{ARGV[0]}"
+      end
+      debug "updating database; id=#{id} name=#{name} sql=#{sql}"
+      stm = @db.prepare sql
+      stm.bind_params *params
+      stm.execute
+    end
+    
+    # Check if the host has been renamed
+    # @return true, if the host has been renamed
+    def rename?
+      @rename
+    end
+    
+    def execute_rename_action
+      raise 'old_name is nil' if @old_name.nil? 
+      raise 'new_name is nil' if @rec['host']['name'].nil?
+      cmd = @rename_hook_command + ' ' + @old_name + ' ' + @rec['host']['name']
+      debug "Running the rename hook action: #{cmd}"
+      open('|' + cmd, 'w+') do |subprocess|
+        subprocess.write @rec.to_json
+      end
+      rc = $?.exitstatus
+      warn "Hook exited with status #{rc}" if rc != 0
+    end
+    
+    def parse_hook_data
+      @action = ARGV[0]   # one of: create, update, destroy
+      @rec = JSON.parse $stdin.read
+      debug "action=#{@action} rec=#{@rec.inspect}"
+    end
+    
+    def log_level=(level)
+      @log_level = level
+      @log.level = level
+    end
+
+    def open_logfile
+      @log = Logger.new(@log_path, 10, 1024000)
+      case @log_level
+      when 'debug'
+        @log.level = Logger::DEBUG
+      when 'warn'
+        @log.level = Logger::WARN
+      when 'info'
+        @log.level = Logger::INFO
+      else
+        raise 'Unsupported log_level'
+      end
+    end
+    
+    # Convenience methods for writing to the logfile
+    def debug(message)    ; @log.debug(message)   ; end
+    def notice(message)   ; @log.notice(message)  ; end
+    def warn(message)     ; @log.warn(message)    ; end
+    
+    def initialize(opts = {})
+      if opts.has_key? :config
+        f = Tempfile.new('hook-settings')
+        f.write(opts[:config].to_yaml)
+        f.close
+        parse_config(f.path)
+      else
+        parse_config
+      end
+    end
+
+    def run
+      open_logfile
+      begin
+        open_database
+        parse_hook_data
+        execute_hook_action
+        execute_rename_action if rename?
+      rescue Exception => e  
+        @log.error e.message  
+        @log.error e.backtrace.to_yaml
+      end
+    end
+
+    def install(hookdir = nil)
+      hookdir ||= '/usr/share/foreman/config/hooks/host/managed'
+      raise "hook directory not found" unless File.exist? hookdir
+      %w(create update destroy).each do |event|
+        path = "#{hookdir}/#{event}"
+        raise "path not found: #{path}" unless File.exist? path
+        hook = "#{path}/99_host_rename"
+        next if File.exist? hook
+        f = File.open(hook, 'w')
+        f.puts '#!/bin/sh'
+        f.puts 'exec scl enable ruby193 "/usr/bin/foreman_hooks-host_rename $*"'
+        f.close
+        File.chmod 0755, hook
+      end
+      sysconfdir = '/etc/foreman_hooks-host_rename'
+      Dir.mkdir sysconfdir unless File.exist? sysconfdir
+      puts 'The hook has been installed. Please restart Apache to activate the hook.'
+    end
+
+    def uninstall(hookdir = nil)
+      hookdir ||= '/usr/share/foreman/config/hooks/host/managed'
+      %w(create update destroy).each do |event|
+        hook = "#{hookdir}/#{event}/99_host_rename"
+        #puts "removing #{hook}.."
+        File.unlink hook if File.exist? hook
+      end
+      puts 'The hook has been uninstalled. Please restart Apache to deactivate the hook.'
+    end
+
+    private
+  
+    def prefix
+      @prefix ||= File.realpath(File.dirname(__FILE__) + '/../../')
+    end
+
+    def confdir
+      @confdir ||= "#{prefix}/conf"
+    end
+  end
+end

data/lib/foreman_hooks/host_rename/version.rb

@@ -0,0 +1,3 @@
+module ForemanHooks
+  VERSION = "0.0.3"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: foreman_hooks-host_rename
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Mark Heily
+- Bronto Software, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foreman_hooks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: See the README for details
+email:
+- mark.heily@bronto.com
+executables:
+- foreman_hooks-host_rename
+extensions: []
+extra_rdoc_files: []
+files:
+- conf/schema.yaml
+- conf/settings.yaml.EXAMPLE
+- db/.gitignore
+- LICENSE
+- README.md
+- Gemfile
+- Gemfile.lock
+- foreman_hooks-host_rename.gemspec
+- bin/foreman_hooks-host_rename
+- lib/foreman_hooks/host_rename/version.rb
+- lib/foreman_hooks/host_rename.rb
+homepage: https://github.com/bronto/foreman_hooks-host_rename
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Foreman hook that fires when a host is renamed
+test_files: []