Class: Honey::Okapi::Test

Inherits:
Object
  • Object
show all
Defined in:
lib/okapi/test.rb

Instance Method Summary collapse

Constructor Details

#initialize(blueprint_path, test_spec_path, test_url, output, apiary_url) ⇒ Test

Returns a new instance of Test.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/okapi/test.rb', line 7

def initialize(blueprint_path, test_spec_path, test_url, output, apiary_url)
  @blueprint_path = blueprint_path
  @test_spec_path = test_spec_path
  @test_url       = test_url
  @output_format  = output
  @apiary_url     = apiary_url
  @req_path       = GET_REQUESTS_PATH
  @res_path       = GET_RESULTS_PATH
  @connector = Honey::Okapi::ApiaryConnector.new(@apiary_url, @req_path, @res_path)
  @proces_all_bp_resources = false
  @output = []
  @resources = []
  @error = nil        
end

Instance Method Details

#blueprint ⇒ Object 



69
70
71
 
# File 'lib/okapi/test.rb', line 69

def blueprint
  @blueprint ||= parse_blueprint(@blueprint_path)
end

#evaluate ⇒ Object 



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
 
# File 'lib/okapi/test.rb', line 92

def evaluate

  data = @connector.get_results(@resources, blueprint)
  if data[:error] or data[:code] != 200
    raise Exception, 'Can not get evaluation data from apiary: ' + data[:error] ? data[:error] : ''
  end
  
  data[:data].each { |validation|
    @resources.each { |resource|
      if validation['resource']['uri'] == resource.uri and validation['resource']['method'] == resource.method
        resource.validation_result = Honey::Okapi::ValidationResult.new()
        resource.validation_result.error = validation['errors']
        resource.validation_result.schema_res = validation["validations"]['reqSchemaValidations']
        resource.validation_result.body_pass = !validation["validations"]['reqData']['body']['isDifferent']
        resource.validation_result.body_diff = validation["validations"]['reqData']['body']['diff']
        resource.validation_result.header_pass = !validation["validations"]['reqData']['headers']['isDifferent']
        resource.validation_result.header_diff = validation["validations"]['reqData']['headers']['diff']

        resource.response.validation_result = Honey::Okapi::ValidationResult.new()
        resource.response.validation_result.error = validation['errors']
        resource.response.validation_result.schema_res = validation["validations"]['resSchemaValidations']
        resource.response.validation_result.body_pass = !validation["validations"]['resData']['body']['isDifferent']
        resource.response.validation_result.body_diff = validation["validations"]['resData']['body']['diff']
        resource.response.validation_result.header_pass = !validation["validations"]['resData']['headers']['isDifferent']
        resource.response.validation_result.header_diff = validation["validations"]['resData']['headers']['diff']
      end

    }
  }
end

#get_requests_spec(resources, global_vars) ⇒ Object 



134
135
136
 
# File 'lib/okapi/test.rb', line 134

def get_requests_spec(resources, global_vars)
  @connector.get_requests(resources, blueprint, @proces_all_bp_resources, global_vars)
end

#get_responses ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/okapi/test.rb', line 73

def get_responses
  @resources.each { |resource|
    params = {:method => resource.method, :url => @test_url + resource.expanded_uri['url'], :headers => resource.headers || {}, :payload=> resource.body}
    begin            
      response = RestClient::Request.execute(params)

      raw_headers = response.raw_headers.inject({}) do |out, (key, value)|
                      out[key] = %w{ set-cookie }.include?(key.downcase) ? value : value.first
                      out
                    end

      resource.response =  Honey::Okapi::Response.new(response.code, raw_headers, response.body)
    rescue Exception => e
      raise Exception, 'Can not get response for: ' + params.to_json + ' (' + e.to_s + ')'
    end
    }

end

#get_test_spec_parser(test_spec) ⇒ Object 



123
124
125
 
# File 'lib/okapi/test.rb', line 123

def get_test_spec_parser(test_spec)
  Honey::Okapi::Parser.new(test_spec)                
end

#parse_blueprint(blueprint_path) ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/okapi/test.rb', line 127

def parse_blueprint(blueprint_path)
  if not File.exist? blueprint_path
    raise Exception, "Blueprint file '#{blueprint_path}' not found"
  end
  File.read(blueprint_path)
end

#prepare ⇒ Object 



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
 
# File 'lib/okapi/test.rb', line 42

def prepare
  @resources = []
  parser = get_test_spec_parser(@test_spec_path)
  resources = parser.resources
  counter = 0

  resources.each { |res|
    counter += 1
    raise Exception, "Rresource not defined for item #{counter.to_d} in #{@test_spec_path}" unless res["resource"]
    raise Exception, "Method not defined for resource #{res["resource"].to_s} in #{@test_spec_path}" unless res["method"]
  }

  @proces_all_bp_resources = parser.proces_all_bp_resources
  data = get_requests_spec(resources, parser.global_vars)
  
  if data[:error] or data[:code] != 200
    raise Exception, 'Can not get request data from Apiary: ' + data[:error] ? data[:error] : ''
  end
   
  data[:data].each do |res|
    raise Exception, 'Resource error "' + res['error'] + '" for resource "' + res["method"] + ' ' + res["uri"]  + '"' if res['error']
    @resources << Honey::Okapi::Resource.new(res["uri"], res["method"], res["params"], res["expandedUri"], res["headers"], res["body"])          
  end

  @resources      
end

#run ⇒ Object 



22
23
24
25
26
27
28
29
30
 
# File 'lib/okapi/test.rb', line 22

def run
  begin
    test()
  rescue Exception => e
    @resources = []
    @error = e
  end        
  Honey::Okapi::Output.get(@output_format, @resources, @error)
end

#test ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/okapi/test.rb', line 32

def test
  prepare()
  if not @resources.empty?
    get_responses
    evaluate
  else
    raise Exception, 'No resources provided'
  end
end