test/test_helper.rb

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