summaryrefslogtreecommitdiff
path: root/lib/custodian/protocoltest/http.rb
blob: 44f76a6dee0ec0a71faf1851cfd0779c837a4e2b (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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
require 'openssl'
require 'socket'
require 'timeout'
require 'uri'



#
#  The HTTP-protocol test.
#
#  This object is instantiated if the parser sees a line such as:
#
###
### http://foo.vm.bytemark.co.uk/ must run http with content 'foo' otherwise 'ftp fail'.
###
#
#
module Custodian

  module ProtocolTest


    class HTTPTest < TestFactory

      #
      # The line from which we were constructed.
      #
      attr_reader :line

      #
      # The URL to poll
      #
      attr_reader :url

      #
      # The expected status + content
      #
      attr_reader :expected_status, :expected_content


      #
      # The actual status & content
      #
      attr_reader :status, :content



      #
      # Constructor
      #
      def initialize( line )

        #
        #  Save the line
        #
        @line = line

        #
        #  Save the URL
        #
        @url  = line.split( /\s+/)[0]

        if ( @url !~ /^https?:/ )
          raise ArgumentError, "The target wasn't an URL"
        end

        #
        # Is this test inverted?
        #
        if ( line =~ /must\s+not\s+run\s+/ )
          @inverted = true
        else
          @inverted = false
        end

        #
        # Expected status
        #
        if ( line =~ /with status ([0-9]+)/ )
          @expected_status = $1.dup
        else
          @expected_status = "200"
        end

        #
        # The content we expect to find
        #
        if ( line =~ /with content '([^']+)'/ )
          @expected_content = $1.dup
        else
          @expected_content = nil
        end

        @status  = nil
        @content = nil

      end




      #
      # Allow this test to be serialized.
      #
      def to_s
        @line
      end



      #
      # Run the test.
      #
      def run_test

        #  Reset state, in case we've previously run.
        @error = nil

        #  Parse the URL
        uri = URI.parse(@url)

        #
        # Ensure we have a path to request - to cover people who write:
        #
        #   http://example.com must run http ..
        #
        if ( uri.path.empty? )
          uri.path = "/"
        end

        #
        #  Connect a socket to the host.
        #
        socket = connect( uri.host, uri.port, uri.scheme == "https" )

        path = uri.path
        if ( uri.query )
          path = "#{url.path}?#{url.query}"
        end

        req =<<EOF
GET #{path} HTTP/1.1
Host: #{uri.host}
Connection: close

EOF

        do_check( socket, req )

        if ( @expected_status.to_i != @status.to_i )
          @error = "Status code was #{@status} not the expected #{@expected_status}"
          return false
        end

        if ( !@expected_content.nil? )
          if (! @content.match(/#{@expected_content}/i) )
            @error = "<p>The response did not contain our expected text '#{@expected_content}'</p>"
          end
        end

        #
        #  Done?
        #
        true
      end



      #
      # Create a socket to the appropriate host - configuring
      # SSL if appropriate.
      #
      def connect( host, port, ssl )
        sock = TCPSocket.new(host, port)
        if ( ssl)
          ssl_sock = OpenSSL::SSL::SSLSocket.new(
                                                 sock,
                                                 OpenSSL::SSL::SSLContext.new("SSLv3_client")
                                                 )
          ssl_sock.sync_close = true
          ssl_sock.connect
          return ssl_sock
        else
          return sock
        end
      end



      #
      # Send the request and get back the response.
      #
      def do_check( socket, script )
        header = true

        begin
          Timeout.timeout(30, Errno::ETIMEDOUT) do
            script.each do |line|
              if line.is_a?(String)
                socket.print line
              end
            end

            loop do
              trans = socket.gets

              if ( header && trans =~ /HTTP\/[0-9]\.[0-9] ([0-9]+) OK/ )
                @status = $1.dup
              end
              if ( header && trans =~ /^$/ )
                header = false
                next
              end

              if ( !header )
                @content = "#{@content}#{trans}"
              end
              break if trans.nil?
            end
            socket.close
          end
        rescue => err
          @error = err
        ensure
          socket.close if socket.is_a?(Socket) and not socket.closed?
        end

      end



      #
      # If the test fails then report the error.
      #
      def error
        @error
      end




      register_test_type "http"
      register_test_type "https"




    end
  end
end