-test_name "should create an email alias"
+test_name 'should create an email alias'
-confine :except, :platform => 'windows'
+confine :except, platform: 'windows'
tag 'audit:low',
'audit:refactor', # Use block style `test_name`
'audit:acceptance' # Could be done at the integration (or unit) layer though
- # actual changing of resources could irreparably damage a
- # host running this, or require special permissions.
+# actual changing of resources could irreparably damage a
+# host running this, or require special permissions.
-name = "pl#{rand(999999).to_i}"
+name = "pl#{rand(999_999).to_i}"
agents.each do |agent|
teardown do
- #(teardown) restore the alias file
- on(agent, "mv /tmp/aliases /etc/aliases", :acceptable_exit_codes => [0,1])
+ # (teardown) restore the alias file
+ on(agent, 'mv /tmp/aliases /etc/aliases', acceptable_exit_codes: [0, 1])
end
#------- SETUP -------#
- step "(setup) backup alias file"
- on(agent, "cp /etc/aliases /tmp/aliases", :acceptable_exit_codes => [0,1])
+ step '(setup) backup alias file'
+ on(agent, 'cp /etc/aliases /tmp/aliases', acceptable_exit_codes: [0, 1])
#------- TESTS -------#
- step "create a mailalias with puppet"
+ step 'create a mailalias with puppet'
args = ['ensure=present',
'recipient="foo,bar,baz"']
on(agent, puppet_resource('mailalias', name, args))
- step "verify the alias exists"
- on(agent, "cat /etc/aliases") do |res|
- assert_match(/#{name}:.*foo,bar,baz/, res.stdout, "mailalias not in aliases file")
+ step 'verify the alias exists'
+ on(agent, 'cat /etc/aliases') do |res|
+ assert_match(%r{#{name}:.*foo,bar,baz}, res.stdout, 'mailalias not in aliases file')
end
-end
+end
-test_name "should delete an email alias"
+test_name 'should delete an email alias'
-confine :except, :platform => 'windows'
+confine :except, platform: 'windows'
tag 'audit:low',
'audit:refactor', # Use block style `test_name`
'audit:acceptance' # Could be done at the integration (or unit) layer though
- # actual changing of resources could irreparably damage a
- # host running this, or require special permissions.
+# actual changing of resources could irreparably damage a
+# host running this, or require special permissions.
-name = "pl#{rand(999999).to_i}"
+name = "pl#{rand(999_999).to_i}"
agents.each do |agent|
teardown do
- #(teardown) restore the alias file
- on(agent, "mv /tmp/aliases /etc/aliases", :acceptable_exit_codes => [0,1])
+ # (teardown) restore the alias file
+ on(agent, 'mv /tmp/aliases /etc/aliases', acceptable_exit_codes: [0, 1])
end
#------- SETUP -------#
- step "(setup) backup alias file"
- on(agent, "cp /etc/aliases /tmp/aliases", :acceptable_exit_codes => [0,1])
+ step '(setup) backup alias file'
+ on(agent, 'cp /etc/aliases /tmp/aliases', acceptable_exit_codes: [0, 1])
- step "(setup) create a mailalias"
+ step '(setup) create a mailalias'
on(agent, "echo '#{name}: foo,bar,baz' >> /etc/aliases")
- step "(setup) verify the alias exists"
- on(agent, "cat /etc/aliases") do |res|
- assert_match(/#{name}:.*foo,bar,baz/, res.stdout, "mailalias not in aliases file")
+ step '(setup) verify the alias exists'
+ on(agent, 'cat /etc/aliases') do |res|
+ assert_match(%r{#{name}:.*foo,bar,baz}, res.stdout, 'mailalias not in aliases file')
end
#------- TESTS -------#
- step "delete the aliases database with puppet"
+ step 'delete the aliases database with puppet'
args = ['ensure=absent',
'recipient="foo,bar,baz"']
on(agent, puppet_resource('mailalias', name, args))
-
- step "verify the alias is absent"
- on(agent, "cat /etc/aliases") do |res|
- assert_no_match(/#{name}:.*foo,bar,baz/, res.stdout, "mailalias was not removed from aliases file")
+ step 'verify the alias is absent'
+ on(agent, 'cat /etc/aliases') do |res|
+ assert_no_match(%r{#{name}:.*foo,bar,baz}, res.stdout, 'mailalias was not removed from aliases file')
end
-end
+end
-test_name "should modify an email alias"
+test_name 'should modify an email alias'
-confine :except, :platform => 'windows'
+confine :except, platform: 'windows'
tag 'audit:low',
'audit:refactor', # Use block style `test_name`
'audit:acceptance' # Could be done at the integration (or unit) layer though
- # actual changing of resources could irreparably damage a
- # host running this, or require special permissions.
+# actual changing of resources could irreparably damage a
+# host running this, or require special permissions.
-name = "pl#{rand(999999).to_i}"
+name = "pl#{rand(999_999).to_i}"
agents.each do |agent|
teardown do
- #(teardown) restore the alias file
- on(agent, "mv /tmp/aliases /etc/aliases", :acceptable_exit_codes => [0,1])
+ # (teardown) restore the alias file
+ on(agent, 'mv /tmp/aliases /etc/aliases', acceptable_exit_codes: [0, 1])
end
#------- SETUP -------#
- step "(setup) backup alias file"
- on(agent, "cp /etc/aliases /tmp/aliases", :acceptable_exit_codes => [0,1])
+ step '(setup) backup alias file'
+ on(agent, 'cp /etc/aliases /tmp/aliases', acceptable_exit_codes: [0, 1])
- step "(setup) create a mailalias"
+ step '(setup) create a mailalias'
on(agent, "echo '#{name}: foo,bar,baz' >> /etc/aliases")
- step "(setup) verify the alias exists"
- on(agent, "cat /etc/aliases") do |res|
- assert_match(/#{name}:.*foo,bar,baz/, res.stdout, "mailalias not in aliases file")
+ step '(setup) verify the alias exists'
+ on(agent, 'cat /etc/aliases') do |res|
+ assert_match(%r{#{name}:.*foo,bar,baz}, res.stdout, 'mailalias not in aliases file')
end
#------- TESTS -------#
- step "modify the aliases database with puppet"
+ step 'modify the aliases database with puppet'
args = ['ensure=present',
'recipient="foo,bar,baz,blarvitz"']
on(agent, puppet_resource('mailalias', name, args))
-
- step "verify the updated alias is present"
- on(agent, "cat /etc/aliases") do |res|
- assert_match(/#{name}:.*foo,bar,baz,blarvitz/, res.stdout, "updated mailalias not in aliases file")
+ step 'verify the updated alias is present'
+ on(agent, 'cat /etc/aliases') do |res|
+ assert_match(%r{#{name}:.*foo,bar,baz,blarvitz}, res.stdout, 'updated mailalias not in aliases file')
end
end
-test_name "should be able to find an exisitng email alias"
+test_name 'should be able to find an exisitng email alias'
-confine :except, :platform => 'windows'
+confine :except, platform: 'windows'
tag 'audit:low',
'audit:refactor', # Use block style `test_name`
'audit:acceptance' # Could be done at the integration (or unit) layer though
- # actual changing of resources could irreparably damage a
- # host running this, or require special permissions.
+# actual changing of resources could irreparably damage a
+# host running this, or require special permissions.
-name = "pl#{rand(999999).to_i}"
+name = "pl#{rand(999_999).to_i}"
agents.each do |agent|
teardown do
- #(teardown) restore the alias file
- on(agent, "mv /tmp/aliases /etc/aliases", :acceptable_exit_codes => [0,1])
+ # (teardown) restore the alias file
+ on(agent, 'mv /tmp/aliases /etc/aliases', acceptable_exit_codes: [0, 1])
end
#------- SETUP -------#
- step "(setup) backup alias file"
- on(agent, "cp /etc/aliases /tmp/aliases", :acceptable_exit_codes => [0,1])
+ step '(setup) backup alias file'
+ on(agent, 'cp /etc/aliases /tmp/aliases', acceptable_exit_codes: [0, 1])
- step "(setup) create a mailalias"
+ step '(setup) create a mailalias'
on(agent, "echo '#{name}: foo,bar,baz' >> /etc/aliases")
- step "(setup) verify the alias exists"
- on(agent, "cat /etc/aliases") do |res|
- assert_match(/#{name}:.*foo,bar,baz/, res.stdout, "mailalias not in aliases file")
+ step '(setup) verify the alias exists'
+ on(agent, 'cat /etc/aliases') do |res|
+ assert_match(%r{#{name}:.*foo,bar,baz}, res.stdout, 'mailalias not in aliases file')
end
#------- TESTS -------#
- step "query for the mail alias with puppet"
+ step 'query for the mail alias with puppet'
on(agent, puppet_resource('mailalias', name)) do
fail_test "didn't find the scheduled_task #{name}" unless stdout.include? 'present'
end
Puppet::Type.type(:mailalias).provide(
:aliases,
- :parent => Puppet::Provider::ParsedFile,
- :default_target => "/etc/aliases",
- :filetype => :flat
+ parent: Puppet::Provider::ParsedFile,
+ default_target: '/etc/aliases',
+ filetype: :flat,
) do
- text_line :comment, :match => /^#/
- text_line :blank, :match => /^\s*$/
+ text_line :comment, match: %r{^#}
+ text_line :blank, match: %r{^\s*$}
- record_line :aliases, :fields => %w{name recipient}, :separator => /\s*:\s*/, :block_eval => :instance do
+ record_line :aliases, fields: %w[name recipient], separator: %r{\s*:\s*}, block_eval: :instance do
def post_parse(record)
if record[:recipient]
- record[:recipient] = record[:recipient].split(/\s*,\s*/).collect { |d| d.gsub(/^['"]|['"]$/, '') }
+ record[:recipient] = record[:recipient].split(%r{\s*,\s*}).map { |d| d.gsub(%r{^['"]|['"]$}, '') }
end
record
end
def process(line)
ret = {}
- records = line.split(':',4)
+ records = line.split(':', 4)
ret[:name] = records[0].strip
- if records.length == 4 and records[2].strip == 'include'
- ret[:file] = records[3].strip
+ if records.length == 4 && records[2].strip == 'include'
+ ret[:file] = records[3].strip
else
- records = line.split(':',2)
- ret[:recipient] = records[1].strip
+ records = line.split(':', 2)
+ ret[:recipient] = records[1].strip
end
ret
end
def to_line(record)
if record[:recipient]
- dest = record[:recipient].collect do |d|
- # Quote aliases that have non-alpha chars
- if d =~ /[^-+\w@.]/
- '"%s"' % d
- else
- d
- end
- end.join(",")
- "#{record[:name]}: #{dest}"
+ dest = record[:recipient].map { |d|
+ # Quote aliases that have non-alpha chars
+ if d =~ %r{[^-+\w@.]}
+ '"%s"' % d
+ else
+ d
+ end
+ }.join(',')
+ "#{record[:name]}: #{dest}"
elsif record[:file]
- "#{record[:name]}: :include: #{record[:file]}"
+ "#{record[:name]}: :include: #{record[:file]}"
end
end
end
end
-
+# Creates an email alias in the local alias database.
module Puppet
Type.newtype(:mailalias) do
- @doc = "Creates an email alias in the local alias database."
+ @doc = 'Creates an email alias in the local alias database.'
ensurable
- newparam(:name, :namevar => true) do
- desc "The alias name."
+ newparam(:name, namevar: true) do
+ desc 'The alias name.'
end
- newproperty(:recipient, :array_matching => :all) do
+ newproperty(:recipient, array_matching: :all) do
desc "Where email should be sent. Multiple values
should be specified as an array. The file and the
recipient entries are mutually exclusive."
recipient entries are mutually exclusive."
validate do |value|
- unless Puppet::Util.absolute_path?(value)
- fail Puppet::Error, _("File paths must be fully qualified, not '%{value}'") % { value: value }
- end
+ unless Puppet::Util.absolute_path?(value)
+ raise Puppet::Error, _("File paths must be fully qualified, not '%{value}'") % { value: value }
+ end
end
end
desc "The file in which to store the aliases. Only used by
those providers that write to disk."
- defaultto { if @resource.class.defaultprovider.ancestors.include?(Puppet::Provider::ParsedFile)
+ defaultto do
+ if @resource.class.defaultprovider.ancestors.include?(Puppet::Provider::ParsedFile)
@resource.class.defaultprovider.default_target
else
nil
end
- }
+ end
end
validate do
if self[:recipient] && self[:file]
- self.fail _("You cannot specify both a recipient and a file")
+ # rubocop:disable Style/SignalException
+ # We need to override this cop because puppet overrides `fail`. We need
+ # to use the puppet implementation of `fail` rather than the default
+ # ruby implementation
+ fail _('You cannot specify both a recipient and a file')
end
end
end
describe provider_class do
# #1560, in which we corrupt the format of complex mail aliases.
- it_should_behave_like "all parsedfile providers", provider_class
+ it_behaves_like 'all parsedfile providers', provider_class
end
# A support module for testing files.
module PuppetSpec::Files
+ @global_tempfiles = []
+
def self.cleanup
- $global_tempfiles ||= []
- while path = $global_tempfiles.pop do
+ until @global_tempfiles.empty?
+ path = @global_tempfiles.pop
begin
Dir.unstub(:entries)
- FileUtils.rm_rf path, :secure => true
- rescue Errno::ENOENT
- # nothing to do
+ FileUtils.rm_rf path, secure: true
end
end
end
- def make_absolute(path) PuppetSpec::Files.make_absolute(path) end
+ def make_absolute(path)
+ PuppetSpec::Files.make_absolute(path)
+ end
+
def self.make_absolute(path)
path = File.expand_path(path)
path[0] = 'c' if Puppet.features.microsoft_windows?
path
end
- def tmpfile(name, dir = nil) PuppetSpec::Files.tmpfile(name, dir) end
+ def tmpfile(name, dir = nil)
+ PuppetSpec::Files.tmpfile(name, dir)
+ end
+
def self.tmpfile(name, dir = nil)
# Generate a temporary file, just for the name...
source = dir ? Tempfile.new(name, dir) : Tempfile.new(name)
path
end
- def file_containing(name, contents) PuppetSpec::Files.file_containing(name, contents) end
+ def file_containing(name, contents)
+ PuppetSpec::Files.file_containing(name, contents)
+ end
+
def self.file_containing(name, contents)
file = tmpfile(name)
File.open(file, 'wb') { |f| f.write(contents) }
file
end
- def script_containing(name, contents) PuppetSpec::Files.script_containing(name, contents) end
+ def script_containing(name, contents)
+ PuppetSpec::Files.script_containing(name, contents)
+ end
+
def self.script_containing(name, contents)
file = tmpfile(name)
if Puppet.features.microsoft_windows?
text = contents[:posix]
end
File.open(file, 'wb') { |f| f.write(text) }
- Puppet::FileSystem.chmod(0755, file)
+ Puppet::FileSystem.chmod(0o755, file)
file
end
- def tmpdir(name) PuppetSpec::Files.tmpdir(name) end
+ def tmpdir(name)
+ PuppetSpec::Files.tmpdir(name)
+ end
+
def self.tmpdir(name)
dir = Puppet::FileSystem.expand_path(Dir.mktmpdir(name).encode!(Encoding::UTF_8))
dir
end
- def dir_containing(name, contents_hash) PuppetSpec::Files.dir_containing(name, contents_hash) end
+ def dir_containing(name, contents_hash)
+ PuppetSpec::Files.dir_containing(name, contents_hash)
+ end
+
def self.dir_containing(name, contents_hash)
dir_contained_in(tmpdir(name), contents_hash)
end
- def dir_contained_in(dir, contents_hash) PuppetSpec::Files.dir_contained_in(dir, contents_hash) end
+ def dir_contained_in(dir, contents_hash)
+ PuppetSpec::Files.dir_contained_in(dir, contents_hash)
+ end
+
def self.dir_contained_in(dir, contents_hash)
- contents_hash.each do |k,v|
+ contents_hash.each do |k, v|
if v.is_a?(Hash)
- Dir.mkdir(tmp = File.join(dir,k))
+ Dir.mkdir(tmp = File.join(dir, k))
dir_contained_in(tmp, v)
else
file = File.join(dir, k)
- File.open(file, 'wb') {|f| f.write(v) }
+ File.open(file, 'wb') { |f| f.write(v) }
end
end
dir
def self.record_tmp(tmp)
# ...record it for cleanup,
- $global_tempfiles ||= []
- $global_tempfiles << tmp
+ @global_tempfiles << tmp
end
def expect_file_mode(file, mode)
- actual_mode = "%o" % Puppet::FileSystem.stat(file).mode
+ actual_mode = '%o' % Puppet::FileSystem.stat(file).mode
target_mode = if Puppet.features.microsoft_windows?
- mode
- else
- "10" + "%04i" % mode.to_i
- end
+ mode
+ else
+ '10' + '%04i' % mode.to_i
+ end
expect(actual_mode).to eq(target_mode)
end
end
-shared_examples_for "all parsedfile providers" do |provider, *files|
- if files.empty? then
+shared_examples_for 'all parsedfile providers' do |provider, *files|
+ if files.empty?
files = my_fixtures
end
provider.prefetch
text = provider.to_file(provider.target_records(file))
- text.gsub!(/^# HEADER.+\n/, '')
+ text.gsub!(%r{^# HEADER.+\n}, '')
oldlines = File.readlines(file)
newlines = text.chomp.split "\n"
oldlines.zip(newlines).each do |old, new|
- expect(new.gsub(/\s+/, '')).to eq(old.chomp.gsub(/\s+/, ''))
+ expect(new.gsub(%r{\s+}, '')).to eq(old.chomp.gsub(%r{\s+}, ''))
end
end
end
# So everyone else doesn't have to include this base constant.
module PuppetSpec
- FIXTURE_DIR = File.join(File.expand_path(File.dirname(__FILE__)), "fixtures") unless defined?(FIXTURE_DIR)
+ FIXTURE_DIR = File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures') unless defined?(FIXTURE_DIR)
end
require 'puppet_spec/files'
describe Puppet::Type.type(:mailalias) do
include PuppetSpec::Files
- let :tmpfile_path do tmpfile('afile') end
- let :target do tmpfile('mailalias') end
+ let :tmpfile_path do
+ tmpfile('afile')
+ end
+
+ let :target do
+ tmpfile('mailalias')
+ end
+
let :recipient_resource do
- described_class.new(:name => "luke", :recipient => "yay", :target => target)
+ described_class.new(name: 'luke', recipient: 'yay', target: target)
end
let :file_resource do
- described_class.new(:name => "lukefile", :file => tmpfile_path, :target => target)
+ described_class.new(name: 'lukefile', file: tmpfile_path, target: target)
end
- it "should be initially absent as a recipient" do
+ it 'is initially absent as a recipient' do
expect(recipient_resource.retrieve_resource[:recipient]).to eq(:absent)
end
- it "should be initially absent as an included file" do
+ it 'is initially absent as an included file' do
expect(file_resource.retrieve_resource[:file]).to eq(:absent)
end
- it "should try and set the recipient when it does the sync" do
+ it 'tries and set the recipient when it does the sync' do
expect(recipient_resource.retrieve_resource[:recipient]).to eq(:absent)
- recipient_resource.property(:recipient).expects(:set).with(["yay"])
+ recipient_resource.property(:recipient).expects(:set).with(['yay'])
recipient_resource.property(:recipient).sync
end
- it "should try and set the included file when it does the sync" do
+ it 'tries and set the included file when it does the sync' do
expect(file_resource.retrieve_resource[:file]).to eq(:absent)
file_resource.property(:file).expects(:set).with(tmpfile_path)
file_resource.property(:file).sync
end
- it "should fail when file is not an absolute path" do
+ it 'fails when file is not an absolute path' do
expect {
- Puppet::Type.type(:mailalias).new(:name => 'x', :file => 'afile')
- }.to raise_error Puppet::Error, /File paths must be fully qualified/
+ Puppet::Type.type(:mailalias).new(name: 'x', file: 'afile')
+ }.to raise_error Puppet::Error, %r{File paths must be fully qualified}
end
- it "should fail when both file and recipient are specified" do
+ it 'fails when both file and recipient are specified' do
expect {
- Puppet::Type.type(:mailalias).new(:name => 'x', :file => tmpfile_path,
- :recipient => 'foo@example.com')
- }.to raise_error Puppet::Error, /cannot specify both a recipient and a file/
+ Puppet::Type.type(:mailalias).new(name: 'x', file: tmpfile_path,
+ recipient: 'foo@example.com')
+ }.to raise_error Puppet::Error, %r{cannot specify both a recipient and a file}
end
end
projects / puppet-mailalias_core.git / commitdiff