test/test_helper.rb

   1 require "simplecov"
   2 require "simplecov-lcov"
   3
   4 # Fix incompatibility of simplecov-lcov with older versions of simplecov that are not expresses in its gemspec.
   5 # https://github.com/fortissimo1997/simplecov-lcov/pull/25
   6 unless SimpleCov.respond_to?(:branch_coverage)
   7   module SimpleCov
   8     def self.branch_coverage?
   9       false
  10     end
  11   end
  12 end
  13
  14 SimpleCov::Formatter::LcovFormatter.config do |config|
  15   config.report_with_single_file = true
  16   config.single_report_path = "coverage/lcov.info"
  17 end
  18
  19 SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
  20   [
  21     SimpleCov::Formatter::HTMLFormatter,
  22     SimpleCov::Formatter::LcovFormatter
  23   ]
  24 )
  25
  26 SimpleCov.start("rails")
  27
  28 require "securerandom"
  29 require "digest/sha1"
  30
  31 ENV["RAILS_ENV"] = "test"
  32 require_relative "../config/environment"
  33 require "rails/test_help"
  34 require "webmock/minitest"
  35 require "minitest/focus" unless ENV["CI"]
  36
  37 WebMock.disable_net_connect!(:allow_localhost => true)
  38
  39 module ActiveSupport
  40   class TestCase
  41     include FactoryBot::Syntax::Methods
  42     include ActiveJob::TestHelper
  43
  44     # Run tests in parallel with specified workers
  45     parallelize(:workers => :number_of_processors)
  46
  47     parallelize_setup do |worker|
  48       SimpleCov.command_name "#{SimpleCov.command_name}-#{worker}"
  49     end
  50
  51     parallelize_teardown do
  52       SimpleCov.result
  53     end
  54
  55     ##
  56     # takes a block which is executed in the context of a different
  57     # ActionController instance. this is used so that code can call methods
  58     # on the node controller whilst testing the old_node controller.
  59     def with_controller(new_controller)
  60       controller_save = @controller
  61       begin
  62         @controller = new_controller
  63         yield
  64       ensure
  65         @controller = controller_save
  66       end
  67     end
  68
  69     ##
  70     # execute a block with missing translation exceptions suppressed
  71     def without_i18n_exceptions
  72       exception_handler = I18n.exception_handler
  73       begin
  74         I18n.exception_handler = nil
  75         yield
  76       ensure
  77         I18n.exception_handler = exception_handler
  78       end
  79     end
  80
  81     ##
  82     # work round minitest insanity that causes it to tell you
  83     # to use assert_nil to test for nil, which is fine if you're
  84     # comparing to a nil constant but not if you're comparing
  85     # an expression that might be nil sometimes
  86     def assert_equal_allowing_nil(exp, act, msg = nil)
  87       if exp.nil?
  88         assert_nil act, msg
  89       else
  90         assert_equal exp, act, msg
  91       end
  92     end
  93
  94     ##
  95     # for some reason assert_equal a, b fails when the relations are
  96     # actually equal, so this method manually checks the fields...
  97     def assert_relations_are_equal(a, b)
  98       assert_not_nil a, "first relation is not allowed to be nil"
  99       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
 100       assert_equal a.id, b.id, "relation IDs"
 101       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
 102       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
 103       assert_equal a.version, b.version, "version on relation #{a.id}"
 104       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
 105       assert_equal a.members, b.members, "member references on relation #{a.id}"
 106     end
 107
 108     ##
 109     # for some reason assert_equal a, b fails when the ways are actually
 110     # equal, so this method manually checks the fields...
 111     def assert_ways_are_equal(a, b)
 112       assert_not_nil a, "first way is not allowed to be nil"
 113       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
 114       assert_equal a.id, b.id, "way IDs"
 115       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
 116       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
 117       assert_equal a.version, b.version, "version on way #{a.id}"
 118       assert_equal a.tags, b.tags, "tags on way #{a.id}"
 119       assert_equal a.nds, b.nds, "node references on way #{a.id}"
 120     end
 121
 122     ##
 123     # for some reason a==b is false, but there doesn't seem to be any
 124     # difference between the nodes, so i'm checking all the attributes
 125     # manually and blaming it on ActiveRecord
 126     def assert_nodes_are_equal(a, b)
 127       assert_equal a.id, b.id, "node IDs"
 128       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
 129       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
 130       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
 131       assert_equal a.visible, b.visible, "visible on node #{a.id}"
 132       assert_equal a.version, b.version, "version on node #{a.id}"
 133       assert_equal a.tags, b.tags, "tags on node #{a.id}"
 134     end
 135
 136     ##
 137     # return request header for HTTP Bearer Authorization
 138     def bearer_authorization_header(token_or_user = nil, scopes: Oauth::SCOPES)
 139       token = case token_or_user
 140               when nil then create(:oauth_access_token, :scopes => scopes).token
 141               when User then create(:oauth_access_token, :resource_owner_id => token_or_user.id, :scopes => scopes).token
 142               when Doorkeeper::AccessToken then token_or_user.token
 143               when String then token_or_user
 144               end
 145
 146       { "Authorization" => "Bearer #{token}" }
 147     end
 148
 149     ##
 150     # return request header for HTTP Accept
 151     def accept_format_header(format)
 152       { "Accept" => format }
 153     end
 154
 155     ##
 156     # return request header to ask for a particular error format
 157     def error_format_header(f)
 158       { "X-Error-Format" => f }
 159     end
 160
 161     ##
 162     # Used to check that the error header and the forbidden responses are given
 163     # when the owner of the changeset has their data not marked as public
 164     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
 165       assert_response :forbidden, msg
 166       assert_equal("You must make your edits public to upload new data", @response.headers["Error"], "Wrong error message")
 167     end
 168
 169     ##
 170     # Not sure this is the best response we could give
 171     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
 172       assert_response :forbidden, msg
 173       # assert_equal @response.headers['Error'], ""
 174     end
 175
 176     ##
 177     # Check for missing translations in an HTML response
 178     def assert_no_missing_translations(msg = "")
 179       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
 180     end
 181
 182     ##
 183     # execute a block with a given set of HTTP responses stubbed
 184     def with_http_stubs(stubs_file)
 185       stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
 186       stubs.each do |url, response|
 187         stub_request(:get, Regexp.new(Regexp.quote(url))).to_return(:status => response["code"], :body => response["body"])
 188       end
 189
 190       yield
 191     end
 192
 193     def stub_gravatar_request(email, status = 200, body = nil)
 194       hash = ::Digest::MD5.hexdigest(email.downcase)
 195       url = "https://www.gravatar.com/avatar/#{hash}?d=404"
 196       stub_request(:get, url).and_return(:status => status, :body => body)
 197     end
 198
 199     def email_text_parts(message)
 200       message.parts.each_with_object([]) do |part, text_parts|
 201         if part.content_type.start_with?("text/")
 202           text_parts.push(part)
 203         elsif part.multipart?
 204           text_parts.concat(email_text_parts(part))
 205         end
 206       end
 207     end
 208
 209     def session_for(user)
 210       get login_path
 211       post login_path, :params => { :username => user.display_name, :password => "test" }
 212       follow_redirect!
 213     end
 214
 215     def xml_for_node(node)
 216       doc = OSM::API.new.xml_doc
 217       doc.root << xml_node_for_node(node)
 218       doc
 219     end
 220
 221     def xml_node_for_node(node)
 222       el = XML::Node.new "node"
 223       el["id"] = node.id.to_s
 224
 225       add_metadata_to_xml_node(el, node, {}, {})
 226
 227       if node.visible?
 228         el["lat"] = node.lat.to_s
 229         el["lon"] = node.lon.to_s
 230       end
 231
 232       add_tags_to_xml_node(el, node.node_tags)
 233
 234       el
 235     end
 236
 237     def xml_for_way(way)
 238       doc = OSM::API.new.xml_doc
 239       doc.root << xml_node_for_way(way)
 240       doc
 241     end
 242
 243     def xml_node_for_way(way)
 244       el = XML::Node.new "way"
 245       el["id"] = way.id.to_s
 246
 247       add_metadata_to_xml_node(el, way, {}, {})
 248
 249       # make sure nodes are output in sequence_id order
 250       ordered_nodes = []
 251       way.way_nodes.each do |nd|
 252         ordered_nodes[nd.sequence_id] = nd.node_id.to_s if nd.node&.visible?
 253       end
 254
 255       ordered_nodes.each do |nd_id|
 256         next unless nd_id && nd_id != "0"
 257
 258         node_el = XML::Node.new "nd"
 259         node_el["ref"] = nd_id
 260         el << node_el
 261       end
 262
 263       add_tags_to_xml_node(el, way.way_tags)
 264
 265       el
 266     end
 267
 268     def xml_for_relation(relation)
 269       doc = OSM::API.new.xml_doc
 270       doc.root << xml_node_for_relation(relation)
 271       doc
 272     end
 273
 274     def xml_node_for_relation(relation)
 275       el = XML::Node.new "relation"
 276       el["id"] = relation.id.to_s
 277
 278       add_metadata_to_xml_node(el, relation, {}, {})
 279
 280       relation.relation_members.each do |member|
 281         member_el = XML::Node.new "member"
 282         member_el["type"] = member.member_type.downcase
 283         member_el["ref"] = member.member_id.to_s
 284         member_el["role"] = member.member_role
 285         el << member_el
 286       end
 287
 288       add_tags_to_xml_node(el, relation.relation_tags)
 289
 290       el
 291     end
 292
 293     def add_metadata_to_xml_node(el, osm, changeset_cache, user_display_name_cache)
 294       el["changeset"] = osm.changeset_id.to_s
 295       el["redacted"] = osm.redaction.id.to_s if osm.redacted?
 296       el["timestamp"] = osm.timestamp.xmlschema
 297       el["version"] = osm.version.to_s
 298       el["visible"] = osm.visible.to_s
 299
 300       if changeset_cache.key?(osm.changeset_id)
 301         # use the cache if available
 302       else
 303         changeset_cache[osm.changeset_id] = osm.changeset.user_id
 304       end
 305
 306       user_id = changeset_cache[osm.changeset_id]
 307
 308       if user_display_name_cache.key?(user_id)
 309         # use the cache if available
 310       elsif osm.changeset.user.data_public?
 311         user_display_name_cache[user_id] = osm.changeset.user.display_name
 312       else
 313         user_display_name_cache[user_id] = nil
 314       end
 315
 316       unless user_display_name_cache[user_id].nil?
 317         el["user"] = user_display_name_cache[user_id]
 318         el["uid"] = user_id.to_s
 319       end
 320     end
 321
 322     def add_tags_to_xml_node(el, tags)
 323       tags.each do |tag|
 324         tag_el = XML::Node.new("tag")
 325
 326         tag_el["k"] = tag.k
 327         tag_el["v"] = tag.v
 328
 329         el << tag_el
 330       end
 331     end
 332
 333     def with_settings(settings)
 334       saved_settings = Settings.to_hash.slice(*settings.keys)
 335
 336       Settings.merge!(settings)
 337
 338       yield
 339     ensure
 340       Settings.merge!(saved_settings)
 341     end
 342
 343     def with_user_account_deletion_delay(value, &)
 344       freeze_time
 345
 346       with_settings(:user_account_deletion_delay => value, &)
 347     ensure
 348       unfreeze_time
 349     end
 350
 351     # This is a convenience method for checks of resources rendered in a map view sidebar
 352     # First we check that when we don't have an id, it will correctly return a 404
 353     # then we check that we get the correct 404 when a non-existant id is passed
 354     # then we check that it will get a successful response, when we do pass an id
 355     def sidebar_browse_check(path, id, template)
 356       path_method = method(path)
 357
 358       assert_raise ActionController::UrlGenerationError do
 359         get path_method.call
 360       end
 361
 362       assert_raise ActionController::UrlGenerationError do
 363         get path_method.call(:id => -10) # we won't have an id that's negative
 364       end
 365
 366       get path_method.call(:id => 0)
 367       assert_response :not_found
 368       assert_template "browse/not_found"
 369       assert_template :layout => "map"
 370
 371       get path_method.call(:id => 0), :xhr => true
 372       assert_response :not_found
 373       assert_template "browse/not_found"
 374       assert_template :layout => "xhr"
 375
 376       get path_method.call(:id => id)
 377       assert_response :success
 378       assert_template template
 379       assert_template :layout => "map"
 380
 381       get path_method.call(:id => id), :xhr => true
 382       assert_response :success
 383       assert_template template
 384       assert_template :layout => "xhr"
 385     end
 386   end
 387 end