Merge remote-tracking branch 'openstreetmap/pull/1349'
[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 load "composite_primary_keys/fixtures.rb"
8
9 module ActiveSupport
10   class TestCase
11     include FactoryGirl::Syntax::Methods
12
13     # Load standard fixtures needed to test API methods
14     def self.api_fixtures
15       # print "setting up the api_fixtures"
16       fixtures :users, :user_roles
17       fixtures :changesets, :changeset_tags
18
19       fixtures :current_nodes, :nodes
20       set_fixture_class :current_nodes => Node
21       set_fixture_class :nodes => OldNode
22
23       fixtures :current_node_tags, :node_tags
24       set_fixture_class :current_node_tags => NodeTag
25       set_fixture_class :node_tags => OldNodeTag
26
27       fixtures :current_ways
28       set_fixture_class :current_ways => Way
29
30       fixtures :current_way_nodes, :current_way_tags
31       set_fixture_class :current_way_nodes => WayNode
32       set_fixture_class :current_way_tags => WayTag
33
34       fixtures :ways
35       set_fixture_class :ways => OldWay
36
37       fixtures :way_nodes, :way_tags
38       set_fixture_class :way_nodes => OldWayNode
39       set_fixture_class :way_tags => OldWayTag
40
41       fixtures :current_relations
42       set_fixture_class :current_relations => Relation
43
44       fixtures :current_relation_members, :current_relation_tags
45       set_fixture_class :current_relation_members => RelationMember
46       set_fixture_class :current_relation_tags => RelationTag
47
48       fixtures :relations
49       set_fixture_class :relations => OldRelation
50
51       fixtures :relation_members, :relation_tags
52       set_fixture_class :relation_members => OldRelationMember
53       set_fixture_class :relation_tags => OldRelationTag
54
55       fixtures :gpx_files, :gps_points, :gpx_file_tags
56       set_fixture_class :gpx_files => Trace
57       set_fixture_class :gps_points => Tracepoint
58       set_fixture_class :gpx_file_tags => Tracetag
59
60       fixtures :client_applications
61
62       fixtures :redactions
63     end
64
65     ##
66     # takes a block which is executed in the context of a different
67     # ActionController instance. this is used so that code can call methods
68     # on the node controller whilst testing the old_node controller.
69     def with_controller(new_controller)
70       controller_save = @controller
71       begin
72         @controller = new_controller
73         yield
74       ensure
75         @controller = controller_save
76       end
77     end
78
79     ##
80     # for some reason assert_equal a, b fails when the relations are
81     # actually equal, so this method manually checks the fields...
82     def assert_relations_are_equal(a, b)
83       assert_not_nil a, "first relation is not allowed to be nil"
84       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
85       assert_equal a.id, b.id, "relation IDs"
86       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
87       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
88       assert_equal a.version, b.version, "version on relation #{a.id}"
89       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
90       assert_equal a.members, b.members, "member references on relation #{a.id}"
91     end
92
93     ##
94     # for some reason assert_equal a, b fails when the ways are actually
95     # equal, so this method manually checks the fields...
96     def assert_ways_are_equal(a, b)
97       assert_not_nil a, "first way is not allowed to be nil"
98       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
99       assert_equal a.id, b.id, "way IDs"
100       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
101       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
102       assert_equal a.version, b.version, "version on way #{a.id}"
103       assert_equal a.tags, b.tags, "tags on way #{a.id}"
104       assert_equal a.nds, b.nds, "node references on way #{a.id}"
105     end
106
107     ##
108     # for some reason a==b is false, but there doesn't seem to be any
109     # difference between the nodes, so i'm checking all the attributes
110     # manually and blaming it on ActiveRecord
111     def assert_nodes_are_equal(a, b)
112       assert_equal a.id, b.id, "node IDs"
113       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
114       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
115       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
116       assert_equal a.visible, b.visible, "visible on node #{a.id}"
117       assert_equal a.version, b.version, "version on node #{a.id}"
118       assert_equal a.tags, b.tags, "tags on node #{a.id}"
119     end
120
121     ##
122     # set request headers for HTTP basic authentication
123     def basic_authorization(user, pass)
124       @request.env["HTTP_AUTHORIZATION"] = format("Basic %s", Base64.encode64("#{user}:#{pass}"))
125     end
126
127     ##
128     # set request readers to ask for a particular error format
129     def error_format(format)
130       @request.env["HTTP_X_ERROR_FORMAT"] = format
131     end
132
133     ##
134     # set the raw body to be sent with a POST request
135     def content(c)
136       @request.env["RAW_POST_DATA"] = c.to_s
137     end
138
139     ##
140     # Used to check that the error header and the forbidden responses are given
141     # when the owner of the changset has their data not marked as public
142     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
143       assert_response :forbidden, msg
144       assert_equal @response.headers["Error"], "You must make your edits public to upload new data", "Wrong error message"
145     end
146
147     ##
148     # Not sure this is the best response we could give
149     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
150       assert_response :unauthorized, msg
151       # assert_equal @response.headers['Error'], ""
152     end
153
154     ##
155     # Check for missing translations in an HTML response
156     def assert_no_missing_translations(msg = "")
157       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
158     end
159
160     ##
161     # execute a block with a given set of HTTP responses stubbed
162     def with_http_stubs(stubs_file)
163       http_client_save = OSM.http_client
164
165       begin
166         stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
167
168         OSM.http_client = Faraday.new do |builder|
169           builder.adapter :test do |stub|
170             stubs.each do |url, response|
171               stub.get(url) { |_env| [response["code"], {}, response["body"]] }
172             end
173           end
174         end
175
176         yield
177       ensure
178         OSM.http_client = http_client_save
179       end
180     end
181   end
182 end