hostlint 0.0.1

data/bin/hostlint

@@ -0,0 +1,449 @@
+#!/usr/bin/env ruby
+require "optparse"
+require "csv"
+require "logger"
+require "yaml"
+require "pathname"
+require "pp"
+require "syslog"
+require "open4"
+require "bunny"
+require "map"
+
+# fixme jobs support
+def logd(string) $logger.add(Logger::DEBUG, string, "") if $verbose; end
+def logi(string) $logger.add(Logger::INFO,  string, " ") ; end
+def loge(string) $logger.add(Logger::ERROR, string, "") ; end
+def logw(string) $logger.add(Logger::WARN,  string, " ") if $verbose; end
+
+class Main
+  attr_accessor :checks
+
+  def parse_inner_opts
+  end
+  def prelude
+    $logger = Logger.new(STDOUT)
+    $logger.formatter = proc do |severity, datetime, progname, msg|
+      "#{severity}: #{progname}#{msg}\n"
+    end
+
+    optparser = OptionParser.new do |o|
+      o.on("-c", "--run-checks C1[,C2...]",
+           "run specific check(s) by name") do |arg|
+        @checks_filter = CSV.parse_line(arg)
+
+      end
+      o.on("-d", "--check-dir DIR",
+           "Specifies the directory of checks to run") do |arg|
+        @check_dir = Pathname.new(arg)
+      end
+      o.on("-f", "--config-file FILE",
+           "Specifies the location of the config file") do |arg|
+        @config_file = Pathname.new(arg)
+      end
+
+      # fixme re-implement
+      o.on("-j", "--jobs N",
+           "Specifies the number of jobs (checks) to run simultaneously " +
+           "(0 for unbounded)") do |arg|
+        @jobs = arg.to_i
+      end
+      o.on("-o", "--output-methods M[:OPTS]",
+           "Output using M (see below). Default stdout, may be specified multiple times") do |arg|
+        @output_methods ||= []
+        method, options = arg.split(":")
+        hsh = {}
+        if options
+          CSV.parse_line(options).map {|x| x.split("=")}.each {|k,v| hsh[k] = v}
+        end
+        @output_methods << [method, hsh]
+      end
+      o.on("-v", "--verbose", "Print debugging information") do # levels
+        $verbose = true
+      end
+      o.on("-u", "--user-mode",
+           "Allow an arbitrary user to run hostlint") do
+        @user_run = true
+      end
+
+      o.on_tail('-h', '--help',
+                'print usage information and exit') do
+        puts o
+        puts <<FILE
+
+Hostlint is like the lint program for source code, but for hosts.
+Full documentation currently lives at https://github.com/whd/hostlint .
+
+Output methods: (syntax for options is M[:opt1=val1[,opt2=val2...]])
+
+stdout: print a concise summary of what checks ran and if they succeeded to the standard output (no options)
+
+log: like stdout, but be more verbose by printing the stdout and stderr of each check and exit status if applicable
+  options: file (optional, defaults to '/var/log/hostlint.log', use '-' for standard out)
+
+syslog: print failing checks to the system log
+  options: severity
+
+yaml: output in yaml format
+  options: file (optional, defaults to '-', which is stdout)
+
+amqp: send serialized results (to, say, a hostmon server) via amqp
+  options: host, port, user, pass, vhost, exchange=hostlint
+
+terse: don't print anything except the summary
+
+email: not implemented
+
+post: not implemented
+FILE
+        exit
+      end
+
+    end
+
+    optparser.parse!
+    abort "need to run as root (or -u)" unless @user_run || Process.euid == 0
+
+    logd "parsed command line"
+
+    @config_file ||= Pathname.new("hostlint.yml")
+    unless @config_file.exist? && @config_file.file? && @config_file.readable?
+      loge "config file #{@config_file} nonexistent or unreadable (use -f)"
+      abort
+    end
+
+    @conf = YAML.load(@config_file.read)
+    loge "parsing config file failed: #{@config_file}" and abort unless @conf
+    loge "no :main key in #{@config_file}" and abort unless @conf[:main]
+    @conf = Map(@conf)
+
+    # FIXME if check_dir is relative, it should resolve relative to the
+    # config file instead of the current working directory
+    # (do this without using chdir crap)
+    @check_dir  ||= @conf[:main][:check_dir]
+    @host = @conf[:main][:host]
+    @cluster    ||= @conf[:main][:colo]
+    unless @host && @cluster
+      h = %x[hostname].chomp.split(".")
+      @host ||= h[0]
+      @cluster ||= h[1]
+    end
+
+    if @conf[:output]
+      @output_methods ||= @conf[:output].map do |x|
+        x.respond_to?(:to_a) ? x.to_a : [x, nil]
+      end.map(&:first)
+    end
+    @jobs       ||= 1
+    @output_methods ||= [["stdout", {}]]
+    @check_dir = Pathname.new(@check_dir)
+
+    oldpwd = Dir.pwd
+    Dir.chdir(@config_file.dirname)
+    unless @check_dir.directory? && @check_dir.readable?
+      loge "#{@check_dir.expand_path} not a directory or unreadable" and abort
+    end
+
+    @check_dir = @check_dir.realpath
+    Dir.chdir(oldpwd)
+
+    Check.global_info = {:host => @host, :cluster => @cluster}
+    logd "info:\n  check_dir: #{@check_dir}" +
+      "\n  host: #{@host}\n  cluster: #{@cluster}\n  jobs: #{@jobs}" +
+      "\n  output: #{@output_methods.inspect}"
+  end
+
+  def check_name (f)
+    foo = Pathname.new(f).relative_path_from(Pathname.new(@check_dir)).to_s
+    foo.chomp(File.extname(f)).gsub(File::SEPARATOR, ".")
+  end
+
+  def theme
+    @checks = []
+    Dir.glob("#{@check_dir}/**/*").each do |f|
+      path = Pathname.new(f)
+      next unless path.file?
+      # FIXME add subdir support to -c (and document)
+      # also add a warning when checks specified with -c don't end up matching
+      # a file
+      if @checks_filter &&
+          !@checks_filter.find {|c| f =~ /^#{c}\.?[^\/]*$|.*\/#{c}\.?[^\/]*$/}
+        next
+      end
+      check = Check.new(check_name(path), path)
+      check.run
+      @checks << check
+    end
+  end
+
+  def variations
+    logi "SUMMARY"
+    if m = @checks.map {|c| c.name.length}.max
+      max = m + 2
+    end
+    @output_methods.each do |m, opts|
+      opts ||= {}
+      # FIXME maxl -> global_info
+      opts["maxl"] = max if max
+      method = "output_" + m.to_s
+      if Check.respond_to?(method)
+        Check.send(method, opts)
+      else
+        logw "no output method '#{m}', ignoring"
+        break
+      end
+    end
+  end
+
+  def stats
+    check_ok = 0
+    check_failed = 0
+    failed = 0
+    @checks.each do |c|
+      check_ok += 1 if c.check_ok?
+      check_failed += 1 if c.check_failed?
+      failed += 1 if c.failed?
+    end
+    "#{check_ok + check_failed + failed} checks total, " +
+      "#{check_ok} succeeded, #{check_failed} failed," +
+      " #{failed} failed to run properly"
+  end
+
+  def run
+    report_begin = Time.now
+    prelude # parse command line and configs
+    theme   # run the checks
+    variations # output in various ways
+    report_end = Time.now
+
+    logi "hostlint check complete (#{report_end - report_begin}s)"
+    logi stats
+  end
+
+end
+
+class Check
+  @@checks = []
+  @@status_map = {
+    :CHECK_OK => 0b000000,
+    :CHECK_FAILED => 0b000001,
+    :FAILED_MISSING_PRELUDE => 0b000100,
+    :FAILED_STDERR_NONEMPTY => 0b001000,
+    :FAILED_BAD_EXIT_STATUS => 0b010000,
+    :FAILED_SKIPPED => 0b100000
+  }
+
+  @@global_info = {}
+  def self.global_info= (hsh)
+    @@global_info = hsh
+  end
+
+  attr_accessor :name, :exit_status, :status, :timestamp, :program, :stdout, :stderr
+  def initialize (name, program)
+    @name = name
+    @program = program
+    @status = []
+    @stdout, @stderr = '', ''
+    @@checks << self
+  end
+
+  def int_status
+    # first legitimate reason to put :| in source code I've seen
+    @status.map {|x| @@status_map[x]}.inject(:|)
+  end
+
+  # run @program, set name from first line etc. as appropriate
+  def run
+    unless @program.executable_real?
+      logw "#{@program} not executable, skipping"
+      status << :FAILED_SKIPPED
+      # make sure to set a timestamp
+      @timestamp = Time.now.to_s
+      return
+    end
+    regex = /^((.*):\s+)?(OK|FAIL)$/
+    logd "executing #{program}"
+
+    # FIXME on bad exit status, don't remove the prelude from the output stream
+    _status = Open4::popen4(program.to_s) do |pid, stdin, stdout, stderr|
+      out = stdout.read
+      err = stderr.read
+      if match = (out.lines.first||"").match(regex)
+        check_name = match[2]
+        @name = check_name if check_name
+        status << (match[3] == "OK" ? :CHECK_OK : :CHECK_FAILED)
+        out.sub!(out.lines.first, "")
+      else
+        logw "check #{@name} missing prelude"
+        status << :FAILED_MISSING_PRELUDE
+      end
+
+      if err.size > 0
+        logw "standard error for check #{@name} not empty"
+        status << :FAILED_STDERR_NONEMPTY
+      end
+      @stdout = out
+      @stderr = err
+    end
+
+    @exit_status = _status.exitstatus
+
+    if @exit_status != 0
+      logw "check #{@name} had nonzero exit status"
+      status << :FAILED_BAD_EXIT_STATUS
+    end
+    @timestamp = Time.now.to_s
+  end
+
+  def to_s
+    inspect
+  end
+
+  def inspect
+    result.inspect
+  end
+
+  def to_hash
+    @@global_info.merge({
+      :name => @name,
+      :exit_status => @exit_status,
+      :status => @status,
+      :timestamp => @timestamp,
+      :stdout => @stdout,
+      :stderr => @stderr
+    })
+  end
+
+  alias result to_hash
+
+  def check_ok?
+    int_status == 0
+  end
+
+  def check_failed?
+    int_status == 1
+  end
+
+  def failed?
+    int_status > 1
+  end
+
+  # output formats
+  # FIXME make instance methods (like before) and avoid duplication
+
+  # syslog
+  # fixme add log_healthy=false option
+  def self.output_syslog (opts={})
+    puts "output syslog"
+    Syslog.open unless Syslog.opened?
+    @@checks.each do |c|
+      if c.int_status > 0
+        # hostlint checks shouldn't really be immediately actionable
+        Syslog.notice "check #{c.name} failed #{c.status.inspect.gsub(":", "")}"
+      end
+    end
+    Syslog.close
+  end
+
+  # stdout
+  def self.output_stdout (opts={})
+    n = opts["maxl"]
+    @@checks.each do |c|
+      printf "%-#{n}s %s\n" % [c.name+":", c.status.inspect.gsub(":", "")]
+    end
+  end
+
+  # log, more verbose than stdout
+  # FIXME make formatting not suck, remove code duplication
+  def self.output_log (opts={})
+    file = opts["file"] || '/var/log/hostlint.log'
+    h1 = "hostlint report #{Time.now}"
+    header = "#{'*'*h1.length}\n#{h1}\n#{'*'*h1.length}"
+    if file == '-'
+      n = opts["maxl"]
+      STDOUT.puts header
+      @@checks.each do |c|
+        STDOUT.printf "%-#{n}s %s\n" % [c.name+":", c.status.inspect.gsub(":", "")]
+        if c.exit_status && c.exit_status != 0
+          STDOUT.puts "  EXIT_STATUS: #{c.exit_status}"
+        end
+        unless c.stderr.empty?
+          STDOUT.puts "  STDERR:"
+          STDOUT.puts c.stderr.gsub(/^/, "\t")
+        end
+        unless c.stdout.empty?
+          STDOUT.puts "  STDOUT:"
+          STDOUT.puts c.stdout.gsub(/^/, "\t")
+        end
+      end
+    else
+      begin
+        File.open(file, "a") do |f|
+          f.puts header
+          @@checks.each do |c|
+            f.printf "%-#{n}s %s\n" % [c.name+":", c.status.inspect.gsub(":", "")]
+            if c.exit_status && c.exit_status != 0
+              f.puts "  EXIT_STATUS: #{c.exit_status}"
+            end
+            unless c.stderr.empty?
+              f.puts "  STDERR:"
+              f.puts c.stderr.gsub(/^/, "\t")
+            end
+            unless c.stdout.empty?
+              f.puts "  STDOUT:"
+              f.puts c.stdout.gsub(/^/, "\t")
+            end
+          end
+          f.puts
+        end
+      rescue
+        loge "error writing to log file #{file}"
+      end
+    end
+  end
+
+  def self.output_terse(opts={})
+  end
+
+  # yaml
+  def self.output_yaml (opts={})
+    file = opts["file"] || '-'
+    if file == '-'
+      @@checks.each {|c| STDOUT.puts c.result.to_yaml}
+    else
+      begin
+        File.open(file, "a") do |f|
+          @@checks.each {|c| f.puts c.result.to_yaml}
+        end
+      rescue
+        loge "error writing to log file #{file}"
+      end
+    end
+  end
+
+  # amqp
+  def self.output_amqp (opts)
+    puts "output amqp"
+    connection_params = {}
+    connection_params[:port] = opts['port']
+    connection_params[:host] = opts['host']
+    connection_params[:user] = opts['user']
+    connection_params[:pass] = opts['pass']
+    connection_params[:vhost] = opts['vhost']
+    begin
+      amqp = Bunny.new(connection_params)
+      amqp.start
+      exchange = amqp.exchange(opts['exchange'] || 'hostlint',
+                               :type => :topic,
+                               :durable => true)
+      @@checks.each do |c|
+        exchange.publish c.result.to_yaml
+      end
+      amqp.close
+    rescue
+      'amqp transport failed'
+    end
+  end
+end
+
+Main.new.run

data/examples/checks/network/config/bootproto_dhcp.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+fail=""
+match="BOOTPROTO=dhcp"
+
+for file in /etc/sysconfig/networking/devices/* ; do
+  if [[ -f $file ]] ; then
+    output="$(grep -i $match $file &>/dev/null)"
+    if [[ $? == 0 ]]; then
+      fail="${fail}
+${file}"
+    fi
+  fi
+done
+
+if [[ -z "$fail" ]] ; then
+  echo "OK"
+else
+  echo "network.config.dhcp: [FAIL]"
+  echo -n "devices configured to use ${match}:"
+  echo "$fail"
+fi

data/examples/checks/network/ethernet_bonded.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# "verify that eth0 and eth1 are bonded"
+# this should likely be generalized
+
+if [[ -d /proc/net/bonding ]]  ; then
+  for file in /proc/net/bonding/* ; do
+    if grep 'eth0' $file &>/dev/null && grep 'eth1' $file &>/dev/null ; then
+      echo "OK"
+      exit 0
+    fi
+  done
+fi
+
+# fell thru
+echo "FAIL
+output of ifconfig:
+$(ifconfig 2>/dev/null)"

data/examples/checks/yum/security_updates.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# requirith yum-plugin-security
+
+output="$(yum --security check-update 2>/dev/null)"
+
+if [[ $? == 100 ]] ; then #security updates exist!
+    echo "FAIL"
+    echo "you could try \"yum --security update\""
+    echo "$output" | tail -n +3
+else
+    echo "OK"
+fi

data/examples/config/hostlint.yml

@@ -0,0 +1,12 @@
+:main:
+  :colo: cluster1
+  :host: mach1
+  :check_dir: "../checks" # "/etc/hostlint.d"
+
+  :output:
+    - :log:
+        :file: "./log/hostlint.log"
+    - :amqp:
+        host: localhost
+        user: guest
+        pass: guest

data/tests/checks/exec_fail/bad_exit_prelude

@@ -0,0 +1,5 @@
+#! /usr/bin/bash
+echo fail_stderr >&2
+echo fail "bad prelude"
+exit 123
+

data/tests/checks/exec_fail/bad_exit_status.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+echo 'OK
+This check should EXEC_FAIL because of its exit status (even though the
+prelude is correct).
+'
+# but exit badly
+exit 1

data/tests/checks/exec_fail/bad_output.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "--INTROIBO AD ALTARE DEI. (first line doesn't match prelude)"

data/tests/checks/exec_fail/empty_bad_exit_status.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+exit 1

data/tests/checks/exec_fail/fail_stderr_bad_exit_status.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# EXEC_FAIL because there is output on the standard error
+
+STDERR.puts "shoot"
+puts "OK
+--Come up, Kinch! Come up, you fearful jesuit!
+"
+exit 1

data/tests/checks/exec_fail/missing_prelude.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "this should fail because the prelude is missing"

data/tests/checks/exec_fail/no_output.sh

@@ -0,0 +1 @@
+#!/bin/bash

data/tests/checks/exec_fail/rename_exec_fail1

@@ -0,0 +1,3 @@
+#! /bin/sh
+echo "exec_fail.rename.check1: OK"
+exit 1

data/tests/checks/exec_fail/rename_exec_fail2

@@ -0,0 +1,3 @@
+#! /bin/sh
+echo "exec_fail.rename.check2: FAIL"
+exit 1

data/tests/checks/fail/fail.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo 'fail.test_failure: FAIL
+Buck Mulligan peeped an instant under the mirror and then covered
+the bowl smartly.'

data/tests/checks/fail/rename

@@ -0,0 +1,2 @@
+#!/bin/sh
+echo "fail.renamed_check_fail: FAIL"

data/tests/checks/ok/python.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+print """ok.python.works: OK
+STATELY, PLUMP BUCK MULLIGAN CAME FROM THE STAIRHEAD, bearing a bowl of
+lather on which a mirror and a razor lay crossed. A yellow dressinggown,
+ungirdled, was sustained gently behind him by the mild morning air. He
+held the bowl aloft and intoned:
+""",

data/tests/checks/ok/rename

@@ -0,0 +1,2 @@
+#!/bin/sh
+echo "ok.renamed_check: OK"

data/tests/checks/ok/succeed_ok_body.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+echo 'OK
+--Thanks, old chap, he cried briskly. That will do nicely. Switch off the
+current, will you?'

data/tests/checks/ok/succeed_ok_no_body.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+echo "OK"

data/tests/config.yml

@@ -0,0 +1,9 @@
+# test configuration
+:main:
+  :colo: cluster1
+  :host: mach1
+  :check_dir: "./checks" # "/etc/hostlint.d"
+
+:output:
+  - :stdout
+

data/tests/test.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# simple test wrapper, must be run from __FILE__/.
+# subdirs of checks/ indicate which checks should pass, fail, and fail to run
+
+output = %x[../bin/hostlint -u -f config.yml]
+status = 0
+output.each_line do |line|
+  next if line =~ /^INFO/
+  r = /^ok.*\[CHECK_OK\]$|^fail.*\[CHECK_FAILED\]$|exec_fail.*\[.*FAILED_.*$/
+  unless line =~ r
+    puts "error: line doesn't match expectations"
+    puts line
+    status = 1
+  end
+end
+
+if status == 0
+  puts "all tests pass"
+end
+exit status

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: hostlint
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Wesley Dawson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open4
+  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: bunny
+  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: map
+  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'
+description: hostlint client
+email:
+- wdawson@mozilla.com
+executables:
+- hostlint
+extensions: []
+extra_rdoc_files: []
+files:
+- examples/config/hostlint.yml
+- examples/checks/network/config/bootproto_dhcp.sh
+- examples/checks/network/ethernet_bonded.sh
+- examples/checks/yum/security_updates.sh
+- tests/checks/fail/fail.sh
+- tests/checks/fail/rename
+- tests/checks/ok/python.py
+- tests/checks/ok/succeed_ok_no_body.sh
+- tests/checks/ok/rename
+- tests/checks/ok/succeed_ok_body.sh
+- tests/checks/exec_fail/bad_output.sh
+- tests/checks/exec_fail/empty_bad_exit_status.sh
+- tests/checks/exec_fail/fail_stderr_bad_exit_status.rb
+- tests/checks/exec_fail/bad_exit_status.sh
+- tests/checks/exec_fail/rename_exec_fail1
+- tests/checks/exec_fail/rename_exec_fail2
+- tests/checks/exec_fail/bad_exit_prelude
+- tests/checks/exec_fail/nonexec
+- tests/checks/exec_fail/missing_prelude.sh
+- tests/checks/exec_fail/no_output.sh
+- tests/test.rb
+- tests/config.yml
+- bin/hostlint
+homepage: https://github.com/whd/hostlint
+licenses:
+- Mozilla Public License (2.0)
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: hostlint -- lint for hosts
+test_files: []