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