openstreetmap-website/test/models/trace_test.rb

require "test_helper"
require "gpx"
require "minitest/mock"

class TraceTest < ActiveSupport::TestCase
  # Use temporary directories with unique names for each test
  # This allows the tests to be run in parallel.
  def setup
    @gpx_trace_dir_orig = Settings.gpx_trace_dir
    @gpx_image_dir_orig = Settings.gpx_image_dir
    Settings.gpx_trace_dir = Dir.mktmpdir("trace", Rails.root.join("test/gpx"))
    Settings.gpx_image_dir = Dir.mktmpdir("image", Rails.root.join("test/gpx"))
  end

  def teardown
    FileUtils.remove_dir(Settings.gpx_trace_dir)
    FileUtils.remove_dir(Settings.gpx_image_dir)
    Settings.gpx_trace_dir = @gpx_trace_dir_orig
    Settings.gpx_image_dir = @gpx_image_dir_orig
  end

  def test_visible
    public_trace_file = create(:trace)
    create(:trace, :deleted)
    check_query(Trace.visible, [public_trace_file])
  end

  def test_visible_to
    first_user = create(:user)
    second_user = create(:user)
    third_user = create(:user)
    fourth_user = create(:user)
    public_trace_file = create(:trace, :visibility => "public", :user => first_user)
    anon_trace_file = create(:trace, :visibility => "private", :user => second_user)
    identifiable_trace_file = create(:trace, :visibility => "identifiable", :user => first_user)
    pending_trace_file = create(:trace, :visibility => "public", :user => second_user, :inserted => false)
    trackable_trace_file = create(:trace, :visibility => "trackable", :user => second_user)
    _other_trace_file = create(:trace, :visibility => "private", :user => third_user)

    check_query(Trace.visible_to(first_user), [
                  public_trace_file, identifiable_trace_file, pending_trace_file
                ])
    check_query(Trace.visible_to(second_user), [
                  public_trace_file, anon_trace_file, trackable_trace_file,
                  identifiable_trace_file, pending_trace_file
                ])
    check_query(Trace.visible_to(fourth_user), [
                  public_trace_file, identifiable_trace_file, pending_trace_file
                ])
  end

  def test_visible_to_all
    public_trace_file = create(:trace, :visibility => "public")
    _private_trace_file = create(:trace, :visibility => "private")
    identifiable_trace_file = create(:trace, :visibility => "identifiable")
    _trackable_trace_file = create(:trace, :visibility => "trackable")
    deleted_trace_file = create(:trace, :deleted, :visibility => "public")
    pending_trace_file = create(:trace, :visibility => "public", :inserted => false)

    check_query(Trace.visible_to_all, [
                  public_trace_file, identifiable_trace_file,
                  deleted_trace_file, pending_trace_file
                ])
  end

  def test_tagged
    london_trace_file = create(:trace) do |trace|
      create(:tracetag, :trace => trace, :tag => "London")
    end
    birmingham_trace_file = create(:trace) do |trace|
      create(:tracetag, :trace => trace, :tag => "Birmingham")
    end
    check_query(Trace.tagged("London"), [london_trace_file])
    check_query(Trace.tagged("Birmingham"), [birmingham_trace_file])
    check_query(Trace.tagged("Unknown"), [])
  end

  def test_validations
    trace_valid({})
    trace_valid({ :user_id => nil }, false)
    trace_valid(:name => "a" * 255)
    trace_valid({ :name => "a" * 256 }, false)
    trace_valid({ :description => nil }, false)
    trace_valid(:description => "a" * 255)
    trace_valid({ :description => "a" * 256 }, false)
    trace_valid(:visibility => "private")
    trace_valid(:visibility => "public")
    trace_valid(:visibility => "trackable")
    trace_valid(:visibility => "identifiable")
    trace_valid({ :visibility => "foo" }, false)
  end

  def test_tagstring
    trace = build(:trace)
    trace.tagstring = "foo bar baz"
    assert trace.valid?
    assert_equal 3, trace.tags.length
    assert_equal "foo", trace.tags[0].tag
    assert_equal "bar", trace.tags[1].tag
    assert_equal "baz", trace.tags[2].tag
    assert_equal "foo, bar, baz", trace.tagstring
    trace.tagstring = "foo, bar baz ,qux"
    assert trace.valid?
    assert_equal 3, trace.tags.length
    assert_equal "foo", trace.tags[0].tag
    assert_equal "bar baz", trace.tags[1].tag
    assert_equal "qux", trace.tags[2].tag
    assert_equal "foo, bar baz, qux", trace.tagstring
  end

  def test_public?
    assert_equal true, build(:trace, :visibility => "public").public?
    assert_equal false, build(:trace, :visibility => "private").public?
    assert_equal false, build(:trace, :visibility => "trackable").public?
    assert_equal true, build(:trace, :visibility => "identifiable").public?
    assert_equal true, build(:trace, :deleted, :visibility => "public").public?
  end

  def test_trackable?
    assert_equal false, build(:trace, :visibility => "public").trackable?
    assert_equal false, build(:trace, :visibility => "private").trackable?
    assert_equal true, build(:trace, :visibility => "trackable").trackable?
    assert_equal true, build(:trace, :visibility => "identifiable").trackable?
    assert_equal false, build(:trace, :deleted, :visibility => "public").trackable?
  end

  def test_identifiable?
    assert_equal false, build(:trace, :visibility => "public").identifiable?
    assert_equal false, build(:trace, :visibility => "private").identifiable?
    assert_equal false, build(:trace, :visibility => "trackable").identifiable?
    assert_equal true, build(:trace, :visibility => "identifiable").identifiable?
    assert_equal false, build(:trace, :deleted, :visibility => "public").identifiable?
  end

  def test_mime_type
    # The ids refer to the .gpx fixtures in test/traces
    check_mime_type("a", "application/gpx+xml")
    check_mime_type("b", "application/gpx+xml")
    check_mime_type("c", "application/x-bzip2")
    check_mime_type("d", "application/x-gzip")
    check_mime_type("f", "application/x-zip")
    check_mime_type("g", "application/x-tar")
    check_mime_type("h", "application/x-gzip")
    check_mime_type("i", "application/x-bzip2")
  end

  def test_extension_name
    # The ids refer to the .gpx fixtures in test/traces
    check_extension_name("a", ".gpx")
    check_extension_name("b", ".gpx")
    check_extension_name("c", ".gpx.bz2")
    check_extension_name("d", ".gpx.gz")
    check_extension_name("f", ".zip")
    check_extension_name("g", ".tar")
    check_extension_name("h", ".tar.gz")
    check_extension_name("i", ".tar.bz2")
  end

  def test_xml_file
    check_xml_file("a", "848caa72f2f456d1bd6a0fdf228aa1b9")
    check_xml_file("b", "db4cb5ed2d7d2b627b3b504296c4f701")
    check_xml_file("c", "848caa72f2f456d1bd6a0fdf228aa1b9")
    check_xml_file("d", "abd6675fdf3024a84fc0a1deac147c0d")
    check_xml_file("f", "a7c05d676c77dc14369c21be216a3713")
    check_xml_file("g", "a7c05d676c77dc14369c21be216a3713")
    check_xml_file("h", "a7c05d676c77dc14369c21be216a3713")
    check_xml_file("i", "a7c05d676c77dc14369c21be216a3713")
  end

  def test_large_picture
    picture = File.read(Rails.root.join("test/gpx/fixtures/a.gif"), :mode => "rb")

    trace = Trace.create
    trace.large_picture = picture
    assert_equal "7c841749e084ee4a5d13f12cd3bef456", md5sum(File.new(trace.large_picture_name))
    assert_equal picture, trace.large_picture

    trace.destroy
  end

  def test_icon_picture
    picture = File.read(Rails.root.join("test/gpx/fixtures/a_icon.gif"), :mode => "rb")

    trace = Trace.create
    trace.icon_picture = picture
    assert_equal "b47baf22ed0e85d77e808694fad0ee27", md5sum(File.new(trace.icon_picture_name))
    assert_equal picture, trace.icon_picture

    trace.destroy
  end

  # When testing the trace.import method, care needs to be taken regarding the icon
  # fixture files, since the fixtures could be overwritten by newly generated files.
  # We use FakeFS to temporarily protect the real fixture files from being overwritten.

  def test_import_removes_previous_tracepoints
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "a")
      # Tracepoints don't have a primary key, so we use a specific latitude to
      # check for successful deletion
      create(:tracepoint, :latitude => 54321, :trace => trace)
      assert_equal 1, Tracepoint.where(:latitude => 54321).count

      trace.import

      assert_equal 0, Tracepoint.where(:latitude => 54321).count
    end
  end

  def test_import_creates_tracepoints
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "a")
      assert_equal 0, Tracepoint.where(:gpx_id => trace.id).count

      trace.import

      trace.reload
      assert_equal 1, Tracepoint.where(:gpx_id => trace.id).count

      # Check that the tile has been set prior to the bulk import
      # i.e. that the callbacks have been run correctly
      assert_equal 3221331576, Tracepoint.where(:gpx_id => trace.id).first.tile
    end
  end

  def test_import_creates_icon
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "a")
      icon_path = File.join(Settings.gpx_image_dir, "#{trace.id}_icon.gif")
      FileUtils.rm(icon_path)
      assert_equal false, File.exist?(icon_path)

      trace.import

      assert_equal true, File.exist?(icon_path)
    end
  end

  def test_import_creates_large_picture
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "a")
      large_picture_path = File.join(Settings.gpx_image_dir, "#{trace.id}.gif")
      FileUtils.rm(large_picture_path)
      assert_equal false, File.exist?(large_picture_path)

      trace.import

      assert_equal true, File.exist?(large_picture_path)
    end
  end

  def test_import_handles_bz2
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "c")

      trace.import

      assert_equal 1, trace.size
    end
  end

  def test_import_handles_plain
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "a")

      trace.import

      assert_equal 1, trace.size
    end
  end

  def test_import_handles_plain_with_bom
    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace = create(:trace, :fixture => "b")

      trace.import

      assert_equal 1, trace.size
    end
  end

  def test_import_handles_gz
    trace = create(:trace, :fixture => "d")

    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace.import

      assert_equal 1, trace.size
    ensure
      trace.destroy
    end
  end

  def test_import_handles_zip
    trace = create(:trace, :fixture => "f")

    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace.import

      assert_equal 2, trace.size
    ensure
      trace.destroy
    end
  end

  def test_import_handles_tar
    trace = create(:trace, :fixture => "g")

    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace.import

      assert_equal 2, trace.size
    ensure
      trace.destroy
    end
  end

  def test_import_handles_tar_gz
    trace = create(:trace, :fixture => "h")

    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace.import

      assert_equal 2, trace.size
    ensure
      trace.destroy
    end
  end

  def test_import_handles_tar_bz2
    trace = create(:trace, :fixture => "i")

    FakeFS do
      FakeFS::FileSystem.clone(Rails.root.join("test/gpx"))
      trace.import

      assert_equal 2, trace.size
    ensure
      trace.destroy
    end
  end

  private

  def check_query(query, traces)
    traces = traces.map(&:id).sort
    assert_equal traces, query.order(:id).ids
  end

  def check_mime_type(id, mime_type)
    assert_equal mime_type, create(:trace, :fixture => id).mime_type
  end

  def check_extension_name(id, extension_name)
    assert_equal extension_name, create(:trace, :fixture => id).extension_name
  end

  def check_xml_file(id, md5sum)
    assert_equal md5sum, md5sum(create(:trace, :fixture => id).xml_file)
  end

  def trace_valid(attrs, result = true)
    entry = build(:trace, attrs)
    assert_equal result, entry.valid?, "Expected #{attrs.inspect} to be #{result}"
  end

  def md5sum(io)
    io.each_with_object(Digest::MD5.new) { |l, d| d.update(l) }.hexdigest
  end
end