test/test_helper.rb

   1 require "coveralls"
   2 Coveralls.wear!("rails")
   3
   4 # Override the simplecov output message, since it is mostly unwanted noise
   5 module SimpleCov
   6   module Formatter
   7     class HTMLFormatter
   8       def output_message(_result); end
   9     end
  10   end
  11 end
  12
  13 # Output both the local simplecov html and the coveralls report
  14 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
  15   [SimpleCov::Formatter::HTMLFormatter,
  16    Coveralls::SimpleCov::Formatter]
  17 )
  18
  19 ENV["RAILS_ENV"] = "test"
  20 require_relative "../config/environment"
  21 require "rails/test_help"
  22 require "webmock/minitest"
  23
  24 WebMock.disable_net_connect!(:allow_localhost => true)
  25
  26 module ActiveSupport
  27   class TestCase
  28     include FactoryBot::Syntax::Methods
  29     include ActiveJob::TestHelper
  30
  31     # Run tests in parallel with specified workers
  32     parallelize(:workers => :number_of_processors)
  33
  34     ##
  35     # takes a block which is executed in the context of a different
  36     # ActionController instance. this is used so that code can call methods
  37     # on the node controller whilst testing the old_node controller.
  38     def with_controller(new_controller)
  39       controller_save = @controller
  40       begin
  41         @controller = new_controller
  42         yield
  43       ensure
  44         @controller = controller_save
  45       end
  46     end
  47
  48     ##
  49     # execute a block with missing translation exceptions suppressed
  50     def without_i18n_exceptions
  51       exception_handler = I18n.exception_handler
  52       begin
  53         I18n.exception_handler = nil
  54         yield
  55       ensure
  56         I18n.exception_handler = exception_handler
  57       end
  58     end
  59
  60     ##
  61     # work round minitest insanity that causes it to tell you
  62     # to use assert_nil to test for nil, which is fine if you're
  63     # comparing to a nil constant but not if you're comparing
  64     # an expression that might be nil sometimes
  65     def assert_equal_allowing_nil(exp, act, msg = nil)
  66       if exp.nil?
  67         assert_nil act, msg
  68       else
  69         assert_equal exp, act, msg
  70       end
  71     end
  72
  73     ##
  74     # for some reason assert_equal a, b fails when the relations are
  75     # actually equal, so this method manually checks the fields...
  76     def assert_relations_are_equal(a, b)
  77       assert_not_nil a, "first relation is not allowed to be nil"
  78       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
  79       assert_equal a.id, b.id, "relation IDs"
  80       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
  81       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
  82       assert_equal a.version, b.version, "version on relation #{a.id}"
  83       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
  84       assert_equal a.members, b.members, "member references on relation #{a.id}"
  85     end
  86
  87     ##
  88     # for some reason assert_equal a, b fails when the ways are actually
  89     # equal, so this method manually checks the fields...
  90     def assert_ways_are_equal(a, b)
  91       assert_not_nil a, "first way is not allowed to be nil"
  92       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
  93       assert_equal a.id, b.id, "way IDs"
  94       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
  95       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
  96       assert_equal a.version, b.version, "version on way #{a.id}"
  97       assert_equal a.tags, b.tags, "tags on way #{a.id}"
  98       assert_equal a.nds, b.nds, "node references on way #{a.id}"
  99     end
 100
 101     ##
 102     # for some reason a==b is false, but there doesn't seem to be any
 103     # difference between the nodes, so i'm checking all the attributes
 104     # manually and blaming it on ActiveRecord
 105     def assert_nodes_are_equal(a, b)
 106       assert_equal a.id, b.id, "node IDs"
 107       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
 108       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
 109       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
 110       assert_equal a.visible, b.visible, "visible on node #{a.id}"
 111       assert_equal a.version, b.version, "version on node #{a.id}"
 112       assert_equal a.tags, b.tags, "tags on node #{a.id}"
 113     end
 114
 115     ##
 116     # set request headers for HTTP basic authentication
 117     def basic_authorization(user, pass)
 118       @request.env["HTTP_AUTHORIZATION"] = format("Basic %{auth}", :auth => Base64.encode64("#{user}:#{pass}"))
 119     end
 120
 121     ##
 122     # set request header for HTTP Accept
 123     def http_accept_format(format)
 124       @request.env["HTTP_ACCEPT"] = format
 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     # Used to check that the error header and the forbidden responses are given
 135     # when the owner of the changset has their data not marked as public
 136     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
 137       assert_response :forbidden, msg
 138       assert_equal @response.headers["Error"], "You must make your edits public to upload new data", "Wrong error message"
 139     end
 140
 141     ##
 142     # Not sure this is the best response we could give
 143     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
 144       assert_response :unauthorized, msg
 145       # assert_equal @response.headers['Error'], ""
 146     end
 147
 148     ##
 149     # Check for missing translations in an HTML response
 150     def assert_no_missing_translations(msg = "")
 151       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
 152     end
 153
 154     ##
 155     # execute a block with a given set of HTTP responses stubbed
 156     def with_http_stubs(stubs_file)
 157       stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
 158       stubs.each do |url, response|
 159         stub_request(:get, Regexp.new(Regexp.quote(url))).to_return(:status => response["code"], :body => response["body"])
 160       end
 161
 162       yield
 163     end
 164
 165     def stub_gravatar_request(email, status = 200, body = nil)
 166       hash = ::Digest::MD5.hexdigest(email.downcase)
 167       url = "https://www.gravatar.com/avatar/#{hash}?d=404"
 168       stub_request(:get, url).and_return(:status => status, :body => body)
 169     end
 170
 171     def email_text_parts(message)
 172       message.parts.each_with_object([]) do |part, text_parts|
 173         if part.content_type.start_with?("text/")
 174           text_parts.push(part)
 175         elsif part.multipart?
 176           text_parts.concat(email_text_parts(part))
 177         end
 178       end
 179     end
 180
 181     def sign_in_as(user)
 182       visit login_path
 183       fill_in "username", :with => user.email
 184       fill_in "password", :with => "test"
 185       click_on "Login", :match => :first
 186     end
 187
 188     def session_for(user)
 189       post login_path, :params => { :username => user.display_name, :password => "test" }
 190       follow_redirect!
 191     end
 192
 193     def xml_for_node(node)
 194       doc = OSM::API.new.get_xml_doc
 195       doc.root << xml_node_for_node(node)
 196       doc
 197     end
 198
 199     def xml_node_for_node(node)
 200       el = XML::Node.new "node"
 201       el["id"] = node.id.to_s
 202
 203       OMHelper.add_metadata_to_xml_node(el, node, {}, {})
 204
 205       if node.visible?
 206         el["lat"] = node.lat.to_s
 207         el["lon"] = node.lon.to_s
 208       end
 209
 210       OMHelper.add_tags_to_xml_node(el, node.node_tags)
 211
 212       el
 213     end
 214
 215     def xml_for_way(way)
 216       doc = OSM::API.new.get_xml_doc
 217       doc.root << xml_node_for_way(way)
 218       doc
 219     end
 220
 221     def xml_node_for_way(way)
 222       el = XML::Node.new "way"
 223       el["id"] = way.id.to_s
 224
 225       OMHelper.add_metadata_to_xml_node(el, way, {}, {})
 226
 227       # make sure nodes are output in sequence_id order
 228       ordered_nodes = []
 229       way.way_nodes.each do |nd|
 230         ordered_nodes[nd.sequence_id] = nd.node_id.to_s if nd.node&.visible?
 231       end
 232
 233       ordered_nodes.each do |nd_id|
 234         next unless nd_id && nd_id != "0"
 235
 236         node_el = XML::Node.new "nd"
 237         node_el["ref"] = nd_id
 238         el << node_el
 239       end
 240
 241       OMHelper.add_tags_to_xml_node(el, way.way_tags)
 242
 243       el
 244     end
 245
 246     def xml_for_relation(relation)
 247       doc = OSM::API.new.get_xml_doc
 248       doc.root << xml_node_for_relation(relation)
 249       doc
 250     end
 251
 252     def xml_node_for_relation(relation)
 253       el = XML::Node.new "relation"
 254       el["id"] = relation.id.to_s
 255
 256       OMHelper.add_metadata_to_xml_node(el, relation, {}, {})
 257
 258       relation.relation_members.each do |member|
 259         member_el = XML::Node.new "member"
 260         member_el["type"] = member.member_type.downcase
 261         member_el["ref"] = member.member_id.to_s
 262         member_el["role"] = member.member_role
 263         el << member_el
 264       end
 265
 266       OMHelper.add_tags_to_xml_node(el, relation.relation_tags)
 267
 268       el
 269     end
 270
 271     class OMHelper
 272       extend ObjectMetadata
 273     end
 274   end
 275 end