nagira 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef58ceb2eb909d1f350fe719b8178952f23a836a
-  data.tar.gz: 3eb3dcdd3b8c40aa63c9aa40ab8095b0894421d7
+  metadata.gz: a336625df06fa45529696e6c76a24a514c658acc
+  data.tar.gz: 06c24925a8f55086540c180432c78a16012c9bf4
 SHA512:
-  metadata.gz: 6f791716dbb7435f502d10adf55300dbdcfe92d5e19484f2aa1c3054234eab3487cea700ce75ee76a46e32e42725ccb95ee9b50f33842488dcbbf0a30058bc85
-  data.tar.gz: 212b0cbade25d508b51cbd9dd402568d49f6008088f2b7b93adb715742dd85cb983a823bf62edf966a68bc039cbb9ab1e626cd1290c7f5cec16a9e15aec17e3b
+  metadata.gz: ea2dbe47313fa3f3b1a5ca50e328cff6e35df7869918fea89022a7ccb1856a54cab7a62bf123406d681394bb9bf9a735bbd140892fa6fee3b3a83d8ef0fd3ccd
+  data.tar.gz: 9008b71560d0196af7130b684d814d3512a22a6c694d2b966f6932841e5fc8703ddaf73fe53de514a1167b48304a011655eea8e5c33e059525c5b0b0e5d974eb

data/History.md

@@ -1,3 +1,12 @@
+### v.0.2.12
+* Thr Aug 08 2013 -- Dmytro Kovalov
+  - Implementation for GET comments endpoints:
+    - /_status/:hostname/_services
+    - /_status/:hostname/_hostcomments
+    - /_status/:hostname/_servicecomments
+* July, Aug 2013
+  - RSpec tests
+    - GET endpoints checks
 ### v.0.2.10, v.0.2.11
 * Fri Jul 19 2013 -- Dmytro Kovalov
   - Gem versions fixes in gemspec, use gemspec in Gemfile.

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

@@ -60,7 +60,6 @@ class Nagira < Sinatra::Base
   #
   get "/_status/:hostname/_services/:service_name" do |hostname,service|
 
-
     hostname = hostname.to_i if hostname =~ /^\d+$/
     if @status && @status[hostname]
       if @output == :state
@@ -76,23 +75,36 @@ class Nagira < Sinatra::Base
   # @method get_status_hostname_services
   # @!macro hostname
   #
-  # All services for single host.
+  # Endpoints: 
+  # -  GET /_status/:hostname/_services
+  # -  GET /_status/:hostname/_hostcomments
+  # -  GET /_status/:hostname/_servicecomments
+  #
+  # Read +services+, +hostcomments+ or +servicecomments+ for single
+  # host. 
   #
   # @!macro accepted
   # @!macro state
   # @!macro list
   # @!macro full
-  get "/_status/:hostname/_services" do |hostname|
+  get %r{^/_status/(?<hostname>[\w\-\.]+)/_(?<service>(services|hostcomments|servicecomments))$} do |hostname,service|
 
     hostname = hostname.to_i if hostname =~ /^\d+$/
+    key = case service
+          when 'services' 
+            'servicestatus'
+          else
+            service
+          end
+            
     if @status && @status[hostname]
       case @output
       when :list
-        @data = @status[hostname]['servicestatus'].keys
+        @data = @status[hostname][key].keys
       when :state
         @data = @status.each { |k,v| @data[k] = v.slice("host_name", "service_description", "current_state") }
       else
-        @data = @status[hostname]['servicestatus']
+        @data = @status[hostname][key]
       end
     end
 
@@ -104,7 +116,10 @@ class Nagira < Sinatra::Base
   #
   # Return all hosts status. 
   #
-  # If no output modifier provided, outputs full hosttatus information for each host. Not including services information.
+  # If no output modifier provided, outputs full hosttatus information
+  # for each host. Not including services information. When +_full+
+  # modifier is provided data include hoststatus, servicestatus and
+  # all comments (servicecomments and hostcomments) for hosts.
   #
   # Alias: get /_status is the same thing as get /_status/_hosts with
   # ActiveResource compatibility, i.e. for */_hosts request Nagira
@@ -119,7 +134,7 @@ class Nagira < Sinatra::Base
   # - plural resources: N/A
   # - object access by ID: N/A
   
-  get /^\/_status(\/_hosts)?/ do
+  get /^\/_status(\/_hosts)?$/ do
 
     @data = @status.dup
 

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

@@ -22,7 +22,7 @@ class Nagira < Sinatra::Base
   #        $ curl -i -H "Accept: application/json" -d @host.json -X
   #            PUT http://localhost:4567/_status/svaroh
   #
-  #          => {"status": true, "object": [{"data": {"host_name":"svaroh",
+  #          => {"result": true, "object": [{"data": {"host_name":"svaroh",
   #          "status_code": "0", "plugin_output": "ping OK", "action":
   #          "PROCESS_HOST_CHECK_RESULT"}, "result":true, "messages": []}]}
   #

data/spec/get/comments_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+
+shared_examples_for :comment_data do 
+
+  let(:data) { JSON.parse(last_response.body) }
+
+  subject do
+    case data
+    when Array
+      data.first
+    when Hash
+      data.values.first.first
+    end
+  end
+
+  it { should be_a_kind_of Hash }
+  it { should have_key 'comment_id' }
+  it { should have_key 'comment_data' }
+  it { should have_key 'author' }  
+
+end
+
+
+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 "/_status/:host/_hostcomments" do 
+    before {  get "/_status/#{@host}/_hostcomments.json" }
+    it_should_behave_like :comment_data    
+  end
+
+
+  context "/_status/:host/_servicecomments" do 
+    before { get "/_status/#{@host}/_servicecomments.json" }
+
+    it_should_behave_like :comment_data
+
+    let (:data) {  JSON.parse(last_response.body).values.first.first }
+    it { data.should have_key 'service_description' }
+    it { data.should have_key 'host_name' }
+
+  end
+
+
+    
+end

data/spec/get/endpoints_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+#
+# Specs for implemetned API endpoints. Only check response: OK or 404.
+#
+
+shared_examples_for :fail_on_random_url do |base|  
+  RANDOM.each do |url|
+    ep = "#{base}/#{url}"
+    it "fails on #{ep} string" do
+      get ep
+      last_response.status.should be 404
+    end
+  end
+end
+
+shared_examples_for :respond_to_valid_url do |base, urls|
+  urls.each do |url|
+    ep = "#{base}/#{url}"
+    it "responds to #{ep}" do
+      get ep
+      last_response.should be_ok
+    end
+  end
+end
+
+shared_examples_for :fail_on_bad_url do |url|
+  before {  get url }
+  it "fails on #{url}" do 
+    last_response.status.should be 404
+  end
+end
+
+describe Nagira do 
+  
+  set :environment, :test       # This should run only in test mode as it uses hardcoded host names
+  include Rack::Test::Methods
+  def app 
+    @app ||= Nagira
+  end
+  
+  context "API endpoints" do
+    
+    host = IMPLEMENTED[:hosts].first 
+
+    context :top do 
+      it_should_behave_like :respond_to_valid_url,  '', IMPLEMENTED[:top]
+      it_should_behave_like :fail_on_random_url,    ''
+    end
+      
+
+    context "/_status" do
+      it_should_behave_like :respond_to_valid_url,  "/_status", IMPLEMENTED[:hosts]
+      it_should_behave_like :respond_to_valid_url,  "/_status", IMPLEMENTED[:output] + ["_hosts"]
+      it_should_behave_like :fail_on_random_url, '/_status'
+    end
+
+    context "/_status/:host" do
+      it_should_behave_like :respond_to_valid_url,  "/_status/#{host}", IMPLEMENTED[:status]
+      it_should_behave_like :fail_on_random_url,    "/_status/#{host}"
+
+      context :unknown_host do
+        it_should_behave_like :fail_on_bad_url,       '/_status/unknown_host'
+        it_should_behave_like :fail_on_random_url,    "/_status/unknown_host"
+      end
+
+    end
+
+  end                           # API endpoints
+
+    
+end

data/spec/put/host_spec.rb

@@ -1,4 +1,6 @@
 require 'spec_helper'
+require_relative 'support'
+require 'pp'
 
 describe Nagira do 
   
@@ -8,45 +10,50 @@ describe Nagira do
     @app ||= Nagira
   end
 
-  let (:content_type) {  {'Content-Type' => 'application/json'} }
-
   before :all do 
-    @data = {
+    get "/_status/_list.json"
+    @host = JSON.parse(last_response.body).first
+  end
+
+  let (:content_type) {  {'Content-Type' => 'application/json'} }
+  let (:host) { @host }
+  let (:input) { 
+    {
       "status_code" => 0, 
       "plugin_output" => "Plugin said: Bla" 
     }
+  }
 
-    get "/_status/_list.json"
-    @host = JSON.parse(last_response.body).first
+  # --------------------------------------------
+  # Tests
+  #
 
-  end
+  context "/_status" do
+    it { pending "Not implemented" }
+  end                           # ----------- "/_status" do
 
-  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
+  context "/_status/:host_name" do
+    let (:url) { "/_status/#{host}"}
 
-      it "with hostname" do
-        put url, @data, content_type
-        pp last_response.body
-        last_response.should_not be_ok
-      end
+    before (:each) do 
+      put url, input.to_json, content_type
+    end
 
+    it_should_behave_like :put_status
 
+    it "should fail with missing data" do
+      input.keys.each do |key|
+        (inp = input.dup).delete key
+        put url, inp.to_json, content_type
+        last_response.status.should eq 400
+      end
     end
 
-    it "Multiple checks" do
-      pending
-    end
+    context "/_host_status/:host_name" do
+      it { pending "Not implemented" }
+    end                         # ----------- "/_host_status/:host_name" 
+
 
-  end                           #  /_status/:host
+  end                           #  ----------- /_status/:host
 
 end

data/spec/put/support.rb

@@ -38,7 +38,6 @@ shared_examples_for :json_success_response do
   end
   subject { @ret }
   
-  #it {  subject.}
 end
 
 shared_examples_for :write_to_nagios_cmd_file do
@@ -49,7 +48,7 @@ shared_examples_for :write_to_nagios_cmd_file do
   
   it "writes to nagios.cmd file" do
     File.should exist(cmd)
-    File.read(cmd).should =~ /^\[\d+\] PROCESS_SERVICE_CHECK_RESULT;#{host}/
+    File.read(cmd).should =~ /^\[\d+\] PROCESS_(SERVICE|HOST)_CHECK_RESULT;#{host}/
   end
 
   after (:each) do 

data/spec/spec_helper.rb

@@ -2,3 +2,12 @@ $: << File.dirname(__FILE__) + '/../lib/'
 require_relative '../lib/nagira.rb'
 require_relative '../lib/app.rb'
 require 'rack/test'
+
+IMPLEMENTED = {
+  top:            %w{ _api _status _objects _config _runtime},
+  output:          %w{ _list _state _full }, # Type of requests as in varaible @output
+  hosts:          %w{ archive tv },
+  status:         %w{ _services _servicecomments _hostcomments }
+}
+
+RANDOM = %w{ _bla _foo bla foo ahdhjdjda }

data/test/data/status.dat

@@ -1650,3 +1650,30 @@ contactstatus {
 	service_notifications_enabled=1
 	}
 
+servicecomment {
+	host_name=archive
+	service_description=Disk space
+	entry_type=4
+	comment_id=38
+	source=0
+	persistent=0
+	entry_time=1373457035
+	expires=0
+	expire_time=0
+	author=dmytro
+	comment_data=Need to verify what to delete.
+    }
+
+hostcomment {
+	host_name=archive
+	entry_type=1
+	comment_id=40
+	source=1
+	persistent=1
+	entry_time=1375778132
+	expires=0
+	expire_time=0
+	author=dmytro
+	comment_data=Testing Host Comment --dk
+	}
+

data/version.txt

@@ -1 +1 @@
-0.2.11
+0.2.12

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nagira
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Dmytro Kovalov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -292,13 +292,14 @@ files:
 - lib/nagira/background_parse.rb
 - lib/nagira/nagios.rb
 - lib/nagira/timed_parse.rb
-- lib/nagira/version.rb
 - lib/nagira.rb
 - spec/00_configuration_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/comments_spec.rb
+- spec/get/endpoints_spec.rb
 - spec/get/hosts_spec.rb
 - spec/get/services_spec.rb
 - spec/put/host_spec.rb

data/lib/nagira/version.rb

@@ -1,4 +0,0 @@
-require 'sinatra'
-class Nagira < Sinatra::Base
-  VERSION  = File.read(File.expand_path(File.dirname(__FILE__)) + '/../../version.txt').strip
-end