Merge remote-tracking branch 'openstreetmap/pull/1401'
[rails.git] / test / test_helper.rb
1 require "coveralls"
2 Coveralls.wear!("rails")
3
4 ENV["RAILS_ENV"] = "test"
5 require File.expand_path("../../config/environment", __FILE__)
6 require "rails/test_help"
7 require "webmock/minitest"
8 load "composite_primary_keys/fixtures.rb"
9
10 module ActiveSupport
11   class TestCase
12     include FactoryGirl::Syntax::Methods
13
14     # Load standard fixtures needed to test API methods
15     def self.api_fixtures
16       # print "setting up the api_fixtures"
17       fixtures :users, :user_roles
18       fixtures :changesets
19
20       fixtures :current_nodes, :nodes
21       set_fixture_class :current_nodes => Node
22       set_fixture_class :nodes => OldNode
23
24       fixtures :current_ways
25       set_fixture_class :current_ways => Way
26
27       fixtures :current_way_nodes
28       set_fixture_class :current_way_nodes => WayNode
29
30       fixtures :ways
31       set_fixture_class :ways => OldWay
32
33       fixtures :way_nodes
34       set_fixture_class :way_nodes => OldWayNode
35
36       fixtures :current_relations
37       set_fixture_class :current_relations => Relation
38
39       fixtures :current_relation_members
40       set_fixture_class :current_relation_members => RelationMember
41
42       fixtures :relations
43       set_fixture_class :relations => OldRelation
44
45       fixtures :relation_members
46       set_fixture_class :relation_members => OldRelationMember
47
48       fixtures :gpx_files, :gps_points, :gpx_file_tags
49       set_fixture_class :gpx_files => Trace
50       set_fixture_class :gps_points => Tracepoint
51       set_fixture_class :gpx_file_tags => Tracetag
52
53       fixtures :redactions
54     end
55
56     ##
57     # takes a block which is executed in the context of a different
58     # ActionController instance. this is used so that code can call methods
59     # on the node controller whilst testing the old_node controller.
60     def with_controller(new_controller)
61       controller_save = @controller
62       begin
63         @controller = new_controller
64         yield
65       ensure
66         @controller = controller_save
67       end
68     end
69
70     ##
71     # work round minitest insanity that causes it to tell you
72     # to use assert_nil to test for nil, which is fine if you're
73     # comparing to a nil constant but not if you're comparing
74     # an expression that might be nil sometimes
75     def assert_equal_allowing_nil(exp, act, msg = nil)
76       if exp.nil?
77         assert_nil act, msg
78       else
79         assert_equal exp, act, msg
80       end
81     end
82
83     ##
84     # for some reason assert_equal a, b fails when the relations are
85     # actually equal, so this method manually checks the fields...
86     def assert_relations_are_equal(a, b)
87       assert_not_nil a, "first relation is not allowed to be nil"
88       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
89       assert_equal a.id, b.id, "relation IDs"
90       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
91       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
92       assert_equal a.version, b.version, "version on relation #{a.id}"
93       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
94       assert_equal a.members, b.members, "member references on relation #{a.id}"
95     end
96
97     ##
98     # for some reason assert_equal a, b fails when the ways are actually
99     # equal, so this method manually checks the fields...
100     def assert_ways_are_equal(a, b)
101       assert_not_nil a, "first way is not allowed to be nil"
102       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
103       assert_equal a.id, b.id, "way IDs"
104       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
105       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
106       assert_equal a.version, b.version, "version on way #{a.id}"
107       assert_equal a.tags, b.tags, "tags on way #{a.id}"
108       assert_equal a.nds, b.nds, "node references on way #{a.id}"
109     end
110
111     ##
112     # for some reason a==b is false, but there doesn't seem to be any
113     # difference between the nodes, so i'm checking all the attributes
114     # manually and blaming it on ActiveRecord
115     def assert_nodes_are_equal(a, b)
116       assert_equal a.id, b.id, "node IDs"
117       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
118       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
119       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
120       assert_equal a.visible, b.visible, "visible on node #{a.id}"
121       assert_equal a.version, b.version, "version on node #{a.id}"
122       assert_equal a.tags, b.tags, "tags on node #{a.id}"
123     end
124
125     ##
126     # set request headers for HTTP basic authentication
127     def basic_authorization(user, pass)
128       @request.env["HTTP_AUTHORIZATION"] = format("Basic %s", Base64.encode64("#{user}:#{pass}"))
129     end
130
131     ##
132     # set request readers to ask for a particular error format
133     def error_format(format)
134       @request.env["HTTP_X_ERROR_FORMAT"] = format
135     end
136
137     ##
138     # set the raw body to be sent with a POST request
139     def content(c)
140       @request.env["RAW_POST_DATA"] = c.to_s
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 stub_hostip_requests
182       # Controller tests and integration tests use different IPs
183       stub_request(:get, "http://api.hostip.info/country.php?ip=0.0.0.0")
184       stub_request(:get, "http://api.hostip.info/country.php?ip=127.0.0.1")
185     end
186
187     def email_text_parts(message)
188       message.parts.each_with_object([]) do |part, text_parts|
189         if part.content_type.start_with?("text/")
190           text_parts.push(part)
191         elsif part.multipart?
192           text_parts.concat(email_text_parts(part))
193         end
194       end
195     end
196   end
197 end