hq-check-site 0.0.0

data/bin/hq-check-site

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+script_path = $0
+script_path = File.readlink(script_path) while File.symlink?(script_path)
+CONFIG = File.expand_path("#{File.dirname(script_path)}/../..")
+$LOAD_PATH.unshift "#{CONFIG}/alchemy-hq/ruby"
+
+require "hq/systools/monitoring/check-site-script"
+
+include HQ::SysTools::Monitoring
+
+script = CheckSiteScript.new
+script.args = ARGV
+script.main
+exit script.status

data/features/check-site.feature

@@ -0,0 +1,178 @@
+Feature: Check site script
+
+  Background:
+
+    Given a config "default":
+      """
+        <check-site-script base-url="http://hostname:${port}">
+          <timings warning="2" critical="4" timeout="10"/>
+          <step name="page">
+            <request path="/page"/>
+            <response/>
+          </step>
+        </check-site-script>
+      """
+
+    Given a config "regex":
+      """
+        <check-site-script base-url="http://hostname:${port}">
+          <timings warning="2" critical="4" timeout="10"/>
+          <step name="page">
+            <request path="/page"/>
+            <response body-regex="y+e+s+"/>
+          </step>
+        </check-site-script>
+      """
+
+    Given a config "timeout":
+      """
+        <check-site-script base-url="http://hostname:${port}">
+          <timings warning="2" critical="4" timeout="0"/>
+          <step name="page">
+            <request path="/page"/>
+            <response/>
+          </step>
+        </check-site-script>
+      """
+
+    Given a config "http-auth":
+      """
+        <check-site-script base-url="http://hostname:${port}">
+          <timings warning="2" critical="4" timeout="10"/>
+          <step name="page">
+            <request path="/page" username="USER" password="PASS"/>
+            <response/>
+          </step>
+        </check-site-script>
+      """
+
+    Given a config "form-auth":
+      """
+        <check-site-script base-url="http://hostname:${port}">
+          <timings warning="2" critical="4" timeout="10"/>
+          <step name="login">
+            <request path="/login" method="post">
+              <param name="username" value="USER"/>
+              <param name="password" value="PASS"/>
+            </request>
+            <response/>
+          </step>
+          <step name="page">
+            <request path="/page" username="USER" password="PASS"/>
+            <response/>
+          </step>
+        </check-site-script>
+      """
+
+    Given a config "no-path":
+      """
+        <check-site-script base-url="http://hostname:${port}/page">
+          <timings warning="2" critical="4" timeout="10"/>
+          <step name="page">
+            <request/>
+            <response/>
+          </step>
+        </check-site-script>
+      """
+
+    Given a config "wrong-port":
+      """
+        <check-site-script base-url="http://hostname:65535">
+          <timings warning="2" critical="4" timeout="10"/>
+          <step name="page">
+            <request path="/path"/>
+            <response/>
+          </step>
+        </check-site-script>
+      """
+
+  Scenario: Site responds in ok time
+    Given one server which responds in 1 second
+     When check-site is run with config "default"
+     Then all servers should receive page requests
+      And the message should be "Site OK: 1 hosts found, 1.0s time"
+      And the status should be 0
+
+  Scenario: Site responds in warning time
+    Given one server which responds in 1 second
+      And one server which responds in 3 seconds
+     When check-site is run with config "default"
+     Then all servers should receive page requests
+      And the message should be "Site WARNING: 2 hosts found, 3.0s time (warning is 2.0)"
+      And the status should be 1
+
+  Scenario: Site responds in critical time
+    Given one server which responds in 1 second
+      And one server which responds in 3 seconds
+      And one server which responds in 5 seconds
+     When check-site is run with config "default"
+     Then all servers should receive page requests
+      And the message should be "Site CRITICAL: 3 hosts found, 5.0s time (critical is 4.0)"
+      And the status should be 2
+
+  Scenario: Body contains regex
+    Given one server which responds with "-yes-"
+     When check-site is run with config "regex"
+     Then all servers should receive page requests
+      And the message should be "Site OK: 1 hosts found, 0.0s time"
+      And the status should be 0
+
+  Scenario: Body does not contain regex
+    Given one server which responds with "-yes-"
+      And one server which responds with "-no-"
+     When check-site is run with config "regex"
+     Then all servers should receive page requests
+      And the message should be "Site CRITICAL: 2 hosts found, 1 mismatches, 0.0s time"
+      And the status should be 2
+
+  Scenario: Timeout does not expire
+    Given one server which responds in 0 seconds
+     When check-site is run with config "default"
+     Then all servers should receive page requests
+      And the message should be "Site OK: 1 hosts found, 0.0s time"
+      And the status should be 0
+
+  Scenario: Timeout expires
+    Given one server which responds in 0 seconds
+     When check-site is run with config "timeout"
+      And the message should be "Site CRITICAL: 1 hosts found, 1 uncontactable"
+      And the status should be 2
+
+  Scenario: Username and password are correct
+    Given one server which requires username "USER" and password "PASS"
+     When check-site is run with config "http-auth"
+     Then all servers should receive page requests
+      And the message should be "Site OK: 1 hosts found, 0.0s time"
+      And the status should be 0
+
+  Scenario: Username and password are incorrect
+    Given one server which requires username "USER" and password "SECRET"
+     When check-site is run with config "http-auth"
+     Then all servers should receive page requests
+      And the message should be "Site CRITICAL: 1 hosts found, 1 errors (401), 0.0s time"
+      And the status should be 2
+
+  Scenario: No servers
+     When check-site is run with config "default"
+      And the message should be "Site CRITICAL: unable to resolve hostname"
+      And the status should be 2
+
+  Scenario: Form based login
+    Given one server which requires form based login with "USER" and "PASS"
+     When check-site is run with config "form-auth"
+     Then all servers should receive page requests
+      And the message should be "Site OK: 1 hosts found, 0.0s time"
+      And the status should be 0
+
+  Scenario: No path specified
+    Given one server which responds in 0 seconds
+     When check-site is run with config "no-path"
+     Then all servers should receive page requests
+      And the message should be "Site OK: 1 hosts found, 0.0s time"
+      And the status should be 0
+
+  Scenario: Connection refused
+    Given one server which responds in 0 seconds
+     When check-site is run with config "wrong-port"
+     Then the message should be "Site CRITICAL: 1 hosts found, 1 uncontactable"
+      And the status should be 2

data/features/support/env.rb

@@ -0,0 +1,105 @@
+require "cucumber/rspec/doubles"
+require "webrick"
+require "xml"
+
+require "hq/check-site/script"
+
+$web_config = {
+	:Port => 10000 + rand(55535),
+	:AccessLog => [],
+	:Logger => WEBrick::Log::new("/dev/null", 7),
+	:DoNotReverseLookup => true,
+}
+
+$web_server =
+	WEBrick::HTTPServer.new \
+		$web_config
+
+Thread.new do
+	$web_server.start
+end
+
+at_exit do
+	$web_server.shutdown
+end
+
+$web_server.mount_proc "/login" do
+	|request, response|
+
+	server_address = request.addr[3]
+	server = $servers[server_address]
+
+	raise "auth method" unless server[:auth_method] == :form
+	raise "request method" unless request.request_method == "POST"
+	raise "username" unless request.query["username"] == server[:auth_username]
+	raise "password" unless request.query["password"] == server[:auth_password]
+
+	# set session id
+
+	server[:session_id] = (?a..?z).to_a.sample(10).join
+
+	# add session cookie and more to make it harder
+
+	misc_cookie_0 = WEBrick::Cookie.new "foo", "bar"
+	misc_cookie_0.path = "/"
+	response.cookies << misc_cookie_0
+
+	session_cookie = WEBrick::Cookie.new "session", server[:session_id]
+	session_cookie.expires = Time.now + 60
+	response.cookies << session_cookie
+
+	misc_cookie_1 = WEBrick::Cookie.new "blah", "meh"
+	misc_cookie_0.path = "/"
+	response.cookies << misc_cookie_1
+
+end
+
+$web_server.mount_proc "/page" do
+	|request, response|
+
+	server_address = request.addr[3]
+	server = $servers[server_address]
+
+	server[:request_count] += 1
+
+	if server[:auth_method] == :http
+		WEBrick::HTTPAuth.basic_auth request, response, "Realm" do
+			|user, pass|
+			user == server[:auth_username] &&
+			pass == server[:auth_password]
+		end
+	end
+
+	if server[:auth_method] == :form
+
+		session_cookie =
+			request.cookies.find {
+				|cookie|
+				cookie.name == "session"
+			}
+
+		session_id =
+			session_cookie.value
+
+		raise "not logged in" \
+			unless session_id = server[:session_id]
+
+	end
+
+	response.status = server[:response_code]
+	response.body = server[:response_body]
+
+	$time += server[:response_time]
+
+end
+
+Before do
+
+	$servers = {}
+	$time = Time.now
+
+	@configs = {}
+
+	Time.stub(:now) { $time }
+
+end

data/features/support/steps.rb

@@ -0,0 +1,121 @@
+Given /^a config "(.*?)":$/ do
+	|name, content|
+	@configs[name] = content
+end
+
+Given /^(?:one|another) server which responds in (\d+) seconds?$/ do
+	|time_str|
+
+	server = {
+		address: "127.0.1.#{$servers.size}",
+		request_count: 0,
+		response_code: "200",
+		response_time: time_str.to_i,
+		response_body: "",
+	}
+
+	$servers[server[:address]] = server
+
+end
+
+Given /^(?:one|another) server which responds with "(.*?)"$/ do
+	|response_str|
+
+	server = {
+		address: "127.0.1.#{$servers.size}",
+		request_count: 0,
+		response_code: "200",
+		response_time: 0,
+		response_body: response_str,
+	}
+
+	$servers[server[:address]] = server
+
+end
+
+Given /^(?:one|another) server which requires username "([^"]*)" and password "([^"]+)"$/ do
+	|username, password|
+
+	server = {
+		address: "127.0.1.#{$servers.size}",
+		request_count: 0,
+		response_code: "200",
+		response_time: 0,
+		response_body: "",
+		auth_method: :http,
+		auth_username: username,
+		auth_password: password,
+	}
+
+	$servers[server[:address]] = server
+
+end
+
+Given /^one server which requires form based login with "([^"]*)" and "([^"]*)"$/ do
+	|username, password|
+
+	server = {
+		address: "127.0.1.#{$servers.size}",
+		request_count: 0,
+		response_code: "200",
+		response_time: 0,
+		response_body: "",
+		auth_method: :form,
+		auth_username: username,
+		auth_password: password,
+	}
+
+	$servers[server[:address]] = server
+
+end
+
+When /^check\-site is run with config "([^"]*)"$/ do
+	|config_name|
+
+	Resolv.stub(:getaddresses).and_return(
+		$servers.values.map {
+			|server| server[:address]
+		}
+	)
+
+	@script =
+		HQ::CheckSite::Script.new
+
+	@script.stdout = StringIO.new
+	@script.stderr = StringIO.new
+
+	Tempfile.open "check-site-script-" do
+		|temp|
+
+		config_str = @configs[config_name]
+		config_str.gsub! "${port}", $web_config[:Port].to_s
+		config_doc = XML::Document.string config_str
+		temp.write config_doc
+		temp.flush
+
+		@script.args = [
+			"--config", temp.path,
+		]
+
+		@script.main
+
+	end
+
+end
+
+Then /^all servers should receive page requests$/ do
+	$servers.each do
+		|server_address, server|
+		server[:request_count].should >= 1
+	end
+end
+
+Then /^the status should be (\d+)$/ do
+	|status_str|
+	@script.status.should == status_str.to_i
+end
+
+Then /^the message should be "(.*?)"$/ do
+	|message|
+	@script.stdout.string.strip.should == message
+end

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

@@ -0,0 +1,269 @@
+require "net/http"
+require "net/https"
+require "resolv"
+require "set"
+require "webrick"
+require "xml"
+
+require "hq/tools/check-script"
+require "hq/tools/getopt"
+
+module HQ
+module CheckSite
+class Script < Tools::CheckScript
+
+	# custom http class allows us to connect to a different address
+
+	class CustomHTTP < Net::HTTP
+		attr_accessor :conn_address
+	end
+
+	def initialize
+		super
+		@name = "Site"
+	end
+
+	def process_args
+
+		@opts, @args =
+			Tools::Getopt.process @args, [
+
+				{ :name => :config,
+					:required => true },
+
+				{ :name => :debug,
+					:boolean => true },
+
+			]
+
+		@args.empty? or raise "Extra args on command line"
+
+	end
+
+	def prepare
+
+		config_doc =
+			XML::Document.file @opts[:config]
+
+		@config_elem =
+			config_doc.root
+
+		@timings_elem =
+			@config_elem.find_first "timings"
+
+		@critical_time =
+			@timings_elem["critical"].to_f
+
+		@warning_time =
+			@timings_elem["warning"].to_f
+
+		@timeout_time =
+			@timings_elem["timeout"].to_f
+
+		@base_url = URI.parse @config_elem["base-url"]
+
+	end
+
+	def perform_checks
+
+		addresses = Resolv.getaddresses @base_url.host
+
+		@worst = nil
+		@successes = 0
+		@failures = 0
+		@mismatches = 0
+		@error_codes = Set.new
+
+		addresses.each do
+			|address|
+
+			check_address address
+
+		end
+
+		errors = @error_codes.size
+		total = @successes + errors + @failures + @mismatches
+
+		if total == 0
+			critical "unable to resolve #{@base_url.host}"
+		else
+			message "#{total} hosts found"
+
+			critical "#{@failures} uncontactable" \
+				if @failures > 0
+
+			critical "#{errors} errors (#{@error_codes.to_a.join(",")})" \
+				if errors > 0
+
+			critical "#{@mismatches} mismatches" \
+				if @mismatches > 0
+
+			if @worst != nil
+
+				if @worst >= @critical_time
+					critical "#{@worst}s time (critical is #{@critical_time})"
+				elsif @worst >= @warning_time
+					warning "#{@worst}s time (warning is #{@warning_time})"
+				else
+					message "#{@worst}s time"
+				end
+
+			end
+
+		end
+
+	end
+
+	def check_address address
+
+		cookies = {}
+
+		begin
+
+			# open http connection
+
+			http = CustomHTTP.new @base_url.host, @base_url.port
+			http.conn_address = address
+			http.open_timeout = @timeout_time
+			http.read_timeout = @timeout_time
+			http.use_ssl = @base_url.scheme == "https"
+			http.start
+
+			success = true
+
+			@config_elem.find("step").each do
+				|step_elem|
+
+				success =
+					check_step http, cookies, step_elem
+
+				break unless success
+
+			end
+
+			@successes += 1 if success
+
+		rescue Errno::ECONNREFUSED
+
+			@failures += 1
+
+		rescue Timeout::Error
+
+			@failures += 1
+
+		end
+
+	end
+
+	def check_step http, cookies, step_elem
+
+		@postscript << "performing step #{step_elem["name"]}"
+
+		request_elem = step_elem.find_first "request"
+		response_elem = step_elem.find_first "response"
+
+		# create request
+
+		path = @base_url.path + (request_elem["path"] || "")
+
+		req =
+			case request_elem["method"] || "get"
+			when "get"
+				Net::HTTP::Get.new path
+			when "post"
+				Net::HTTP::Post.new path
+			else
+				raise "error"
+			end
+
+		# set headers
+
+		req["host"] = @base_url.host
+		req["user-agent"] = "hq check-site"
+
+		unless cookies.empty?
+			req["cookie"] =
+				cookies.map {
+					|name, value|
+					"#{name}=#{value}"
+				}.join ", "
+		end
+
+		# set http auth
+
+		if request_elem["username"]
+			req.basic_auth \
+				request_elem["username"],
+				request_elem["password"]
+		end
+
+		# set form data
+
+		form_data = {}
+
+		request_elem.find("param").each do |param_elem|
+			form_data[param_elem["name"]] = param_elem["value"]
+		end
+
+		req.set_form_data form_data
+
+		# make request
+
+		start_time = Time.now
+
+		res = http.request req
+
+		end_time = Time.now
+		duration = end_time - start_time
+
+		# save cookies
+
+		if res["set-cookie"]
+			WEBrick::Cookie.parse_set_cookies(res["set-cookie"]).each do
+				|cookie|
+				cookies[cookie.name] = cookie.value
+			end
+		end
+
+		# process results
+
+		@worst = duration if @worst == nil
+		@worst = duration if duration > @worst
+
+		debug "REQUEST #{req.path}"
+		req.each { |k,v| debug "  #{k}: #{v}" }
+		debug "RESPONSE #{res.code} #{res.message}"
+		res.each { |k,v| debug "  #{k}: #{v}" }
+
+		if res.code != "200"
+
+			debug "EXPECTED response code 200"
+			@error_codes << res.code
+			return false
+
+		elsif response_elem["body-regex"] &&
+			res.body !~ /#{response_elem["body-regex"]}/
+
+			debug "EXPECTED body to match #{response_elem["body-regex"]}"
+
+			if @opts[:debug]
+				debug "BODY"
+				debug res.body.gsub(/^/, "  ")
+			end
+
+			@mismatches += 1
+			return false
+
+		end
+
+		return true
+
+	end
+
+	def debug message
+		@postscript << message
+	end
+
+end
+end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: hq-check-site
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- James Pharaoh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 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.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HQ nagios plugin to check a web site
+email:
+- james@phsys.co.uk
+executables:
+- hq-check-site
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hq/check-site/script.rb
+- features/check-site.feature
+- features/support/steps.rb
+- features/support/env.rb
+- bin/hq-check-site
+homepage: https://github.com/jamespharaoh/hq-check-site
+licenses: []
+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-check-site
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: HQ check site script
+test_files:
+- features/check-site.feature
+- features/support/steps.rb
+- features/support/env.rb