]> git.openstreetmap.org Git - rails.git/blob - test/test_helper.rb
Refactor changesets_controller_test
[rails.git] / test / test_helper.rb
1 require "coveralls"
2 Coveralls.wear!("rails")
3
4 # Override the simplecov output message, since it is mostly unwanted noise
5 module SimpleCov
6   module Formatter
7     class HTMLFormatter
8       def output_message(_result); end
9     end
10   end
11 end
12
13 # Output both the local simplecov html and the coveralls report
14 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
15   [SimpleCov::Formatter::HTMLFormatter,
16    Coveralls::SimpleCov::Formatter]
17 )
18
19 ENV["RAILS_ENV"] = "test"
20 require_relative "../config/environment"
21 require "rails/test_help"
22 require "webmock/minitest"
23
24 WebMock.disable_net_connect!(:allow_localhost => true)
25
26 module ActiveSupport
27   class TestCase
28     include FactoryBot::Syntax::Methods
29     include ActiveJob::TestHelper
30
31     # Run tests in parallel with specified workers
32     parallelize(:workers => :number_of_processors)
33
34     ##
35     # takes a block which is executed in the context of a different
36     # ActionController instance. this is used so that code can call methods
37     # on the node controller whilst testing the old_node controller.
38     def with_controller(new_controller)
39       controller_save = @controller
40       begin
41         @controller = new_controller
42         yield
43       ensure
44         @controller = controller_save
45       end
46     end
47
48     ##
49     # execute a block with missing translation exceptions suppressed
50     def without_i18n_exceptions
51       exception_handler = I18n.exception_handler
52       begin
53         I18n.exception_handler = nil
54         yield
55       ensure
56         I18n.exception_handler = exception_handler
57       end
58     end
59
60     ##
61     # work round minitest insanity that causes it to tell you
62     # to use assert_nil to test for nil, which is fine if you're
63     # comparing to a nil constant but not if you're comparing
64     # an expression that might be nil sometimes
65     def assert_equal_allowing_nil(exp, act, msg = nil)
66       if exp.nil?
67         assert_nil act, msg
68       else
69         assert_equal exp, act, msg
70       end
71     end
72
73     ##
74     # for some reason assert_equal a, b fails when the relations are
75     # actually equal, so this method manually checks the fields...
76     def assert_relations_are_equal(a, b)
77       assert_not_nil a, "first relation is not allowed to be nil"
78       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
79       assert_equal a.id, b.id, "relation IDs"
80       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
81       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
82       assert_equal a.version, b.version, "version on relation #{a.id}"
83       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
84       assert_equal a.members, b.members, "member references on relation #{a.id}"
85     end
86
87     ##
88     # for some reason assert_equal a, b fails when the ways are actually
89     # equal, so this method manually checks the fields...
90     def assert_ways_are_equal(a, b)
91       assert_not_nil a, "first way is not allowed to be nil"
92       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
93       assert_equal a.id, b.id, "way IDs"
94       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
95       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
96       assert_equal a.version, b.version, "version on way #{a.id}"
97       assert_equal a.tags, b.tags, "tags on way #{a.id}"
98       assert_equal a.nds, b.nds, "node references on way #{a.id}"
99     end
100
101     ##
102     # for some reason a==b is false, but there doesn't seem to be any
103     # difference between the nodes, so i'm checking all the attributes
104     # manually and blaming it on ActiveRecord
105     def assert_nodes_are_equal(a, b)
106       assert_equal a.id, b.id, "node IDs"
107       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
108       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
109       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
110       assert_equal a.visible, b.visible, "visible on node #{a.id}"
111       assert_equal a.version, b.version, "version on node #{a.id}"
112       assert_equal a.tags, b.tags, "tags on node #{a.id}"
113     end
114
115     ##
116     # set request headers for HTTP basic authentication
117     def basic_authorization(user, pass)
118       @request.env["HTTP_AUTHORIZATION"] = format("Basic %{auth}", :auth => Base64.encode64("#{user}:#{pass}"))
119     end
120
121     ##
122     # return request header for HTTP Basic Authorization
123     def basic_authorization_header(user, pass)
124       { "Authorization" => format("Basic %{auth}", :auth => Base64.encode64("#{user}:#{pass}")) }
125     end
126
127     ##
128     # set request header for HTTP Accept
129     def http_accept_format(format)
130       @request.env["HTTP_ACCEPT"] = format
131     end
132
133     ##
134     # set request readers to ask for a particular error format
135     def error_format(format)
136       @request.env["HTTP_X_ERROR_FORMAT"] = format
137     end
138
139     def error_format_header(f)
140       { "X-Error-Format" => f }
141     end
142
143     ##
144     # Used to check that the error header and the forbidden responses are given
145     # when the owner of the changset has their data not marked as public
146     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
147       assert_response :forbidden, msg
148       assert_equal @response.headers["Error"], "You must make your edits public to upload new data", "Wrong error message"
149     end
150
151     ##
152     # Not sure this is the best response we could give
153     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
154       assert_response :unauthorized, msg
155       # assert_equal @response.headers['Error'], ""
156     end
157
158     ##
159     # Check for missing translations in an HTML response
160     def assert_no_missing_translations(msg = "")
161       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
162     end
163
164     ##
165     # execute a block with a given set of HTTP responses stubbed
166     def with_http_stubs(stubs_file)
167       stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
168       stubs.each do |url, response|
169         stub_request(:get, Regexp.new(Regexp.quote(url))).to_return(:status => response["code"], :body => response["body"])
170       end
171
172       yield
173     end
174
175     def stub_gravatar_request(email, status = 200, body = nil)
176       hash = ::Digest::MD5.hexdigest(email.downcase)
177       url = "https://www.gravatar.com/avatar/#{hash}?d=404"
178       stub_request(:get, url).and_return(:status => status, :body => body)
179     end
180
181     def email_text_parts(message)
182       message.parts.each_with_object([]) do |part, text_parts|
183         if part.content_type.start_with?("text/")
184           text_parts.push(part)
185         elsif part.multipart?
186           text_parts.concat(email_text_parts(part))
187         end
188       end
189     end
190
191     def sign_in_as(user)
192       visit login_path
193       fill_in "username", :with => user.email
194       fill_in "password", :with => "test"
195       click_on "Login", :match => :first
196     end
197
198     def session_for(user)
199       post login_path, :params => { :username => user.display_name, :password => "test" }
200       follow_redirect!
201     end
202
203     def xml_for_node(node)
204       doc = OSM::API.new.get_xml_doc
205       doc.root << xml_node_for_node(node)
206       doc
207     end
208
209     def xml_node_for_node(node)
210       el = XML::Node.new "node"
211       el["id"] = node.id.to_s
212
213       OMHelper.add_metadata_to_xml_node(el, node, {}, {})
214
215       if node.visible?
216         el["lat"] = node.lat.to_s
217         el["lon"] = node.lon.to_s
218       end
219
220       OMHelper.add_tags_to_xml_node(el, node.node_tags)
221
222       el
223     end
224
225     def xml_for_way(way)
226       doc = OSM::API.new.get_xml_doc
227       doc.root << xml_node_for_way(way)
228       doc
229     end
230
231     def xml_node_for_way(way)
232       el = XML::Node.new "way"
233       el["id"] = way.id.to_s
234
235       OMHelper.add_metadata_to_xml_node(el, way, {}, {})
236
237       # make sure nodes are output in sequence_id order
238       ordered_nodes = []
239       way.way_nodes.each do |nd|
240         ordered_nodes[nd.sequence_id] = nd.node_id.to_s if nd.node&.visible?
241       end
242
243       ordered_nodes.each do |nd_id|
244         next unless nd_id && nd_id != "0"
245
246         node_el = XML::Node.new "nd"
247         node_el["ref"] = nd_id
248         el << node_el
249       end
250
251       OMHelper.add_tags_to_xml_node(el, way.way_tags)
252
253       el
254     end
255
256     def xml_for_relation(relation)
257       doc = OSM::API.new.get_xml_doc
258       doc.root << xml_node_for_relation(relation)
259       doc
260     end
261
262     def xml_node_for_relation(relation)
263       el = XML::Node.new "relation"
264       el["id"] = relation.id.to_s
265
266       OMHelper.add_metadata_to_xml_node(el, relation, {}, {})
267
268       relation.relation_members.each do |member|
269         member_el = XML::Node.new "member"
270         member_el["type"] = member.member_type.downcase
271         member_el["ref"] = member.member_id.to_s
272         member_el["role"] = member.member_role
273         el << member_el
274       end
275
276       OMHelper.add_tags_to_xml_node(el, relation.relation_tags)
277
278       el
279     end
280
281     class OMHelper
282       extend ObjectMetadata
283     end
284   end
285 end