Add coverage for URLValidator (#25591)

This commit is contained in:
Matt Jankowski 2023-07-28 17:12:25 -04:00 committed by GitHub
parent 6602edf064
commit 660993b415
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 70 additions and 23 deletions

View file

@ -1,16 +1,31 @@
# frozen_string_literal: true # frozen_string_literal: true
class URLValidator < ActiveModel::EachValidator class URLValidator < ActiveModel::EachValidator
VALID_SCHEMES = %w(http https).freeze
def validate_each(record, attribute, value) def validate_each(record, attribute, value)
record.errors.add(attribute, :invalid) unless compliant?(value) @value = value
record.errors.add(attribute, :invalid) unless compliant_url?
end end
private private
def compliant?(url) def compliant_url?
parsed_url = Addressable::URI.parse(url) parsed_url.present? && valid_url_scheme? && valid_url_host?
parsed_url && %w(http https).include?(parsed_url.scheme) && parsed_url.host end
def parsed_url
Addressable::URI.parse(@value)
rescue Addressable::URI::InvalidURIError rescue Addressable::URI::InvalidURIError
false false
end end
def valid_url_scheme?
VALID_SCHEMES.include?(parsed_url.scheme)
end
def valid_url_host?
parsed_url.host.present?
end
end end

View file

@ -2,32 +2,64 @@
require 'rails_helper' require 'rails_helper'
RSpec.describe URLValidator, type: :validator do describe URLValidator do
let(:record_class) do
Class.new do
include ActiveModel::Validations
attr_accessor :profile
validates :profile, url: true
end
end
let(:record) { record_class.new }
describe '#validate_each' do describe '#validate_each' do
before do context 'with a nil value' do
allow(validator).to receive(:compliant?).with(value) { compliant } it 'adds errors' do
validator.validate_each(record, attribute, value) record.profile = nil
end
let(:validator) { described_class.new(attributes: [attribute]) } expect(record).to_not be_valid
let(:record) { instance_double(Webhook, errors: errors) } expect(record.errors.first.attribute).to eq(:profile)
let(:errors) { instance_double(ActiveModel::Errors, add: nil) } expect(record.errors.first.type).to eq(:invalid)
let(:value) { '' }
let(:attribute) { :foo }
context 'when not compliant?' do
let(:compliant) { false }
it 'calls errors.add' do
expect(errors).to have_received(:add).with(attribute, :invalid)
end end
end end
context 'when compliant?' do context 'with an invalid url scheme' do
let(:compliant) { true } it 'adds errors' do
record.profile = 'ftp://example.com/page'
it 'not calls errors.add' do expect(record).to_not be_valid
expect(errors).to_not have_received(:add).with(attribute, any_args) expect(record.errors.first.attribute).to eq(:profile)
expect(record.errors.first.type).to eq(:invalid)
end
end
context 'without a hostname' do
it 'adds errors' do
record.profile = 'https:///page'
expect(record).to_not be_valid
expect(record.errors.first.attribute).to eq(:profile)
expect(record.errors.first.type).to eq(:invalid)
end
end
context 'with an unparseable value' do
it 'adds errors' do
record.profile = 'https://host:port/page' # non-numeric port string causes invalid uri error
expect(record).to_not be_valid
expect(record.errors.first.attribute).to eq(:profile)
expect(record.errors.first.type).to eq(:invalid)
end
end
context 'with a valid url' do
it 'does not add errors' do
record.profile = 'https://example.com/page'
expect(record).to be_valid
expect(record.errors).to be_empty
end end
end end
end end