Merge branch 'master' into cancancan
[rails.git] / test / test_helper.rb
1 require "coveralls"
2 Coveralls.wear!("rails")
3
4 ENV["RAILS_ENV"] = "test"
5 require_relative "../config/environment"
6 require "rails/test_help"
7 require "webmock/minitest"
8
9 WebMock.disable_net_connect!(:allow_localhost => true)
10
11 module ActiveSupport
12   class TestCase
13     include FactoryBot::Syntax::Methods
14
15     ##
16     # takes a block which is executed in the context of a different
17     # ActionController instance. this is used so that code can call methods
18     # on the node controller whilst testing the old_node controller.
19     def with_controller(new_controller)
20       controller_save = @controller
21       begin
22         @controller = new_controller
23         yield
24       ensure
25         @controller = controller_save
26       end
27     end
28
29     ##
30     # work round minitest insanity that causes it to tell you
31     # to use assert_nil to test for nil, which is fine if you're
32     # comparing to a nil constant but not if you're comparing
33     # an expression that might be nil sometimes
34     def assert_equal_allowing_nil(exp, act, msg = nil)
35       if exp.nil?
36         assert_nil act, msg
37       else
38         assert_equal exp, act, msg
39       end
40     end
41
42     ##
43     # for some reason assert_equal a, b fails when the relations are
44     # actually equal, so this method manually checks the fields...
45     def assert_relations_are_equal(a, b)
46       assert_not_nil a, "first relation is not allowed to be nil"
47       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
48       assert_equal a.id, b.id, "relation IDs"
49       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
50       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
51       assert_equal a.version, b.version, "version on relation #{a.id}"
52       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
53       assert_equal a.members, b.members, "member references on relation #{a.id}"
54     end
55
56     ##
57     # for some reason assert_equal a, b fails when the ways are actually
58     # equal, so this method manually checks the fields...
59     def assert_ways_are_equal(a, b)
60       assert_not_nil a, "first way is not allowed to be nil"
61       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
62       assert_equal a.id, b.id, "way IDs"
63       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
64       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
65       assert_equal a.version, b.version, "version on way #{a.id}"
66       assert_equal a.tags, b.tags, "tags on way #{a.id}"
67       assert_equal a.nds, b.nds, "node references on way #{a.id}"
68     end
69
70     ##
71     # for some reason a==b is false, but there doesn't seem to be any
72     # difference between the nodes, so i'm checking all the attributes
73     # manually and blaming it on ActiveRecord
74     def assert_nodes_are_equal(a, b)
75       assert_equal a.id, b.id, "node IDs"
76       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
77       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
78       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
79       assert_equal a.visible, b.visible, "visible on node #{a.id}"
80       assert_equal a.version, b.version, "version on node #{a.id}"
81       assert_equal a.tags, b.tags, "tags on node #{a.id}"
82     end
83
84     ##
85     # set request headers for HTTP basic authentication
86     def basic_authorization(user, pass)
87       @request.env["HTTP_AUTHORIZATION"] = format("Basic %{auth}", :auth => Base64.encode64("#{user}:#{pass}"))
88     end
89
90     ##
91     # set oauth token permissions
92     def grant_oauth_token(*tokens)
93       request.env["oauth.token"] = AccessToken.new do |token|
94         tokens.each do |t|
95           token.public_send("#{t}=", true)
96         end
97       end
98     end
99
100     ##
101     # set request readers to ask for a particular error format
102     def error_format(format)
103       @request.env["HTTP_X_ERROR_FORMAT"] = format
104     end
105
106     ##
107     # set the raw body to be sent with a POST request
108     def content(c)
109       @request.env["RAW_POST_DATA"] = c.to_s
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   end
174 end