Update bundle
[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     ##
32     # takes a block which is executed in the context of a different
33     # ActionController instance. this is used so that code can call methods
34     # on the node controller whilst testing the old_node controller.
35     def with_controller(new_controller)
36       controller_save = @controller
37       begin
38         @controller = new_controller
39         yield
40       ensure
41         @controller = controller_save
42       end
43     end
44
45     ##
46     # work round minitest insanity that causes it to tell you
47     # to use assert_nil to test for nil, which is fine if you're
48     # comparing to a nil constant but not if you're comparing
49     # an expression that might be nil sometimes
50     def assert_equal_allowing_nil(exp, act, msg = nil)
51       if exp.nil?
52         assert_nil act, msg
53       else
54         assert_equal exp, act, msg
55       end
56     end
57
58     ##
59     # for some reason assert_equal a, b fails when the relations are
60     # actually equal, so this method manually checks the fields...
61     def assert_relations_are_equal(a, b)
62       assert_not_nil a, "first relation is not allowed to be nil"
63       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
64       assert_equal a.id, b.id, "relation IDs"
65       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
66       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
67       assert_equal a.version, b.version, "version on relation #{a.id}"
68       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
69       assert_equal a.members, b.members, "member references on relation #{a.id}"
70     end
71
72     ##
73     # for some reason assert_equal a, b fails when the ways are actually
74     # equal, so this method manually checks the fields...
75     def assert_ways_are_equal(a, b)
76       assert_not_nil a, "first way is not allowed to be nil"
77       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
78       assert_equal a.id, b.id, "way IDs"
79       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
80       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
81       assert_equal a.version, b.version, "version on way #{a.id}"
82       assert_equal a.tags, b.tags, "tags on way #{a.id}"
83       assert_equal a.nds, b.nds, "node references on way #{a.id}"
84     end
85
86     ##
87     # for some reason a==b is false, but there doesn't seem to be any
88     # difference between the nodes, so i'm checking all the attributes
89     # manually and blaming it on ActiveRecord
90     def assert_nodes_are_equal(a, b)
91       assert_equal a.id, b.id, "node IDs"
92       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
93       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
94       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
95       assert_equal a.visible, b.visible, "visible on node #{a.id}"
96       assert_equal a.version, b.version, "version on node #{a.id}"
97       assert_equal a.tags, b.tags, "tags on node #{a.id}"
98     end
99
100     ##
101     # set request headers for HTTP basic authentication
102     def basic_authorization(user, pass)
103       @request.env["HTTP_AUTHORIZATION"] = format("Basic %{auth}", :auth => Base64.encode64("#{user}:#{pass}"))
104     end
105
106     ##
107     # set request readers to ask for a particular error format
108     def error_format(format)
109       @request.env["HTTP_X_ERROR_FORMAT"] = format
110     end
111
112     ##
113     # Used to check that the error header and the forbidden responses are given
114     # when the owner of the changset has their data not marked as public
115     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
116       assert_response :forbidden, msg
117       assert_equal @response.headers["Error"], "You must make your edits public to upload new data", "Wrong error message"
118     end
119
120     ##
121     # Not sure this is the best response we could give
122     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
123       assert_response :unauthorized, msg
124       # assert_equal @response.headers['Error'], ""
125     end
126
127     ##
128     # Check for missing translations in an HTML response
129     def assert_no_missing_translations(msg = "")
130       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
131     end
132
133     ##
134     # execute a block with a given set of HTTP responses stubbed
135     def with_http_stubs(stubs_file)
136       stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
137       stubs.each do |url, response|
138         stub_request(:get, Regexp.new(Regexp.quote(url))).to_return(:status => response["code"], :body => response["body"])
139       end
140
141       yield
142     end
143
144     def stub_gravatar_request(email, status = 200, body = nil)
145       hash = ::Digest::MD5.hexdigest(email.downcase)
146       url = "https://www.gravatar.com/avatar/#{hash}?d=404"
147       stub_request(:get, url).and_return(:status => status, :body => body)
148     end
149
150     def stub_hostip_requests
151       # Controller tests and integration tests use different IPs
152       stub_request(:get, "https://api.hostip.info/country.php?ip=0.0.0.0")
153       stub_request(:get, "https://api.hostip.info/country.php?ip=127.0.0.1")
154     end
155
156     def email_text_parts(message)
157       message.parts.each_with_object([]) do |part, text_parts|
158         if part.content_type.start_with?("text/")
159           text_parts.push(part)
160         elsif part.multipart?
161           text_parts.concat(email_text_parts(part))
162         end
163       end
164     end
165
166     def sign_in_as(user)
167       stub_hostip_requests
168       visit login_path
169       fill_in "username", :with => user.email
170       fill_in "password", :with => "test"
171       click_on "Login", :match => :first
172     end
173
174     def xml_for_node(node)
175       doc = OSM::API.new.get_xml_doc
176       doc.root << xml_node_for_node(node)
177       doc
178     end
179
180     def xml_node_for_node(node)
181       el = XML::Node.new "node"
182       el["id"] = node.id.to_s
183
184       OMHelper.add_metadata_to_xml_node(el, node, {}, {})
185
186       if node.visible?
187         el["lat"] = node.lat.to_s
188         el["lon"] = node.lon.to_s
189       end
190
191       OMHelper.add_tags_to_xml_node(el, node.node_tags)
192
193       el
194     end
195
196     def xml_for_way(way)
197       doc = OSM::API.new.get_xml_doc
198       doc.root << xml_node_for_way(way)
199       doc
200     end
201
202     def xml_node_for_way(way)
203       el = XML::Node.new "way"
204       el["id"] = way.id.to_s
205
206       OMHelper.add_metadata_to_xml_node(el, way, {}, {})
207
208       # make sure nodes are output in sequence_id order
209       ordered_nodes = []
210       way.way_nodes.each do |nd|
211         ordered_nodes[nd.sequence_id] = nd.node_id.to_s if nd.node&.visible?
212       end
213
214       ordered_nodes.each do |nd_id|
215         next unless nd_id && nd_id != "0"
216
217         node_el = XML::Node.new "nd"
218         node_el["ref"] = nd_id
219         el << node_el
220       end
221
222       OMHelper.add_tags_to_xml_node(el, way.way_tags)
223
224       el
225     end
226
227     def xml_for_relation(relation)
228       doc = OSM::API.new.get_xml_doc
229       doc.root << xml_node_for_relation(relation)
230       doc
231     end
232
233     def xml_node_for_relation(relation)
234       el = XML::Node.new "relation"
235       el["id"] = relation.id.to_s
236
237       OMHelper.add_metadata_to_xml_node(el, relation, {}, {})
238
239       relation.relation_members.each do |member|
240         member_el = XML::Node.new "member"
241         member_el["type"] = member.member_type.downcase
242         member_el["ref"] = member.member_id.to_s
243         member_el["role"] = member.member_role
244         el << member_el
245       end
246
247       OMHelper.add_tags_to_xml_node(el, relation.relation_tags)
248
249       el
250     end
251
252     class OMHelper
253       extend ObjectMetadata
254     end
255   end
256 end