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