hq-tools 0.3.1 → 0.4.0

data/lib/hq/tools/check-script.rb

@@ -13,6 +13,7 @@ class CheckScript
 		@critical = false
 		@warning = false
 		@unknown = false
+		@performances = []
 		@postscript = []
 		@stdout = $stdout
 		@stderr = $stderr
@@ -48,25 +49,36 @@ class CheckScript
 
 	def perform_output
 
-		if @critical
-			@stdout.puts "#{@name} CRITICAL: #{@messages.join ", "}"
-			@status = 2
+		str = StringIO.new
 
-		elsif @warning
-			@stdout.puts "#{@name} WARNING: #{@messages.join ", "}"
-			@status = 1
+		str.print @name, " "
 
+		if @critical
+			str.print "CRITICAL"
+		elsif @warning
+			str.print "WARNING"
 		elsif @unknown
-			@stdout.puts "#{@name} UNKNOWN: #{@messages.join ", "}"
-			@status = 3
-
+			str.print "UNKNOWN"
 		else
-			@stdout.puts "#{@name} OK: #{@messages.join ", "}"
-			@status = 0
+			str.print "OK"
 		end
 
-		@postscript.each do |ps|
-			@stderr.puts ps
+		str.print ": "
+
+		str.print @messages.join(", ")
+
+		unless @performances.empty?
+			str.print " | "
+			str.print @performances.join(" ")
+		end
+
+		str.print "\n"
+
+		@stdout.print str.string
+
+		@postscript.each do
+			|postscript|
+			@stderr.puts postscript
 		end
 
 	end
@@ -90,6 +102,17 @@ class CheckScript
 		@unknown = true
 	end
 
+	def performance name, value, options = {}
+		parts = []
+		parts[0] = "%s%s" % [ value, options[:units] ]
+		parts[1] = options[:warning].to_s if options[:warning]
+		parts[2] = options[:critical].to_s if options[:critical]
+		parts[3] = options[:minimum].to_s if options[:minimum]
+		parts[4] = options[:maximum].to_s if options[:maximum]
+		name = "'#{name.gsub "'", "''"}'" if name.include? "'"
+		@performances << "%s=%s" % [ name, parts.join(";") ]
+	end
+
 end
 end
 end

data/spec/hq/tools/check-script-spec.rb

@@ -0,0 +1,78 @@
+require "hq/tools/check-script"
+
+module HQ
+module Tools
+
+describe CheckScript do
+
+	before do
+		subject.stub(:process_args)
+		subject.stub(:perform_checks)
+		subject.stdout = StringIO.new
+	end
+
+	context "performance data" do
+
+		it "none" do
+			subject.stub(:perform_checks) do
+				subject.message "hello"
+			end
+			subject.main
+			subject.stdout.string.should ==
+				"Unnamed OK: hello\n"
+		end
+
+		it "single metric" do
+			subject.stub(:perform_checks) do
+				subject.message "hello"
+				subject.performance "metric1", 1
+			end
+			subject.main
+			subject.stdout.string.should ==
+				"Unnamed OK: hello | metric1=1\n"
+		end
+
+		it "special chars" do
+			subject.stub(:perform_checks) do
+				subject.message "hello"
+				subject.performance "apos'trophe", 1
+			end
+			subject.main
+			subject.stdout.string.should ==
+				"Unnamed OK: hello | 'apos''trophe'=1\n"
+		end
+
+		it "optional fields" do
+			subject.stub(:perform_checks) do
+				subject.message "hello"
+				subject.performance \
+					"metric1",
+					1,
+					:units => "blops",
+					:warning => 2,
+					:critical => 5,
+					:minimum => 0,
+					:maximum => 10
+			end
+			subject.main
+			subject.stdout.string.should ==
+				"Unnamed OK: hello | metric1=1blops;2;5;0;10\n"
+		end
+
+		it "two metrics" do
+			subject.stub(:perform_checks) do
+				subject.message "hello"
+				subject.performance "metric1", 1
+				subject.performance "metric2", 5
+			end
+			subject.main
+			subject.stdout.string.should ==
+				"Unnamed OK: hello | metric1=1 metric2=5\n"
+		end
+
+	end
+
+end
+
+end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hq-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -102,6 +102,7 @@ files:
 - lib/hq/tools/escape.rb
 - lib/hq/tools/check-script.rb
 - spec/hq/tools/getopt-spec.rb
+- spec/hq/tools/check-script-spec.rb
 homepage: https://github.com/jamespharaoh/hq-tools
 licenses: []
 post_install_message: 
@@ -128,3 +129,4 @@ specification_version: 3
 summary: HQ tools
 test_files:
 - spec/hq/tools/getopt-spec.rb
+- spec/hq/tools/check-script-spec.rb