danbooru/test/test_helpers/source_test_helper.rb

module SourceTestHelper
  # A helper method to automate all the checks needed to make sure that a strategy does not break.
  #
  # * If download_size is nil, it tests that the file is downloaded correctly, otherwise it also checks the filesize.
  # * If deleted is true, it skips the downloading check, but it still tries everything else and makes sure nothing breaks.
  # * Any passed kwargs parameter is tested against the strategy.

  def strategy_should_work(url, arguments = {})
    # XXX: can't use **kwargs because of a bug with shoulda-context
    referer, download_size, deleted = [:referer, :download_size, :deleted].map { |arg| arguments.delete(arg) }

    should "not raise anything" do
      strategy = Source::Extractor.find(url, referer)
      assert_nothing_raised { strategy.to_h }
    end

    should "make sure that image_urls is an array of valid elements" do
      strategy = Source::Extractor.find(url, referer)
      assert((strategy.image_urls.instance_of? Array))
      assert_not(strategy.image_urls.include?(nil))
    end

    should_download_successfully(url, referer, download_size) unless deleted

    # {profile_url: nil}[:profile_url].present? -> false
    # Doing it this way instead we can check profile_url even if it's passed as a nil.
    if arguments.include? :profile_url
      profile_url = arguments.delete(:profile_url)
      should_handle_artists_correctly(url, referer, profile_url)
    end

    tags = arguments.delete(:tags)
    should_validate_tags(url, referer, tags)

    should_match_source_data(url, referer, arguments)
  end

  def should_download_successfully(url, referer, download_size = nil) # XXX perhaps refactor into should_upload_successfully in order to streamline the source tests further?
    should "download successfully" do
      strategy = Source::Extractor.find(url, referer)

      if download_size.present? && strategy.image_urls.present?
        file = strategy.download_file!(strategy.image_urls.first)
        assert_equal(download_size, file.size)
      end
    end
  end

  def should_handle_artists_correctly(url, referer, profile_url)
    if profile_url.present?
      should "correctly match a strategy to an artist with the same profile url" do
        strategy = Source::Extractor.find(url, referer)

        assert_not_nil(Danbooru::URL.parse(strategy.profile_url))
        assert_equal(profile_url, strategy.profile_url)
        artist = FactoryBot.create(:artist, name: strategy.tag_name, url_string: profile_url)
        assert_equal([artist], strategy.artists)
      end
    else
      should "not incorrectly extract a profile url or artist data when there's none to be found" do
        strategy = Source::Extractor.find(url, referer)

        assert_nil(strategy.profile_url.presence)
        assert_nil(strategy.artist_name.presence)
        assert_equal([], strategy.other_names)
      end
    end
  end

  def should_validate_tags(url, referer, tags = nil)
    should "make sure that tags return an array of arrays" do
      strategy = Source::Extractor.find(url, referer)

      assert((strategy.tags.instance_of? Array))
      if strategy.tags.present?
        assert((strategy.tags.first.instance_of? Array))
      end
    end

    return unless tags.present?

    should "make sure that tags match" do
      strategy = Source::Extractor.find(url, referer)

      if tags&.first.instance_of? Array
        assert_equal(tags.sort, strategy.tags.sort)
      elsif tags&.first.instance_of? String
        assert_equal(tags.map(&:downcase).sort, strategy.tags.map(&:first).map(&:downcase).sort)
      end
    end
  end

  def should_match_source_data(url, referer, methods_to_test)
    # check any method that is passed as kwargs, in order to hardcode as few things as possible
    # XXX can't use **kwargs because of a bug with shoulda-context, so we're using a hash temporarily
    methods_to_test.each do |method_name, expected_value|
      should "make sure that '#{method_name}' matches" do
        strategy = Source::Extractor.find(url, referer)
        actual_value = strategy.public_send(method_name)

        if expected_value.instance_of? Regexp
          assert_match(expected_value, actual_value)
        elsif expected_value.instance_of? Array
          if expected_value.first.instance_of? Regexp
            # We don't sort actual_value here because sites like nicoseiga have variable values right in the middle of the url, like timestamps
            expected_value.zip(actual_value).map { |expected_regex, actual_string| assert_match(expected_regex, actual_string) }
          else
            assert_equal(expected_value.sort, actual_value.sort)
          end
        elsif expected_value.nil?
          assert_nil(actual_value)
        else
          assert_equal(expected_value, actual_value)
        end
      end
    end
  end
end