Skip to content

Add validate_email_address function #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions lib/puppet/parser/functions/is_email_address.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#
# is_email_address.rb
#

module Puppet::Parser::Functions
newfunction(:is_email_address, type: :rvalue, doc: <<-EOS
Returns true if the string passed to this function is a valid email address.
EOS
) do |arguments|
if arguments.size != 1
raise(Puppet::ParseError, 'is_email_address(): Wrong number of arguments '\
"given #{arguments.size} for 1")
end

# Taken from http://emailregex.com/ (simpler regex)
valid_email_regex = %r{\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z}
return (arguments[0] =~ valid_email_regex) == 0
end
end

# vim: set ts=2 sw=2 et :
31 changes: 31 additions & 0 deletions lib/puppet/parser/functions/validate_email_address.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
module Puppet::Parser::Functions
newfunction(:validate_email_address, doc: <<-ENDHEREDOC
Validate that all values passed are valid email addresses.
Fail compilation if any value fails this check.
The following values will pass:
$my_email = "[email protected]"
validate_email_address($my_email)
validate_email_address("[email protected]", "[email protected]", $my_email)

The following values will fail, causing compilation to abort:
$some_array = [ 'bad_email@/d/efdf.com' ]
validate_email_address($some_array)
ENDHEREDOC
) do |args|
rescuable_exceptions = [ArgumentError]

if args.empty?
raise Puppet::ParseError, "validate_email_address(): wrong number of arguments (#{args.length}; must be > 0)"
end

args.each do |arg|
raise Puppet::ParseError, "#{arg.inspect} is not a string." unless arg.is_a?(String)

begin
raise Puppet::ParseError, "#{arg.inspect} is not a valid email address" unless function_is_email_address([arg])
rescue *rescuable_exceptions
raise Puppet::ParseError, "#{arg.inspect} is not a valid email address"
end
end
end
end
14 changes: 14 additions & 0 deletions spec/functions/is_email_address_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
require 'spec_helper'

describe 'is_email_address' do
it { is_expected.not_to eq(nil) }
it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) }
it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError, /wrong number of arguments/i) }
it { is_expected.to run.with_params('[email protected]').and_return(true) }
it { is_expected.to run.with_params('[email protected]').and_return(true) }
it { is_expected.to run.with_params('[email protected]').and_return(true) }
it { is_expected.to run.with_params('1.2.3@domain').and_return(false) }
it { is_expected.to run.with_params('1.2.3.4.5@').and_return(false) }
it { is_expected.to run.with_params({}).and_return(false) }
it { is_expected.to run.with_params([]).and_return(false) }
end
23 changes: 23 additions & 0 deletions spec/functions/validate_email_address_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
require 'spec_helper'

describe 'validate_email_address' do
describe 'signature validation' do
it { is_expected.not_to eq(nil) }
it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /wrong number of arguments/i) }
end

describe 'valid inputs' do
it { is_expected.to run.with_params('[email protected]') }
it { is_expected.to run.with_params('[email protected]') }
end

describe 'invalid inputs' do
it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /is not a string/) }
it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /is not a string/) }
it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /is not a string/) }
it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, /is not a valid email/) }
it { is_expected.to run.with_params('[email protected]', {}).and_raise_error(Puppet::ParseError, /is not a string/) }
it { is_expected.to run.with_params('[email protected]', true).and_raise_error(Puppet::ParseError, /is not a string/) }
it { is_expected.to run.with_params('[email protected]', 'one').and_raise_error(Puppet::ParseError, /is not a valid email/) }
end
end