test/test_helper.rb

   1 require "coveralls"
   2 Coveralls.wear!("rails")
   3
   4 # Output both the local simplecov html and the coveralls report
   5 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
   6   [SimpleCov::Formatter::HTMLFormatter,
   7    Coveralls::SimpleCov::Formatter]
   8 )
   9
  10 ENV["RAILS_ENV"] = "test"
  11 require_relative "../config/environment"
  12 require "rails/test_help"
  13 require "webmock/minitest"
  14
  15 WebMock.disable_net_connect!(:allow_localhost => true)
  16
  17 module ActiveSupport
  18   class TestCase
  19     include FactoryBot::Syntax::Methods
  20     include ActiveJob::TestHelper
  21
  22     ##
  23     # takes a block which is executed in the context of a different
  24     # ActionController instance. this is used so that code can call methods
  25     # on the node controller whilst testing the old_node controller.
  26     def with_controller(new_controller)
  27       controller_save = @controller
  28       begin
  29         @controller = new_controller
  30         yield
  31       ensure
  32         @controller = controller_save
  33       end
  34     end
  35
  36     ##
  37     # work round minitest insanity that causes it to tell you
  38     # to use assert_nil to test for nil, which is fine if you're
  39     # comparing to a nil constant but not if you're comparing
  40     # an expression that might be nil sometimes
  41     def assert_equal_allowing_nil(exp, act, msg = nil)
  42       if exp.nil?
  43         assert_nil act, msg
  44       else
  45         assert_equal exp, act, msg
  46       end
  47     end
  48
  49     ##
  50     # for some reason assert_equal a, b fails when the relations are
  51     # actually equal, so this method manually checks the fields...
  52     def assert_relations_are_equal(a, b)
  53       assert_not_nil a, "first relation is not allowed to be nil"
  54       assert_not_nil b, "second relation #{a.id} is not allowed to be nil"
  55       assert_equal a.id, b.id, "relation IDs"
  56       assert_equal a.changeset_id, b.changeset_id, "changeset ID on relation #{a.id}"
  57       assert_equal a.visible, b.visible, "visible on relation #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
  58       assert_equal a.version, b.version, "version on relation #{a.id}"
  59       assert_equal a.tags, b.tags, "tags on relation #{a.id}"
  60       assert_equal a.members, b.members, "member references on relation #{a.id}"
  61     end
  62
  63     ##
  64     # for some reason assert_equal a, b fails when the ways are actually
  65     # equal, so this method manually checks the fields...
  66     def assert_ways_are_equal(a, b)
  67       assert_not_nil a, "first way is not allowed to be nil"
  68       assert_not_nil b, "second way #{a.id} is not allowed to be nil"
  69       assert_equal a.id, b.id, "way IDs"
  70       assert_equal a.changeset_id, b.changeset_id, "changeset ID on way #{a.id}"
  71       assert_equal a.visible, b.visible, "visible on way #{a.id}, #{a.visible.inspect} != #{b.visible.inspect}"
  72       assert_equal a.version, b.version, "version on way #{a.id}"
  73       assert_equal a.tags, b.tags, "tags on way #{a.id}"
  74       assert_equal a.nds, b.nds, "node references on way #{a.id}"
  75     end
  76
  77     ##
  78     # for some reason a==b is false, but there doesn't seem to be any
  79     # difference between the nodes, so i'm checking all the attributes
  80     # manually and blaming it on ActiveRecord
  81     def assert_nodes_are_equal(a, b)
  82       assert_equal a.id, b.id, "node IDs"
  83       assert_equal a.latitude, b.latitude, "latitude on node #{a.id}"
  84       assert_equal a.longitude, b.longitude, "longitude on node #{a.id}"
  85       assert_equal a.changeset_id, b.changeset_id, "changeset ID on node #{a.id}"
  86       assert_equal a.visible, b.visible, "visible on node #{a.id}"
  87       assert_equal a.version, b.version, "version on node #{a.id}"
  88       assert_equal a.tags, b.tags, "tags on node #{a.id}"
  89     end
  90
  91     ##
  92     # set request headers for HTTP basic authentication
  93     def basic_authorization(user, pass)
  94       @request.env["HTTP_AUTHORIZATION"] = format("Basic %{auth}", :auth => Base64.encode64("#{user}:#{pass}"))
  95     end
  96
  97     ##
  98     # set request readers to ask for a particular error format
  99     def error_format(format)
 100       @request.env["HTTP_X_ERROR_FORMAT"] = format
 101     end
 102
 103     ##
 104     # Used to check that the error header and the forbidden responses are given
 105     # when the owner of the changset has their data not marked as public
 106     def assert_require_public_data(msg = "Shouldn't be able to use API when the user's data is not public")
 107       assert_response :forbidden, msg
 108       assert_equal @response.headers["Error"], "You must make your edits public to upload new data", "Wrong error message"
 109     end
 110
 111     ##
 112     # Not sure this is the best response we could give
 113     def assert_inactive_user(msg = "an inactive user shouldn't be able to access the API")
 114       assert_response :unauthorized, msg
 115       # assert_equal @response.headers['Error'], ""
 116     end
 117
 118     ##
 119     # Check for missing translations in an HTML response
 120     def assert_no_missing_translations(msg = "")
 121       assert_select "span[class=translation_missing]", false, "Missing translation #{msg}"
 122     end
 123
 124     ##
 125     # execute a block with a given set of HTTP responses stubbed
 126     def with_http_stubs(stubs_file)
 127       stubs = YAML.load_file(File.expand_path("../http/#{stubs_file}.yml", __FILE__))
 128       stubs.each do |url, response|
 129         stub_request(:get, Regexp.new(Regexp.quote(url))).to_return(:status => response["code"], :body => response["body"])
 130       end
 131
 132       yield
 133     end
 134
 135     def stub_gravatar_request(email, status = 200, body = nil)
 136       hash = ::Digest::MD5.hexdigest(email.downcase)
 137       url = "https://www.gravatar.com/avatar/#{hash}?d=404"
 138       stub_request(:get, url).and_return(:status => status, :body => body)
 139     end
 140
 141     def stub_hostip_requests
 142       # Controller tests and integration tests use different IPs
 143       stub_request(:get, "https://api.hostip.info/country.php?ip=0.0.0.0")
 144       stub_request(:get, "https://api.hostip.info/country.php?ip=127.0.0.1")
 145     end
 146
 147     def email_text_parts(message)
 148       message.parts.each_with_object([]) do |part, text_parts|
 149         if part.content_type.start_with?("text/")
 150           text_parts.push(part)
 151         elsif part.multipart?
 152           text_parts.concat(email_text_parts(part))
 153         end
 154       end
 155     end
 156
 157     def sign_in_as(user)
 158       stub_hostip_requests
 159       visit login_path
 160       fill_in "username", :with => user.email
 161       fill_in "password", :with => "test"
 162       click_on "Login", :match => :first
 163     end
 164   end
 165 end