nagira 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eee44c66e1e2ad2e7bac86476df0bf1b7e718125
-  data.tar.gz: 0053b898f641d501c7f1f4eb6f25c55c4fd4dfba
+  metadata.gz: d5fea0d0e27dede1688541ffcbbd087db1ba7c25
+  data.tar.gz: ad4cbc6c1d5f21d554b0040d02294bc3657fb719
 SHA512:
-  metadata.gz: 5949c8483f123c1d32e6343ff034dafdc889a0f2884997fa9685896e7dde8b2e306bea7ee82f96cceca5ca1323a033a12b35bc643ec8557d0454bd49e749801f
-  data.tar.gz: dfd9e7e8e3cb152ec5e499be73b97a2fc853945a4524812bdf104bcfcecc6ec4ed71352d18a32cbfa75ca37723693574378c6bb1d540de786d640cc24a029d17
+  metadata.gz: 58f1915265edf73b6d8cee206b7143b90ae6b04f911d1260cb878eda659d54825da715546ba711274650f1ceaac4334f953c2bb76c480312ef6ef7e16abf548d
+  data.tar.gz: 5e0a46cf6d93eccf637f282aa27c7fcf4e7786decc0cf5cfeaf52577774e41877bb80a9aa15857d10ac65e340f8de0b05dd12f809e38e906903b6d89bda829cf

data/History.md

@@ -1,3 +1,15 @@
+### v.0.2.10
+* Fri Jul 19 2013 -- Dmytro Kovalov
+  - JSON 1.7.7 dependency conflict fix (#25)
+  - Upgrade to latest ruby-nagios 0.2.0
+* Fri Jul 12 2013 -- Dmytro Kovalov
+  - rspec tests
+      - PUT method specs for /_status _services
+      - JSON structure specs for PUT methods
+      - return 400 if PUT not success
+      - specs for nagios.cmd writes
+### v.0.2.9
+  - Bugfix - library loading order change, for @format processing in PUT routes.
 ### v.0.2.8
 * Wed Apr 17 2013 -- Dmytro Kovalov
   - Bugfix - prevent tracedumps on nonexisting hostnames

data/lib/app.rb

@@ -254,6 +254,7 @@ class Nagira < Sinatra::Base
     end
   end
 
+
   ##
   # @method   object_not_found
   # @overload after("Object not found or bad request")
@@ -264,7 +265,6 @@ class Nagira < Sinatra::Base
   #
   #
   after do
-    # return unless request["REQUEST_METHOD"] == 'PUT'
     if ! @data || @data.empty?
       halt [404, {
               :message => "Object not found or bad request",
@@ -275,6 +275,18 @@ class Nagira < Sinatra::Base
   end
 
 
+  ##
+  # @method argument_error 
+  # @overload after("ArgumentError")
+  #
+  # Return 400 if result of PUT operation is not success.
+  #
+  after do 
+    return unless request.put?
+    halt [400, @data.send("to_#{@format}") ] if ! @data[:result]
+  end
+
+
   ##
   # @method   convert_to_active_resource
   # @overload after("Return Array for ActiveResouce routes")
@@ -358,5 +370,6 @@ class Nagira < Sinatra::Base
 
 end
 
-require "app/routes/put"
 require "app/routes/put/status"
+require "app/routes/put/host"
+require "app/routes/put"

data/lib/app/routes/put.rb

@@ -18,6 +18,7 @@ class Nagira < Sinatra::Base
       # Make sure we always return an Array
       @input = [@input] if @input.is_a? Hash
     end
+    @input
   end
 
   # Define helpers for put methods
@@ -31,7 +32,7 @@ class Nagira < Sinatra::Base
     # FIXME: This only accepts single service. Modify to use Arrays too 
     def put_update action, params
       res = $nagios[:commands].write(params.merge({ :action => action }))
-      { :status => res[:result], :object => res[:data]}
+      { :result => res[:result], :object => res[:data]}
     end
   end
 

data/lib/app/routes/put/host.rb

@@ -0,0 +1,52 @@
+#
+# PUT routes for host status.
+#
+class Nagira < Sinatra::Base
+
+  # @method put_status
+  # @overload put("/_status")
+  #
+  # Submit JSON Hash for multiple services,  on multiple hosts.
+  put "/_status" do
+    "TODO: Not implemented"
+  end
+
+  # @method put_status_host_name
+  # @overload put("/_status/:host_name")
+  #
+  # Update hoststatus information only for the given host. URL
+  # hostname always override hostname given in the JSON file.
+  #
+  # == Example
+  #
+  #        $ curl -i -H "Accept: application/json" -d @host.json -X
+  #            PUT http://localhost:4567/_status/svaroh
+  #
+  #          => {"status": true, "object": [{"data": {"host_name":"svaroh",
+  #          "status_code": "0", "plugin_output": "ping OK", "action":
+  #          "PROCESS_HOST_CHECK_RESULT"}, "result":true, "messages": []}]}
+  #
+  # == Example JSON
+  #
+  #     {
+  #      "status_code":"0",
+  #      "plugin_output" : "ping OK"
+  #     }                               
+  put "/_status/:host_name" do
+    @data = update_host_status @input.first.merge({
+                                                    'host_name' => params['host_name']
+                                                  })
+    nil
+  end
+
+  # Same as /_status/:host_name (Not implemented)
+  #
+  # @method put__host_status_host_name
+  # @overload put("/_host_status/:host_name")
+  #
+  put "/_host_status/:host_name" do 
+    "Not implemented: TODO"
+  end
+  
+
+end

data/lib/app/routes/put/status.rb

@@ -1,51 +1,8 @@
+#
+# PUT method routes for services status.
+#
 class Nagira < Sinatra::Base
 
-
-  # @method put_status
-  # @overload put("/_status")
-  #
-  # Submit JSON Hash for multiple services,  on multiple hosts.
-  put "/_status" do
-    "TODO: Not implemented"
-  end
-
-  # @method put_status_host_name
-  # @overload put("/_status/:host_name")
-  #
-  # Update hoststatus information only for the given host. URL
-  # hostname always override hostname given in the JSON file.
-  #
-  # == Example
-  #
-  #        $ curl -i -H "Accept: application/json" -d @host.json -X
-  #            PUT http://localhost:4567/_status/svaroh
-  #
-  #          => {"status": true, "object": [{"data": {"host_name":"svaroh",
-  #          "status_code": "0", "plugin_output": "ping OK", "action":
-  #          "PROCESS_HOST_CHECK_RESULT"}, "result":true, "messages": []}]}
-  #
-  # == Example JSON
-  #
-  #     {
-  #      "status_code":"0",
-  #      "plugin_output" : "ping OK"
-  #     }                               
-  put "/_status/:host_name" do
-    @data = update_host_status @input.first.merge({
-                                                    'host_name' => params['host_name']
-                                                  })
-    nil
-  end
-
-  # Same as /_status/:host_name (Not implemented)
-  #
-  # @method put__host_status_host_name
-  # @overload put("/_host_status/:host_name")
-  #
-  put "/_host_status/:host_name" do 
-    "Not implemented: TODO"
-  end
-  
   # @method put_status_host_name_services
   # @overload put("/_status/:host_name/_services")
   #
@@ -59,16 +16,16 @@ class Nagira < Sinatra::Base
   #   $ curl -i -H "Accept: application/json" -d @dat_m.json -X PUT
   #   http://localhost:4567/_status/svaroh/_services
   #
-  #     [{"status":true, "object":[{"data":{"host_name":"svaroh",
-  #     "service_description":"PING", "return_code":"0",
-  #     "plugin_output":"OK",
-  #     "action":"PROCESS_SERVICE_CHECK_RESULT"}, "result":true,
-  #     "messages":[]}]}, {"status":true,
-  #     "object":[{"data":{"host_name":"svaroh",
-  #     "service_description":"Apache", "return_code":"r20",
-  #     "plugin_output":"cwfailedOK",
-  #     "action":"PROCESS_SERVICE_CHECK_RESULT"}, "result":true,
-  #     "messages":[]}]}]%
+  #     {"result"=>true,
+  #      "object"=>
+  #       [{"data"=>
+  #          {"return_code"=>0,
+  #           "plugin_output"=>"All OK",
+  #           "service_description"=>"PING",
+  #           "host_name"=>"archive",
+  #           "action"=>"PROCESS_SERVICE_CHECK_RESULT"},
+  #         "result"=>true,
+  #         "messages"=>[]}]}
   #
   # == Example JSON for submit
   #
@@ -96,16 +53,19 @@ class Nagira < Sinatra::Base
   #
   put "/_status/:host_name/_services" do
 
-    data = []
+    data, result = [], true
+
     @input.each do |datum|
       # FIXME - this calls update for each service. Should be batching them together
-      data << update_service_status(
-                                    datum.merge({ 
-                                                  'host_name' => params['host_name']
-                                                })
-                                    )
+      update = update_service_status(
+                                      datum.merge({ 
+                                                    'host_name' => params['host_name']
+                                                  })
+                                      )
+      data << update[:object].first
+      result &&= update[:result]
     end
-    @data = data
+    @data = { result: result, object: data }
     nil
 
   end
@@ -131,7 +91,6 @@ class Nagira < Sinatra::Base
   #        -X PUT http://localhost:4567/_status/viy/_services/PING/_return_code/0/_plugin_output/OK
   #       # => ok
   put "/_status/:host_name/_services/:service_description/_return_code/:return_code/_plugin_output/:plugin_output" do 
-
     @data = update_service_status params
     nil
   end

data/spec/{03_api_spec.rb → 01_data_format/03_api_spec.rb}

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+#
+# Test resonse to /_api GET
+#
 describe Nagira do 
 
   set :environment, ENV['RACK_ENV'] || :test

data/spec/get/hosts_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Nagira do 
+  
+  set :environment, ENV['RACK_ENV'] || :test
+  include Rack::Test::Methods
+  def app 
+    @app ||= Nagira
+  end
+  
+  context "/_hosts" do 
+
+    before :each do 
+      get "/_status/_list"
+      @data = JSON.parse(last_response.body)
+    end
+
+    it "return hosts list " do
+        @data.should be_a_kind_of Array
+    end
+
+    it "hostname is a string" do 
+      @data.first.should be_a_kind_of String
+    end
+
+  end
+
+    
+end

data/spec/get/services_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Nagira do 
+  
+  set :environment, ENV['RACK_ENV'] || :test
+  include Rack::Test::Methods
+  def app 
+    @app ||= Nagira
+  end
+  
+  before :all do
+    get "/_status/_list.json"
+    @host = JSON.parse(last_response.body).first
+  end
+
+  context "/_hosts/:host/_services" do 
+
+    before :each do 
+      get "/_status/#{@host}/_services"
+      @data = JSON.parse(last_response.body)
+    end
+
+    it "return services list " do
+        @data.should be_a_kind_of Hash
+    end
+  end
+
+    
+end

data/spec/put/host_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Nagira do 
+  
+  set :environment, :test       #  This is potentially desctructive test, run only in  test mode
+  include Rack::Test::Methods
+  def app 
+    @app ||= Nagira
+  end
+
+  let (:content_type) {  {'Content-Type' => 'application/json'} }
+
+  before :all do 
+    @data = {
+      "status_code" => 0, 
+      "plugin_output" => "Plugin said: Bla" 
+    }
+
+    get "/_status/_list.json"
+    @host = JSON.parse(last_response.body).first
+
+  end
+
+  context "updates /_status/:host" do 
+    let (:url) { "/_status/#{@host}" }
+    
+    context "single check" do
+      
+      it "with no hostname" do
+        pending
+#         put url, @data, content_type
+
+#         pp [url, @data, last_response.body]
+#         last_response.should be_ok
+      end
+
+      it "with hostname" do
+        put url, @data, content_type
+        pp last_response.body
+        last_response.should_not be_ok
+      end
+
+
+    end
+
+    it "Multiple checks" do
+      pending
+    end
+
+  end                           #  /_status/:host
+
+end

data/spec/put/status_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+require_relative 'support'
+
+describe Nagira do
+
+  set :environment, :test       #  This is potentially desctructive test, run only in  test mode
+  include Rack::Test::Methods
+  def app
+    @app ||= Nagira
+  end
+
+  let (:content_type) {  {'Content-Type' => 'application/json'} }
+
+  before :all do
+    get "/_status/_list.json"
+
+    @host = JSON.parse(last_response.body).first
+    get "/_status/#{@host}/_services.json"
+
+    @input = {
+      "service_description" => "Host Service",
+      "return_code" => 0,
+      "plugin_output" => "Plugin said: Bla"
+    }
+
+    @input2 = {
+      "service_description" => "Another Host Service",
+      "return_code" => 2,
+      "plugin_output" => "Plugin said: Bla and Bla"
+    }
+
+  end
+
+  before :each do
+    File.delete nagios_cmd rescue nil
+  end
+
+  let (:host) { @host }
+
+  # ==================================================================
+  # Tests
+  #
+
+  context "/_status/:host/_services" do
+    
+    context :single do 
+      
+      let (:url) { "/_status/#{host}/_services" }
+      before (:each) do
+        put url, @input.to_json, content_type
+      end
+      
+      it_should_behave_like :put_status
+      
+      it "URL param hostname is higher priority than JSON" do
+        pending
+#         put url, @input.merge({ "host_name" => "fake_host"}).to_json, content_type
+
+#         out = JSON.parse last_response.body 
+# pp out
+#         out["object"]["data"]["host_name"].should eq host
+      end
+      
+      it "update with valid data" do
+        last_response.should be_ok
+      end
+      
+      it 'Fails with missing data' do
+        @input.keys.each do |key|
+          data = @input.dup
+          data.delete key
+          put url, data.to_json, content_type
+          last_response.status.should be 400
+        end
+      end
+    end
+    
+    context :multiple do
+      let (:url) { "/_status/#{host}/_services" }
+      before do
+        put url, [@input, @input2].to_json, content_type
+      end
+      
+      let (:out) { JSON.parse last_response.body }
+      
+      it_should_behave_like :put_status
+      
+      context "data check" do 
+        subject {  out["object"] }
+        
+        it {  should be_a_kind_of Array }
+        it {  subject.size.should eq 2 }
+      end
+    end
+  end
+  
+  context "/_status/:host_name/_services/:service_description" do
+    let(:url) { "/_status/#{host}/_services/PING" }
+    before do
+      put url, [{ return_code: 0, plugin_output: "All OK"}].to_json, content_type
+    end
+    
+    it "writes status" do
+      last_response.should be_ok
+    end
+    it_should_behave_like :put_status
+
+  end
+
+
+
+#   context 'host does not exist' do
+#     let (:host) { "some_nonexisting_host" }
+#     let (:url) { "/_status/#{host}/_services" }
+
+#     it_should_behave_like :put_status
+#     it {  pending "Add validaton for host existence in Ruby-Nagios for PUT"}
+
+#     #       it "fails with valid data" do
+#     #       end
+#     #       it 'fails with invalid data' do
+#     #       end
+
+#   end                         # host does not exist
+
+
+  context "/_status/:host_name/_services/:service_description/_return_code/:return_code/_plugin_output/:plugin_output" do
+    it { pending "To be depreciated "}
+  end
+
+end                           # update /_hosts

data/spec/put/support.rb

@@ -0,0 +1,64 @@
+shared_examples_for :json_response do 
+  before (:each) do 
+    @ret = JSON.parse(last_response.body)
+  end
+  subject { @ret }
+  
+  it { should be_a_kind_of Hash }
+  it { should have_key "result" }
+  it { should have_key "object" }
+
+  let (:obj) {  subject["object"] }
+
+  context :object do
+    # subject { obj }
+    
+    it { obj.should be_a_kind_of Array }
+    it { 
+      obj.each { |x| x.should be_a_kind_of Hash }
+    }
+
+    context :data_keys do
+      
+      it do
+        obj.each do |x| 
+          x.should have_key "data"
+          x.should have_key "result"
+          x.should have_key "messages"
+          [true, false].should include x["result"]
+        end
+      end
+    end
+  end
+end
+
+shared_examples_for :json_success_response do
+  before (:each) do 
+    @ret = JSON.parse(last_response.body)
+  end
+  subject { @ret }
+  
+  #it {  subject.}
+end
+
+shared_examples_for :write_to_nagios_cmd_file do
+  before (:all) do 
+      File.delete $nagios[:commands].path rescue nil
+  end
+  let (:cmd) { $nagios[:commands].path }
+  
+  it "writes to nagios.cmd file" do
+    File.should exist(cmd)
+    File.read(cmd).should =~ /^\[\d+\] PROCESS_SERVICE_CHECK_RESULT;#{host}/
+  end
+
+  after (:each) do 
+      File.delete $nagios[:commands].path rescue nil
+  end
+end
+
+
+shared_examples_for :put_status do 
+      it_should_behave_like :json_response
+      it_should_behave_like :write_to_nagios_cmd_file
+end

data/version.txt

@@ -1 +1 @@
-0.2.9
+0.2.10

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nagira
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Dmytro Kovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -276,6 +276,7 @@ files:
 - lib/app/routes/get/config.rb
 - lib/app/routes/get/objects.rb
 - lib/app/routes/get/status.rb
+- lib/app/routes/put/host.rb
 - lib/app/routes/put/status.rb
 - lib/app/routes/put.rb
 - lib/app.rb
@@ -284,11 +285,15 @@ files:
 - lib/nagira/timed_parse.rb
 - lib/nagira.rb
 - spec/00_configuration_spec.rb
-- spec/01_nagira_response_spec.rb
-- spec/02_0_status_spec.rb
-- spec/02_nagira_data_spec.rb
-- spec/03_api_spec.rb
-- spec/integration/10_put_service_spec.rb
+- spec/01_data_format/01_nagira_response_spec.rb
+- spec/01_data_format/02_0_status_spec.rb
+- spec/01_data_format/02_nagira_data_spec.rb
+- spec/01_data_format/03_api_spec.rb
+- spec/get/hosts_spec.rb
+- spec/get/services_spec.rb
+- spec/put/host_spec.rb
+- spec/put/status_spec.rb
+- spec/put/support.rb
 - spec/spec_helper.rb
 - config/defaults.rb
 - config/environment.rb
@@ -312,7 +317,8 @@ files:
 - test/data/status.dat
 - bin/nagira-setup
 homepage: http://dmytro.github.com/nagira
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/spec/integration/10_put_service_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-describe Nagira do 
-
-  set :environment, ENV['RACK_ENV'] || :test
-
-  include Rack::Test::Methods
-  
-  def app
-    @app ||= Nagira
-  end
-
-
-
-  context "Update services" do
-
-    context "/_status/:host_name/_services"
-
-    it "should ignore 404 for some services" do 
-      pending
-    end
-  end
-
-
-end