test/test_helper.rb

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