summaryrefslogtreecommitdiff
path: root/lib/custodian/protocoltest/tftp.rb
blob: 9b263fe69bc437efbe91dc0fdb479d7330c0b6ad (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
require 'custodian/settings'
require 'custodian/testfactory'
require 'custodian/util/tftp'

require 'uri'


#
# The TFTP-protocol test
#
# This object is instantiated if the parser sees a line such as:
#
###
### tftp://foo.vm.bytemark.co.uk/pxelinux.0 must run tftp otherwise 'tftp fail'
###
#
#
module Custodian

  module ProtocolTest

    class TFTPTest < TestFactory

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

      #
      # The TFTP server
      #
      attr_reader :host

      #
      # The TFTP port
      #
      attr_reader :port

      #
      # The file on the TFTP server to test
      #
      attr_reader :file

      #
      # Constructor
      #
      def initialize(line)

        #
        #  Save the line
        #
        @line = line

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

        #
        #  Ensure we've got a TFTP url.
        #
        if url !~ /^tftp:/
          raise ArgumentError, "The target wasn't a TFTP URL: #{line}"
        end

        #
        #  Parse the URL which should have a host + path, and optional port
        #
        u = URI.parse(url)

        #
        #  Record the values.
        #
        @host = u.host
        @file = u.path

        # Port might not be specified, if it is missing then default to 69.
        @port = u.port || '69'
        @port = @port.to_i

        #
        # Ensure there is a file to fetch
        #
        if @file.nil? || @file.empty?
          raise ArgumentError, 'Missing file name'
        end

      end

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

      #
      # Run the test.
      #
      def run_test
        tftp = Custodian::Util::Tftp.new(@host, @port)
        if tftp.test(@file)
          Custodian::TestResult::TEST_PASSED
        else
          @error = "TFTP failed for #{@file} on #{@host}"
          Custodian::TestResult::TEST_FAILED
        end
      end

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

      register_test_type 'tftp'

    end

  end

end