hq-sms-global-balance-check 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd135a8ba3ea2cfef393062bdd82c055abffbfae
+  data.tar.gz: 07f2c99c82e1c70944b0f8c68beaa17e0307e6de
+SHA512:
+  metadata.gz: 9e174f85e98b9ec5c78302eae4945c364932632b5c7361f0463edc82ddc31398738bd69247333b73d763d1a3d075bf25d97b9c601a3691169b2a1aa448221760
+  data.tar.gz: f200d1538c878e018bcb320e0e6213de614b50d83a4bda4aa909189eb1351c32846b4229e3a7808f9d8847db9ed62865c73a394661e8048fb61dfed1f15765a3

data/features/basic.feature

@@ -10,11 +10,7 @@ Feature: Basic functionality
       </hq-sms-global-balance-check-config>
       """
 
-  Scenario: Balance ok
-
-    Given that the balance is 750
-
-    When I run the script with args:
+    Given a file "default.args":
       """
       --config default.config
       --account account
@@ -22,6 +18,12 @@ Feature: Basic functionality
       --critical 100
       """
 
+  Scenario: Balance ok
+
+    Given the balance is 750
+
+    When I run the script with "default.args"
+
     Then the status should be 0
     And the output should be:
       """
@@ -30,15 +32,9 @@ Feature: Basic functionality
 
   Scenario: Balance warning
 
-    Given that the balance is 250
+    Given the balance is 250
 
-    When I run the script with args:
-      """
-      --config default.config
-      --account account
-      --warning 500
-      --critical 100
-      """
+    When I run the script with "default.args"
 
     Then the status should be 1
     And the output should be:
@@ -48,15 +44,9 @@ Feature: Basic functionality
 
   Scenario: Balance critical
 
-    Given that the balance is 50
+    Given the balance is 50
 
-    When I run the script with args:
-      """
-      --config default.config
-      --account account
-      --warning 500
-      --critical 100
-      """
+    When I run the script with "default.args"
 
     Then the status should be 2
     And the output should be:

data/features/cache.feature

@@ -0,0 +1,71 @@
+Feature: Cached results
+
+  If the service does not respond for some reason a cached result can be used
+  instead. Alerts will be generated if the time since the last check exceeds a
+  specified amount.
+
+  Background:
+
+    Given a file "default.config":
+      """
+      <hq-sms-global-balance-check-config>
+        <server url="${server-url}"/>
+        <cache dir="cache"/>
+        <account name="account" username="USER" password="PASS"/>
+      </hq-sms-global-balance-check-config>
+      """
+
+    And a file "default.args":
+      """
+      --config default.config
+      --account account
+      --warning 500
+      --critical 100
+      --cache-warning 10
+      --cache-critical 20
+      """
+
+    And a directory "cache"
+
+    And the balance is 750
+    And the time is 100
+    And I run the script with "default.args"
+
+  Scenario: Cache ok
+
+    Given the time is 105
+    And the server is offline
+
+    When I run the script with "default.args"
+
+    Then the status should be 0
+    And the output should be:
+      """
+      SMS Global account OK: 750 credits, last check 5 seconds ago
+      """
+
+  Scenario: Cache warning
+
+    Given the time is 115
+    And the server is offline
+
+    When I run the script with "default.args"
+
+    Then the status should be 1
+    And the output should be:
+      """
+      SMS Global account WARNING: 750 credits, last check 15 seconds ago (warning is 10)
+      """
+
+  Scenario: Cache critical
+
+    Given the time is 125
+    And the server is offline
+
+    When I run the script with "default.args"
+
+    Then the status should be 2
+    And the output should be:
+      """
+      SMS Global account CRITICAL: 750 credits, last check 25 seconds ago (critical is 20)
+      """

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require "hq/cucumber/temp-dir"
+require "hq/cucumber/time"

data/features/support/steps.rb

@@ -2,33 +2,24 @@ require "shellwords"
 
 require "hq/sms-global/balance-check/script"
 
-Given /^a file "(.*?)":$/ do
-	|file_name, file_contents|
-
-	File.open file_name, "w" do
-		|file_io|
-
-		file_contents =
-			file_contents.gsub "${server-url}", $web_url
-
-		file_io.write file_contents
+Given /^the balance is (\d+)$/ do
+	|balance_str|
 
-	end
+	$balance = balance_str.to_f
 
 end
 
-Given /^that the balance is (\d+)$/ do
-	|balance_str|
+Given /^the server is offline$/ do
 
-	$balance = balance_str.to_f
+	$status = :offline
 
 end
 
-When /^I run the script with args:$/ do
-	|args_str|
+When /^I run the script with "(.+)"$/ do
+	|args_file|
 
 	@script = HQ::SmsGlobal::BalanceCheck::Script.new
-	@script.args = Shellwords.split args_str
+	@script.args = Shellwords.split File.read(args_file)
 
 	@script.stdout = StringIO.new
 	@script.stderr = StringIO.new

data/features/support/web-server.rb

@@ -28,13 +28,28 @@ end
 $web_server.mount_proc "/balance-api.php" do
 	|request, response|
 
-	request.query["user"].should == "USER"
-	request.query["password"].should == "PASS"
+	case $status
 
-	response.body = "BALANCE: #{$balance}; USER: USER"
+		when :online
+
+			request.query["user"].should == "USER"
+			request.query["password"].should == "PASS"
+
+			response.body = "BALANCE: #{$balance}; USER: USER"
+
+		when :offline
+
+			response.status = 500
+			response.message = "Internal server error"
+
+			response.body = "Sorry, an error occurred"
+
+	end
 
 end
 
 Before do
 	$balance = 0.0
+	$status = :online
+	$placeholders["${server-url}"] = $web_url
 end

data/lib/hq/sms-global/balance-check/script.rb

@@ -33,6 +33,12 @@ class Script < Tools::CheckScript
 					:convert => :to_f,
 					:required => true },
 
+				{ :name => :cache_warning,
+					:convert => :to_i },
+
+				{ :name => :cache_critical,
+					:convert => :to_i },
+
 			]
 
 		raise "Extra args" unless @args.empty?
@@ -58,6 +64,9 @@ class Script < Tools::CheckScript
 		@server_elem =
 			@config_elem.find_first "server"
 
+		@cache_elem =
+			@config_elem.find_first "cache"
+
 		@account_elem =
 			@config_elem.find_first "account [
 				@name = #{esc_xp @opts[:account]}
@@ -67,6 +76,81 @@ class Script < Tools::CheckScript
 
 	def perform_checks
 
+		used_cache = false
+
+		begin
+
+			get_balance_from_server
+
+		rescue => exception
+
+			raise exception \
+				unless @cache_elem
+
+			read_cache
+
+			used_cache = true
+
+		end
+
+		# report balance
+
+		if @actual_balance < @opts[:critical]
+
+			critical "%s credits (critical is %s)" % [
+				@actual_balance.to_i,
+				@opts[:critical].to_i,
+			]
+
+		elsif @actual_balance < @opts[:warning]
+
+			warning "%s credits (warning is %s)" % [
+				@actual_balance.to_i,
+				@opts[:warning].to_i,
+			]
+
+		else
+
+			message "%s credits" % [
+				@actual_balance.to_i,
+			]
+
+		end
+
+		# report cache usage
+
+		if used_cache
+
+			if @opts[:cache_critical] \
+				&& @cache_age >= @opts[:cache_critical]
+
+				critical "last check %s seconds ago (critical is %s)" % [
+					@cache_age,
+					@opts[:cache_critical]
+				]
+
+			elsif @opts[:cache_warning] \
+				&& @cache_age >= @opts[:cache_warning]
+
+				warning "last check %s seconds ago (warning is %s)" % [
+					@cache_age,
+					@opts[:cache_warning]
+				]
+
+			else
+
+				message "last check #{@cache_age} seconds ago"
+
+			end
+
+		end
+
+		write_cache
+
+	end
+
+	def get_balance_from_server
+
 		url =
 			URI.parse "#{@server_elem["url"]}/balance-api.php"
 
@@ -79,7 +163,6 @@ class Script < Tools::CheckScript
 		Net::HTTP.start url.host, url.port do
 			|http|
 
-
 			request = Net::HTTP::Get.new "#{url.path}?#{url.query}"
 
 			response = http.request request
@@ -90,32 +173,54 @@ class Script < Tools::CheckScript
 			raise "Error 2" \
 				unless response.body =~ /^BALANCE: ([^;]+); USER: (.+)$/
 
-			actual_balance = $1.to_f
+			@actual_balance =
+				$1.to_f
+
+		end
 
-			if actual_balance < @opts[:critical]
+	end
 
-				critical "%s credits (critical is %s)" % [
-					actual_balance.to_i,
-					@opts[:critical].to_i,
-				]
+	def read_cache
 
-			elsif actual_balance < @opts[:warning]
+		cache_path = "%s/%s.yaml" % [
+			@cache_elem["dir"],
+			@opts[:account],
+		]
 
-				warning "%s credits (warning is %s)" % [
-					actual_balance.to_i,
-					@opts[:warning].to_i,
-				]
+		cache_data =
+			YAML.load_file cache_path
 
-			else
+		@actual_balance =
+			cache_data["balance"]
 
-				message "%s credits" % [
-					actual_balance.to_i,
-				]
+		@cache_age =
+			(Time.now - cache_data["timestamp"]).to_i
 
-			end
+	end
+
+	def write_cache
+
+		return unless @cache_elem
+
+		cache_data = {
+			"balance" => @actual_balance,
+			"timestamp" => Time.now,
+		}
+
+		cache_path = "%s/%s.yaml" % [
+			@cache_elem["dir"],
+			@opts[:account],
+		]
+
+		File.open "#{cache_path}.new", "w" do
+			|cache_io|
+
+			cache_io.write YAML.dump cache_data
 
 		end
 
+		FileUtils.mv "#{cache_path}.new", cache_path
+
 	end
 
 end

metadata

@@ -1,158 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: hq-sms-global-balance-check
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - James Pharaoh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hq-tools
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: hq-dev
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.0.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
 description: HQ nagios/icinga plugin to check balance of SMS global account
@@ -164,39 +145,38 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/hq/sms-global/balance-check/script.rb
+- features/cache.feature
 - features/basic.feature
-- features/support/temp-dir.rb
 - features/support/steps.rb
 - features/support/env.rb
 - features/support/web-server.rb
 - bin/hq-sms-global-balance-check
 homepage: https://github.com/jamespharaoh/hq-sms-global-balance-check
 licenses: []
+metadata: {}
 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: 1.3.6
 requirements: []
 rubyforge_project: hq-sms-global-balance-check
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HQ SMS Global balance check
 test_files:
+- features/cache.feature
 - features/basic.feature
-- features/support/temp-dir.rb
 - features/support/steps.rb
 - features/support/env.rb
 - features/support/web-server.rb

data/features/support/temp-dir.rb

@@ -1,16 +0,0 @@
-require "tmpdir"
-
-Before do
-
-	@old_dir = Dir.pwd
-	@temp_dir = Dir.mktmpdir
-	Dir.chdir @temp_dir
-
-end
-
-After do
-
-	FileUtils.remove_entry_secure @temp_dir
-	Dir.chdir @old_dir
-
-end