summaryrefslogtreecommitdiff
path: root/lib/custodian/protocol-tests/https.rb
blob: 8db4da59f18bd493a13bee0030abafa9238f50bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
#!/usr/bin/ruby1.8

require 'net/http'
require 'net/https'
require 'uri'



class HTTPSTest

  #
  # Data passed from the JSON hash.
  #
  attr_reader :test_data

  #
  # The HTTP status, the HTTP response body, and the error text
  # we return on failure.
  #
  attr_reader :status, :body, :error



  #
  # Save the data away.
  #
  def initialize( data )
    @test_data = data
    @error     = nil

    #
    # Ensure we have an URL
    #
    if ( @test_data["target_host"].nil? )
      @error = "Missing URL for the test."
      raise ArgumentError, @error
    end

    #
    # Ensure we have a port
    #
    if ( @test_data["test_port"].nil? )
      @error = "Missing port for the test."
      raise ArgumentError, @error

    end

  end


  #
  # Run the test.
  #
  #  Return "true" on success
  #
  #  Return "false" on failure.
  #
  # If the test fails the details should be retrieved from "error()".
  #
  def run_test

    #
    # Reset state from previous test.
    #
    @error = nil

    #
    #  Do the fetch, if this success then we'll have the
    # @status + @text setup
    #
    if ( getURL (@test_data["target_host"] ) )

      #
      #  Do we need to test for a HTTP status code?
      #
      if ( @test_data["http_status"] )
        puts "Testing for HTTP status code: #{@test_data['http_status']}" if ( @test_data['verbose'] )

        if ( @status != @test_data['http_status'].to_i)
          @error = "#{@error} status code was #{@status} not #{@test_data['http_status']}"
        end
      end



      #
      #  Do we need to search for text in the body of the reply?
      #
      if ( @test_data['http_text'] )
        puts "Testing for text in the response: '#{@test_data['http_text']}'" if ( @test_data['verbose'] )

        if (! @body.match(/#{@test_data['http_text']}/i) )
          @error = "#{@error} The response did not contain our expected text '#{test_data['http_text']}'"
        end
      end

      return true if ( @error.nil? )

      return false
    end

    return false
  end


  #
  #  Return the error text for why this test failed.
  #
  def error
    return @error
  end


  #
  # Retrieve a HTTP page from the web.
  #
  # NOTE:  This came from sentinel.
  def getURL (uri_str)
    begin
      uri_str = 'http://' + uri_str unless uri_str.match(/^http/)
      url = URI.parse(uri_str)
      http = Net::HTTP.new(url.host, url.port)
      http.open_timeout = 3
      http.read_timeout = 3

      if (url.scheme == "https")
        http.use_ssl = true
        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
      end

      response = nil

      #
      # Ensure we have a trailing "/"
      #
      if ( url.path.empty? )
        url.path = "/"
      end

      if nil == url.query
        response = http.start { http.get(url.path) }
      else
        response = http.start { http.get("#{url.path}?#{url.query}") }
      end

      case response
      when Net::HTTPRedirection
      then
        newURL = response['location'].match(/^http/)?
        response['Location']:uri_str+response['Location']
        return( getURL(newURL) )
      else
        @status = response.code.to_i
        @body   =  response.body
      end

      return true
    rescue Errno::EHOSTUNREACH => ex
      @error = "no route to host"
      return false
    rescue Timeout::Error => ex
      @error = "time out reached"
      return false
    rescue Errno::ECONNREFUSED => ex
      @error = "Connection refused"
      return false
    rescue => ex
      @error = ex
      return false
    end
    @error = "Misc failure"
    return false
  end



end



#
# Sample test, for testing.
#
if __FILE__ == $0 then

  #
  #  Sample data.
  #
  test = {
    "target_host" => "http://www.steve.org.uk/",
    "test_type"   => "http",
    "verbose"     => 1,
    "test_port"   => 80,
    "test_alert"  => "Steve's website is unavailable",
    "http_text"   => "Steve Kemp",
    "http_status" => "200"
  }


  #
  #  Run the test.
  #
  http = HTTPSTest.new( test )
  if ( http.run_test )
    puts "TEST OK"
  else
    puts "TEST FAILED"
    puts http.error()
  end

end