remote_config_spec.rb

# frozen_string_literal: true

RSpec.describe RuboCop::RemoteConfig do
  include FileHelper

  subject(:remote_config) { described_class.new(remote_config_url, base_dir).file }

  let(:remote_config_url) { 'http://example.com/rubocop.yml' }
  let(:base_dir) { '.' }
  let(:cached_file_name) { '.rubocop-http---example-com-rubocop-yml' }
  let(:cached_file_path) { File.expand_path(cached_file_name, base_dir) }

  before do
    stub_request(:get, remote_config_url)
      .to_return(status: 200, body: "Style/Encoding:\n    Enabled: true")
  end

  after do
    File.unlink cached_file_path if File.exist? cached_file_path
  end

  describe '.file' do
    it 'downloads the file if the file does not exist' do
      expect(remote_config).to eq(cached_file_path)
      expect(File.exist?(cached_file_path)).to be_truthy
    end

    it 'does not download the file if cache lifetime has not been reached' do
      FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 20)

      expect(remote_config).to eq(cached_file_path)
      assert_not_requested :get, remote_config_url
    end

    it 'downloads the file if cache lifetime has been reached' do
      FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 30)

      expect(remote_config).to eq(cached_file_path)
      assert_requested :get, remote_config_url
    end

    context 'when remote URL is configured with token auth' do
      let(:token) { 'personal_access_token' }
      let(:remote_config_url) { "http://#{token}@example.com/rubocop.yml" }
      let(:stripped_remote_config_url) { 'http://example.com/rubocop.yml' }

      before do
        stub_request(:get, stripped_remote_config_url)
          .with(basic_auth: [token])
          .to_return(status: 200, body: "Style/Encoding:\n    Enabled: true")
      end

      it 'downloads the file if the file does not exist' do
        expect(remote_config).to eq(cached_file_path)
        expect(File.exist?(cached_file_path)).to be_truthy
      end

      it 'does not download the file if cache lifetime has not been reached' do
        FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 20)

        expect(remote_config).to eq(cached_file_path)
        assert_not_requested :get, remote_config_url
      end

      it 'downloads the file if cache lifetime has been reached' do
        FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 30)

        expect(remote_config).to eq(cached_file_path)
        assert_requested :get, stripped_remote_config_url
      end

      context 'when the remote URL responds with 404' do
        before do
          stub_request(:get, stripped_remote_config_url).to_return(status: 404)
        end

        it 'raises error' do
          exception = RUBY_VERSION >= '2.6' ? Net::HTTPClientException : Net::HTTPServerException

          expect do
            remote_config
          end.to raise_error(exception,
                             '404 "" while downloading remote config file http://example.com/rubocop.yml')
        end
      end
    end

    context 'when remote URL is configured with basic auth' do
      let(:username) { 'username' }
      let(:password) { 'password' }
      let(:remote_config_url) { "http://#{username}:#{password}@example.com/rubocop.yml" }
      let(:stripped_remote_config_url) { 'http://example.com/rubocop.yml' }

      before do
        stub_request(:get, stripped_remote_config_url)
          .with(basic_auth: [username, password])
          .to_return(status: 200, body: "Style/Encoding:\n    Enabled: true")
      end

      it 'downloads the file if the file does not exist' do
        expect(remote_config).to eq(cached_file_path)
        expect(File.exist?(cached_file_path)).to be_truthy
      end

      it 'does not download the file if cache lifetime has not been reached' do
        FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 20)

        expect(remote_config).to eq(cached_file_path)
        assert_not_requested :get, remote_config_url
      end

      it 'downloads the file if cache lifetime has been reached' do
        FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 30)

        expect(remote_config).to eq(cached_file_path)
        assert_requested :get, stripped_remote_config_url
      end

      context 'when the remote URL responds with 404' do
        before do
          stub_request(:get, stripped_remote_config_url).to_return(status: 404)
        end

        it 'raises error' do
          exception = RUBY_VERSION >= '2.6' ? Net::HTTPClientException : Net::HTTPServerException

          expect do
            remote_config
          end.to raise_error(exception,
                             '404 "" while downloading remote config file http://example.com/rubocop.yml')
        end
      end

      context 'when the remote URL responds with 500' do
        before { stub_request(:get, stripped_remote_config_url).to_return(status: 500) }

        it 'raises error' do
          expect do
            remote_config
          end.to raise_error(Net::HTTPFatalError,
                             '500 "" while downloading remote config file http://example.com/rubocop.yml')
        end
      end
    end

    context 'when the remote URL responds with redirect' do
      let(:new_location) { 'http://cdn.example.com/rubocop.yml' }

      before do
        stub_request(:get, remote_config_url).to_return(headers: { 'Location' => new_location })

        stub_request(:get, new_location)
          .to_return(status: 200, body: "Style/Encoding:\n    Enabled: true")
      end

      it 'follows the redirect and downloads the file' do
        expect(remote_config).to eq(cached_file_path)
        expect(File.exist?(cached_file_path)).to be_truthy
      end
    end

    context 'when the remote URL responds with not modified' do
      before { stub_request(:get, remote_config_url).to_return(status: 304) }

      it 'reuses the existing cached file' do
        FileUtils.touch cached_file_path, mtime: Time.now - ((60 * 60) * 30)

        expect { remote_config }.not_to change(File.stat(cached_file_path), :mtime)
        assert_requested :get, remote_config_url
      end
    end

    context 'when the network is inaccessible' do
      before { stub_request(:get, remote_config_url).to_raise(SocketError) }

      it 'reuses the existing cached file' do
        expect(remote_config).to eq(cached_file_path)
      end
    end

    context 'when the remote URL responds with 500' do
      before { stub_request(:get, remote_config_url).to_return(status: 500) }

      it 'raises error' do
        expect do
          remote_config
        end.to raise_error(Net::HTTPFatalError,
                           '500 "" while downloading remote config file http://example.com/rubocop.yml')
      end
    end
  end

  describe '.inherit_from_remote' do
    context 'when the remote includes file starting with `./`' do
      let(:includes_file) { './base.yml' }

      it 'returns remote includes URI' do
        remote_config = described_class.new(remote_config_url, base_dir)
        includes_config = remote_config.inherit_from_remote(includes_file, remote_config_url)

        expect(includes_config.uri).to eq URI.parse('http://example.com/base.yml')
      end
    end
  end
end