nagios_parser 1.1.0 → 1.2.0

data/CHANGES.md

@@ -1,7 +1,15 @@
 nagios_parser - ChangeLog
 =========================
 
-# next
+# 1.2.0
+* Add NagiosParser::Resource parser to parse Nagios resource
+  macro files.
+* Add NagiosParser::Config parser to parse the Nagios main
+  configuration file.
+* Ignore inline comments starting with ';' in the object
+  configuration files.
+
+# 1.1.0
 * Remove hardcoded status types to make the parser less strict.
 * More Nagios 2.x/3.x status types. (mariussturm)
 

data/README.md

@@ -8,6 +8,8 @@ files and a parser for the Nagios object definition files.
 
 * NagiosParser::Status::Parser
 * NagiosParser::Object::Parser
+* NagiosParser::Config::Parser
+* NagiosParser::Resource::Parser
 
 Both parsers return plain hashes and arrays. There are no special
 Nagios objects or something like that. That means you can create
@@ -100,6 +102,42 @@ This will print a data structure that looks like this.
         "host_name"=>"server1",
         "alias"=>"server1.example.com"}]}
 
+## Config Parser
+
+    require 'nagios_parser/config/parser'
+    require 'pp'
+
+    config = <<-CONFIG
+      log_file=/var/log/nagios3/nagios.log
+      status_update_interval=10
+    CONFIG
+
+    data = NagiosParser::Config::Parser.parse(config)
+    pp data
+
+This will print a data structure that looks like this.
+
+    {"log_file"=>"/var/log/nagios3/nagios.log",
+     "status_update_interval"=>10}
+
+## Resource macro parser
+
+    require 'nagios_parser/resource/parser'
+    require 'pp'
+
+    resource = <<-RESOURCE
+      $USER1$=/usr/lib/nagios/plugins
+      $USER10$=mysqluser
+    RESOURCE
+
+    data = NagiosParser::Resource::Parser.parse(resource)
+    pp data
+
+This will print a data structure that looks like this.
+
+    {"$USER10$"=>"mysqluser",
+     "$USER1$"=>"/usr/lib/nagios/plugins"}
+
 # Development
 
 The parsers are based on the racc parser generator. racc is needed
@@ -111,6 +149,8 @@ the Ruby files afterwards. There are two rake tasks to help with that.
 
 * `rake parser::status`
 * `rake parser::object`
+* `rake parser::config`
+* `rake parser::resource`
 
 The bundler gem is used to handle the development dependencies.
 Run `bundle install` to install them.

data/Rakefile

@@ -14,6 +14,12 @@ namespace :parser do
   desc 'Generate the object parser with racc'
   task :object => [ 'lib/nagios_parser/object/parser.rb' ]
 
+  desc 'Generate the resource parser with racc'
+  task :resource => [ 'lib/nagios_parser/resource/parser.rb' ]
+
+  desc 'Generate the main config parser with racc'
+  task :config => [ 'lib/nagios_parser/config/parser.rb' ]
+
   rule '.rb' => '.y' do |target|
     sh "racc -o #{target.name} #{target.source}"
   end

data/lib/nagios_parser/config/parser.rb

@@ -0,0 +1,152 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.4.6
+# from Racc grammer file "".
+#
+
+require 'racc/parser.rb'
+
+require 'strscan'
+
+module NagiosParser
+  module Config
+    class Parser < Racc::Parser
+
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 19)
+
+def create_token(string)
+  result = []
+  scanner = StringScanner.new(string)
+
+  until scanner.empty?
+    case
+    when scanner.scan(/\s+/)
+      # ignore whitespace
+    when scanner.scan(/#[^\n]*/)
+      # ignore comments
+    when match = scanner.scan(/\w+\=/)
+      result << [:KEY, match.chop.gsub(/\s+$/, '')]
+    when match = scanner.scan(/\-?\d+$/)
+      result << [:VALUE, match.to_i]
+    when match = scanner.scan(/[^\n]+$/)
+      result << [:VALUE, match.gsub(/\s+$/, '')]
+    else
+      raise "Can't tokenize <#{scanner.peek(10)}>"
+    end
+  end
+
+  result << [false, false]
+end
+
+attr_accessor :token
+
+def self.parse(string)
+  new.parse(string)
+end
+
+def parse(string)
+  @result = {}
+  @token = create_token(string)
+  do_parse
+  @result
+end
+
+def next_token
+  @token.shift
+end
+...end parser.y/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+     5,     1,     1,     4,     7 ]
+
+racc_action_check = [
+     2,     0,     2,     1,     5 ]
+
+racc_action_pointer = [
+    -1,     0,     0,   nil,   nil,     4,   nil,   nil ]
+
+racc_action_default = [
+    -4,    -4,    -4,    -1,    -3,    -4,    -2,     8 ]
+
+racc_goto_table = [
+     3,     2,     6 ]
+
+racc_goto_check = [
+     2,     1,     2 ]
+
+racc_goto_pointer = [
+   nil,     1,     0 ]
+
+racc_goto_default = [
+   nil,   nil,   nil ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  1, 5, :_reduce_none,
+  2, 5, :_reduce_none,
+  2, 6, :_reduce_3 ]
+
+racc_reduce_n = 4
+
+racc_shift_n = 8
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :KEY => 2,
+  :VALUE => 3 }
+
+racc_nt_base = 4
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "KEY",
+  "VALUE",
+  "$start",
+  "assignments",
+  "assignment" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+# reduce 1 omitted
+
+# reduce 2 omitted
+
+module_eval(<<'.,.,', 'parser.y', 10)
+  def _reduce_3(val, _values, result)
+     @result[val[0]] = val[1] 
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+    end   # class Parser
+    end   # module Config
+  end   # module NagiosParser

data/lib/nagios_parser/config/parser.y

@@ -0,0 +1,59 @@
+class NagiosParser::Config::Parser
+  token
+    KEY VALUE
+
+  rule
+    assignments
+      : assignment
+      | assignments assignment
+      ;
+    assignment
+      : KEY VALUE { @result[val[0]] = val[1] }
+      ;
+end
+
+---- header
+require 'strscan'
+
+---- inner
+
+def create_token(string)
+  result = []
+  scanner = StringScanner.new(string)
+
+  until scanner.empty?
+    case
+    when scanner.scan(/\s+/)
+      # ignore whitespace
+    when scanner.scan(/#[^\n]*/)
+      # ignore comments
+    when match = scanner.scan(/\w+\=/)
+      result << [:KEY, match.chop.gsub(/\s+$/, '')]
+    when match = scanner.scan(/\-?\d+$/)
+      result << [:VALUE, match.to_i]
+    when match = scanner.scan(/[^\n]+$/)
+      result << [:VALUE, match.gsub(/\s+$/, '')]
+    else
+      raise "Can't tokenize <#{scanner.peek(10)}>"
+    end
+  end
+
+  result << [false, false]
+end
+
+attr_accessor :token
+
+def self.parse(string)
+  new.parse(string)
+end
+
+def parse(string)
+  @result = {}
+  @token = create_token(string)
+  do_parse
+  @result
+end
+
+def next_token
+  @token.shift
+end

data/lib/nagios_parser/object/parser.rb

@@ -46,7 +46,8 @@ def create_token(string)
     when (inside and match = scanner.scan(/\d+$/))
       result << [:VALUE, match.to_i]
     when (inside and match = scanner.scan(/[^\n\}]+/))
-      result << [:VALUE, match.gsub(/\s+$/, '')]
+      # Make sure to ignore inline comments starting with ';'.
+      result << [:VALUE, match.split(';').first.gsub(/\s+$/, '')]
     else
       raise "Can't tokenize <#{scanner.peek(10)}>"
     end

data/lib/nagios_parser/object/parser.y

@@ -64,7 +64,8 @@ def create_token(string)
     when (inside and match = scanner.scan(/\d+$/))
       result << [:VALUE, match.to_i]
     when (inside and match = scanner.scan(/[^\n\}]+/))
-      result << [:VALUE, match.gsub(/\s+$/, '')]
+      # Make sure to ignore inline comments starting with ';'.
+      result << [:VALUE, match.split(';').first.gsub(/\s+$/, '')]
     else
       raise "Can't tokenize <#{scanner.peek(10)}>"
     end

data/lib/nagios_parser/resource/parser.rb

@@ -0,0 +1,150 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.4.6
+# from Racc grammer file "".
+#
+
+require 'racc/parser.rb'
+
+require 'strscan'
+
+module NagiosParser
+  module Resource
+    class Parser < Racc::Parser
+
+module_eval(<<'...end parser.y/module_eval...', 'parser.y', 19)
+
+def create_token(string)
+  result = []
+  scanner = StringScanner.new(string)
+
+  until scanner.empty?
+    case
+    when scanner.scan(/\s+/)
+      # ignore whitespace
+    when scanner.scan(/#[^\n]*/)
+      # ignore comments
+    when match = scanner.scan(/\$\w+\$\s*\=/)
+      result << [:KEY, match.chop.gsub(/\s+$/, '')]
+    when match = scanner.scan(/[^\n]+/)
+      result << [:VALUE, match.gsub(/\s+$/, '')]
+    else
+      raise "Can't tokenize <#{scanner.peek(10)}>"
+    end
+  end
+
+  result << [false, false]
+end
+
+attr_accessor :token
+
+def self.parse(string)
+  new.parse(string)
+end
+
+def parse(string)
+  @result = {}
+  @token = create_token(string)
+  do_parse
+  @result
+end
+
+def next_token
+  @token.shift
+end
+...end parser.y/module_eval...
+##### State transition tables begin ###
+
+racc_action_table = [
+     5,     1,     1,     4,     7 ]
+
+racc_action_check = [
+     2,     0,     2,     1,     5 ]
+
+racc_action_pointer = [
+    -1,     0,     0,   nil,   nil,     4,   nil,   nil ]
+
+racc_action_default = [
+    -4,    -4,    -4,    -1,    -3,    -4,    -2,     8 ]
+
+racc_goto_table = [
+     3,     2,     6 ]
+
+racc_goto_check = [
+     2,     1,     2 ]
+
+racc_goto_pointer = [
+   nil,     1,     0 ]
+
+racc_goto_default = [
+   nil,   nil,   nil ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  1, 5, :_reduce_none,
+  2, 5, :_reduce_none,
+  2, 6, :_reduce_3 ]
+
+racc_reduce_n = 4
+
+racc_shift_n = 8
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :KEY => 2,
+  :VALUE => 3 }
+
+racc_nt_base = 4
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "KEY",
+  "VALUE",
+  "$start",
+  "assignments",
+  "assignment" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+# reduce 1 omitted
+
+# reduce 2 omitted
+
+module_eval(<<'.,.,', 'parser.y', 10)
+  def _reduce_3(val, _values, result)
+     @result[val[0]] = val[1] 
+    result
+  end
+.,.,
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+    end   # class Parser
+    end   # module Resource
+  end   # module NagiosParser

data/lib/nagios_parser/resource/parser.y

@@ -0,0 +1,57 @@
+class NagiosParser::Resource::Parser
+  token
+    KEY VALUE
+
+  rule
+    assignments
+      : assignment
+      | assignments assignment
+      ;
+    assignment
+      : KEY VALUE { @result[val[0]] = val[1] }
+      ;
+end
+
+---- header
+require 'strscan'
+
+---- inner
+
+def create_token(string)
+  result = []
+  scanner = StringScanner.new(string)
+
+  until scanner.empty?
+    case
+    when scanner.scan(/\s+/)
+      # ignore whitespace
+    when scanner.scan(/#[^\n]*/)
+      # ignore comments
+    when match = scanner.scan(/\$\w+\$\s*\=/)
+      result << [:KEY, match.chop.gsub(/\s+$/, '')]
+    when match = scanner.scan(/[^\n]+/)
+      result << [:VALUE, match.gsub(/\s+$/, '')]
+    else
+      raise "Can't tokenize <#{scanner.peek(10)}>"
+    end
+  end
+
+  result << [false, false]
+end
+
+attr_accessor :token
+
+def self.parse(string)
+  new.parse(string)
+end
+
+def parse(string)
+  @result = {}
+  @token = create_token(string)
+  do_parse
+  @result
+end
+
+def next_token
+  @token.shift
+end

data/lib/nagios_parser/version.rb

@@ -1,3 +1,3 @@
 module NagiosParser
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/nagios_parser.rb

@@ -1,2 +1,4 @@
+require 'nagios_parser/config/parser'
 require 'nagios_parser/object/parser'
+require 'nagios_parser/resource/parser'
 require 'nagios_parser/status/parser'

data/spec/nagios_parser/config/parser_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'nagios_parser/config/parser'
+
+describe NagiosParser::Config::Parser do
+  let(:parser) { NagiosParser::Config::Parser.new }
+
+  describe ".parse" do
+    it "returns a hash of macro definitions" do
+      data = parser.parse('log_file=/var/log/nagios3/nagios.log')
+      data['log_file'].should == '/var/log/nagios3/nagios.log'
+    end
+  end
+
+  describe "#create_token" do
+    context "given a valid string" do
+      it "creates a valid token list" do
+        string = <<-RUBY
+          # LOG FILE
+          # This is the main log file where service and host events are logged
+          # for historical purposes.  This should be the first option specified 
+          # in the config file!!!
+
+          log_file=/var/log/nagios3/nagios.log
+          object_cache_file=/var/cache/nagios3/objects.cache
+
+          nagios_group=nagios
+
+          status_update_interval=10
+        RUBY
+
+        parser.create_token(string).should == [
+          [:KEY, 'log_file'], [:VALUE, '/var/log/nagios3/nagios.log'],
+          [:KEY, 'object_cache_file'], [:VALUE, '/var/cache/nagios3/objects.cache'],
+          [:KEY, 'nagios_group'], [:VALUE, 'nagios'],
+          [:KEY, 'status_update_interval'], [:VALUE, 10],
+          [false, false]
+        ]
+      end
+    end
+  end
+
+  describe "#next_token" do
+    it "shifts the next element off the token list" do
+      parser.token = [:one, :two, :three]
+      parser.next_token
+      parser.next_token.should == :two
+    end
+  end
+
+  describe "#parse" do
+    context "with a valid string" do
+      it "returns a hash of config key value pairs" do
+        string = <<-RUBY
+          external_command_buffer_slots=4096
+
+
+          # LOCK FILE
+          # This is the lockfile that Nagios will use to store its PID number
+          # in when it is running in daemon mode.
+
+          lock_file=/var/run/nagios3/nagios3.pid
+          event_broker_options=-1
+        RUBY
+
+        data = parser.parse(string)
+        data['external_command_buffer_slots'].should == 4096
+        data['lock_file'].should == '/var/run/nagios3/nagios3.pid'
+        data['event_broker_options'].should == -1
+      end
+    end
+
+    context "with an invalid config" do
+      it "will raise an exception" do
+        expect {
+          parser.parse('$foo=bar')
+        }.to raise_error
+      end
+    end
+  end
+end

data/spec/nagios_parser/object/parser_spec.rb

@@ -21,7 +21,7 @@ describe NagiosParser::Object::Parser do
           }
           define service {
             host_name   foo.example.com
-            service_description SUPERD
+            service_description SUPERD ; I like that!
             }
         RUBY
 

data/spec/nagios_parser/resource/parser_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'nagios_parser/resource/parser'
+
+describe NagiosParser::Resource::Parser do
+  let(:parser) { NagiosParser::Resource::Parser.new }
+
+  describe ".parse" do
+    it "returns a hash of macro definitions" do
+      data = parser.parse('$USER1$=/usr/lib/nagios/plugins')
+      data['$USER1$'].should == '/usr/lib/nagios/plugins'
+    end
+  end
+
+  describe "#create_token" do
+    context "given a valid string" do
+      it "creates a valid token list" do
+        string = <<-RUBY
+          # This is the resource configuration
+          $USER1$=/usr/lib/nagios/plugins
+          $USER10$=mysqluser
+
+          $USER30$ = /bin
+        RUBY
+
+        parser.create_token(string).should == [
+          [:KEY, '$USER1$'], [:VALUE, '/usr/lib/nagios/plugins'],
+          [:KEY, '$USER10$'], [:VALUE, 'mysqluser'],
+          [:KEY, '$USER30$'], [:VALUE, '/bin'],
+          [false, false]
+        ]
+      end
+    end
+  end
+
+  describe "#next_token" do
+    it "returns shifts the next element off the token list" do
+      parser.token = [:one, :two, :three]
+      parser.next_token
+      parser.next_token.should == :two
+    end
+  end
+
+  describe "#parse" do
+    context "with a valid string" do
+      it "returns a hash of resource macros" do
+        string = <<-RUBY
+          # This is the resource configuration
+          $USER1$=/usr/lib/nagios/plugins
+          $USER10$=mysqluser
+
+          $USER30$ = /bin
+        RUBY
+
+        data = parser.parse(string)
+        data['$USER1$'].should == '/usr/lib/nagios/plugins'
+        data['$USER10$'].should == 'mysqluser'
+        data['$USER30$'].should == '/bin'
+      end
+    end
+
+    context "with invalid resource macro" do
+      it "will raise an exception" do
+        expect {
+          parser.parse('foo=bar')
+        }.to raise_error
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nagios_parser
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Bernd Ahlers
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-09 00:00:00 +01:00
-default_executable: 
+date: 2011-06-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -77,16 +76,21 @@ files:
 - README.md
 - Rakefile
 - lib/nagios_parser.rb
+- lib/nagios_parser/config/parser.rb
+- lib/nagios_parser/config/parser.y
 - lib/nagios_parser/object/parser.rb
 - lib/nagios_parser/object/parser.y
+- lib/nagios_parser/resource/parser.rb
+- lib/nagios_parser/resource/parser.y
 - lib/nagios_parser/status/parser.rb
 - lib/nagios_parser/status/parser.y
 - lib/nagios_parser/version.rb
 - nagios_parser.gemspec
+- spec/nagios_parser/config/parser_spec.rb
 - spec/nagios_parser/object/parser_spec.rb
+- spec/nagios_parser/resource/parser_spec.rb
 - spec/nagios_parser/status/parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/nagios_parser
 licenses: []
 
@@ -116,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: parser lib for parsing Nagios status and config files