Merge remote-tracking branch 'openstreetmap/pull/1347' into master
[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 :redactions
49     end
50
51     ##
52     # takes a block which is executed in the context of a different
53     # ActionController instance. this is used so that code can call methods
54     # on the node controller whilst testing the old_node controller.
55     def with_controller(new_controller)
56       controller_save = @controller
57       begin
58         @controller = new_controller
59         yield
60       ensure
61         @controller = controller_save
62       end
63     end
64
65     ##
66     # work round minitest insanity that causes it to tell you
67     # to use assert_nil to test for nil, which is fine if you're
68     # comparing to a nil constant but not if you're comparing
69     # an expression that might be nil sometimes
70     def assert_equal_allowing_nil(exp, act, msg = nil)
71       if exp.nil?
72         assert_nil act, msg
73       else
74         assert_equal exp, act, msg
75       end
76     end
77
78     ##
79     # for some reason assert_equal a, b fails when the relations are
80     # actually equal, so this method manually checks the fields...
81     def assert_relations_are_equal(a, b)
82       assert_not_nil a, "first relation is not allowed to be nil"
83       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
84       assert_equal a.id, b.id, "relation IDs"
85       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
86       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
87       assert_equal a.version, b.version, "version on relation #{a.id}"
88       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
89       assert_equal a.members, b.members, "member references on relation #{a.id}"
90     end
91
92     ##
93     # for some reason assert_equal a, b fails when the ways are actually
94     # equal, so this method manually checks the fields...
95     def assert_ways_are_equal(a, b)
96       assert_not_nil a, "first way is not allowed to be nil"
97       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
98       assert_equal a.id, b.id, "way IDs"
99       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
100       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
101       assert_equal a.version, b.version, "version on way #{a.id}"
102       assert_equal a.tags, b.tags, "tags on way #{a.id}"
103       assert_equal a.nds, b.nds, "node references on way #{a.id}"
104     end
105
106     ##
107     # for some reason a==b is false, but there doesn't seem to be any
108     # difference between the nodes, so i'm checking all the attributes
109     # manually and blaming it on ActiveRecord
110     def assert_nodes_are_equal(a, b)
111       assert_equal a.id, b.id, "node IDs"
112       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
113       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
114       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
115       assert_equal a.visible, b.visible, "visible on node #{a.id}"
116       assert_equal a.version, b.version, "version on node #{a.id}"
117       assert_equal a.tags, b.tags, "tags on node #{a.id}"
118     end
119
120     ##
121     # set request headers for HTTP basic authentication
122     def basic_authorization(user, pass)
123       @request.env["HTTP_AUTHORIZATION"] = format("Basic %s", Base64.encode64("#{user}:#{pass}"))
124     end
125
126     ##
127     # set request readers to ask for a particular error format
128     def error_format(format)
129       @request.env["HTTP_X_ERROR_FORMAT"] = format
130     end
131
132     ##
133     # set the raw body to be sent with a POST request
134     def content(c)
135       @request.env["RAW_POST_DATA"] = c.to_s
136     end
137
138     ##
139     # Used to check that the error header and the forbidden responses are given
140     # when the owner of the changset has their data not marked as public
141     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
142       assert_response :forbidden, msg
143       assert_equal @response.headers["Error"], "You must make your edits public to upload new data", "Wrong error message"
144     end
145
146     ##
147     # Not sure this is the best response we could give
148     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
149       assert_response :unauthorized, msg
150       # assert_equal @response.headers['Error'], ""
151     end
152
153     ##
154     # Check for missing translations in an HTML response
155     def assert_no_missing_translations(msg = "")
156       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
157     end
158
159     ##
160     # execute a block with a given set of HTTP responses stubbed
161     def with_http_stubs(stubs_file)
162       stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
163       stubs.each do |url, response|
164         stub_request(:get, Regexp.new(Regexp.quote(url))).to_return(:status => response["code"], :body => response["body"])
165       end
166
167       yield
168     end
169
170     def stub_gravatar_request(email, status = 200, body = nil)
171       hash = Digest::MD5.hexdigest(email.downcase)
172       url = "https://www.gravatar.com/avatar/#{hash}?d=404"
173       stub_request(:get, url).and_return(:status => status, :body => body)
174     end
175
176     def stub_hostip_requests
177       # Controller tests and integration tests use different IPs
178       stub_request(:get, "http://api.hostip.info/country.php?ip=0.0.0.0")
179       stub_request(:get, "http://api.hostip.info/country.php?ip=127.0.0.1")
180     end
181
182     def email_text_parts(message)
183       message.parts.each_with_object([]) do |part, text_parts|
184         if part.content_type.start_with?("text/")
185           text_parts.push(part)
186         elsif part.multipart?
187           text_parts.concat(email_text_parts(part))
188         end
189       end
190     end
191   end
192 end